@platformatic/control 3.4.1 → 3.5.0

package/lib/{runtime-api-client.js → index.js}

@@ -1,23 +1,98 @@
-'use strict'
-
-const { tmpdir, platform, EOL } = require('node:os')
-const { join } = require('node:path')
-const { exec, spawn } = require('node:child_process')
-const { readdir, access } = require('node:fs/promises')
-const { Readable } = require('node:stream')
-const { Client } = require('undici')
-const WebSocket = require('ws')
-const errors = require('./errors.js')
-const { safeRemove } = require('@platformatic/utils')
+import { safeRemove } from '@platformatic/foundation'
+import { exec, spawn } from 'node:child_process'
+import { access, readdir } from 'node:fs/promises'
+import { EOL, platform, tmpdir } from 'node:os'
+import { join } from 'node:path'
+import { Readable } from 'node:stream'
+import { Client } from 'undici'
+import WebSocket from 'ws'
+import {
+  ApplicationNotFound,
+  FailedToGetRuntimeAllLogs,
+  FailedToGetRuntimeApplicationConfig,
+  FailedToGetRuntimeApplicationEnv,
+  FailedToGetRuntimeApplications,
+  FailedToGetRuntimeConfig,
+  FailedToGetRuntimeEnv,
+  FailedToGetRuntimeHistoryLogs,
+  FailedToGetRuntimeLogIndexes,
+  FailedToGetRuntimeMetadata,
+  FailedToGetRuntimeMetrics,
+  FailedToGetRuntimeOpenapi,
+  FailedToReloadRuntime,
+  FailedToStartProfiling,
+  FailedToStopProfiling,
+  FailedToStopRuntime,
+  FailedToStreamRuntimeLogs,
+  ProfilingAlreadyStarted,
+  ProfilingNotStarted,
+  RuntimeNotFound
+} from './errors.js'
 
 const PLATFORMATIC_TMP_DIR = join(tmpdir(), 'platformatic', 'runtimes')
 const PLATFORMATIC_PIPE_PREFIX = '\\\\.\\pipe\\platformatic-'
 
