@platformatic/control 3.4.1 → 3.5.0

package/help/inject.txt

@@ -1,30 +0,0 @@
-Injects a request to the platformatic runtime service.
-
-``` bash
-  $ platformatic ctl inject -n runtime-name /hello
-     -X POST
-     -H "Content-Type: application/json"
-     -d '{"key": "value"}'
-```
-
-Options:
-
-* `-p, --pid <number>` - The process id of the runtime.
-* `-n, --name <string>` - The name of the runtime.
-* `-s, --service <string>` - The name of the runtime service.
-* `-X, --request <string>` - The request HTTP method. Default is `GET`.
-* `-H, --header <string>` - The request header. Can be used multiple times.
-* `-d, --data <string>` - The request data.
-* `-i, --include <boolean>` - Include the response headers in the output. Default is `false`.
-* `-v, --verbose <boolean>` - Make the operation more talkative. Default is `false`.
-* `-o, --output <file>` - Write the response to the specified file.
-
-The `inject` command sends a request to the runtime service and prints the
-response to the standard output. If the `--service` option is not specified the
-request is sent to the runtime entrypoint.
-
-The `inject` command uses the Platformatic Runtime Management API. To enable it
-set the `managementApi` option to `true` in the runtime configuration file.
-
-To get the list of runtimes with enabled management API use the
-`platformatic ctl ps` command.

package/help/logs.txt

@@ -1,21 +0,0 @@
-Streams logs from the platformatic runtime application.
-
-``` bash
-  $ platformatic ctl logs -n runtime-name
-```
-
-Options:
-
-* `-p, --pid <number>` - The process id of the runtime.
-* `-n, --name <string>` - The name of the runtime.
-* `-l, --level <string>` - The pino log level to stream. Default is `info`.
-* `-s, --service <string>` - The name of the service to stream logs from.
-* `--pretty <boolean>` - Pretty print the logs. Default is `true`.
-
-If `--service` is not specified, the command will stream logs from all services.
-
-The `logs` command uses the Platformatic Runtime Management API. To enable it
-set the `managementApi` option to `true` in the runtime configuration file.
-
-To get the list of runtimes with enabled management API use the
-`platformatic ctl ps` command.

package/help/ps.txt

@@ -1,10 +0,0 @@
-Lists all running platformatic runtime applications.
-
-``` bash
-  $ platformatic ctl ps
-```
-
-To see the list of all available control commands, run `platformatic ctl help`.
-
-The `ps` command uses the Platformatic Runtime Management API. To enable it
-set the `managementApi` option to `true` in the runtime configuration file.

package/help/reload.txt

@@ -1,19 +0,0 @@
-Reloads a platformatic runtime application.
-
-``` bash
-  $ platformatic ctl reload -n runtime-name
-```
-
-Options:
-
-* `-p, --pid <number>` - The process id of the runtime to reload.
-* `-n, --name <string>` - The name of the runtime to reload.
-
-The difference between `reload` and `restart` is that `reload` does not kill
-the runtime process. It stops and starts all the runtime services.
-
-The `reload` command uses the Platformatic Runtime Management API. To enable it
-set the `managementApi` option to `true` in the runtime configuration file.
-
-To get the list of runtimes with enabled management API use the
-`platformatic ctl ps` command.

package/help/restart.txt

@@ -1,16 +0,0 @@
-Restarts a platformatic runtime application.
-
-``` bash
-  $ platformatic ctl restart -n runtime-name
-```
-
-Options:
-
-* `-p, --pid <number>` - The process id of the runtime to restart.
-* `-n, --name <string>` - The name of the runtime to restart.
-
-The `restart` command uses the Platformatic Runtime Management API. To enable it
-set the `managementApi` option to `true` in the runtime configuration file.
-
-To get the list of runtimes with enabled management API use the
-`platformatic ctl ps` command.

package/help/services.txt

@@ -1,16 +0,0 @@
-Lists the platformatic runtime services.
-
-``` bash
-  $ platformatic ctl services -n runtime-name
-```
-
-Options:
-
-* `-p, --pid <number>` - The process id of the runtime.
-* `-n, --name <string>` - The name of the runtime.
-
-The `services` command uses the Platformatic Runtime Management API. To enable it
-set the `managementApi` option to `true` in the runtime configuration file.
-
-To get the list of runtimes with enabled management API use the
-`platformatic ctl ps` command.

package/help/stop.txt

@@ -1,16 +0,0 @@
-Stops a platformatic runtime application.
-
-``` bash
-  $ platformatic ctl stop -n runtime-name
-```
-
-Options:
-
-* `-p, --pid <number>` - The process id of the runtime to stop.
-* `-n, --name <string>` - The name of the runtime to stop.
-
-The `stop` command uses the Platformatic Runtime Management API. To enable it
-set the `managementApi` option to `true` in the runtime configuration file.
-
-To get the list of runtimes with enabled management API use the
-`platformatic ctl ps` command.

