@platformatic/control 3.0.0-alpha.5 → 3.0.0-alpha.8

package/eslint.config.js

@@ -1,3 +1,3 @@
 import neostandard from 'neostandard'
 
-export default neostandard({})
+export default neostandard()

package/lib/errors.d.ts

@@ -3,18 +3,18 @@ import { FastifyError } from '@fastify/error'
 export declare const ERROR_PREFIX: string
 
 export declare const RuntimeNotFound: (value: string) => FastifyError
-export declare const ServiceNotFound: (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 FailedToGetRuntimeServices: (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 FailedToGetRuntimeServiceEnv: (value: string) => FastifyError
-export declare const FailedToGetRuntimeServiceConfig: (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

package/lib/errors.js

@@ -4,7 +4,7 @@ export const ERROR_PREFIX = 'PLT_CTR'
 
 export const RuntimeNotFound = createError(`${ERROR_PREFIX}_RUNTIME_NOT_FOUND`, 'Runtime not found.')
 
-export const ServiceNotFound = createError(`${ERROR_PREFIX}_SERVICE_NOT_FOUND`, 'Service 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.')
 
@@ -13,9 +13,9 @@ export const FailedToGetRuntimeMetadata = createError(
   'Failed to get runtime metadata %s.'
 )
 
-export const FailedToGetRuntimeServices = createError(
-  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_SERVICES`,
-  'Failed to get runtime services %s.'
+export const FailedToGetRuntimeApplications = createError(
+  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_APPLICATIONS`,
+  'Failed to get runtime applications %s.'
 )
 
 export const FailedToGetRuntimeEnv = createError(
@@ -48,14 +48,14 @@ export const FailedToGetRuntimeConfig = createError(
   'Failed to get runtime config %s.'
 )
 
-export const FailedToGetRuntimeServiceEnv = createError(
-  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_SERVICE_ENV`,
-  'Failed to get runtime service environment variables %s.'
+export const FailedToGetRuntimeApplicationEnv = createError(
+  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_APPLICATION_ENV`,
+  'Failed to get runtime application environment variables %s.'
 )
 
-export const FailedToGetRuntimeServiceConfig = createError(
-  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_SERVICE_CONFIG`,
-  'Failed to get runtime service config %s.'
+export const FailedToGetRuntimeApplicationConfig = createError(
+  `${ERROR_PREFIX}_FAILED_TO_GET_RUNTIME_APPLICATION_CONFIG`,
+  'Failed to get runtime application config %s.'
 )
 
 export const FailedToGetRuntimeHistoryLogs = createError(
@@ -77,3 +77,23 @@ 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

@@ -18,12 +18,12 @@ export interface RuntimeDependency {
   local: boolean
 }
 
-export interface RuntimeServiceBase {
+export interface RuntimeApplicationBase {
   id: string
   status: string
 }
 
-export interface RuntimeService {
+export interface RuntimeApplication {
   id: string
   type: string
   status: string
@@ -49,10 +49,10 @@ export interface Runtime {
   platformaticVersion: string
 }
 
-export interface RuntimeServices {
+export interface RuntimeApplications {
   entrypoint: string
   production: boolean
-  services: (RuntimeService | RuntimeServiceBase)[]
+  applications: (RuntimeApplication | RuntimeApplicationBase)[]
 }
 
 export interface MetricValue {
@@ -71,7 +71,7 @@ export interface MetricValue {
     patch?: number
     le?: number | string
     kind?: string
-    serviceId: string
+    applicationId: string
     workerId?: number
     dispatcher_stats_url?: string
   }
@@ -96,12 +96,12 @@ export class RuntimeApiClient {
   getMatchingRuntime (options?: { pid?: string; name?: string }): Promise<Runtime>
   getRuntimes (): Promise<Runtime[]>
   getRuntimeMetadata (pid: number): Promise<Runtime>
-  getRuntimeServices (pid: number): Promise<RuntimeServices>
+  getRuntimeApplications (pid: number): Promise<RuntimeApplications>
   getRuntimeConfig (pid: number): Promise<Record<string, unknown>>
-  getRuntimeServiceConfig (pid: number, serviceId?: string): Promise<Record<string, unknown>>
+  getRuntimeApplicationConfig (pid: number, applicationId?: string): Promise<Record<string, unknown>>
   getRuntimeEnv (pid: number): Promise<Record<string, string>>
-  getRuntimeOpenapi (pid: number, serviceId: string): Promise<Record<string, unknown>>
-  getRuntimeServiceEnv (pid: number, serviceId: string): 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>
@@ -116,7 +116,7 @@ export class RuntimeApiClient {
   getRuntimeLogIndexes (pid: number, options?: { all?: boolean }): Promise<LogIndexes[]>
   injectRuntime (
     pid: number,
-    serviceId: string,
+    applicationId: string,
     options: {
       url: string
       method: string

package/lib/index.js

@@ -7,7 +7,11 @@ import { Readable } from 'node:stream'
 import { Client } from 'undici'
 import WebSocket from 'ws'
 import {
+  ApplicationNotFound,
   FailedToGetRuntimeAllLogs,
+  FailedToGetRuntimeApplicationConfig,
+  FailedToGetRuntimeApplicationEnv,
+  FailedToGetRuntimeApplications,
   FailedToGetRuntimeConfig,
   FailedToGetRuntimeEnv,
   FailedToGetRuntimeHistoryLogs,
@@ -15,14 +19,14 @@ import {
   FailedToGetRuntimeMetadata,
   FailedToGetRuntimeMetrics,
   FailedToGetRuntimeOpenapi,
-  FailedToGetRuntimeServiceConfig,
-  FailedToGetRuntimeServiceEnv,
-  FailedToGetRuntimeServices,
   FailedToReloadRuntime,
+  FailedToStartProfiling,
+  FailedToStopProfiling,
   FailedToStopRuntime,
   FailedToStreamRuntimeLogs,
-  RuntimeNotFound,
-  ServiceNotFound
+  ProfilingAlreadyStarted,
+  ProfilingNotStarted,
+  RuntimeNotFound
 } from './errors.js'
 
 const PLATFORMATIC_TMP_DIR = join(tmpdir(), 'platformatic', 'runtimes')
@@ -146,21 +150,21 @@ export class RuntimeApiClient {
     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 FailedToGetRuntimeServices(error)
+      throw new FailedToGetRuntimeApplications(error)
     }
 
-    const runtimeServices = await body.json()
-    return runtimeServices
+    const runtimeApplications = await body.json()
+    return runtimeApplications
   }
 
   async getRuntimeConfig (pid) {
@@ -180,11 +184,11 @@ export class RuntimeApiClient {
     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'
     })
 
@@ -198,17 +202,17 @@ export class RuntimeApiClient {
       }
 
       if (
-        jsonError?.code === 'PLT_RUNTIME_SERVICE_NOT_FOUND' ||
-        jsonError?.code === 'PLT_RUNTIME_SERVICE_WORKER_NOT_FOUND'
+        jsonError?.code === 'PLT_RUNTIME_APPLICATION_NOT_FOUND' ||
+        jsonError?.code === 'PLT_RUNTIME_APPLICATION_WORKER_NOT_FOUND'
       ) {
-        throw new ServiceNotFound(error)
+        throw new ApplicationNotFound(error)
       }
 
-      throw new FailedToGetRuntimeServiceConfig(error)
+      throw new FailedToGetRuntimeApplicationConfig(error)
     }
 
-    const serviceConfig = await body.json()
-    return serviceConfig
+    const applicationConfig = await body.json()
+    return applicationConfig
   }
 
   async getRuntimeEnv (pid) {
@@ -228,11 +232,11 @@ export class RuntimeApiClient {
     return runtimeEnv
   }
 
-  async getRuntimeOpenapi (pid, serviceId) {
+  async getRuntimeOpenapi (pid, applicationId) {
     const client = this.#getUndiciClient(pid)
 
     const { statusCode, body } = await client.request({
-      path: `/api/v1/services/${serviceId}/openapi-schema`,
+      path: `/api/v1/applications/${applicationId}/openapi-schema`,
       method: 'GET'
     })
 
@@ -245,11 +249,11 @@ export class RuntimeApiClient {
     return openapi
   }
 
-  async getRuntimeServiceEnv (pid, serviceId) {
+  async getRuntimeApplicationEnv (pid, applicationId) {
     const client = this.#getUndiciClient(pid)
 
     const { statusCode, body } = await client.request({
-      path: `/api/v1/services/${serviceId}/env`,
+      path: `/api/v1/applications/${applicationId}/env`,
       method: 'GET'
     })
 
@@ -263,17 +267,90 @@ export class RuntimeApiClient {
       }
 
       if (
-        jsonError?.code === 'PLT_RUNTIME_SERVICE_NOT_FOUND' ||
-        jsonError?.code === 'PLT_RUNTIME_SERVICE_WORKER_NOT_FOUND'
+        jsonError?.code === 'PLT_RUNTIME_APPLICATION_NOT_FOUND' ||
+        jsonError?.code === 'PLT_RUNTIME_APPLICATION_WORKER_NOT_FOUND'
       ) {
-        throw new ServiceNotFound(error)
+        throw new ApplicationNotFound(error)
       }
 
-      throw new FailedToGetRuntimeServiceEnv(error)
+      throw new FailedToGetRuntimeApplicationEnv(error)
     }
 
-    const serviceConfig = await body.json()
-    return serviceConfig
+    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
+      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_NOT_STARTED') {
+        throw new ProfilingNotStarted(applicationId)
+      }
+
+      throw new FailedToStopProfiling(applicationId, message)
+    }
+
+    // Return the binary profile data as ArrayBuffer
+    return await body.arrayBuffer()
   }
 
   async reloadRuntime (pid, options = {}) {
@@ -429,11 +506,11 @@ export 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,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/control",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.8",
   "description": "Platformatic Control",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -16,15 +16,15 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
-    "borp": "^0.20.0",
+    "cleaner-spec-reporter": "^0.5.0",
     "eslint": "9",
     "execa": "^9.0.0",
     "neostandard": "^0.12.0",
     "split2": "^4.2.0",
-    "tsd": "^0.32.0",
+    "tsd": "^0.33.0",
     "typescript": "^5.5.4",
-    "@platformatic/service": "3.0.0-alpha.5",
-    "@platformatic/runtime": "3.0.0-alpha.5"
+    "@platformatic/service": "3.0.0-alpha.8",
+    "@platformatic/runtime": "3.0.0-alpha.8"
   },
   "dependencies": {
     "@fastify/error": "^4.0.0",
@@ -34,14 +34,14 @@
     "table": "^6.8.1",
     "undici": "^7.0.0",
     "ws": "^8.16.0",
-    "@platformatic/foundation": "3.0.0-alpha.5"
+    "@platformatic/foundation": "3.0.0-alpha.8"
   },
   "engines": {
     "node": ">=22.18.0"
   },
   "scripts": {
-    "test": "pnpm run lint && pnpm run unit && tsd --files test/index.test-d.ts",
-    "unit": "borp --concurrency=1 --timeout=1200000",
+    "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"
   }
 }