@platformatic/runtime 3.0.0-alpha.8 → 3.0.0-rc.1

package/config.d.ts

@@ -133,6 +133,7 @@ export type PlatformaticRuntimeConfig = {
   };
   startTimeout?: number;
   restartOnError?: boolean | number;
+  exitOnUnhandledErrors?: boolean;
   gracefulShutdown?: {
     runtime: number | string;
     application: number | string;

package/index.js

@@ -8,6 +8,7 @@ import {
   loadConfigurationModule,
   loadConfiguration as utilsLoadConfiguration
 } from '@platformatic/foundation'
+import closeWithGrace from 'close-with-grace'
 import inspector from 'node:inspector'
 import { transform, wrapInRuntimeConfig } from './lib/config.js'
 import { NodeInspectorFlagsNotSupportedError } from './lib/errors.js'
@@ -25,12 +26,32 @@ async function restartRuntime (runtime) {
   }
 }
 
-function handleSignal (runtime) {
+function handleSignal (runtime, config) {
+  // The very first time we add a listener for SIGUSR2,
+  // ignore it since it comes from close-with-grace and we want to use to restart the runtime
+  function filterCloseWithGraceSIGUSR2 (event, listener) {
+    if (event === 'SIGUSR2') {
+      process.removeListener('SIGUSR2', listener)
+      process.removeListener('newListener', filterCloseWithGraceSIGUSR2)
+    }
+  }
+
+  process.on('newListener', filterCloseWithGraceSIGUSR2)
+
+  const cwg = closeWithGrace({ delay: config.gracefulShutdown?.runtime ?? 10000 }, async event => {
+    if (event.err instanceof Error) {
+      console.error(event.err)
+    }
+    await runtime.close()
+  })
+
   /* c8 ignore next 3 */
   const restartListener = restartRuntime.bind(null, runtime)
   process.on('SIGUSR2', restartListener)
+
   runtime.on('closed', () => {
     process.removeListener('SIGUSR2', restartListener)
+    cwg.uninstall()
   })
 }
 
@@ -109,7 +130,7 @@ export async function create (configOrRoot, sourceOrConfig, context) {
   }
 
   let runtime = new Runtime(config, context)
-  handleSignal(runtime)
+  handleSignal(runtime, config)
 
   // Handle port handling
   if (context?.start) {
@@ -135,7 +156,7 @@ export async function create (configOrRoot, sourceOrConfig, context) {
 
         config.server.port = ++port
         runtime = new Runtime(config, context)
-        handleSignal(runtime)
+        handleSignal(runtime, config)
       }
     }
   }

package/lib/errors.js

@@ -122,3 +122,8 @@ export const MessagingError = createError(
   `${ERROR_PREFIX}_MESSAGING_ERROR`,
   'Cannot send a message to application "%s": %s'
 )
+
+export const MissingPprofCapture = createError(
+  `${ERROR_PREFIX}_MISSING_PPROF_CAPTURE`,
+  'Please install @platformatic/wattpm-pprof-capture'
+)

package/lib/prom-server.js

@@ -19,13 +19,21 @@ const DEFAULT_LIVENESS_FAIL_BODY = 'ERR'
 async function checkReadiness (runtime) {
   const workers = await runtime.getWorkers()
 
-  // check if all workers are started
+  // Make sure there is at least one started worker
+  const applications = new Set()
+  const started = new Set()
   for (const worker of Object.values(workers)) {
-    if (worker.status !== 'started') {
-      return { status: false }
+    applications.add(worker.application)
+
+    if (worker.status === 'started') {
+      started.add(worker.application)
     }
   }
 
+  if (started.size !== applications.size) {
+    return { status: false }
+  }
+
   // perform custom readiness checks, get custom response content if any
   const checks = await runtime.getCustomReadinessChecks()
 

package/lib/runtime.js

@@ -31,6 +31,7 @@ import {
   InvalidArgumentError,
   MessagingError,
   MissingEntrypointError,
+  MissingPprofCapture,
   RuntimeAbortedError,
   RuntimeExitedError,
   WorkerNotFoundError
@@ -514,12 +515,14 @@ export class Runtime extends EventEmitter {
 
   async startApplicationProfiling (id, options = {}, ensureStarted = true) {
     const service = await this.#getApplicationById(id, ensureStarted)
+    this.#validatePprofCapturePreload()
 
     return sendViaITC(service, 'startProfiling', options)
   }
 
   async stopApplicationProfiling (id, ensureStarted = true) {
     const service = await this.#getApplicationById(id, ensureStarted)
+    this.#validatePprofCapturePreload()
 
     return sendViaITC(service, 'stopProfiling')
   }
@@ -810,7 +813,9 @@ export class Runtime extends EventEmitter {
         const label = `${application}:${i}`
         const worker = this.#workers.get(label)
 
-        status[label] = await sendViaITC(worker, 'getCustomHealthCheck')
+        if (worker) {
+          status[label] = await sendViaITC(worker, 'getCustomHealthCheck')
+        }
       }
     }
 
@@ -825,7 +830,9 @@ export class Runtime extends EventEmitter {
         const label = `${application}:${i}`
         const worker = this.#workers.get(label)
 
-        status[label] = await sendViaITC(worker, 'getCustomReadinessCheck')
+        if (worker) {
+          status[label] = await sendViaITC(worker, 'getCustomReadinessCheck')
+        }
       }
     }
 
@@ -1689,7 +1696,7 @@ export class Runtime extends EventEmitter {
       this.logger.info(`Stopping the ${label}...`)
     }
 
-    const exitTimeout = this.#config.gracefulShutdown.runtime
+    const exitTimeout = this.#config.gracefulShutdown.application
     const exitPromise = once(worker, 'exit')
 
     // Always send the stop message, it will shut down workers that only had ITC and interceptors setup
@@ -2374,4 +2381,12 @@ export class Runtime extends EventEmitter {
     }
     return report
   }
+
+  #validatePprofCapturePreload () {
+    const found = this.#config.preload?.some(p => p.includes('wattpm-pprof-capture'))
+
+    if (!found) {
+      throw new MissingPprofCapture()
+    }
+  }
 }