package/index.js

@@ -1,7 +0,0 @@
-'use strict'
-
-const RuntimeApiClient = require('./lib/runtime-api-client')
-
-module.exports = {
-  RuntimeApiClient,
-}

package/lib/config.js

@@ -1,29 +0,0 @@
-'use strict'
-
-const { parseArgs } = require('node:util')
-const RuntimeApiClient = require('./runtime-api-client')
-
-async function getRuntimeConfigCommand (argv) {
-  const args = parseArgs({
-    args: argv,
-    options: {
-      pid: { type: 'string', short: 'p' },
-      name: { type: 'string', short: 'n' },
-      service: { type: 'string', short: 's' },
-    },
-    strict: false,
-  }).values
-
-  const client = new RuntimeApiClient()
-  const runtime = await client.getMatchingRuntime(args)
-
-  const config = args.service
-    ? await client.getRuntimeServiceConfig(runtime.pid, args.service)
-    : await client.getRuntimeConfig(runtime.pid)
-
-  console.log(JSON.stringify(config, null, 2))
-
-  await client.close()
-}
-
-module.exports = getRuntimeConfigCommand

package/lib/env.js

@@ -1,29 +0,0 @@
-'use strict'
-
-const { parseArgs } = require('node:util')
-const RuntimeApiClient = require('./runtime-api-client')
-
-async function getRuntimeEnvCommand (argv) {
-  const args = parseArgs({
-    args: argv,
-    options: {
-      pid: { type: 'string', short: 'p' },
-      name: { type: 'string', short: 'n' },
-    },
-    strict: false,
-  }).values
-
-  const client = new RuntimeApiClient()
-  const runtime = await client.getMatchingRuntime(args)
-
-  const runtimeEnv = await client.getRuntimeEnv(runtime.pid)
-  let output = ''
-  for (const key in runtimeEnv) {
-    output += `${key}=${runtimeEnv[key]}\n`
-  }
-  console.log(output)
-
-  await client.close()
-}
-
-module.exports = getRuntimeEnvCommand

package/lib/inject.js

@@ -1,102 +0,0 @@
-'use strict'
-
-const { parseArgs } = require('node:util')
-const { writeFile } = require('node:fs/promises')
-const RuntimeApiClient = require('./runtime-api-client')
-const errors = require('./errors')
-
-async function injectRuntimeCommand (argv) {
-  const { values: args, positionals } = parseArgs({
-    args: argv,
-    options: {
-      pid: { type: 'string', short: 'p' },
-      name: { type: 'string', short: 'n' },
-      service: { type: 'string', short: 's' },
-      request: { type: 'string', short: 'X', default: 'GET' },
-      header: { type: 'string', short: 'H', multiple: true },
-      data: { type: 'string', short: 'd' },
-      include: { type: 'boolean', short: 'i', default: false },
-      verbose: { type: 'boolean', short: 'v', default: false },
-      output: { type: 'string', short: 'o' },
-    },
-    strict: false,
-  })
-
-  const client = new RuntimeApiClient()
-  const runtime = await client.getMatchingRuntime(args)
-
-  let serviceId = args.service
-  if (!serviceId) {
-    const runtimeServices = await client.getRuntimeServices(runtime.pid)
-    serviceId = runtimeServices.entrypoint
-  }
-
-  if (positionals.length === 0) {
-    throw errors.MissingRequestURL()
-  }
-
-  let result = ''
-
-  const fullUrl = new URL(positionals[0], runtime.url)
-  const injectPath = fullUrl.href.slice(runtime.url.length)
-
-  const method = args.request
-  const body = args.data
-
-  if (args.verbose) {
-    result += `> ${method} ${injectPath} HTTP/1.1\n`
-  }
-
-  const headers = {}
-  for (const header of args.header || []) {
-    const [name, value] = header.split(':')
-    headers[name] = value
-
-    if (args.verbose) {
-      result += `> ${name}: ${value}\n`
-    }
-  }
-
-  if (args.verbose && args.header.length > 0) {
-    result += '> \n'
-  }
-
-  const injectOptions = { url: injectPath, method, headers, body }
-
-  const response = await client.injectRuntime(runtime.pid, serviceId, injectOptions)
-
-  if (args.verbose) {
-    result += `< HTTP/1.1 ${response.statusCode}\n`
-  }
-  if (args.include) {
-    result += `HTTP/1.1 ${response.statusCode}\n`
-  }
-
-  for (const header in response.headers) {
-    if (args.verbose) {
-      result += `< ${header}: ${response.headers[header]}\n`
-    }
-    if (args.include) {
-      result += `${header}: ${response.headers[header]}\n`
-    }
-  }
-
-  if (args.verbose) {
-    result += '< \n'
-  }
-  if (args.include) {
-    result += '\n'
-  }
-
-  result += await response.body.text()
-
-  if (args.output) {
-    await writeFile(args.output, result)
-  } else {
-    console.log(result)
-  }
-
-  await client.close()
-}
-
-module.exports = injectRuntimeCommand

