@platformatic/control 3.4.1 → 3.5.0

package/README.md

@@ -1,6 +1,6 @@
 # @platformatic/control
 
-Check out the full documentation for Platformatic Runtime on [our website](https://docs.platformatic.dev/docs/guides/runtime-cli-managing).
+Check out the full documentation for Platformatic on [our website](https://docs.platformatic.dev).
 
 ## Install
 

package/eslint.config.js

@@ -1,3 +1,3 @@
-'use strict'
+import neostandard from 'neostandard'
 
-module.exports = require('neostandard')({})
+export default neostandard()

package/lib/errors.d.ts

@@ -0,0 +1,21 @@
+import { FastifyError } from '@fastify/error'
+
+export declare const ERROR_PREFIX: string
+
+export declare const RuntimeNotFound: (value: string) => FastifyError
+export declare const ApplicationNotFound: (value: string) => FastifyError
+export declare const MissingRequestURL: (value: string) => FastifyError
+export declare const FailedToGetRuntimeMetadata: (value: string) => FastifyError
+export declare const FailedToGetRuntimeApplications: (value: string) => FastifyError
+export declare const FailedToGetRuntimeEnv: (value: string) => FastifyError
+export declare const FailedToGetRuntimeOpenapi: (value: string) => FastifyError
+export declare const FailedToStreamRuntimeLogs: (value: string) => FastifyError
+export declare const FailedToStopRuntime: (value: string) => FastifyError
+export declare const FailedToReloadRuntime: (value: string) => FastifyError
+export declare const FailedToGetRuntimeConfig: (value: string) => FastifyError
+export declare const FailedToGetRuntimeApplicationEnv: (value: string) => FastifyError
+export declare const FailedToGetRuntimeApplicationConfig: (value: string) => FastifyError
+export declare const FailedToGetRuntimeHistoryLogs: (value: string) => FastifyError
+export declare const FailedToGetRuntimeAllLogs: (value: string) => FastifyError
+export declare const FailedToGetRuntimeLogIndexes: (value: string) => FastifyError
+export declare const FailedToGetRuntimeMetrics: (value: string) => FastifyError

package/lib/errors.js

@@ -1,26 +1,99 @@
-'use strict'
-
-const createError = require('@fastify/error')
-
-const ERROR_PREFIX = 'PLT_CTR'
-
-module.exports = {
-  RuntimeNotFound: createError(`${ERROR_PREFIX}_RUNTIME_NOT_FOUND`, 'Runtime not found.'),
-  ServiceNotFound: createError(`${ERROR_PREFIX}_SERVICE_NOT_FOUND`, 'Service not found.'),
-  MissingRuntimeIdentifier: createError(`${ERROR_PREFIX}_MISSING_RUNTIME_IDENTIFIER`, 'Runtime name or PID is required.'),
-  MissingRequestURL: createError(`${ERROR_PREFIX}_MISSING_REQUEST_URL`, 'Request URL is required.'),
-  FailedToGetRuntimeMetadata: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_METADATA`, 'Failed to get runtime metadata %s.'),
-  FailedToGetRuntimeServices: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_SERVICES`, 'Failed to get runtime services %s.'),
-  FailedToGetRuntimeEnv: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_ENV`, 'Failed to get runtime environment variables %s.'),
-  FailedToInjectRuntime: createError(`${ERROR_PREFIX}_FAILED_TO_INJECT_RUNTIME`, 'Failed to inject runtime %s.'),
-  FailedToStreamRuntimeLogs: createError(`${ERROR_PREFIX}_FAILED_TO_STREAM_RUNTIME_LOGS`, 'Failed to stream runtime logs %s.'),
-  FailedToRestartRuntime: createError(`${ERROR_PREFIX}_FAILED_TO_RESTART_RUNTIME`, 'Failed to restart runtime %s.'),
-  FailedToStopRuntime: createError(`${ERROR_PREFIX}_FAILED_TO_STOP_RUNTIME`, 'Failed to stop the runtime %s.'),
-  FailedToReloadRuntime: createError(`${ERROR_PREFIX}_FAILED_TO_RELOAD_RUNTIME`, 'Failed to reload the runtime %s.'),
-  FailedToGetRuntimeConfig: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_CONFIG`, 'Failed to get runtime config %s.'),
-  FailedToGetRuntimeServiceEnv: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_SERVICE_ENV`, 'Failed to get runtime service environment variables %s.'),
-  FailedToGetRuntimeServiceConfig: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_SERVICE_CONFIG`, 'Failed to get runtime service config %s.'),
-  FailedToGetRuntimeHistoryLogs: createError(`${ERROR_PREFIX}_FAILED_TO_GET_HISTORY_LOGS`, 'Failed to get history logs %s.'),
-  FailedToGetRuntimeAllLogs: createError(`${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_ALL_LOGS`, 'Failed to get runtime all logs %s.'),
-  FailedToGetRuntimeLogIndexes: createError(`${ERROR_PREFIX}_FAILED_TO_GET_HISTORY_LOGS_COUNT`, 'Failed to get history logs count %s.'),
-}
+import createError from '@fastify/error'
+
+export const ERROR_PREFIX = 'PLT_CTR'
+
+export const RuntimeNotFound = createError(`${ERROR_PREFIX}_RUNTIME_NOT_FOUND`, 'Runtime not found.')
+
+export const ApplicationNotFound = createError(`${ERROR_PREFIX}_APPLICATION_NOT_FOUND`, 'Application not found.')
+
+export const MissingRequestURL = createError(`${ERROR_PREFIX}_MISSING_REQUEST_URL`, 'Request URL is required.')
+
+export const FailedToGetRuntimeMetadata = createError(
+  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_METADATA`,
+  'Failed to get runtime metadata %s.'
+)
+
+export const FailedToGetRuntimeApplications = createError(
+  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_APPLICATIONS`,
+  'Failed to get runtime applications %s.'
+)
+
+export const FailedToGetRuntimeEnv = createError(
+  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_ENV`,
+  'Failed to get runtime environment variables %s.'
+)
+
+export const FailedToGetRuntimeOpenapi = createError(
+  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_OPENAPI`,
+  'Failed to get runtime OpenAPI schema %s.'
+)
+
+export const FailedToStreamRuntimeLogs = createError(
+  `${ERROR_PREFIX}_FAILED_TO_STREAM_RUNTIME_LOGS`,
+  'Failed to stream runtime logs %s.'
+)
+
+export const FailedToStopRuntime = createError(
+  `${ERROR_PREFIX}_FAILED_TO_STOP_RUNTIME`,
+  'Failed to stop the runtime %s.'
+)
+
+export const FailedToReloadRuntime = createError(
+  `${ERROR_PREFIX}_FAILED_TO_RELOAD_RUNTIME`,
+  'Failed to reload the runtime %s.'
+)
+
+export const FailedToGetRuntimeConfig = createError(
+  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_CONFIG`,
+  'Failed to get runtime config %s.'
+)
+
+export const FailedToGetRuntimeApplicationEnv = createError(
+  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_APPLICATION_ENV`,
+  'Failed to get runtime application environment variables %s.'
+)
+
+export const FailedToGetRuntimeApplicationConfig = createError(
+  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_APPLICATION_CONFIG`,
+  'Failed to get runtime application config %s.'
+)
+
+export const FailedToGetRuntimeHistoryLogs = createError(
+  `${ERROR_PREFIX}_FAILED_TO_GET_HISTORY_LOGS`,
+  'Failed to get history logs %s.'
+)
+
+export const FailedToGetRuntimeAllLogs = createError(
+  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_ALL_LOGS`,
+  'Failed to get runtime all logs %s.'
+)
+
+export const FailedToGetRuntimeLogIndexes = createError(
+  `${ERROR_PREFIX}_FAILED_TO_GET_HISTORY_LOGS_COUNT`,
+  'Failed to get history logs count %s.'
+)
+
+export const FailedToGetRuntimeMetrics = createError(
+  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_METRICS`,
+  'Failed to get runtime metrics %s.'
+)
+
+export const ProfilingAlreadyStarted = createError(
+  `${ERROR_PREFIX}_PROFILING_ALREADY_STARTED`,
+  'Profiling is already started for service "%s".'
+)
+
+export const ProfilingNotStarted = createError(
+  `${ERROR_PREFIX}_PROFILING_NOT_STARTED`,
+  'Profiling not started for service "%s".'
+)
+
+export const FailedToStartProfiling = createError(
+  `${ERROR_PREFIX}_FAILED_TO_START_PROFILING`,
+  'Failed to start profiling for service "%s": %s'
+)
+
+export const FailedToStopProfiling = createError(
+  `${ERROR_PREFIX}_FAILED_TO_STOP_PROFILING`,
+  'Failed to stop profiling for service "%s": %s'
+)

package/lib/index.d.ts

@@ -0,0 +1,130 @@
+import { ChildProcess } from 'node:child_process'
+import { Readable } from 'node:stream'
+import { Dispatcher } from 'undici'
+import WebSocket from 'ws'
+
+export * from './errors.js'
+
+export type ReadableBody = Dispatcher.ResponseData['body']
+
+export class WebSocketStream extends Readable {
+  constructor (url: string)
+  ws: WebSocket
+}
+
+export interface RuntimeDependency {
+  id: string
+  url: string
+  local: boolean
+}
+
+export interface RuntimeApplicationBase {
+  id: string
+  status: string
+}
+
+export interface RuntimeApplication {
+  id: string
+  type: string
+  status: string
+  version: string
+  localUrl: string
+  entrypoint: boolean
+  url?: string
+  workers?: number
+  dependencies: Runtime
+}
+
+export interface Runtime {
+  pid: number
+  cwd: string
+  argv: string[]
+  uptimeSeconds: number
+  execPath: string
+  nodeVersion: string
+  projectDir: string
+  packageName: string | null
+  packageVersion: string | null
+  url: string | null
+  platformaticVersion: string
+  startTime?: number
+}
+
+export interface RuntimeApplications {
+  entrypoint: string
+  production: boolean
+  applications: (RuntimeApplication | RuntimeApplicationBase)[]
+}
+
+export interface MetricValue {
+  value: number
+  labels: {
+    route?: string
+    quantile?: number
+    method?: string
+    status_code?: number
+    telemetry_id?: string
+    type?: string
+    space?: string
+    version?: string
+    major?: number
+    minor?: number
+    patch?: number
+    le?: number | string
+    kind?: string
+    applicationId: string
+    workerId?: number
+    dispatcher_stats_url?: string
+  }
+  metricName?: string
+  exemplar?: unknown
+}
+
+export interface Metric {
+  help: string
+  name: string
+  type: string
+  values: MetricValue[]
+  aggregator: string
+}
+
+export interface LogIndexes {
+  pid: number
+  indexes: number[]
+}
+
+export class RuntimeApiClient {
+  getMatchingRuntime (options?: { pid?: string; name?: string }): Promise<Runtime>
+  getRuntimes (): Promise<Runtime[]>
+  getRuntimeMetadata (pid: number): Promise<Runtime>
+  getRuntimeApplications (pid: number): Promise<RuntimeApplications>
+  getRuntimeConfig (pid: number): Promise<Record<string, unknown> & { path?: string, configFile?: string, configPath?: string, server?: { path?: string } }>
+  getRuntimeApplicationConfig (pid: number, applicationId?: string): Promise<Record<string, unknown>>
+  getRuntimeEnv (pid: number): Promise<Record<string, string>>
+  getRuntimeOpenapi (pid: number, applicationId: string): Promise<Record<string, unknown>>
+  getRuntimeApplicationEnv (pid: number, applicationId: string): Promise<Record<string, string>>
+  reloadRuntime (pid: number, options?: object): Promise<ChildProcess>
+  restartRuntime (pid: number): Promise<void>
+  stopRuntime (pid: number): Promise<void>
+  getRuntimeMetrics<T extends { format?: 'text' | 'json' }> (
+    pid: number,
+    options?: T
+  ): Promise<T extends { format: 'text' } ? string : Metric[]>
+  getRuntimeLiveMetricsStream (pid: number): WebSocketStream
+  getRuntimeLiveLogsStream (pid: number, startLogIndex?: number): WebSocketStream
+  getRuntimeLogsStream (pid: number, logsId: string, options?: { runtimePID?: number }): Promise<ReadableBody>
+  getRuntimeAllLogsStream (pid: number, options?: { runtimePID?: number }): Promise<ReadableBody>
+  getRuntimeLogIndexes (pid: number, options?: { all?: boolean }): Promise<LogIndexes[]>
+  injectRuntime (
+    pid: number,
+    applicationId: string,
+    options: {
+      url: string
+      method: string
+      headers?: Record<string, string>
+      query?: Record<string, any>
+      body?: any
+    }
+  ): Promise<Dispatcher.ResponseData>
+  close (): Promise<void>
+}