@platformatic/runtime 2.75.0-alpha.0 → 2.75.0

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime2750Alpha0Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime2750Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;
@@ -129,6 +129,7 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime2750Alpha0Json = {
   };
   startTimeout?: number;
   restartOnError?: boolean | number;
+  exitOnUnhandledErrors?: boolean;
   gracefulShutdown?: {
     runtime: number | string;
     service: number | string;

package/lib/errors.js

@@ -112,5 +112,7 @@ module.exports = {
   CannotRemoveServiceOnUpdateError: createError(
     `${ERROR_PREFIX}_CANNOT_REMOVE_SERVICE_ON_UPDATE`,
     'Cannot remove service "%s" when updating a Runtime'
-  )
+  ),
+
+  MissingPprofCapture: createError(`${ERROR_PREFIX}_MISSING_PPROF_CAPTURE`, 'Please install @platformatic/watt-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 services = new Set()
+  const started = new Set()
   for (const worker of Object.values(workers)) {
-    if (worker.status !== 'started') {
-      return { status: false }
+    services.add(worker.service)
+
+    if (worker.status === 'started') {
+      started.add(worker.service)
     }
   }
 
+  if (started.size !== services.size) {
+    return { status: false }
+  }
+
   // perform custom readiness checks, get custom response content if any
   const checks = await runtime.getCustomReadinessChecks()
 
@@ -89,7 +97,7 @@ async function startPrometheusServer (runtime, opts) {
           return reply.code(401).send({ message: 'Unauthorized' })
         }
         return done()
-      },
+      }
     })
     onRequestHook = promServer.basicAuth
   }
@@ -129,7 +137,7 @@ async function startPrometheusServer (runtime, opts) {
         reply.type('text/plain')
       }
       return (await runtime.getMetrics(reqType)).metrics
-    },
+    }
   })
 
   if (opts.readiness !== false) {
@@ -167,7 +175,7 @@ async function startPrometheusServer (runtime, opts) {
             reply.status(failStatusCode).send(failBody)
           }
         }
-      },
+      }
     })
   }
 
@@ -206,7 +214,7 @@ async function startPrometheusServer (runtime, opts) {
             reply.status(failStatusCode).send(readiness?.body || failBody)
           }
         }
-      },
+      }
     })
   }
 
@@ -215,5 +223,5 @@ async function startPrometheusServer (runtime, opts) {
 }
 
 module.exports = {
-  startPrometheusServer,
+  startPrometheusServer
 }

package/lib/runtime.js

@@ -1,7 +1,14 @@
 'use strict'
 
 const { ITC } = require('@platformatic/itc')
-const { features, ensureLoggableError, executeWithTimeout, deepmerge, parseMemorySize, kTimeout } = require('@platformatic/utils')
+const {
+  features,
+  ensureLoggableError,
+  executeWithTimeout,
+  deepmerge,
+  parseMemorySize,
+  kTimeout
+} = require('@platformatic/utils')
 const { once, EventEmitter } = require('node:events')
 const { createReadStream, watch, existsSync } = require('node:fs')
 const { readdir, readFile, stat, access } = require('node:fs/promises')
@@ -718,7 +725,9 @@ class Runtime extends EventEmitter {
         const label = `${service}:${i}`
         const worker = this.#workers.get(label)
 
-        status[label] = await sendViaITC(worker, 'getCustomHealthCheck')
+        if (worker) {
+          status[label] = await sendViaITC(worker, 'getCustomHealthCheck')
+        }
       }
     }
 
@@ -733,7 +742,9 @@ class Runtime extends EventEmitter {
         const label = `${service}:${i}`
         const worker = this.#workers.get(label)
 
-        status[label] = await sendViaITC(worker, 'getCustomReadinessCheck')
+        if (worker) {
+          status[label] = await sendViaITC(worker, 'getCustomReadinessCheck')
+        }
       }
     }
 
@@ -795,14 +806,24 @@ class Runtime extends EventEmitter {
     return sendViaITC(service, 'getServiceEnv')
   }
 
+  #validatePprofCapturePreload () {
+    const found = this.#configManager.current.preload?.some(p => p.includes('watt-pprof-capture'))
+
+    if (!found) {
+      throw new errors.MissingPprofCapture()
+    }
+  }
+
   async startServiceProfiling (id, options = {}, ensureStarted = true) {
     const service = await this.#getServiceById(id, ensureStarted)
+    this.#validatePprofCapturePreload()
 
     return sendViaITC(service, 'startProfiling', options)
   }
 
   async stopServiceProfiling (id, ensureStarted = true) {
     const service = await this.#getServiceById(id, ensureStarted)
+    this.#validatePprofCapturePreload()
 
     return sendViaITC(service, 'stopProfiling')
   }