package/lib/logs.js

@@ -1,67 +0,0 @@
-'use strict'
-
-const { parseArgs } = require('node:util')
-const { prettyFactory } = require('pino-pretty')
-const RuntimeApiClient = require('./runtime-api-client')
-
-const pinoLogLevels = {
-  fatal: 60,
-  error: 50,
-  warn: 40,
-  info: 30,
-  debug: 20,
-  trace: 10,
-}
-
-async function streamRuntimeLogsCommand (argv) {
-  const args = parseArgs({
-    args: argv,
-    options: {
-      pid: { type: 'string', short: 'p' },
-      name: { type: 'string', short: 'n' },
-      level: { type: 'string', short: 'l', default: 'info' },
-      pretty: { type: 'string', default: 'true' },
-      service: { type: 'string', short: 's' },
-    },
-    strict: false,
-  }).values
-
-  const client = new RuntimeApiClient()
-  const runtime = await client.getMatchingRuntime(args)
-
-  const logLevelNumber = pinoLogLevels[args.level]
-  const prettify = prettyFactory()
-
-  const logsStream = client.getRuntimeLiveLogsStream(runtime.pid)
-
-  logsStream.on('data', (data) => {
-    const logs = data.toString().split('\n').filter(Boolean)
-
-    for (let log of logs) {
-      try {
-        const parsedLog = JSON.parse(log)
-        if (parsedLog.level < logLevelNumber) continue
-        if (args.service && parsedLog.name !== args.service) continue
-        if (args.pretty !== 'false') {
-          log = prettify(parsedLog)
-        } else {
-          log += '\n'
-        }
-        process.stdout.write(log)
-      } catch (err) {
-        console.error('Failed to parse log message: ', log, err)
-      }
-    }
-  })
-
-  process.on('SIGINT', () => {
-    logsStream.destroy()
-    process.exit(0)
-  })
-  process.on('SIGTERM', () => {
-    logsStream.destroy()
-    process.exit(0)
-  })
-}
-
-module.exports = streamRuntimeLogsCommand

package/lib/ps.js

@@ -1,96 +0,0 @@
-'use strict'
-
-const { table, getBorderCharacters } = require('table')
-const RuntimeApiClient = require('./runtime-api-client')
-
-const tableColumns = [
-  {
-    value: 'pid',
-    alias: 'PID',
-  },
-  {
-    value: 'packageName',
-    alias: 'NAME',
-  },
-  {
-    value: 'platformaticVersion',
-    alias: 'PLT',
-  },
-  {
-    value: 'uptimeSeconds',
-    alias: 'TIME',
-    formatter: formatRuntimeTime,
-  },
-  {
-    value: 'url',
-    alias: 'URL',
-  },
-  {
-    value: 'projectDir',
-    alias: 'PWD',
-  },
-]
-
-function formatRuntimeTime (timeSeconds) {
-  let result = ''
-  if (timeSeconds < 3600) {
-    const seconds = Math.floor(timeSeconds % 60)
-    result = `${seconds}s`
-  }
-  if (timeSeconds >= 60) {
-    const minutes = Math.floor((timeSeconds % 3600) / 60)
-    result = `${minutes}m ` + result
-  }
-  if (timeSeconds >= 3600) {
-    const hours = Math.floor((timeSeconds % (3600 * 24)) / 3600)
-    result = `${hours}h ` + result
-  }
-  if (timeSeconds >= 3600 * 24) {
-    const days = Math.floor(timeSeconds / (3600 * 24))
-    result = `${days}d ` + result
-  }
-  return result
-}
-
-const tableConfig = {
-  border: getBorderCharacters('void'),
-  columnDefault: {
-    paddingLeft: 0,
-    paddingRight: 1,
-  },
-  drawHorizontalLine: () => false,
-}
-
-async function printRuntimes (runtimes) {
-  const raws = [tableColumns.map(column => column.alias)]
-
-  for (const runtime of runtimes) {
-    const raw = []
-    for (const column of tableColumns) {
-      let value = runtime[column.value]
-      if (column.formatter) {
-        value = column.formatter(value)
-      }
-      value ??= '-----'
-      raw.push(value)
-    }
-    raws.push(raw)
-  }
-
-  const runtimesTable = table(raws, tableConfig)
-  process.stdout.write(runtimesTable)
-}
-
-async function listRuntimesCommand () {
-  const client = new RuntimeApiClient()
-  const runtimes = await client.getRuntimes()
-  if (runtimes.length === 0) {
-    console.log('No platformatic runtimes found.')
-    return
-  }
-  printRuntimes(runtimes)
-
-  await client.close()
-}
-
-module.exports = listRuntimesCommand

