@platformatic/runtime 3.61.1 → 3.62.0

package/config.d.ts

@@ -10,6 +10,23 @@ export type PlatformaticRuntimeConfig = {
 } & {
   $schema?: string;
   preload?: string | string[];
+  extensions?:
+    | string
+    | {
+        path: string;
+        options?: {
+          [k: string]: unknown;
+        };
+      }
+    | (
+        | string
+        | {
+            path: string;
+            options?: {
+              [k: string]: unknown;
+            };
+          }
+      )[];
   entrypoint?: string;
   basePath?: string;
   autoload?: {
@@ -44,6 +61,8 @@ export type PlatformaticRuntimeConfig = {
           gracePeriod?: number | string;
           maxUnhealthyChecks?: number | string;
           maxELU?: number | string;
+          maxEventLoopDelay?: number | string;
+          maxEventLoopDelayP99?: number | string;
           maxHeapUsed?: number | string;
           maxHeapTotal?: number | string;
           maxYoungGeneration?: number | string;
@@ -51,6 +70,10 @@ export type PlatformaticRuntimeConfig = {
           bufferPoolSize?: number | string;
           defaultHighWaterMark?: number | string;
         };
+        /**
+         * Overrides the runtime-level restartOnError for this application. Set to false or 0 to never restart the application when it crashes, a positive number to wait that amount of milliseconds between restarts, or true to use the default delay.
+         */
+        restartOnError?: boolean | number;
         dependencies?: string[];
         arguments?: string[];
         env?: {
@@ -251,6 +274,8 @@ export type PlatformaticRuntimeConfig = {
     gracePeriod?: number | string;
     maxUnhealthyChecks?: number | string;
     maxELU?: number | string;
+    maxEventLoopDelay?: number | string;
+    maxEventLoopDelayP99?: number | string;
     maxHeapUsed?: number | string;
     maxHeapTotal?: number | string;
     maxYoungGeneration?: number | string;

package/index.d.ts

@@ -4,6 +4,7 @@ import { BaseGenerator } from '@platformatic/generators'
 import { PlatformaticGlobal } from '@platformatic/globals'
 import { JSONSchemaType } from 'ajv'
 import * as colorette from 'colorette'
+import { EventEmitter } from 'node:events'
 import { Logger } from 'pino'
 import { PlatformaticRuntimeConfig } from './config.js'
 
@@ -52,6 +53,11 @@ export namespace errors {
   export const InspectorHostError: () => FastifyError
   export const CannotMapSpecifierToAbsolutePathError: (specifier: string) => FastifyError
   export const NodeInspectorFlagsNotSupportedError: () => FastifyError
+  export const FailedToLoadExtensionError: (path: string, error: string) => FastifyError
+  export const InvalidExtensionError: (path: string) => FastifyError
+  export const ReservedITCHandlerNameError: (name: string) => FastifyError
+  export const DuplicateITCHandlerNameError: (name: string) => FastifyError
+  export const LastProfileTimeoutError: (id: string) => FastifyError
 }
 
 export namespace symbols {
@@ -148,7 +154,29 @@ export class WrappedGenerator extends BaseGenerator {}
 
 export declare const schema: JSONSchemaType<PlatformaticRuntimeConfig>
 
-export declare class Runtime {
+export interface RuntimeExtensionITC {
+  handle (name: string, handler: (payload: any) => any): void
+  send<Response = unknown> (target: string, name: string, payload?: unknown): Promise<Response>
+  notify (target: string, name: string, payload?: unknown): Promise<void>
+}
+
+export interface RuntimeExtensionContext {
+  runtime: Runtime
+  itc: RuntimeExtensionITC
+  logger: Logger
+  options: Record<string, unknown>
+  root: string
+}
+
+export interface RuntimeExtensionInstance {
+  close?: () => void | Promise<void>
+}
+
+export type RuntimeExtension = (
+  context: RuntimeExtensionContext
+) => void | RuntimeExtensionInstance | Promise<void | RuntimeExtensionInstance>
+
+export declare class Runtime extends EventEmitter {
   init (): Promise<void>
   start (silent?: boolean): Promise<string | undefined>
   stop (silent?: boolean): Promise<void>
@@ -167,6 +195,9 @@ export declare class Runtime {
   restartApplication (id: string): Promise<void>
   addApplications (applications: unknown[], start?: boolean): Promise<ApplicationDetails[]>
   removeApplications (applications: string[], silent?: boolean): Promise<ApplicationDetails[]>
+  startApplicationProfiling (id: string, options?: Record<string, unknown>, ensureStarted?: boolean): Promise<void>
+  stopApplicationProfiling (id: string, options?: Record<string, unknown>, ensureStarted?: boolean): Promise<Buffer>
+  getApplicationLastProfile (id: string, options?: Record<string, unknown>, ensureStarted?: boolean): Promise<{ profile: Buffer, timestamp: number | null, preserved: boolean }>
 }
 
 export function wrapInRuntimeConfig (

package/lib/errors.js

@@ -145,6 +145,31 @@ export const MissingPprofCapture = createError(
   'Please install @platformatic/wattpm-pprof-capture'
 )
 
+export const LastProfileTimeoutError = createError(
+  `${ERROR_PREFIX}_LAST_PROFILE_TIMEOUT`,
+  'Timed out while retrieving the last profile from the application "%s"'
+)
+
+export const FailedToLoadExtensionError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_LOAD_EXTENSION`,
+  'Failed to load the extension "%s": %s'
+)
+
+export const InvalidExtensionError = createError(
+  `${ERROR_PREFIX}_INVALID_EXTENSION`,
+  'The extension "%s" must export a setup function as its default export'
+)
+
+export const ReservedITCHandlerNameError = createError(
+  `${ERROR_PREFIX}_RESERVED_ITC_HANDLER_NAME`,
+  'The ITC command name "%s" is reserved by the runtime'
+)
+
+export const DuplicateITCHandlerNameError = createError(
+  `${ERROR_PREFIX}_DUPLICATE_ITC_HANDLER_NAME`,
+  'The ITC command "%s" has already been registered'
+)
+
 export const FailedToSendHealthSignalsError = createError(
   `${ERROR_PREFIX}_FAILED_TO_SEND_HEALTH_SIGNALS`,
   'Cannot send health signals from application "%s": %s'