@@ -1107,9 +1128,7 @@ class Runtime extends EventEmitter {
 
     const promises = []
     for (const worker of this.#workers.values()) {
-      promises.push(
-        sendViaITC(worker, 'setSharedContext', sharedContext)
-      )
+      promises.push(sendViaITC(worker, 'setSharedContext', sharedContext))
     }
 
     const results = await Promise.allSettled(promises)
@@ -1214,8 +1233,12 @@ class Runtime extends EventEmitter {
       workerEnv['NODE_OPTIONS'] = `${originalNodeOptions} ${serviceConfig.nodeOptions}`.trim()
     }
 
-    const maxHeapTotal = typeof health.maxHeapTotal === 'string' ? parseMemorySize(health.maxHeapTotal) : health.maxHeapTotal
-    const maxYoungGeneration = typeof health.maxYoungGeneration === 'string' ? parseMemorySize(health.maxYoungGeneration) : health.maxYoungGeneration
+    const maxHeapTotal =
+      typeof health.maxHeapTotal === 'string' ? parseMemorySize(health.maxHeapTotal) : health.maxHeapTotal
+    const maxYoungGeneration =
+      typeof health.maxYoungGeneration === 'string'
+        ? parseMemorySize(health.maxYoungGeneration)
+        : health.maxYoungGeneration
 
     const maxOldGenerationSizeMb = Math.floor(
       (maxYoungGeneration > 0 ? maxHeapTotal - maxYoungGeneration : maxHeapTotal) / (1024 * 1024)
@@ -1391,9 +1414,7 @@ class Runtime extends EventEmitter {
     if (features.node.worker.getHeapStatistics) {
       const { used_heap_size: heapUsed, total_heap_size: heapTotal } = await worker.getHeapStatistics()
       const currentELU = worker.performance.eventLoopUtilization()
-      const elu = worker[kLastELU]
-        ? worker.performance.eventLoopUtilization(currentELU, worker[kLastELU])
-        : currentELU
+      const elu = worker[kLastELU] ? worker.performance.eventLoopUtilization(currentELU, worker[kLastELU]) : currentELU
       worker[kLastELU] = currentELU
       return { elu: elu.utilization, heapUsed, heapTotal }
     }
@@ -1543,7 +1564,16 @@ class Runtime extends EventEmitter {
       if (enabled && config.restartOnError > 0) {
         // if gracePeriod is 0, it will be set to 1 to start health checks immediately
         // however, the health event will start when the worker is started
-        this.#setupHealthCheck(config, serviceConfig, workersCount, id, index, worker, label, gracePeriod > 0 ? gracePeriod : 1)
+        this.#setupHealthCheck(
+          config,
+          serviceConfig,
+          workersCount,
+          id,
+          index,
+          worker,
+          label,
+          gracePeriod > 0 ? gracePeriod : 1
+        )
       }
     } catch (error) {
       // TODO: handle port allocation error here
@@ -1613,7 +1643,7 @@ class Runtime extends EventEmitter {
       this.logger?.info(`Stopping the ${label}...`)
     }
 
-    const exitTimeout = this.#configManager.current.gracefulShutdown.runtime
+    const exitTimeout = this.#configManager.current.gracefulShutdown.service
     const exitPromise = once(worker, 'exit')
 
     // Always send the stop message, it will shut down workers that only had ITC and interceptors setup
@@ -2112,14 +2142,29 @@ class Runtime extends EventEmitter {
       const { serviceId, config: serviceConfig, workers, health, currentWorkers, currentHealth } = update
 
       if (workers && health) {
-        const r = await this.#updateServiceWorkersAndHealth(serviceId, config, serviceConfig, workers, health, currentWorkers, currentHealth)
+        const r = await this.#updateServiceWorkersAndHealth(
+          serviceId,
+          config,
+          serviceConfig,
+          workers,
+          health,
+          currentWorkers,
+          currentHealth
+        )
         report.push({
           service: serviceId,
           workers: r.workers,
           health: r.health
         })
       } else if (health) {
-        const r = await this.#updateServiceHealth(serviceId, config, serviceConfig, currentWorkers, currentHealth, health)
+        const r = await this.#updateServiceHealth(
+          serviceId,
+          config,
+          serviceConfig,
+          currentWorkers,
+          currentHealth,
+          health
+        )
         report.push({
           service: serviceId,
           health: r.health
@@ -2193,7 +2238,10 @@ class Runtime extends EventEmitter {
               throw new errors.InvalidArgumentError('maxHeapTotal', 'must be greater than 0')
             }
           } else {
-            throw new errors.InvalidArgumentError('maxHeapTotal', 'must be a number or a string representing a memory size')
+            throw new errors.InvalidArgumentError(
+              'maxHeapTotal',
+              'must be a number or a string representing a memory size'
+            )
           }
 
           if (currentHealth.maxHeapTotal === maxHeapTotal) {
@@ -2215,7 +2263,10 @@ class Runtime extends EventEmitter {
               throw new errors.InvalidArgumentError('maxYoungGeneration', 'must be greater than 0')
             }
           } else {
-            throw new errors.InvalidArgumentError('maxYoungGeneration', 'must be a number or a string representing a memory size')
+            throw new errors.InvalidArgumentError(
+              'maxYoungGeneration',
+              'must be a number or a string representing a memory size'
+            )
           }
 
           if (currentHealth.maxYoungGeneration && currentHealth.maxYoungGeneration === maxYoungGeneration) {
@@ -2228,7 +2279,7 @@ class Runtime extends EventEmitter {
       if (workers || maxHeapTotal || maxYoungGeneration) {
         let health
         if (maxHeapTotal || maxYoungGeneration) {
-          health = { }
+          health = {}
           if (maxHeapTotal) {
             health.maxHeapTotal = maxHeapTotal
           }
@@ -2243,12 +2294,27 @@ class Runtime extends EventEmitter {
     return validatedUpdates
   }
 
-  async #updateServiceWorkersAndHealth (serviceId, config, serviceConfig, workers, health, currentWorkers, currentHealth) {
+  async #updateServiceWorkersAndHealth (
+    serviceId,
+    config,
+    serviceConfig,
+    workers,
+    health,
+    currentWorkers,
+    currentHealth
+  ) {
     if (currentWorkers > workers) {
       // stop workers
       const reportWorkers = await this.#updateServiceWorkers(serviceId, config, serviceConfig, workers, currentWorkers)
       // update heap for current workers
-      const reportHealth = await this.#updateServiceHealth(serviceId, config, serviceConfig, workers, currentHealth, health)
+      const reportHealth = await this.#updateServiceHealth(
+        serviceId,
+        config,
+        serviceConfig,
+        workers,
+        currentHealth,
+        health
+      )
 
       return { workers: reportWorkers, health: reportHealth }
     } else {
@@ -2257,13 +2323,29 @@ class Runtime extends EventEmitter {
       // start new workers with new heap
       const reportWorkers = await this.#updateServiceWorkers(serviceId, config, serviceConfig, workers, currentWorkers)
       // update heap for current workers
-      const reportHealth = await this.#updateServiceHealth(serviceId, config, serviceConfig, currentWorkers, currentHealth, health, false)
+      const reportHealth = await this.#updateServiceHealth(
+        serviceId,
+        config,
+        serviceConfig,
+        currentWorkers,
+        currentHealth,
+        health,
+        false
+      )
 
       return { workers: reportWorkers, health: reportHealth }
     }
   }
 
-  async #updateServiceHealth (serviceId, config, serviceConfig, currentWorkers, currentHealth, health, updateConfig = true) {
+  async #updateServiceHealth (
+    serviceId,
+    config,
+    serviceConfig,
+    currentWorkers,
+    currentHealth,
+    health,
+    updateConfig = true
+  ) {
     const report = {
       current: currentHealth,
       new: health,
@@ -2275,15 +2357,25 @@ class Runtime extends EventEmitter {
       }
 
       for (let i = 0; i < currentWorkers; i++) {
-        this.logger.info({ health: { current: currentHealth, new: health } }, `Restarting service "${serviceId}" worker ${i} to update config health heap...`)
+        this.logger.info(
+          { health: { current: currentHealth, new: health } },
+          `Restarting service "${serviceId}" worker ${i} to update config health heap...`
+        )
 
         const worker = await this.#getWorkerById(serviceId, i)
-        if (health.maxHeapTotal) { worker[kConfig].health.maxHeapTotal = health.maxHeapTotal }
-        if (health.maxYoungGeneration) { worker[kConfig].health.maxYoungGeneration = health.maxYoungGeneration }
+        if (health.maxHeapTotal) {
+          worker[kConfig].health.maxHeapTotal = health.maxHeapTotal
+        }
+        if (health.maxYoungGeneration) {
+          worker[kConfig].health.maxYoungGeneration = health.maxYoungGeneration
+        }
 
         await this.#replaceWorker(config, serviceConfig, currentWorkers, serviceId, i, worker)
         report.updated.push(i)
-        this.logger.info({ health: { current: currentHealth, new: health } }, `Restarted service "${serviceId}" worker ${i}`)
+        this.logger.info(
+          { health: { current: currentHealth, new: health } },
+          `Restarted service "${serviceId}" worker ${i}`
+        )
       }
       report.success = true
     } catch (err) {
@@ -2291,7 +2383,10 @@ class Runtime extends EventEmitter {
         this.logger.error({ err }, 'Cannot update service health heap, no worker updated')
         await this.#updateServiceConfigHealth(serviceId, currentHealth)
       } else {
-        this.logger.error({ err }, `Cannot update service health heap, updated workers: ${report.updated.length} out of ${currentWorkers}`)
+        this.logger.error(
+          { err },
+          `Cannot update service health heap, updated workers: ${report.updated.length} out of ${currentWorkers}`
+        )
       }
       report.success = false
     }
@@ -2318,7 +2413,10 @@ class Runtime extends EventEmitter {
           this.logger.error({ err }, 'Cannot start service workers, no worker started')
           await this.#updateServiceConfigWorkers(serviceId, currentWorkers)
         } else {
-          this.logger.error({ err }, `Cannot start service workers, started workers: ${report.started.length} out of ${workers}`)
+          this.logger.error(
+            { err },
+            `Cannot start service workers, started workers: ${report.started.length} out of ${workers}`
+          )
           await this.#updateServiceConfigWorkers(serviceId, currentWorkers + report.started.length)
         }
         report.success = false
@@ -2339,7 +2437,10 @@ class Runtime extends EventEmitter {
         if (report.stopped.length < 1) {
           this.logger.error({ err }, 'Cannot stop service workers, no worker stopped')
         } else {
-          this.logger.error({ err }, `Cannot stop service workers, stopped workers: ${report.stopped.length} out of ${workers}`)
+          this.logger.error(
+            { err },
+            `Cannot stop service workers, stopped workers: ${report.stopped.length} out of ${workers}`
+          )
           await this.#updateServiceConfigWorkers(serviceId, currentWorkers - report.stopped)
         }
         report.success = false

package/lib/start.js

@@ -150,7 +150,7 @@ async function startCommand (args, throwAllErrors = false, returnRuntime = false
     const runtime = startResult.runtime
     const res = startResult.address
 
-    closeWithGrace(async event => {
+    closeWithGrace({ delay: config.configManager.current.gracefulShutdown?.runtime ?? 10000 }, async event => {
       if (event.err instanceof Error) {
         console.error(event.err)
       }

package/lib/worker/main.js

@@ -178,8 +178,18 @@ async function main () {
     !!config.watch
   )
 
-  process.on('uncaughtException', handleUnhandled.bind(null, app, 'uncaught exception'))
-  process.on('unhandledRejection', handleUnhandled.bind(null, app, 'unhandled rejection'))
+  if (config.exitOnUnhandledErrors) {
+    process.on('uncaughtException', handleUnhandled.bind(null, app, 'uncaught exception'))
+    process.on('unhandledRejection', handleUnhandled.bind(null, app, '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 app.init()
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.75.0-alpha.0",
+  "version": "2.75.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -37,12 +37,12 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.75.0-alpha.0",
-    "@platformatic/db": "2.75.0-alpha.0",
-    "@platformatic/node": "2.75.0-alpha.0",
-    "@platformatic/service": "2.75.0-alpha.0",
-    "@platformatic/sql-graphql": "2.75.0-alpha.0",
-    "@platformatic/sql-mapper": "2.75.0-alpha.0"
+    "@platformatic/composer": "2.75.0",
+    "@platformatic/db": "2.75.0",
+    "@platformatic/node": "2.75.0",
+    "@platformatic/service": "2.75.0",
+    "@platformatic/sql-graphql": "2.75.0",
+    "@platformatic/sql-mapper": "2.75.0"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -76,14 +76,14 @@
     "undici": "^7.0.0",
     "undici-thread-interceptor": "^0.14.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.75.0-alpha.0",
-    "@platformatic/config": "2.75.0-alpha.0",
-    "@platformatic/generators": "2.75.0-alpha.0",
-    "@platformatic/metrics": "2.75.0-alpha.0",
-    "@platformatic/itc": "2.75.0-alpha.0",
-    "@platformatic/telemetry": "2.75.0-alpha.0",
-    "@platformatic/ts-compiler": "2.75.0-alpha.0",
-    "@platformatic/utils": "2.75.0-alpha.0"
+    "@platformatic/basic": "2.75.0",
+    "@platformatic/itc": "2.75.0",
+    "@platformatic/telemetry": "2.75.0",
+    "@platformatic/metrics": "2.75.0",
+    "@platformatic/ts-compiler": "2.75.0",
+    "@platformatic/utils": "2.75.0",
+    "@platformatic/generators": "2.75.0",
+    "@platformatic/config": "2.75.0"
   },
   "scripts": {
     "test": "pnpm run lint && borp --concurrency=1 --timeout=1200000 && tsd",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.75.0-alpha.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.75.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
@@ -960,6 +960,10 @@
         }
       ]
     },
+    "exitOnUnhandledErrors": {
+      "default": true,
+      "type": "boolean"
+    },
     "gracefulShutdown": {
       "type": "object",
       "properties": {