wattpm 2.21.1 → 2.23.0

package/lib/commands/build.js

@@ -5,7 +5,15 @@ import { execa } from 'execa'
 import { existsSync } from 'node:fs'
 import { readFile } from 'node:fs/promises'
 import { resolve } from 'node:path'
-import { buildRuntime, findConfigurationFile, loadConfigurationFile, overrideFatal, parseArgs } from '../utils.js'
+import {
+  buildRuntime,
+  findConfigurationFile,
+  getPackageManager,
+  getRoot,
+  loadConfigurationFile,
+  overrideFatal,
+  parseArgs
+} from '../utils.js'
 
 // This function will not perform the command if the .npmrc file contains the 'dry-run' flag - This is useful in tests
 async function executeCommand (root, ...args) {
@@ -33,13 +41,8 @@ export async function installDependencies (logger, root, services, production, p
     services = config.services
   }
 
-  /* c8 ignore next 8 */
   if (!packageManager) {
-    if (existsSync(resolve(root, 'pnpm-lock.yaml'))) {
-      packageManager = 'pnpm'
-    } else {
-      packageManager = 'npm'
-    }
+    packageManager = getPackageManager(root)
   }
 
   const args = ['install']
@@ -87,7 +90,7 @@ export async function installDependencies (logger, root, services, production, p
 export async function buildCommand (logger, args) {
   const { positionals } = parseArgs(args, {}, false)
   /* c8 ignore next */
-  const root = resolve(process.cwd(), positionals[0] ?? '')
+  const root = getRoot(positionals)
 
   const configurationFile = await findConfigurationFile(logger, root)
 
@@ -142,7 +145,7 @@ export async function installCommand (logger, args) {
   )
 
   /* c8 ignore next */
-  const root = resolve(process.cwd(), positionals[0] ?? '')
+  const root = getRoot(positionals)
   const configurationFile = await findConfigurationFile(logger, root)
 
   await installDependencies(logger, root, configurationFile, production, packageManager)

package/lib/commands/execution.js

@@ -4,13 +4,12 @@ import { ensureLoggableError } from '@platformatic/utils'
 import { bold } from 'colorette'
 import { spawn } from 'node:child_process'
 import { watch } from 'node:fs/promises'
-import { resolve } from 'node:path'
-import { findConfigurationFile, getMatchingRuntimeArgs, parseArgs } from '../utils.js'
+import { findConfigurationFile, getMatchingRuntime, getRoot, parseArgs } from '../utils.js'
 
 export async function devCommand (logger, args) {
   const { positionals } = parseArgs(args, {}, false)
   /* c8 ignore next */
-  const root = resolve(process.cwd(), positionals[0] ?? '')
+  const root = getRoot(positionals)
 
   const configurationFile = await findConfigurationFile(logger, root)
   let runtime = await pltStartCommand(['-c', configurationFile], true, true)
@@ -27,14 +26,18 @@ export async function devCommand (logger, args) {
 }
 
 export async function startCommand (logger, args) {
-  const { positionals, values } = parseArgs(args, {
-    inspect: {
-      type: 'boolean',
-      short: 'i',
-    }
-  }, false)
+  const { positionals, values } = parseArgs(
+    args,
+    {
+      inspect: {
+        type: 'boolean',
+        short: 'i'
+      }
+    },
+    false
+  )
   /* c8 ignore next */
-  const root = resolve(process.cwd(), positionals[0] ?? '')
+  const root = getRoot(positionals)
 
   const configurationFile = await findConfigurationFile(logger, root)
   const cmd = ['--production', '-c', configurationFile]
@@ -49,7 +52,7 @@ export async function stopCommand (logger, args) {
 
   try {
     const client = new RuntimeApiClient()
-    const runtime = await client.getMatchingRuntime(getMatchingRuntimeArgs(logger, positionals))
+    const [runtime] = await getMatchingRuntime(client, positionals)
 
     await client.stopRuntime(runtime.pid)
     await client.close()
@@ -70,7 +73,7 @@ export async function restartCommand (logger, args) {
 
   try {
     const client = new RuntimeApiClient()
-    const runtime = await client.getMatchingRuntime(getMatchingRuntimeArgs(logger, positionals))
+    const [runtime] = await getMatchingRuntime(client, positionals)
 
     await client.restartRuntime(runtime.pid)
     await client.close()
@@ -91,7 +94,7 @@ export async function reloadCommand (logger, args) {
 
   try {
     const client = new RuntimeApiClient()
-    const runtime = await client.getMatchingRuntime(getMatchingRuntimeArgs(logger, positionals))
+    const [runtime] = await getMatchingRuntime(client, positionals)
 
     // Stop the previous runtime
     await client.stopRuntime(runtime.pid)
@@ -140,10 +143,12 @@ export const help = {
         description: 'The directory containing the application (the default is the current directory)'
       }
     ],
-    options: [{
-      usage: '-i --inspect',
-      description: 'Enables the inspector for each service'
-    }]
+    options: [
+      {
+        usage: '-i --inspect',
+        description: 'Enables the inspector for each service'
+      }
+    ]
   },
   stop: {
     usage: 'stop [id]',

package/lib/commands/external.js

@@ -10,6 +10,8 @@ import { defaultServiceJson } from '../defaults.js'
 import { version } from '../schema.js'
 import {
   findConfigurationFile,
+  getPackageManager,
+  getRoot,
   loadConfigurationFile,
   loadRawConfigurationFile,
   overrideFatal,
@@ -119,7 +121,7 @@ async function fixConfiguration (logger, root) {
   }
 }
 
-async function importService (logger, configurationFile, id, path, url) {
+async function importService (logger, configurationFile, id, path, url, branch) {
   const config = await loadConfigurationFile(logger, configurationFile)
   const rawConfig = await loadRawConfigurationFile(logger, configurationFile)
   const root = dirname(configurationFile)
@@ -168,7 +170,13 @@ async function importService (logger, configurationFile, id, path, url) {
   rawConfig.web ??= []
 
   if (useEnv) {
-    rawConfig.web.push({ id, path: `{${envVariable}}`, url })
+    const resolveConfig = { id, path: `{${envVariable}}`, url }
+
+    if (resolveConfig.url && branch) {
+      resolveConfig.gitBranch = branch
+    }
+
+    rawConfig.web.push(resolveConfig)
 
     // Make sure the environment variable is not already defined
     if (existsSync(envFile)) {
@@ -195,13 +203,13 @@ async function importService (logger, configurationFile, id, path, url) {
   await saveConfigurationFile(logger, configurationFile, rawConfig)
 }
 
-async function importURL (logger, _, configurationFile, rawUrl, id, http) {
+async function importURL (logger, _, configurationFile, rawUrl, id, http, branch) {
   let url = rawUrl
   if (rawUrl.match(/^[a-z0-9-]+\/[a-z0-9-]+$/i)) {
     url = http ? `https://github.com/${rawUrl}.git` : `git@github.com:${rawUrl}.git`
   }
 
-  await importService(logger, configurationFile, id ?? basename(rawUrl, '.git'), null, url)
+  await importService(logger, configurationFile, id ?? basename(rawUrl, '.git'), null, url, branch)
 }
 
 async function importLocal (logger, root, configurationFile, path, overridenId) {
@@ -246,13 +254,8 @@ export async function resolveServices (
 ) {
   const config = await loadConfigurationFile(logger, configurationFile)
 
-  /* c8 ignore next 8 */
   if (!packageManager) {
-    if (existsSync(resolve(root, 'pnpm-lock.yaml'))) {
-      packageManager = 'pnpm'
-    } else {
-      packageManager = 'npm'
-    }
+    getPackageManager(root)
   }
 
   // The services which might be to be resolved are the one that have a URL and either
@@ -318,13 +321,23 @@ export async function resolveServices (
         url = parsed.toString()
       }
 
+      const cloneArgs = ['clone', url, absolutePath]
+
+      let branchLabel = ''
+      if (service.gitBranch && service.gitBranch !== 'main') {
+        cloneArgs.push('--branch', service.gitBranch)
+        branchLabel = ` (branch ${bold(service.gitBranch)})`
+      }
+
       if (username) {
-        childLogger.info(`Cloning ${bold(service.url)} as user ${bold(username)} into ${bold(relativePath)} ...`)
+        childLogger.info(
+          `Cloning ${bold(service.url)}${branchLabel} as user ${bold(username)} into ${bold(relativePath)} ...`
+        )
       } else {
-        childLogger.info(`Cloning ${bold(service.url)} into ${bold(relativePath)} ...`)
+        childLogger.info(`Cloning ${bold(service.url)}${branchLabel} into ${bold(relativePath)} ...`)
       }
 
-      await execa('git', ['clone', url, absolutePath])
+      await execa('git', cloneArgs)
     } catch (error) {
       childLogger.fatal(
         { error: ensureLoggableError(error) },
@@ -341,7 +354,7 @@ export async function resolveServices (
 
 export async function importCommand (logger, args) {
   const {
-    values: { id, http },
+    values: { id, http, branch },
     positionals
   } = parseArgs(
     args,
@@ -353,6 +366,10 @@ export async function importCommand (logger, args) {
       http: {
         type: 'boolean',
         short: 'h'
+      },
+      branch: {
+        type: 'string',
+        short: 'b'
       }
     },
     false
@@ -370,16 +387,13 @@ export async function importCommand (logger, args) {
     /* c8 ignore next */
     return fixConfiguration(logger, '')
   } else if (positionals.length === 1) {
-    root = ''
+    root = getRoot()
     rawUrl = positionals[0]
   } else {
-    root = positionals[0]
+    root = getRoot(positionals)
     rawUrl = positionals[1]
   }
 
-  /* c8 ignore next */
-  root = resolve(process.cwd(), root)
-
   const configurationFile = await findConfigurationFile(logger, root)
 
   // If the rawUrl exists as local folder, import a local folder, otherwise go for Git.
@@ -392,7 +406,7 @@ export async function importCommand (logger, args) {
     return importLocal(logger, root, configurationFile, local, id)
   }
 
-  return importURL(logger, root, configurationFile, rawUrl, id, http)
+  return importURL(logger, root, configurationFile, rawUrl, id, http, branch)
 }
 
 export async function resolveCommand (logger, args) {
@@ -426,7 +440,7 @@ export async function resolveCommand (logger, args) {
   )
 
   /* c8 ignore next */
-  const root = resolve(process.cwd(), positionals[0] ?? '')
+  const root = getRoot(positionals)
   const configurationFile = await findConfigurationFile(logger, root)
 
   await resolveServices(logger, root, configurationFile, username, password, skipDependencies, packageManager)
@@ -455,6 +469,10 @@ export const help = {
       {
         usage: '-h, --http',
         description: 'Use HTTP URL when expanding GitHub repositories'
+      },
+      {
+        usage: '-b, --branch <branch>',
+        description: 'The branch to clone (the default is main)'
       }
     ]
   },

package/lib/commands/init.js

@@ -7,7 +7,7 @@ import { basename, resolve } from 'node:path'
 import { defaultConfiguration, defaultPackageJson } from '../defaults.js'
 import { gitignore } from '../gitignore.js'
 import { schema, version } from '../schema.js'
-import { parseArgs, saveConfigurationFile, verbose } from '../utils.js'
+import { getRoot, parseArgs, saveConfigurationFile, verbose } from '../utils.js'
 
 export async function initCommand (logger, args) {
   const {
@@ -26,7 +26,7 @@ export async function initCommand (logger, args) {
   )
 
   /* c8 ignore next */
-  const root = resolve(process.cwd(), positionals[0] ?? '')
+  const root = getRoot(positionals)
   const web = resolve(root, 'web')
   const configurationFile = resolve(root, 'watt.json')
 

package/lib/commands/inject.js

@@ -5,7 +5,7 @@ import { readFile } from 'node:fs/promises'
 import { resolve } from 'node:path'
 import { finished } from 'node:stream/promises'
 import { setTimeout as sleep } from 'node:timers/promises'
-import { getMatchingRuntimeArgs, parseArgs, verbose } from '../utils.js'
+import { getMatchingRuntime, parseArgs, verbose } from '../utils.js'
 
 function appendOutput (logger, stream, fullOutput, line) {
   if (verbose) {
@@ -20,7 +20,7 @@ function appendOutput (logger, stream, fullOutput, line) {
 export async function injectCommand (logger, args) {
   const {
     values: { method, path: url, header: rawHeaders, data, 'data-file': file, output, 'full-output': fullOutput },
-    positionals
+    positionals: allPositionals
   } = parseArgs(
     args,
     {
@@ -73,8 +73,8 @@ export async function injectCommand (logger, args) {
 
   try {
     const client = new RuntimeApiClient()
-    const runtime = await client.getMatchingRuntime(getMatchingRuntimeArgs(logger, positionals))
-    let service = positionals[1]
+    const [runtime, positionals] = await getMatchingRuntime(client, allPositionals)
+    let service = positionals[0]
 
     if (!service) {
       const servicesInfo = await client.getRuntimeServices(runtime.pid)

package/lib/commands/logs.js

@@ -2,10 +2,10 @@ import { RuntimeApiClient } from '@platformatic/control'
 import { ensureLoggableError } from '@platformatic/utils'
 import pinoPretty from 'pino-pretty'
 import split2 from 'split2'
-import { getMatchingRuntimeArgs, parseArgs } from '../utils.js'
+import { getMatchingRuntime, parseArgs } from '../utils.js'
 
 export async function logsCommand (logger, args) {
-  const { values, positionals } = parseArgs(
+  const { values, positionals: allPositionals } = parseArgs(
     args,
     {
       level: { type: 'string', short: 'l', default: 'info' },
@@ -14,15 +14,15 @@ export async function logsCommand (logger, args) {
     false
   )
 
-  const service = positionals[1]
-
   const minimumLevel = logger.levels.values[values.level]
   /* c8 ignore next */
   const output = values.pretty ? pinoPretty({ colorize: true }) : process.stdout
 
+  let service
   try {
     const client = new RuntimeApiClient()
-    const runtime = await client.getMatchingRuntime(getMatchingRuntimeArgs(logger, positionals))
+    const [runtime, positionals] = await getMatchingRuntime(client, allPositionals)
+    service = positionals[0]
 
     const logsStream = client.getRuntimeLiveLogsStream(runtime.pid)
 

package/lib/commands/management.js

@@ -3,7 +3,7 @@ import { ensureLoggableError } from '@platformatic/utils'
 import { bold, reset } from 'colorette'
 import { sep } from 'node:path'
 import { getBorderCharacters, table } from 'table'
-import { getMatchingRuntimeArgs, parseArgs } from '../utils.js'
+import { getMatchingRuntime, parseArgs } from '../utils.js'
 
 const ONE_DAY = 3600 * 24
 const ONE_HOUR = 3600
@@ -61,7 +61,7 @@ function formatDuration (duration) {
   return result.trim()
 }
 
-export async function psCommand (logger, args) {
+export async function psCommand (logger) {
   try {
     const client = new RuntimeApiClient()
     const runtimes = await client.getRuntimes()
@@ -95,7 +95,7 @@ export async function servicesCommand (logger, args) {
 
   try {
     const client = new RuntimeApiClient()
-    const runtime = await client.getMatchingRuntime(getMatchingRuntimeArgs(logger, positionals))
+    const [runtime] = await getMatchingRuntime(client, positionals)
     const { production, services } = await client.getRuntimeServices(runtime.pid)
     await client.close()
 
@@ -122,13 +122,13 @@ export async function servicesCommand (logger, args) {
 }
 
 export async function envCommand (logger, args) {
-  const { values, positionals } = parseArgs(args, { table: { type: 'boolean', short: 't' } }, false)
-
-  const service = positionals[1]
+  const { values, positionals: allPositionals } = parseArgs(args, { table: { type: 'boolean', short: 't' } }, false)
 
+  let service
   try {
     const client = new RuntimeApiClient()
-    const runtime = await client.getMatchingRuntime(getMatchingRuntimeArgs(logger, positionals))
+    const [runtime, positionals] = await getMatchingRuntime(client, allPositionals)
+    service = positionals[0]
 
     const env = service
       ? await client.getRuntimeServiceEnv(runtime.pid, service)
@@ -166,12 +166,13 @@ export async function envCommand (logger, args) {
 }
 
 export async function configCommand (logger, args) {
-  const { positionals } = parseArgs(args, {}, false)
-  const service = positionals[1]
+  const { positionals: allPositionals } = parseArgs(args, {}, false)
 
+  let service
   try {
     const client = new RuntimeApiClient()
-    const runtime = await client.getMatchingRuntime(getMatchingRuntimeArgs(logger, positionals))
+    const [runtime, positionals] = await getMatchingRuntime(client, allPositionals)
+    service = positionals[0]
 
     const config = service
       ? await client.getRuntimeServiceConfig(runtime.pid, service)

package/lib/utils.js

@@ -5,10 +5,12 @@ import {
   loadConfig as pltConfigLoadConfig,
   Store
 } from '@platformatic/config'
+import { errors } from '@platformatic/control'
 import { platformaticRuntime, buildRuntime as pltBuildRuntime } from '@platformatic/runtime'
 import { bgGreen, black, bold } from 'colorette'
 import { readFile, writeFile } from 'node:fs/promises'
 import { dirname, resolve } from 'node:path'
+import { existsSync } from 'node:fs'
 import { parseArgs as nodeParseArgs } from 'node:util'
 import { pino } from 'pino'
 import pinoPretty from 'pino-pretty'
@@ -85,16 +87,58 @@ export function parseArgs (args, options, stopAtFirstPositional = true) {
   }
 }
 
-export function getMatchingRuntimeArgs (logger, positional) {
-  const args = {}
-  const pidOrName = positional[0]
+export function getPackageManager (root) {
+  if (existsSync(resolve(root, 'pnpm-lock.yaml'))) {
+    return 'pnpm'
+  }
+
+  if (existsSync(resolve(root, 'yarn.lock'))) {
+    return 'yarn'
+  }
+
+  return 'npm'
+}
+
+export function getRoot (positionals) {
+  let root = process.cwd()
+
+  if (positionals?.[0]) {
+    root = resolve(root, positionals[0])
+  }
+
+  return root
+}
+
+export async function getMatchingRuntime (client, positionals) {
+  const runtimes = await client.getRuntimes()
+  const pidOrName = positionals[0]
+  let runtime
 
+  // We have an argument to match
   if (pidOrName) {
-    /* c8 ignore next */
-    args[pidOrName?.match(/^\d+$/) ? 'pid' : 'name'] = pidOrName
+    if (pidOrName.match(/^\d+$/)) {
+      const pid = parseInt(pidOrName)
+      runtime = runtimes.find(runtime => runtime.pid === pid)
+    } else {
+      runtime = runtimes.find(runtime => runtime.packageName === pidOrName)
+    }
+
+    if (runtime) {
+      return [runtime, positionals.slice(1)]
+    }
+  }
+
+  // We found no match, find any runtime whose running directory is the current one
+  if (!runtime) {
+    runtime = runtimes.find(runtime => runtime.cwd === process.cwd())
+  }
+
+  if (!runtime) {
+    throw errors.RuntimeNotFound()
   }
+  /* c8 ignore next 2 */
 
-  return args
+  return [runtime, positionals]
 }
 
 export function serviceToEnvVariable (service) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wattpm",
-  "version": "2.21.1",
+  "version": "2.23.0",
   "description": "The Node.js Application Server",
   "main": "index.js",
   "type": "module",
@@ -35,21 +35,21 @@
     "pino-pretty": "^13.0.0",
     "split2": "^4.2.0",
     "table": "^6.8.2",
-    "@platformatic/config": "2.21.1",
-    "@platformatic/utils": "2.21.1",
-    "@platformatic/control": "2.21.1",
-    "@platformatic/runtime": "2.21.1",
-    "@platformatic/basic": "2.21.1"
+    "@platformatic/basic": "2.23.0",
+    "@platformatic/control": "2.23.0",
+    "@platformatic/config": "2.23.0",
+    "@platformatic/runtime": "2.23.0",
+    "@platformatic/utils": "2.23.0"
   },
   "devDependencies": {
     "borp": "^0.19.0",
     "eslint": "9",
-    "inspector-client": "^0.1.2",
+    "inspector-client": "^0.2.0",
     "json-schema-to-typescript": "^15.0.0",
-    "neostandard": "^0.11.1",
+    "neostandard": "^0.12.0",
     "typescript": "^5.5.4",
     "undici": "^7.0.0",
-    "@platformatic/node": "2.21.1"
+    "@platformatic/node": "2.23.0"
   },
   "scripts": {
     "test": "npm run lint && borp --concurrency=1 --timeout=300000",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/wattpm/2.21.1.json",
+  "$id": "https://schemas.platformatic.dev/wattpm/2.23.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
@@ -192,6 +192,10 @@
           "url": {
             "type": "string"
           },
+          "gitBranch": {
+            "type": "string",
+            "default": "main"
+          },
           "useHttp": {
             "type": "boolean"
           },
@@ -296,6 +300,19 @@
               }
             },
             "additionalProperties": false
+          },
+          "env": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string"
+            }
+          },
+          "envfile": {
+            "type": "string"
+          },
+          "sourceMaps": {
+            "type": "boolean",
+            "default": false
           }
         }
       }
@@ -345,6 +362,10 @@
           "url": {
             "type": "string"
           },
+          "gitBranch": {
+            "type": "string",
+            "default": "main"
+          },
           "useHttp": {
             "type": "boolean"
           },
@@ -449,6 +470,19 @@
               }
             },
             "additionalProperties": false
+          },
+          "env": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string"
+            }
+          },
+          "envfile": {
+            "type": "string"
+          },
+          "sourceMaps": {
+            "type": "boolean",
+            "default": false
           }
         }
       }
@@ -1113,6 +1147,16 @@
     "resolvedServicesBasePath": {
       "type": "string",
       "default": "external"
+    },
+    "env": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "sourceMaps": {
+      "type": "boolean",
+      "default": false
     }
   },
   "anyOf": [