@platformatic/runtime 2.10.0 → 2.12.0

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime2100Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime2120Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;
@@ -104,6 +104,7 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime2100Json = {
           )[];
     };
   };
+  startTimeout?: number;
   restartOnError?: boolean | number;
   gracefulShutdown?: {
     runtime: number | string;
@@ -163,6 +164,7 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime2100Json = {
     watchDisabled?: boolean;
     [k: string]: unknown;
   };
+  serviceTimeout?: number | string;
 };
 
 export interface UndiciInterceptor {

package/lib/errors.js

@@ -13,6 +13,7 @@ module.exports = {
   UnknownRuntimeAPICommandError: createError(`${ERROR_PREFIX}_UNKNOWN_RUNTIME_API_COMMAND`, 'Unknown Runtime API command "%s"'),
   ServiceNotFoundError: createError(`${ERROR_PREFIX}_SERVICE_NOT_FOUND`, 'Service %s not found. Available services are: %s'),
   ServiceNotStartedError: createError(`${ERROR_PREFIX}_SERVICE_NOT_STARTED`, "Service with id '%s' is not started"),
+  ServiceStartTimeoutError: createError(`${ERROR_PREFIX}_SERVICE_START_TIMEOUT`, "Service with id '%s' failed to start in %dms."),
   FailedToRetrieveOpenAPISchemaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_OPENAPI_SCHEMA`, 'Failed to retrieve OpenAPI schema for service with id "%s": %s'),
   FailedToRetrieveGraphQLSchemaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_GRAPHQL_SCHEMA`, 'Failed to retrieve GraphQL schema for service with id "%s": %s'),
   FailedToRetrieveMetaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_META`, 'Failed to retrieve metadata for service with id "%s": %s'),

package/lib/runtime.js

@@ -79,7 +79,10 @@ class Runtime extends EventEmitter {
     this.#servicesIds = []
     this.#url = undefined
     // Note: nothing hits the main thread so there is no reason to set the globalDispatcher here
-    this.#interceptor = createThreadInterceptor({ domain: '.plt.local', timeout: true })
+    this.#interceptor = createThreadInterceptor({
+      domain: '.plt.local',
+      timeout: this.#configManager.current.serviceTimeout
+    })
     this.#status = undefined
     this.#restartingWorkers = new Map()
   }
@@ -973,7 +976,19 @@ class Runtime extends EventEmitter {
     worker[kWorkerStatus] = 'starting'
 
     try {
-      const workerUrl = await sendViaITC(worker, 'start')
+      let workerUrl
+      if (config.startTimeout > 0) {
+        workerUrl = await executeWithTimeout(sendViaITC(worker, 'start'), config.startTimeout)
+
+        if (workerUrl === 'timeout') {
+          this.logger.info(`The ${label} failed to start in ${config.startTimeout}ms. Forcefully killing the thread.`)
+          worker.terminate()
+          throw new errors.ServiceStartTimeoutError(id, config.startTimeout)
+        }
+      } else {
+        workerUrl = await sendViaITC(worker, 'start')
+      }
+
       if (workerUrl) {
         this.#url = workerUrl
       }
@@ -986,9 +1001,12 @@ class Runtime extends EventEmitter {
 
       const { enabled, gracePeriod } = worker[kConfig].health
       if (enabled && config.restartOnError > 0) {
-        worker[kHealthCheckTimer] = setTimeout(() => {
-          this.#setupHealthCheck(worker, label)
-        }, gracePeriod > 0 ? gracePeriod : 1)
+        worker[kHealthCheckTimer] = setTimeout(
+          () => {
+            this.#setupHealthCheck(worker, label)
+          },
+          gracePeriod > 0 ? gracePeriod : 1
+        )
       }
     } catch (error) {
       // TODO: handle port allocation error here
@@ -1002,7 +1020,9 @@ class Runtime extends EventEmitter {
         await worker.terminate()
       }
 
-      this.logger.error({ err: ensureLoggableError(error) }, `Failed to start ${label}.`)
+      if (error.code !== 'PLT_RUNTIME_SERVICE_START_TIMEOUT') {
+        this.logger.error({ err: ensureLoggableError(error) }, `Failed to start ${label}.`)
+      }
 
       const restartOnError = config.restartOnError
 

package/lib/schema.js

@@ -108,6 +108,11 @@ const platformaticRuntimeSchema = {
     web: services,
     logger,
     server,
+    startTimeout: {
+      default: 30000,
+      type: 'number',
+      minimum: 0
+    },
     restartOnError: {
       default: true,
       anyOf: [
@@ -269,6 +274,16 @@ const platformaticRuntimeSchema = {
           type: 'boolean'
         }
       }
+    },
+    serviceTimeout: {
+      anyOf: [
+        {
+          type: 'number',
+          minimum: 1
+        },
+        { type: 'string' }
+      ],
+      default: 300000 // 5 minutes
     }
   },
   anyOf: [{ required: ['autoload'] }, { required: ['services'] }, { required: ['web'] }],

package/lib/start.js

@@ -31,7 +31,7 @@ async function restartRuntime (runtime) {
 async function buildRuntime (configManager, env) {
   env = env || process.env
 
-  if (inspector.url()) {
+  if (inspector.url() && !env.VSCODE_INSPECTOR_OPTIONS) {
     throw new errors.NodeInspectorFlagsNotSupportedError()
   }
 

package/lib/worker/main.js

@@ -98,9 +98,7 @@ async function main () {
   setGlobalDispatcher(globalDispatcher)
 
   // Setup mesh networker
-  // The timeout is set to 5 minutes to avoid long term memory leaks
-  // TODO: make this configurable
-  const threadDispatcher = wire({ port: parentPort, useNetwork: service.useHttp, timeout: 5 * 60 * 1000 })
+  const threadDispatcher = wire({ port: parentPort, useNetwork: service.useHttp, timeout: config.serviceTimeout })
 
   // If the service is an entrypoint and runtime server config is defined, use it.
   let serverConfig = null

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.10.0",
+  "version": "2.12.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -35,12 +35,12 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.10.0",
-    "@platformatic/db": "2.10.0",
-    "@platformatic/node": "2.10.0",
-    "@platformatic/service": "2.10.0",
-    "@platformatic/sql-mapper": "2.10.0",
-    "@platformatic/sql-graphql": "2.10.0"
+    "@platformatic/composer": "2.12.0",
+    "@platformatic/db": "2.12.0",
+    "@platformatic/service": "2.12.0",
+    "@platformatic/node": "2.12.0",
+    "@platformatic/sql-mapper": "2.12.0",
+    "@platformatic/sql-graphql": "2.12.0"
   },
   "dependencies": {
     "@fastify/error": "^4.0.0",
@@ -62,22 +62,21 @@
     "help-me": "^5.0.0",
     "minimist": "^1.2.8",
     "pino": "^8.19.0",
-    "pino-pretty": "^12.0.0",
+    "pino-pretty": "^13.0.0",
     "pino-roll": "^2.0.0",
     "prom-client": "^15.1.2",
     "semgrator": "^0.3.0",
     "tail-file-stream": "^0.2.0",
-    "thread-cpu-usage": "^0.2.0",
     "undici": "^6.9.0",
-    "undici-thread-interceptor": "^0.8.0",
+    "undici-thread-interceptor": "^0.9.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.10.0",
-    "@platformatic/generators": "2.10.0",
-    "@platformatic/config": "2.10.0",
-    "@platformatic/itc": "2.10.0",
-    "@platformatic/telemetry": "2.10.0",
-    "@platformatic/utils": "2.10.0",
-    "@platformatic/ts-compiler": "2.10.0"
+    "@platformatic/basic": "2.12.0",
+    "@platformatic/config": "2.12.0",
+    "@platformatic/generators": "2.12.0",
+    "@platformatic/utils": "2.12.0",
+    "@platformatic/itc": "2.12.0",
+    "@platformatic/ts-compiler": "2.12.0",
+    "@platformatic/telemetry": "2.12.0"
   },
   "scripts": {
     "test": "npm run lint && borp --concurrency=1 --timeout=300000 && tsd",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.10.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.12.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
@@ -654,6 +654,11 @@
       },
       "additionalProperties": false
     },
+    "startTimeout": {
+      "default": 30000,
+      "type": "number",
+      "minimum": 0
+    },
     "restartOnError": {
       "default": true,
       "anyOf": [
@@ -1051,6 +1056,18 @@
           "type": "boolean"
         }
       }
+    },
+    "serviceTimeout": {
+      "anyOf": [
+        {
+          "type": "number",
+          "minimum": 1
+        },
+        {
+          "type": "string"
+        }
+      ],
+      "default": 300000
     }
   },
   "anyOf": [