platformatic 1.6.0 → 1.7.0

package/help/deploy.txt

@@ -21,3 +21,44 @@ Options:
 > :information_source:
 >
 > When deploying an application to a ***dynamic workspace***, specify the deploy `--label` option. You can find it on your cloud dashboard or you can specify a new one.
+>
+> If you do not specify an environment file to use with the `-e` flag, **ensure that a default environment file named `.env` exists**.
+
+Deploy a **static** Platformatic Cloud application.
+
+```bash
+platformatic deploy \
+    -t static \
+    -c platformatic.db.json \
+    -e .env.prototype \
+    --workspace-id=00000000-0000-0000-0000-000000000000 \
+    --workspace-key=11111111111111111111111111111111
+```
+
+Deploy a **static** Platformatic Cloud application with a workspace keys file. The keys file can be downloaded from the Platformatic Console when generating a new API key.
+
+```bash
+platformatic deploy \
+    -t static \
+    -c platformatic.db.json \
+    -k foo.plt.txt
+```
+
+The `foo.plt.txt` must contain two variables for the workspace id and workspace API key.
+
+```
+# Contents of foo.plt.txt
+PLATFORMATIC_STATIC_WORKSPACE_ID=00000000-0000-0000-0000-000000000000
+PLATFORMATIC_STATIC_WORKSPACE_API_KEY=11111111111111111111111111111111
+```
+
+Deploy a **dynamic** Platformatic Cloud application.
+
+```bash
+platformatic deploy \
+    -t dynamic \
+    -c platformatic.db.json \
+    -l dev \
+    --workspace-id=00000000-0000-0000-0000-000000000000 \
+    --workspace-key=11111111111111111111111111111111
+```

package/help/help.txt

@@ -9,3 +9,4 @@ Welcome to Platformatic. Available commands are:
 * `deploy` - deploy a Platformatic application to the cloud.
 * `runtime` - start Platformatic Runtime; type `platformatic runtime help` to know more.
 * `start` - start a Platformatic application.
+* `login` - generate a Platformatic login api key.

package/help/login.txt

@@ -0,0 +1,10 @@
+Generate a Platformatic login api key.
+
+``` bash
+ $ platformatic deploy
+```
+
+Options:
+
+* `-c, --config FILE` - Specify a path to a global platformatic config file. Defaults to `~/.platformatic/config.json`.
+* `--browser` - Automatically open default browser. If process stdout is a TTY, the default is `true`. Otherwise, the default is `false`.

package/lib/deploy.js

@@ -3,12 +3,14 @@
 import { isAbsolute, dirname, relative, join } from 'path'
 import { readFile } from 'fs/promises'
 
+import { request } from 'undici'
 import pino from 'pino'
 import pretty from 'pino-pretty'
 import dotenv from 'dotenv'
 import inquirer from 'inquirer'
 import parseArgs from 'minimist'
 import deployClient from '@platformatic/deploy-client'
+import { getUserApiKey } from '@platformatic/authenticate'
 import errors from './errors.js'
 
 export const DEPLOY_SERVICE_HOST = 'https://deploy.platformatic.cloud'
@@ -21,8 +23,12 @@ const logger = pino(pretty({
   ignore: 'hostname,pid'
 }))
 
