@platformatic/runtime 3.68.0 → 3.70.0

package/config.d.ts

@@ -160,13 +160,10 @@ export type PlatformaticRuntimeConfig = {
       };
   workersRestartDelay?: number | string;
   logger?: {
-    level?: (
-      | ("fatal" | "error" | "warn" | "info" | "debug" | "trace" | "silent")
-      | {
-          [k: string]: unknown;
-        }
-    ) &
-      string;
+    /**
+     * The log level. It must be one of the standard pino levels (fatal, error, warn, info, debug, trace, silent) or, when customLevels is set, one of the custom levels.
+     */
+    level?: string;
     transport?:
       | {
           target?: string;
@@ -199,6 +196,10 @@ export type PlatformaticRuntimeConfig = {
     redact?: {
       paths: string[];
       censor?: string;
+      /**
+       * Remove the redacted keys entirely instead of replacing their values with the censor. Defaults to false.
+       */
+      remove?: boolean;
     };
     base?: {
       [k: string]: unknown;
@@ -207,6 +208,46 @@ export type PlatformaticRuntimeConfig = {
     customLevels?: {
       [k: string]: unknown;
     };
+    /**
+     * The numeric value of the level defined in level, when it is not one of the standard pino levels.
+     */
+    levelVal?: number;
+    /**
+     * Only use the levels defined in customLevels and omit the standard pino ones.
+     */
+    useOnlyCustomLevels?: boolean;
+    /**
+     * How log levels are compared to the logger level. Use DESC when lower values are more severe. Defaults to ASC.
+     */
+    levelComparison?: "ASC" | "DESC";
+    /**
+     * A string prefixed to every message, including the ones of child loggers.
+     */
+    msgPrefix?: string;
+    /**
+     * The key under which any logged object is placed.
+     */
+    nestedKey?: string;
+    /**
+     * The key used for the serialized error in the log object. Defaults to err.
+     */
+    errorKey?: string;
+    /**
+     * The stringification limit at a specific nesting depth when logging circular objects. Defaults to 5.
+     */
+    depthLimit?: number;
+    /**
+     * The stringification limit of properties or elements when logging a circular object or array. Defaults to 100.
+     */
+    edgeLimit?: number;
+    /**
+     * Terminate each log line with \r\n instead of \n. Defaults to false.
+     */
+    crlf?: boolean;
+    /**
+     * Set to false to disable logging entirely. Defaults to true.
+     */
+    enabled?: boolean;
     openTelemetryExporter?: {
       protocol: "grpc" | "http";
       url: string;

package/lib/runtime.js

@@ -8,7 +8,8 @@ import {
   kEnvFileFallbackKeys,
   kMetadata,
   kTimeout,
-  parseMemorySize
+  parseMemorySize,
+  scheduleCompileCacheFlush
 } from '@platformatic/foundation'
 import { getExecutable } from '@platformatic/globals'
 import { ITC } from '@platformatic/itc'
@@ -449,6 +450,11 @@ export class Runtime extends EventEmitter {
 
     this.#updateStatus('started')
 
+    // The CLI enables the module compile cache for this process. Node.js would only write it when
+    // the process terminates, so flush it now that the boot is complete to not lose it when the
+    // process is killed abruptly. This is a no-op when the compile cache is not enabled.
+    scheduleCompileCacheFlush()
+
     // Start the global health metrics timer for all workers if needed
     this.#startHealthMetricsCollectionIfNeeded()
 
@@ -2865,7 +2871,21 @@ export class Runtime extends EventEmitter {
     // Setup the interceptor
     // kInterceptorReadyPromise resolves when the worker
     // is ready to receive requests: after calling the replaceServer method
-    worker[kInterceptorReadyPromise] = this.#meshInterceptor.route(applicationId, worker)
+    //
+    // It is stored, not awaited: #startWorker awaits it later, and only if the
+    // worker is actually started. A worker that is discarded or torn down
+    // before that — a replacement abandoned because the runtime stopped
+    // mid-restart, for instance — leaves the promise with nobody to observe
+    // it. Closing the mesh interceptor rejects any routing still in flight
+    // ('The dispatcher has been closed.'), so that is a routine shutdown
+    // outcome, not an exotic one, and it surfaced as an unhandledRejection
+    // that could take the process down before graceful shutdown finished.
+    //
+    // Attaching a no-op handler marks the rejection observed WITHOUT
+    // swallowing it: the await in #startWorker still sees and reports it.
+    const interceptorReady = this.#meshInterceptor.route(applicationId, worker)
+    interceptorReady.catch(() => {})
+    worker[kInterceptorReadyPromise] = interceptorReady
 
     // Wait for initialization
     try {

package/lib/worker/controller.js

@@ -1,4 +1,5 @@
 import {
+  convertApplicationNameToPrefix,
   ensureLoggableError,
   FileWatcher,
   kHandledError,
@@ -28,12 +29,27 @@ import { ApplicationAlreadyStartedError, exitCodes, RuntimeNotStartedError } fro
 import { getApplicationUrl } from '../utils.js'
 import { markAsPlatformaticDispatcher, refreshGlobalDispatcher } from './interceptors.js'
 
-function fetchApplicationUrl (application, key) {
-  if (!key.endsWith('_URL') || !application.id) {
-    return null
+/**
+ * Resolves {PLT_<APPLICATION>_URL} placeholders that no environment variable defines, so that
+ * applications can reference each other without the user having to set a variable per pair.
+ *
+ * The mapping is built forwards, from the ids of the applications that actually exist in the runtime
+ * to the variable name each of them owns. Parsing the variable name instead would be ambiguous, both
+ * because the id to prefix conversion is not reversible ("with-logger" and "with_logger" share a
+ * prefix) and because plenty of _URL variables do not name an application at all: a connection string
+ * fragment like {VALKEY_URL} or a DSN like {PLT_DATABASE_URL} must keep resolving to nothing rather
+ * than silently becoming an HTTP URL.
+ */
+function buildApplicationUrlResolver (applications) {
+  const urls = new Map()
+
+  for (const { id } of applications ?? []) {
+    if (id) {
+      urls.set(`PLT_${convertApplicationNameToPrefix(id)}_URL`, getApplicationUrl(id))
+    }
   }
 
-  return getApplicationUrl(application.id)
+  return key => urls.get(key) ?? null
 }
 
 function handleUnhandled (app, event, listeners, timeout, err, ...args) {
@@ -53,7 +69,11 @@ function handleUnhandled (app, event, listeners, timeout, err, ...args) {
     }
   }
 
-  app.stop().catch()
+  // stop() rejects while the controller is not started. Left unobserved, that rejection re-enters
+  // this handler forever and starves the event loop, so the exit scheduled above never runs.
+  app.stop().catch(stopError => {
+    logger.debug({ err: ensureLoggableError(stopError) }, `Stopping the ${label} after the ${event} event failed.`)
+  })
 }
 
 export class Controller extends EventEmitter {
@@ -78,6 +98,8 @@ export class Controller extends EventEmitter {
     this.capability = null
     this.#fileWatcher = null
 
+    const onMissingEnv = buildApplicationUrlResolver(runtimeConfig.applications)
+
     this.#context = {
       controller: this,
       runtimeConfig: this.runtimeConfig,
@@ -95,7 +117,10 @@ export class Controller extends EventEmitter {
       worker: workerData?.worker,
       resourceLimits: workerData?.resourceLimits,
       hasManagementApi: !!runtimeConfig.managementApi,
-      fetchApplicationUrl: fetchApplicationUrl.bind(null, applicationConfig),
+      fetchApplicationUrl: onMissingEnv,
+      // Capabilities spread the whole context into their loadConfiguration call, which is what makes
+      // the configuration they load resolve application references like the throwaway load below.
+      onMissingEnv,
       strictEnv: runtimeConfig.strictEnv
     }
   }
@@ -143,10 +168,11 @@ export class Controller extends EventEmitter {
         // Parse the configuration file the first time to obtain the schema. This load is thrown away:
         // the capability loads the configuration again below and that is the configuration the
         // application actually runs on. This one only has to yield $schema and module, so it must not
-        // diverge from the second load in any way the user can observe: it deliberately applies no
-        // onMissingEnv fallback and emits no strictEnv report, both of which are left to the load the
-        // application is built from.
+        // diverge from the second load in any way the user can observe: it resolves environment
+        // variables identically, and leaves the strictEnv report to the load the application is
+        // built from, which would otherwise be duplicated for every application.
         const unvalidatedConfig = await loadConfiguration(appConfig.config, null, {
+          onMissingEnv: this.#context.onMissingEnv,
           strictEnv: false
         })
         const pkg = await loadConfigurationModule(appConfig.path, unvalidatedConfig)

package/lib/worker/main.js

@@ -4,7 +4,8 @@ import {
   disablePinoDirectWrite,
   ensureLoggableError,
   getPrivateSymbol,
-  parseMemorySize
+  parseMemorySize,
+  scheduleCompileCacheFlush
 } from '@platformatic/foundation'
 import { getITC, getLogger, updateGlobals } from '@platformatic/globals'
 import { addPinoInstrumentation } from '@platformatic/telemetry'
@@ -149,6 +150,9 @@ function setupDefaultHighWaterMark (runtimeConfig, applicationConfig, logger) {
   }
 }
 
+// Whether the module compile cache has been enabled in this worker.
+let compileCacheEnabled = false
+
 // Enable compile cache if configured (Node.js 22.1.0+)
 async function setupCompileCache (runtimeConfig, applicationConfig, logger) {
   // Normalize boolean shorthand: true -> { enabled: true }
@@ -187,8 +191,10 @@ async function setupCompileCache (runtimeConfig, applicationConfig, logger) {
     const { compileCacheStatus } = moduleApi.constants ?? {}
 
     if (result.status === compileCacheStatus?.ENABLED) {
+      compileCacheEnabled = true
       logger.debug({ directory: result.directory }, 'Module compile cache enabled')
     } else if (result.status === compileCacheStatus?.ALREADY_ENABLED) {
+      compileCacheEnabled = true
       logger.debug({ directory: result.directory }, 'Module compile cache already enabled')
     } else if (result.status === compileCacheStatus?.FAILED) {
       logger.warn({ message: result.message }, 'Failed to enable module compile cache')
@@ -319,6 +325,14 @@ async function main () {
 
   await controller.init(cleanup)
 
+  // Make the compile cache accumulated while booting durable, as Node.js would otherwise only write
+  // it when the worker terminates.
+  controller.on('started', () => {
+    if (compileCacheEnabled) {
+      scheduleCompileCacheFlush(logger)
+    }
+  })
+
   if (applicationConfig.entrypoint && runtimeConfig.basePath) {
     const meta = await controller.capability.getMeta()
     if (!meta.gateway.wantsAbsoluteUrls) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "3.68.0",
+  "version": "3.70.0",
   "description": "Platformatic runtime",
   "main": "index.js",
   "type": "module",
@@ -35,18 +35,18 @@
     "pino-abstract-transport": "^2.0.0",
     "pino-sentry-transport": "^1.6.0",
     "split2": "^4.2.0",
-    "tstyche": "^6.2.0",
+    "tstyche": "^7.0.0",
     "typescript": "~6.0.3",
     "undici-oidc-interceptor": "^0.9.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "3.68.0",
-    "@platformatic/db": "3.68.0",
-    "@platformatic/gateway": "3.68.0",
-    "@platformatic/node": "3.68.0",
-    "@platformatic/service": "3.68.0",
-    "@platformatic/sql-graphql": "3.68.0",
-    "@platformatic/sql-mapper": "3.68.0",
-    "@platformatic/wattpm-pprof-capture": "3.68.0"
+    "@platformatic/composer": "3.70.0",
+    "@platformatic/db": "3.70.0",
+    "@platformatic/gateway": "3.70.0",
+    "@platformatic/node": "3.70.0",
+    "@platformatic/service": "3.70.0",
+    "@platformatic/sql-graphql": "3.70.0",
+    "@platformatic/sql-mapper": "3.70.0",
+    "@platformatic/wattpm-pprof-capture": "3.70.0"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -77,13 +77,13 @@
     "undici": "^7.27.2",
     "undici-thread-interceptor": "^1.3.1",
     "ws": "^8.16.0",
-    "@platformatic/generators": "3.68.0",
-    "@platformatic/globals": "3.68.0",
-    "@platformatic/itc": "3.68.0",
-    "@platformatic/metrics": "3.68.0",
-    "@platformatic/telemetry": "3.68.0",
-    "@platformatic/basic": "3.68.0",
-    "@platformatic/foundation": "3.68.0"
+    "@platformatic/foundation": "3.70.0",
+    "@platformatic/basic": "3.70.0",
+    "@platformatic/generators": "3.70.0",
+    "@platformatic/itc": "3.70.0",
+    "@platformatic/metrics": "3.70.0",
+    "@platformatic/telemetry": "3.70.0",
+    "@platformatic/globals": "3.70.0"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.68.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.70.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Runtime Config",
   "type": "object",
@@ -1894,22 +1894,7 @@
       "properties": {
         "level": {
           "type": "string",
-          "oneOf": [
-            {
-              "enum": [
-                "fatal",
-                "error",
-                "warn",
-                "info",
-                "debug",
-                "trace",
-                "silent"
-              ]
-            },
-            {
-              "pattern": "^\\{.+\\}$"
-            }
-          ]
+          "description": "The log level. It must be one of the standard pino levels (fatal, error, warn, info, debug, trace, silent) or, when customLevels is set, one of the custom levels."
         },
         "transport": {
           "anyOf": [
@@ -2010,6 +1995,10 @@
             "censor": {
               "type": "string",
               "default": "[redacted]"
+            },
+            "remove": {
+              "type": "boolean",
+              "description": "Remove the redacted keys entirely instead of replacing their values with the censor. Defaults to false."
             }
           },
           "required": [
@@ -2035,6 +2024,50 @@
           "type": "object",
           "additionalProperties": true
         },
+        "levelVal": {
+          "type": "integer",
+          "description": "The numeric value of the level defined in level, when it is not one of the standard pino levels."
+        },
+        "useOnlyCustomLevels": {
+          "type": "boolean",
+          "description": "Only use the levels defined in customLevels and omit the standard pino ones."
+        },
+        "levelComparison": {
+          "type": "string",
+          "enum": [
+            "ASC",
+            "DESC"
+          ],
+          "description": "How log levels are compared to the logger level. Use DESC when lower values are more severe. Defaults to ASC."
+        },
+        "msgPrefix": {
+          "type": "string",
+          "description": "A string prefixed to every message, including the ones of child loggers."
+        },
+        "nestedKey": {
+          "type": "string",
+          "description": "The key under which any logged object is placed."
+        },
+        "errorKey": {
+          "type": "string",
+          "description": "The key used for the serialized error in the log object. Defaults to err."
+        },
+        "depthLimit": {
+          "type": "integer",
+          "description": "The stringification limit at a specific nesting depth when logging circular objects. Defaults to 5."
+        },
+        "edgeLimit": {
+          "type": "integer",
+          "description": "The stringification limit of properties or elements when logging a circular object or array. Defaults to 100."
+        },
+        "crlf": {
+          "type": "boolean",
+          "description": "Terminate each log line with \\r\\n instead of \\n. Defaults to false."
+        },
+        "enabled": {
+          "type": "boolean",
+          "description": "Set to false to disable logging entirely. Defaults to true."
+        },
         "openTelemetryExporter": {
           "type": "object",
           "properties": {
@@ -2079,6 +2112,35 @@
           "additionalProperties": false
         }
       },
+      "if": {
+        "not": {
+          "required": [
+            "customLevels"
+          ]
+        }
+      },
+      "then": {
+        "properties": {
+          "level": {
+            "oneOf": [
+              {
+                "enum": [
+                  "fatal",
+                  "error",
+                  "warn",
+                  "info",
+                  "debug",
+                  "trace",
+                  "silent"
+                ]
+              },
+              {
+                "pattern": "^\\{.+\\}$"
+              }
+            ]
+          }
+        }
+      },
       "default": {},
       "additionalProperties": true
     },