platformatic 0.22.0 → 0.23.0

package/cli.js

@@ -4,6 +4,7 @@ import commist from 'commist'
 import minimist from 'minimist'
 import { runDB } from '@platformatic/db/db.mjs'
 import { runService } from '@platformatic/service/service.mjs'
+import { startCommand } from '@platformatic/start'
 import { login } from '@platformatic/authenticate/authenticate.js'
 import { command as client } from '@platformatic/client-cli'
 import { readFile } from 'fs/promises'
@@ -38,6 +39,7 @@ const ensureCommand = async ({ output, help }) => {
 
 program.register('db', async (args) => ensureCommand(await runDB(args)))
 program.register('service', async (args) => ensureCommand(await runService(args)))
+program.register('start', startCommand)
 program.register('upgrade', upgrade)
 program.register('client', client)
 program.register('help', help.toStdout)

package/help/help.txt

@@ -7,3 +7,4 @@ Welcome to Platformatic. Available commands are:
 * upgrade - upgrade the Platformatic configuration to the latest version.
 * gh - creates a new gh action for Platformatic deployments
 * deploy - deploy a Platformatic application to the cloud
+* start - start a Platformatic application

package/help/start.txt

@@ -0,0 +1,5 @@
+Start a Platformatic application with the following command:
+
+``` bash
+$ platformatic start
+```

package/lib/deploy.js

@@ -104,10 +104,7 @@ export async function deploy (argv) {
       const labelPrefix = label.split(':')[0]
       const labelPrefixes = ['cli', 'github-pr']
       if (!labelPrefix || !labelPrefixes.includes(labelPrefix)) {
-        throw new Error(
-          `Invalid deploy label provided: "${label}". ` +
-          `Label must be prefixed with one of: ${labelPrefixes.join(', ')}.`
-        )
+        label = `cli:${label}`
       }
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "platformatic",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "description": "Platformatic CLI",
   "main": "cli.js",
   "type": "module",
@@ -46,15 +46,16 @@
     "help-me": "^4.2.0",
     "inquirer": "^9.2.0",
     "minimist": "^1.2.8",
-    "pino": "^8.11.0",
+    "pino": "^8.12.0",
     "pino-pretty": "^10.0.0",
-    "@platformatic/authenticate": "0.22.0",
-    "@platformatic/client-cli": "0.22.0",
-    "@platformatic/config": "0.22.0",
-    "@platformatic/db": "0.22.0",
-    "@platformatic/metaconfig": "0.22.0",
-    "@platformatic/service": "0.22.0",
-    "create-platformatic": "0.22.0"
+    "@platformatic/authenticate": "0.23.0",
+    "@platformatic/client-cli": "0.23.0",
+    "@platformatic/config": "0.23.0",
+    "@platformatic/db": "0.23.0",
+    "@platformatic/metaconfig": "0.23.0",
+    "@platformatic/service": "0.23.0",
+    "@platformatic/start": "0.23.0",
+    "create-platformatic": "0.23.0"
   },
   "scripts": {
     "test": "standard | snazzy && c8 --100 tap --no-coverage test/*.test.js",

package/test/deploy.test.js

@@ -147,28 +147,54 @@ test('should fail if invalid workspace type provided', async (t) => {
   }
 })
 
-test('should fail if deploy label does not start with a "cli:" prefix', async (t) => {
+test('should deploy to a dynamic workspace to the cloud', async (t) => {
   const workspaceType = 'dynamic'
   const workspaceId = 'b3d7f7e0-8c03-11e8-9eb6-529269fb1459'
   const workspaceKey = 'b3d7f7e08c0311e89eb6529269fb1459'
   const pathToConfig = join(import.meta.url, './fixtures/app-to-deploy/platformatic.db.json')
-  const label = 'my label'
+  const label = 'cli:deploy-2'
 
-  try {
-    await execa('node', [
-      cliPath, 'deploy',
-      '--type', workspaceType,
-      '--label', label,
-      '--config', pathToConfig,
-      '--workspace-id', workspaceId,
-      '--workspace-key', workspaceKey,
-      '--deploy-service-host', 'http://localhost:5555'
-    ])
-    t.fail('should have failed')
-  } catch (err) {
-    t.ok(err.message.includes(
-      `Invalid deploy label provided: "${label}". ` +
-      'Label must be prefixed with one of: cli, github-pr.'
-    ))
-  }
+  const machineHost = await startMachine(t)
+  const deployServiceHost = await startDeployService(t, {
+    createBundleCallback: (request, reply) => {
+      t.equal(request.headers['x-platformatic-workspace-id'], workspaceId)
+      t.equal(request.headers['x-platformatic-api-key'], workspaceKey)
+      t.match(request.body, {
+        bundle: {
+          appType: 'db',
+          configPath: 'platformatic.db.json'
+        }
+      })
+      t.ok(request.body.bundle.checksum)
+    },
+    createDeploymentCallback: (request, reply) => {
+      t.equal(request.headers['x-platformatic-workspace-id'], workspaceId)
+      t.equal(request.headers['x-platformatic-api-key'], workspaceKey)
+      t.same(
+        request.body,
+        {
+          label,
+          variables: {
+            PLT_ENV_VARIABLE1: 'platformatic_variable1',
+            PLT_ENV_VARIABLE2: 'platformatic_variable2'
+          },
+          secrets: {
+            PLT_SECRET_1: 'platformatic_secret_1',
+            PLT_SECRET_2: 'platformatic_secret_2'
+          }
+        }
+      )
+      reply.code(200).send({ entryPointUrl: machineHost })
+    }
+  })
+
+  await execa('node', [
+    cliPath, 'deploy',
+    '--type', workspaceType,
+    '--label', 'deploy-2',
+    '--config', pathToConfig,
+    '--workspace-id', workspaceId,
+    '--workspace-key', workspaceKey,
+    '--deploy-service-host', deployServiceHost
+  ])
 })

package/test/fixtures/platformatic.service.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.22.0/service",
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0,
+    "logger": {
+      "level": "info",
+      "name": "hello server"
+    }
+  },
+  "metrics": false,
+  "watch": false
+}

package/test/start.test.js

@@ -0,0 +1,40 @@
+import { spawn } from 'node:child_process'
+import { cp } from 'node:fs/promises'
+import { tmpdir } from 'node:os'
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { test } from 'tap'
+import { cliPath } from './helper.js'
+
+let count = 0
+
+test('starts a server', async ({ teardown }) => {
+  const src = join(dirname(fileURLToPath(import.meta.url)), 'fixtures', 'platformatic.service.json')
+  const destDir = join(tmpdir(), `test-cli-${process.pid}-${count++}`)
+  const dest = join(destDir, 'platformatic.service.json')
+
+  await cp(src, dest)
+
+  const child = spawn(process.execPath, [cliPath, 'start'], {
+    cwd: destDir,
+    timeout: 10_000
+  })
+
+  teardown(async () => {
+    try {
+      child.kill('SIGINT')
+    } catch {} // Ignore error.
+  })
+
+  let stdout = ''
+
+  child.stdout.setEncoding('utf8')
+
+  for await (const chunk of child.stdout) {
+    stdout += chunk
+
+    if (/server listening at/i.test(stdout)) {
+      break
+    }
+  }
+})