-async function askWorkspaceDetails (args) {
-  let workspaceType = args.type
+async function askMissingWorkspaceDetails (
+  workspaceType,
+  workspaceId,
+  workspaceKey,
+  userApiKey
+) {
   /* c8 ignore next 9 */
   if (!workspaceType) {
     const answer = await inquirer.prompt({
@@ -38,7 +44,6 @@ async function askWorkspaceDetails (args) {
     throw new errors.InvalidWorkspaceTypeError(workspaceType, WORKSPACE_TYPES.join(', '))
   }
 
-  let workspaceId = args['workspace-id']
   /* c8 ignore next 8 */
   if (!workspaceId) {
     const answer = await inquirer.prompt({
@@ -53,9 +58,8 @@ async function askWorkspaceDetails (args) {
     throw new errors.InvalidWorkspaceIdError()
   }
 
-  let workspaceKey = args['workspace-key']
   /* c8 ignore next 9 */
-  if (!workspaceKey) {
+  if (!workspaceKey && !userApiKey) {
     const answer = await inquirer.prompt({
       type: 'password',
       name: 'workspaceKey',
@@ -72,6 +76,93 @@ async function askWorkspaceDetails (args) {
   }
 }
 
+/* c8 ignore next 26 */
+async function askToChooseApplication (applications) {
+  const applicationChoices = applications.map((application) => {
+    return {
+      name: application.name,
+      value: application
+    }
+  })
+  applicationChoices.push({
+    name: 'Deploy to another application',
+    value: null
+  })
+
+  const answer = await inquirer.prompt({
+    type: 'list',
+    name: 'application',
+    message: 'Select application to deploy:',
+    choices: applicationChoices
+  })
+
+  const chosenApplication = answer.application
+  if (chosenApplication === null) {
+    return null
+  }
+
+  return chosenApplication
+}
+
+/* c8 ignore next 27 */
+async function askToChooseWorkspace (workspaces) {
+  const workspaceChoices = workspaces.map((workspace) => {
+    return {
+      name: `${workspace.name} (${workspace.type})`,
+      value: workspace
+    }
+  })
+  workspaceChoices.push({
+    name: 'Deploy to another workspace',
+    value: null
+  })
+
+  const answer = await inquirer.prompt({
+    type: 'list',
+    name: 'workspace',
+    message: 'Select workspace to deploy:',
+    choices: workspaceChoices
+  })
+
+  const chosenWorkspace = answer.workspace
+  if (chosenWorkspace === null) {
+    return null
+  }
+
+  return chosenWorkspace
+}
+
+/* c8 ignore next 19 */
+async function askToChooseDeployLabel (labels) {
+  const entryPointChoices = labels.map((label) => {
+    return { name: label, value: label }
+  })
+  entryPointChoices.push({
+    name: 'Deploy to another label',
+    value: null
+  })
+
+  const answer = await inquirer.prompt({
+    type: 'list',
+    name: 'entryPoint',
+    message: 'Select entry point to deploy:',
+    choices: entryPointChoices
+  })
+
+  return answer.entryPoint
+}
+
+/* c8 ignore next 10 */
+async function askToEnterDeployLabel () {
+  const answer = await inquirer.prompt({
+    type: 'input',
+    name: 'label',
+    message: 'Enter deploy label:',
+    default: 'cli:deploy-1'
+  })
+  return answer.label
+}
+
 async function readWorkspaceDetails (workspaceKeysPath) {
   /* c8 ignore next 3 */
   if (!isAbsolute(workspaceKeysPath)) {
@@ -106,6 +197,65 @@ async function readWorkspaceDetails (workspaceKeysPath) {
   throw new errors.CouldNotFindWorkspaceKeysError()
 }
 
+/* c8 ignore next 18 */
+async function getUserApplications (deployServiceHost, userApiKey) {
+  const { statusCode, body } = await request(`${deployServiceHost}/applications`, {
+    headers: {
+      'Content-Type': 'application/json',
+      'x-platformatic-user-api-key': userApiKey
+    }
+  })
+
+  if (statusCode !== 200) {
+    const error = await body.text()
+    console.error(error)
+    throw new errors.CouldNotFetchUserApplicationsError()
+  }
+
+  const { applications } = await body.json()
+  return applications
+}
+
+/* c8 ignore next 18 */
+async function getWorkspaceLabels (deployServiceHost, workspaceId, userApiKey) {
+  const { statusCode, body } = await request(`${deployServiceHost}/entrypoints`, {
+    headers: {
+      'Content-Type': 'application/json',
+      'x-platformatic-workspace-id': workspaceId,
+      'x-platformatic-user-api-key': userApiKey
+    }
+  })
+
+  if (statusCode !== 200) {
+    const error = await body.text()
+    console.error(error)
+    throw new errors.CouldNotFetchDeployLabelsError()
+  }
+
+  const { entryPoints } = await body.json()
+  return entryPoints.map((entryPoint) => entryPoint.label)
+}
+
+/* c8 ignore next 19 */
+async function getUserWorkspaceDetails (deployServiceHost, userApiKey) {
+  const applications = await getUserApplications(deployServiceHost, userApiKey)
+  if (applications.length === 0) return null
+
+  const application = await askToChooseApplication(applications)
+  if (application === null) return null
+
+  const workspaces = application.workspaces
+  if (workspaces.length === 0) return null
+
+  const workspaceDetails = await askToChooseWorkspace(workspaces)
+  if (workspaceDetails === null) return null
+
+  return {
+    workspaceType: workspaceDetails.type,
+    workspaceId: workspaceDetails.id
+  }
+}
+
 export async function deploy (argv) {
   try {
     const args = parseArgs(argv, {
@@ -134,24 +284,63 @@ export async function deploy (argv) {
       }
     })
 
-    const workspaceKeysPath = args.keys
-    const workspaceDetails = workspaceKeysPath
-      ? await readWorkspaceDetails(workspaceKeysPath)
-      : await askWorkspaceDetails(args)
+    const deployServiceHost = args['deploy-service-host']
+
+    let workspaceId = args['workspace-id']
+    let workspaceType = args.type
 
-    const { workspaceType, workspaceId, workspaceKey } = workspaceDetails
+    let workspaceKey = args['workspace-key']
+    let userApiKey = null
+
+    if (!workspaceId) {
+      if (args.keys) {
+        const workspaceDetails = await readWorkspaceDetails(args.keys)
+        workspaceId = workspaceDetails.workspaceId
+        workspaceType = workspaceDetails.workspaceType
+        workspaceKey = workspaceDetails.workspaceKey
+      /* c8 ignore next 10 */
+      } else {
+        userApiKey = await getUserApiKey()
+        if (userApiKey) {
+          const workspaceDetails = await getUserWorkspaceDetails(deployServiceHost, userApiKey)
+          if (workspaceDetails) {
+            workspaceId = workspaceDetails.workspaceId
+            workspaceType = workspaceDetails.workspaceType
+          }
+        }
+      }
+    }
+
+    const workspaceDetails = await askMissingWorkspaceDetails(
+      workspaceType,
+      workspaceId,
+      workspaceKey,
+      userApiKey
+    )
+    workspaceId = workspaceDetails.workspaceId
+    workspaceType = workspaceDetails.workspaceType
+    workspaceKey = workspaceDetails.workspaceKey
 
     let label = args.label
+
     if (workspaceType === 'dynamic') {
-    /* c8 ignore next 9 */
+      /* c8 ignore next 17 */
       if (!label) {
-        const answer = await inquirer.prompt({
-          type: 'input',
-          name: 'label',
-          message: 'Enter deploy label:',
-          default: 'cli:deploy-1'
-        })
-        label = answer.label
+        userApiKey = userApiKey || await getUserApiKey()
+
+        if (userApiKey) {
+          const workspaceLabels = await getWorkspaceLabels(
+            deployServiceHost,
+            workspaceId,
+            userApiKey
+          )
+          if (workspaceLabels.length !== 0) {
+            label = await askToChooseDeployLabel(workspaceLabels)
+          }
+        }
+        if (!label) {
+          label = await askToEnterDeployLabel()
+        }
       }
 
       const labelPrefix = label.split(':')[0]
@@ -171,12 +360,12 @@ export async function deploy (argv) {
 
     const pathToEnvFile = args.env || '.env'
     const pathToSecretsFile = args.secrets || '.secrets.env'
-    const deployServiceHost = args['deploy-service-host']
 
     await deployClient.deploy({
       deployServiceHost,
       workspaceId,
       workspaceKey,
+      userApiKey,
       pathToProject,
       pathToConfig,
       pathToEnvFile,

package/lib/errors.js

@@ -7,7 +7,9 @@ const ERROR_PREFIX = 'PLT_CLI'
 const errors = {
   InvalidWorkspaceTypeError: createError(`${ERROR_PREFIX}_INVALID_WORKSPACE_TYPE`, 'Invalid workspace type provided: "%s". Type must be one of: %s'),
   InvalidWorkspaceIdError: createError(`${ERROR_PREFIX}_INVALID_WORKSPACE_ID`, 'Invalid workspace id provided. Workspace id must be a valid uuid.'),
-  CouldNotFindWorkspaceKeysError: createError(`${ERROR_PREFIX}_COULD_NOT_FIND_WORKSPACE_KEYS`, 'Could not find workspace keys in provided file.')
+  CouldNotFindWorkspaceKeysError: createError(`${ERROR_PREFIX}_COULD_NOT_FIND_WORKSPACE_KEYS`, 'Could not find workspace keys in provided file.'),
+  CouldNotFetchUserApplicationsError: createError(`${ERROR_PREFIX}_COULD_NOT_FETCH_USER_APPLICATIONS`, 'Could not fetch user applications'),
+  CouldNotFetchDeployLabelsError: createError(`${ERROR_PREFIX}_COULD_NOT_FETCH_DEPLOY_LABELS`, 'Could not fetch deploy labels')
 }
 
 export default errors

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "platformatic",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Platformatic CLI",
   "main": "cli.js",
   "type": "module",
@@ -49,18 +49,18 @@
     "pino": "^8.15.3",
     "pino-pretty": "^10.2.0",
     "undici": "^5.25.4",
-    "@platformatic/authenticate": "1.6.0",
-    "@platformatic/client-cli": "1.6.0",
-    "@platformatic/composer": "1.6.0",
-    "@platformatic/config": "1.6.0",
-    "@platformatic/db": "1.6.0",
-    "@platformatic/deploy-client": "1.6.0",
-    "@platformatic/frontend-template": "1.6.0",
-    "@platformatic/metaconfig": "1.6.0",
-    "@platformatic/runtime": "1.6.0",
-    "@platformatic/service": "1.6.0",
-    "@platformatic/utils": "^1.6.0",
-    "create-platformatic": "1.6.0"
+    "@platformatic/authenticate": "1.7.0",
+    "@platformatic/client-cli": "1.7.0",
+    "@platformatic/composer": "1.7.0",
+    "@platformatic/config": "1.7.0",
+    "@platformatic/db": "1.7.0",
+    "@platformatic/deploy-client": "1.7.0",
+    "@platformatic/frontend-template": "1.7.0",
+    "@platformatic/metaconfig": "1.7.0",
+    "@platformatic/runtime": "1.7.0",
+    "@platformatic/service": "1.7.0",
+    "@platformatic/utils": "^1.7.0",
+    "create-platformatic": "1.7.0"
   },
   "scripts": {
     "test": "standard | snazzy && c8 node ./test/runner.js",