package/lib/reload.js

@@ -1,25 +0,0 @@
-'use strict'
-
-const { parseArgs } = require('node:util')
-const RuntimeApiClient = require('./runtime-api-client')
-
-async function reloadRuntimeCommand (argv) {
-  const args = parseArgs({
-    args: argv,
-    options: {
-      pid: { type: 'string', short: 'p' },
-      name: { type: 'string', short: 'n' }
-    },
-    strict: false
-  }).values
-
-  const client = new RuntimeApiClient()
-  const runtime = await client.getMatchingRuntime(args)
-
-  const child = await client.reloadRuntime(runtime.pid)
-  console.log(`Reloaded runtime "${runtime.packageName}". The new PID is ${child.pid}.`)
-
-  await client.close()
-}
-
-module.exports = reloadRuntimeCommand

package/lib/restart.js

@@ -1,32 +0,0 @@
-'use strict'
-
-const { parseArgs } = require('node:util')
-const RuntimeApiClient = require('./runtime-api-client')
-
-async function restartRuntimeCommand (argv) {
-  const args = parseArgs({
-    args: argv,
-    options: {
-      pid: { type: 'string', short: 'p' },
-      name: { type: 'string', short: 'n' },
-    },
-    strict: false,
-  }).values
-
-  const client = new RuntimeApiClient()
-  const runtime = await client.getMatchingRuntime(args)
-
-  const runtimeProcess = await client.restartRuntime(runtime.pid, { stdio: 'inherit' })
-
-  process.on('SIGINT', () => {
-    runtimeProcess.kill('SIGINT')
-  })
-
-  process.on('SIGTERM', () => {
-    runtimeProcess.kill('SIGTERM')
-  })
-
-  await client.close()
-}
-
-module.exports = restartRuntimeCommand

package/lib/services.js

@@ -1,73 +0,0 @@
-'use strict'
-
-const { parseArgs } = require('node:util')
-const { table, getBorderCharacters } = require('table')
-const RuntimeApiClient = require('./runtime-api-client')
-
-const tableColumns = [
-  {
-    value: 'id',
-    alias: 'NAME',
-  },
-  {
-    value: 'type',
-    alias: 'TYPE',
-  },
-  {
-    value: 'entrypoint',
-    alias: 'ENTRYPOINT',
-    formatter: (entrypoint) => {
-      return entrypoint ? 'yes' : 'no'
-    },
-  },
-]
-
-const tableConfig = {
-  border: getBorderCharacters('void'),
-  columnDefault: {
-    paddingLeft: 0,
-    paddingRight: 1,
-  },
-  drawHorizontalLine: () => false,
-}
-
-async function printRuntimeServices (services) {
-  const raws = [tableColumns.map(column => column.alias)]
-
-  for (const service of services.services) {
-    const raw = []
-    for (const column of tableColumns) {
-      let value = service[column.value]
-      if (column.formatter) {
-        value = column.formatter(value)
-      }
-      value ??= '-----'
-      raw.push(value)
-    }
-    raws.push(raw)
-  }
-
-  const servicesTable = table(raws, tableConfig)
-  process.stdout.write(servicesTable)
-}
-
-async function getRuntimeServicesCommand (argv) {
-  const args = parseArgs({
-    args: argv,
-    options: {
-      pid: { type: 'string', short: 'p' },
-      name: { type: 'string', short: 'n' },
-    },
-    strict: false,
-  }).values
-
-  const client = new RuntimeApiClient()
-  const runtime = await client.getMatchingRuntime(args)
-
-  const runtimeServices = await client.getRuntimeServices(runtime.pid)
-  printRuntimeServices(runtimeServices)
-
-  await client.close()
-}
-
-module.exports = getRuntimeServicesCommand

package/lib/stop.js

@@ -1,25 +0,0 @@
-'use strict'
-
-const { parseArgs } = require('node:util')
-const RuntimeApiClient = require('./runtime-api-client')
-
-async function stopRuntimeCommand (argv) {
-  const args = parseArgs({
-    args: argv,
-    options: {
-      pid: { type: 'string', short: 'p' },
-      name: { type: 'string', short: 'n' },
-    },
-    strict: false,
-  }).values
-
-  const client = new RuntimeApiClient()
-  const runtime = await client.getMatchingRuntime(args)
-
-  await client.stopRuntime(runtime.pid)
-  console.log(`Stopped runtime "${runtime.packageName}".`)
-
-  await client.close()
-}
-
-module.exports = stopRuntimeCommand