-class RuntimeApiClient {
+class WebSocketStream extends Readable {
+  constructor (url) {
+    super()
+    this.ws = new WebSocket(url)
+
+    this.ws.on('message', data => {
+      this.push(data)
+    })
+    this.ws.on('close', () => {
+      this.push(null)
+    })
+    this.ws.on('error', err => {
+      this.emit('error', new FailedToStreamRuntimeLogs(err.message))
+    })
+    this.on('close', () => {
+      this.ws.close()
+    })
+  }
+
+  _read () {}
+}
+
+export * from './errors.js'
+
+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) {
+    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 RuntimeNotFound()
+  }
+  /* c8 ignore next 2 */
+
+  return [runtime, positionals]
+}
+
+export class RuntimeApiClient {
   #undiciClients = new Map()
   #webSockets = new Set()
 
-  async getMatchingRuntime (opts) {
+  async getMatchingRuntime (opts = {}) {
     const runtimes = await this.getRuntimes()
 
     let runtime = null
@@ -29,7 +104,7 @@ class RuntimeApiClient {
       runtime = runtimes[0]
     }
     if (!runtime) {
-      throw errors.RuntimeNotFound()
+      throw new RuntimeNotFound()
     }
     return runtime
   }
@@ -62,33 +137,34 @@ class RuntimeApiClient {
 
     const { statusCode, body } = await client.request({
       path: '/api/v1/metadata',
-      method: 'GET'
+      method: 'GET',
+      headersTimeout: 10 * 1000
     })
 
     if (statusCode !== 200) {
       const error = await body.text()
-      throw new errors.FailedToGetRuntimeMetadata(error)
+      throw new FailedToGetRuntimeMetadata(error)
     }
 
     const metadata = await body.json()
     return metadata
   }
 
-  async getRuntimeServices (pid) {
+  async getRuntimeApplications (pid) {
     const client = this.#getUndiciClient(pid)
 
     const { statusCode, body } = await client.request({
-      path: '/api/v1/services',
+      path: '/api/v1/applications',
       method: 'GET'
     })
 
     if (statusCode !== 200) {
       const error = await body.text()
-      throw new errors.FailedToGetRuntimeServices(error)
+      throw new FailedToGetRuntimeApplications(error)
     }
 
-    const runtimeServices = await body.json()
-    return runtimeServices
+    const runtimeApplications = await body.json()
+    return runtimeApplications
   }
 
   async getRuntimeConfig (pid) {
@@ -101,18 +177,18 @@ class RuntimeApiClient {
 
     if (statusCode !== 200) {
       const error = await body.text()
-      throw new errors.FailedToGetRuntimeConfig(error)
+      throw new FailedToGetRuntimeConfig(error)
     }
 
     const runtimeConfig = await body.json()
     return runtimeConfig
   }
 
-  async getRuntimeServiceConfig (pid, serviceId) {
+  async getRuntimeApplicationConfig (pid, applicationId) {
     const client = this.#getUndiciClient(pid)
 
     const { statusCode, body } = await client.request({
-      path: `/api/v1/services/${serviceId}/config`,
+      path: `/api/v1/applications/${applicationId}/config`,
       method: 'GET'
     })
 
@@ -125,15 +201,18 @@ class RuntimeApiClient {
         // No-op
       }
 
-      if (jsonError?.code === 'PLT_RUNTIME_SERVICE_NOT_FOUND') {
-        throw new errors.ServiceNotFound(error)
+      if (
+        jsonError?.code === 'PLT_RUNTIME_APPLICATION_NOT_FOUND' ||
+        jsonError?.code === 'PLT_RUNTIME_APPLICATION_WORKER_NOT_FOUND'
+      ) {
+        throw new ApplicationNotFound(error)
       }
 
-      throw new errors.FailedToGetRuntimeServiceConfig(error)
+      throw new FailedToGetRuntimeApplicationConfig(error)
     }
 
-    const serviceConfig = await body.json()
-    return serviceConfig
+    const applicationConfig = await body.json()
+    return applicationConfig
   }
 
   async getRuntimeEnv (pid) {
@@ -146,21 +225,107 @@ class RuntimeApiClient {
 
     if (statusCode !== 200) {
       const error = await body.text()
-      throw new errors.FailedToGetRuntimeEnv(error)
+      throw new FailedToGetRuntimeEnv(error)
     }
 
     const runtimeEnv = await body.json()
     return runtimeEnv
   }
 
-  async getRuntimeServiceEnv (pid, serviceId) {
+  async getRuntimeOpenapi (pid, applicationId) {
     const client = this.#getUndiciClient(pid)
 
     const { statusCode, body } = await client.request({
-      path: `/api/v1/services/${serviceId}/env`,
+      path: `/api/v1/applications/${applicationId}/openapi-schema`,
       method: 'GET'
     })
 
+    if (statusCode !== 200) {
+      const error = await body.text()
+      throw new FailedToGetRuntimeOpenapi(error)
+    }
+
+    const openapi = await body.json()
+    return openapi
+  }
+
+  async getRuntimeApplicationEnv (pid, applicationId) {
+    const client = this.#getUndiciClient(pid)
+
+    const { statusCode, body } = await client.request({
+      path: `/api/v1/applications/${applicationId}/env`,
+      method: 'GET'
+    })
+
+    if (statusCode !== 200) {
+      const error = await body.text()
+      let jsonError
+      try {
+        jsonError = JSON.parse(error)
+      } catch {
+        // No-op
+      }
+
+      if (
+        jsonError?.code === 'PLT_RUNTIME_APPLICATION_NOT_FOUND' ||
+        jsonError?.code === 'PLT_RUNTIME_APPLICATION_WORKER_NOT_FOUND'
+      ) {
+        throw new ApplicationNotFound(error)
+      }
+
+      throw new FailedToGetRuntimeApplicationEnv(error)
+    }
+
+    const applicationConfig = await body.json()
+    return applicationConfig
+  }
+
+  async startApplicationProfiling (pid, applicationId, options = {}) {
+    const client = this.#getUndiciClient(pid)
+
+    const { statusCode, body } = await client.request({
+      path: `/api/v1/applications/${applicationId}/pprof/start`,
+      method: 'POST',
+      headers: {
+        'content-type': 'application/json'
+      },
+      body: JSON.stringify(options)
+    })
+
+    if (statusCode !== 200) {
+      const error = await body.text()
+      let jsonError
+      try {
+        jsonError = JSON.parse(error)
+      } catch {
+        // No-op
+      }
+
+      const message = jsonError?.message || error
+      const code = jsonError?.code
+
+      if (code === 'PLT_RUNTIME_APPLICATION_NOT_FOUND' || code === 'PLT_RUNTIME_APPLICATION_WORKER_NOT_FOUND') {
+        throw new ApplicationNotFound(message)
+      }
+
+      if (code === 'PLT_PPROF_PROFILING_ALREADY_STARTED') {
+        throw new ProfilingAlreadyStarted(applicationId)
+      }
+
+      throw new FailedToStartProfiling(applicationId, message)
+    }
+
+    return await body.json()
+  }
+
+  async stopApplicationProfiling (pid, applicationId) {
+    const client = this.#getUndiciClient(pid)
+
+    const { statusCode, body } = await client.request({
+      path: `/api/v1/applications/${applicationId}/pprof/stop`,
+      method: 'POST'
+    })
+
     if (statusCode !== 200) {
       const error = await body.text()
       let jsonError
@@ -170,15 +335,22 @@ class RuntimeApiClient {
         // No-op
       }
 
-      if (jsonError?.code === 'PLT_RUNTIME_SERVICE_NOT_FOUND') {
-        throw new errors.ServiceNotFound(error)
+      const message = jsonError?.message || error
+      const code = jsonError?.code
+
+      if (code === 'PLT_RUNTIME_APPLICATION_NOT_FOUND' || code === 'PLT_RUNTIME_APPLICATION_WORKER_NOT_FOUND') {
+        throw new ApplicationNotFound(message)
       }
 
-      throw new errors.FailedToGetRuntimeServiceEnv(error)
+      if (code === 'PLT_PPROF_PROFILING_NOT_STARTED') {
+        throw new ProfilingNotStarted(applicationId)
+      }
+
+      throw new FailedToStopProfiling(applicationId, message)
     }
 
-    const serviceConfig = await body.json()
-    return serviceConfig
+    // Return the binary profile data as ArrayBuffer
+    return await body.arrayBuffer()
   }
 
   async reloadRuntime (pid, options = {}) {
@@ -208,7 +380,7 @@ class RuntimeApiClient {
 
     if (statusCode !== 200) {
       const error = await body.text()
-      throw new errors.FailedToReloadRuntime(error)
+      throw new FailedToReloadRuntime(error)
     }
   }
 
@@ -222,10 +394,38 @@ class RuntimeApiClient {
 
     if (statusCode !== 200) {
       const error = await body.text()
-      throw new errors.FailedToStopRuntime(error)
+      throw new FailedToStopRuntime(error)
     }
   }
 
+  async getRuntimeMetrics (pid, options = {}) {
+    const client = this.#getUndiciClient(pid)
+
+    const format = options.format ?? 'text'
+    const headers = {}
+    if (format === 'json') {
+      headers['accept'] = 'application/json'
+    }
+    if (format === 'text') {
+      headers['accept'] = 'text/plain'
+    }
+
+    const { statusCode, body } = await client.request({
+      path: '/api/v1/metrics',
+      method: 'GET',
+      headers
+    })
+
+    if (statusCode !== 200) {
+      const error = await body.text()
+      throw new FailedToGetRuntimeMetrics(error)
+    }
+
+    const metrics = format === 'json' ? await body.json() : await body.text()
+
+    return metrics
+  }
+
   getRuntimeLiveMetricsStream (pid) {
     const socketPath = this.#getSocketPathFromPid(pid)
 
@@ -237,12 +437,12 @@ class RuntimeApiClient {
     return webSocketStream
   }
 
-  getRuntimeLiveLogsStream (pid, startLogIndex) {
+  getRuntimeLiveLogsStream (pid) {
     const socketPath = this.#getSocketPathFromPid(pid)
 
     const protocol = platform() === 'win32' ? 'ws+unix:' : 'ws+unix://'
-    const query = startLogIndex ? `?start=${startLogIndex}` : ''
-    const webSocketUrl = protocol + socketPath + ':/api/v1/logs/live' + query
+
+    const webSocketUrl = protocol + socketPath + ':/api/v1/logs/live'
     const webSocketStream = new WebSocketStream(webSocketUrl)
     this.#webSockets.add(webSocketStream.ws)
 
@@ -261,7 +461,7 @@ class RuntimeApiClient {
 
     if (statusCode !== 200) {
       const error = await body.text()
-      throw new errors.FailedToGetRuntimeHistoryLogs(error)
+      throw new FailedToGetRuntimeHistoryLogs(error)
     }
 
     return body
@@ -279,7 +479,7 @@ class RuntimeApiClient {
 
     if (statusCode !== 200) {
       const error = await body.text()
-      throw new errors.FailedToGetRuntimeAllLogs(error)
+      throw new FailedToGetRuntimeAllLogs(error)
     }
 
     return body
@@ -297,7 +497,7 @@ class RuntimeApiClient {
 
     if (statusCode !== 200) {
       const error = await body.text()
-      throw new errors.FailedToGetRuntimeLogIndexes(error)
+      throw new FailedToGetRuntimeLogIndexes(error)
     }
 
     const result = await body.json()
@@ -306,11 +506,11 @@ class RuntimeApiClient {
     return result.indexes
   }
 
-  async injectRuntime (pid, serviceId, options) {
+  async injectRuntime (pid, applicationId, options) {
     const client = this.#getUndiciClient(pid)
 
     const response = await client.request({
-      path: `/api/v1/services/${serviceId}/proxy` + options.url,
+      path: `/api/v1/applications/${applicationId}/proxy` + options.url,
       method: options.method,
       headers: options.headers,
       query: options.query,
@@ -401,27 +601,3 @@ class RuntimeApiClient {
     await safeRemove(runtimeDir)
   }
 }
-
-class WebSocketStream extends Readable {
-  constructor (url) {
-    super()
-    this.ws = new WebSocket(url)
-
-    this.ws.on('message', data => {
-      this.push(data)
-    })
-    this.ws.on('close', () => {
-      this.push(null)
-    })
-    this.ws.on('error', err => {
-      this.emit('error', new errors.FailedToStreamRuntimeLogs(err.message))
-    })
-    this.on('close', () => {
-      this.ws.close()
-    })
-  }
-
-  _read () {}
-}
-
-module.exports = RuntimeApiClient

package/package.json

@@ -1,12 +1,11 @@
 {
   "name": "@platformatic/control",
-  "version": "3.4.1",
+  "version": "3.5.0",
   "description": "Platformatic Control",
-  "main": "index.js",
-  "bin": {
-    "plt-ctl": "./control.js"
-  },
-  "author": "Matteo Collina <hello@matteocollina.com>",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "type": "module",
+  "author": "Platformatic Inc. <oss@platformatic.dev> (https://platformatic.dev)",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/platformatic/platformatic.git"
@@ -17,31 +16,32 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
-    "borp": "^0.17.0",
-    "desm": "^1.3.1",
+    "cleaner-spec-reporter": "^0.5.0",
     "eslint": "9",
-    "execa": "^8.0.1",
-    "neostandard": "^0.11.1",
+    "execa": "^9.0.0",
+    "neostandard": "^0.12.0",
     "split2": "^4.2.0",
-    "tsd": "^0.31.0",
+    "tsd": "^0.33.0",
     "typescript": "^5.5.4",
-    "@platformatic/runtime": "3.4.1",
-    "@platformatic/service": "3.4.1"
+    "@platformatic/runtime": "3.5.0",
+    "@platformatic/service": "3.5.0"
   },
   "dependencies": {
     "@fastify/error": "^4.0.0",
-    "commist": "^3.2.0",
     "help-me": "^5.0.0",
-    "pino": "^9.0.0",
-    "pino-pretty": "^11.0.0",
+    "pino": "^9.9.0",
+    "pino-pretty": "^13.0.0",
     "table": "^6.8.1",
-    "undici": "^6.9.0",
+    "undici": "^7.0.0",
     "ws": "^8.16.0",
-    "@platformatic/utils": "3.4.1"
+    "@platformatic/foundation": "3.5.0"
+  },
+  "engines": {
+    "node": ">=22.19.0"
   },
   "scripts": {
-    "test": "pnpm run lint && pnpm run unit",
-    "unit": "borp --concurrency=1 --timeout=180000",
+    "test": "node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/*.test.js test/**/*.test.js",
+    "posttest": "tsd --files test/index.test-d.ts",
     "lint": "eslint"
   }
 }

package/control.js

@@ -1,83 +0,0 @@
-#! /usr/bin/env node
-
-const { join } = require('node:path')
-const { parseArgs } = require('node:util')
-const commist = require('commist')
-const helpMe = require('help-me')
-
-const getRuntimesCommand = require('./lib/ps')
-const getRuntimesEnvCommand = require('./lib/env')
-const getRuntimeServicesCommand = require('./lib/services')
-const getRuntimeConfigCommand = require('./lib/config')
-const stopRuntimeCommand = require('./lib/stop')
-const reloadRuntimeCommand = require('./lib/reload')
-const restartRuntimeCommand = require('./lib/restart')
-const injectRuntimeCommand = require('./lib/inject')
-const streamRuntimeLogsCommand = require('./lib/logs')
-
-const help = helpMe({
-  dir: join(__dirname, 'help'),
-  ext: '.txt',
-})
-
-const program = commist({ maxDistance: 2 })
-
-program.register('ps', wrapCommand(getRuntimesCommand))
-program.register('stop', wrapCommand(stopRuntimeCommand))
-program.register('reload', wrapCommand(reloadRuntimeCommand))
-program.register('restart', wrapCommand(restartRuntimeCommand))
-program.register('logs', wrapCommand(streamRuntimeLogsCommand))
-program.register('env', wrapCommand(getRuntimesEnvCommand))
-program.register('services', wrapCommand(getRuntimeServicesCommand))
-program.register('config', wrapCommand(getRuntimeConfigCommand))
-program.register('inject', wrapCommand(injectRuntimeCommand))
-program.register('help', help.toStdout)
-
-async function runControl (argv) {
-  if (argv.length === 0) {
-    help.toStdout()
-    return {}
-  }
-
-  const args = parseArgs({
-    args: argv,
-    options: {
-      version: { type: 'boolean', short: 'v' },
-    },
-    strict: false,
-  }).values
-
-  if (args.version && argv[0] !== 'inject') {
-    const packageJson = require(join(__dirname, 'package.json'))
-    console.log(packageJson.version)
-    process.exit(0)
-  }
-
-  const output = await program.parseAsync(argv)
-  return { output }
-}
-
-if (require.main === module) {
-  runControl(process.argv.slice(2))
-}
-
-function wrapCommand (fn) {
-  return async function (...args) {
-    try {
-      return await fn(...args)
-    } catch (err) {
-      console.log(err.message)
-    }
-  }
-}
-
-module.exports = {
-  runControl,
-  getRuntimesCommand,
-  getRuntimesEnvCommand,
-  getRuntimeServicesCommand,
-  stopRuntimeCommand,
-  restartRuntimeCommand,
-  injectRuntimeCommand,
-  streamRuntimeLogsCommand,
-}

package/help/config.txt

@@ -1,16 +0,0 @@
-Prints runtime or runtime service config file
-
-``` bash
-  $ platformatic ctl config -n runtime-name
-```
-
-Options:
-
-* `-p, --pid <number>` - The process id of the runtime.
-* `-n, --name <string>` - The name of the runtime.
-
-The `config` 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/env.txt

@@ -1,16 +0,0 @@
-Lists platformatic runtime application environment variables
-
-``` bash
-  $ platformatic ctl env -n runtime-name
-```
-
-Options:
-
-* `-p, --pid <number>` - The process id of the runtime.
-* `-n, --name <string>` - The name of the runtime.
-
-The `env` 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/help.txt

@@ -1,11 +0,0 @@
-Available commands:
-
-* `ps` - lists all platformatic runtime applications.
-* `stop` - stops a platformatic runtime application.
-* `restart` - restarts all platformatic runtime services.
-* `reload` - reloads all platformatic runtime services.
-* `services` - lists the runtime services.
-* `config` - prints runtime or runtime service config file.
-* `env` - lists the runtime environment variables.
-* `logs` - shows the runtime logs.
-* `inject` - injects a request to the runtime service.