package/lib/worker/main.js

@@ -177,8 +177,18 @@ async function main () {
     !!config.watch
   )
 
-  process.on('uncaughtException', handleUnhandled.bind(null, controller, 'uncaught exception'))
-  process.on('unhandledRejection', handleUnhandled.bind(null, controller, 'unhandled rejection'))
+  if (config.exitOnUnhandledErrors) {
+    process.on('uncaughtException', handleUnhandled.bind(null, controller, 'uncaught exception'))
+    process.on('unhandledRejection', handleUnhandled.bind(null, controller, 'unhandled rejection'))
+
+    process.on('newListener', event => {
+      if (event === 'uncaughtException' || event === 'unhandledRejection') {
+        globalThis.platformatic.logger.warn(
+          `A listener has been added for the "process.${event}" event. This listener will be never triggered as Watt default behavior will kill the process before.\n To disable this behavior, set "exitOnUnhandledErrors" to false in the runtime config.`
+        )
+      }
+    })
+  }
 
   await controller.init()
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "3.0.0-alpha.8",
+  "version": "3.0.0-rc.1",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -34,14 +34,14 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "3.0.0-alpha.8",
-    "@platformatic/gateway": "3.0.0-alpha.8",
-    "@platformatic/db": "3.0.0-alpha.8",
-    "@platformatic/node": "3.0.0-alpha.8",
-    "@platformatic/service": "3.0.0-alpha.8",
-    "@platformatic/sql-graphql": "3.0.0-alpha.8",
-    "@platformatic/sql-mapper": "3.0.0-alpha.8",
-    "@platformatic/wattpm-pprof-capture": "3.0.0-alpha.8"
+    "@platformatic/db": "3.0.0-rc.1",
+    "@platformatic/composer": "3.0.0-rc.1",
+    "@platformatic/gateway": "3.0.0-rc.1",
+    "@platformatic/node": "3.0.0-rc.1",
+    "@platformatic/sql-graphql": "3.0.0-rc.1",
+    "@platformatic/service": "3.0.0-rc.1",
+    "@platformatic/sql-mapper": "3.0.0-rc.1",
+    "@platformatic/wattpm-pprof-capture": "3.0.0-rc.1"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -51,7 +51,7 @@
     "@platformatic/undici-cache-memory": "^0.8.1",
     "@watchable/unpromise": "^1.0.2",
     "change-case-all": "^2.1.0",
-    "close-with-grace": "^2.0.0",
+    "close-with-grace": "^2.2.0",
     "colorette": "^2.0.20",
     "cron": "^4.1.0",
     "debounce": "^2.0.0",
@@ -70,12 +70,12 @@
     "undici": "^7.0.0",
     "undici-thread-interceptor": "^0.14.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "3.0.0-alpha.8",
-    "@platformatic/generators": "3.0.0-alpha.8",
-    "@platformatic/itc": "3.0.0-alpha.8",
-    "@platformatic/telemetry": "3.0.0-alpha.8",
-    "@platformatic/metrics": "3.0.0-alpha.8",
-    "@platformatic/foundation": "3.0.0-alpha.8"
+    "@platformatic/basic": "3.0.0-rc.1",
+    "@platformatic/foundation": "3.0.0-rc.1",
+    "@platformatic/generators": "3.0.0-rc.1",
+    "@platformatic/metrics": "3.0.0-rc.1",
+    "@platformatic/telemetry": "3.0.0-rc.1",
+    "@platformatic/itc": "3.0.0-rc.1"
   },
   "engines": {
     "node": ">=22.18.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.0.0-alpha.8.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.0.0-rc.1.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Runtime Config",
   "type": "object",
@@ -1217,6 +1217,10 @@
         }
       ]
     },
+    "exitOnUnhandledErrors": {
+      "default": true,
+      "type": "boolean"
+    },
     "gracefulShutdown": {
       "type": "object",
       "properties": {