@platformatic/runtime 3.33.0 → 3.34.0

package/.claude/settings.local.json

@@ -0,0 +1,13 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(find:*)",
+      "Bash(rg:*)",
+      "Bash(npm test:*)",
+      "Bash(grep:*)",
+      "Bash(npx eslint:*)",
+      "Bash(node:*)"
+    ],
+    "deny": []
+  }
+}

package/config.d.ts

@@ -213,6 +213,10 @@ export type PlatformaticRuntimeConfig = {
   gracefulShutdown?: {
     runtime: number | string;
     application: number | string;
+    /**
+     * Add Connection: close header to HTTP responses during graceful shutdown
+     */
+    closeConnections?: boolean;
   };
   health?: {
     enabled?: boolean | string;
@@ -376,6 +380,23 @@ export type PlatformaticRuntimeConfig = {
            */
           serviceVersion?: string;
         };
+        /**
+         * Custom labels to add to HTTP metrics (http_request_all_duration_seconds). Each label extracts its value from an HTTP request header.
+         */
+        httpCustomLabels?: {
+          /**
+           * The label name to use in metrics
+           */
+          name: string;
+          /**
+           * The HTTP request header to extract the value from
+           */
+          header: string;
+          /**
+           * Default value when header is missing (defaults to "unknown")
+           */
+          default?: string;
+        }[];
       };
   telemetry?: {
     enabled?: boolean | string;

package/lib/errors.js

@@ -148,3 +148,7 @@ export const WorkerInterceptorNotReadyError = createError(
   `${ERROR_PREFIX}_WORKER_INTERCEPTOR_NOT_READY`,
   'The "%s" application worker interceptor is not ready'
 )
+export const WorkerInterceptorJoinTimeoutError = createError(
+  `${ERROR_PREFIX}_WORKER_INTERCEPTOR_JOIN_TIMEOUT`,
+  'The %s failed to join the mesh network in %dms.'
+)

package/lib/logger.js

@@ -139,7 +139,7 @@ function createPrettifier (context) {
         const current = context.current
         const level = current.caller ? current.caller : labelColorized.replace(label, label.padStart(6, ' '))
 
-        return `${current.prefix} | \u001B[0m ${level}`
+        return `${current.prefix} |\u001B[0m${level}`
       }
     }
   })

package/lib/runtime.js

@@ -10,13 +10,14 @@ import {
   parseMemorySize
 } from '@platformatic/foundation'
 import { ITC } from '@platformatic/itc'
-import { client as metricsClient, collectProcessMetrics } from '@platformatic/metrics'
+import { collectProcessMetrics, client as metricsClient } from '@platformatic/metrics'
 import fastify from 'fastify'
 import { EventEmitter, once } from 'node:events'
 import { existsSync } from 'node:fs'
 import { readFile } from 'node:fs/promises'
 import { STATUS_CODES } from 'node:http'
 import { createRequire } from 'node:module'
+import { availableParallelism } from 'node:os'
 import { dirname, isAbsolute, join } from 'node:path'
 import { setImmediate as immediate, setTimeout as sleep } from 'node:timers/promises'
 import { pathToFileURL } from 'node:url'
@@ -36,8 +37,8 @@ import {
   MissingEntrypointError,
   MissingPprofCapture,
   RuntimeAbortedError,
-  WorkerNotFoundError,
-  WorkerInterceptorNotReadyError
+  WorkerInterceptorJoinTimeoutError,
+  WorkerNotFoundError
 } from './errors.js'
 import { abstractLogger, createLogger } from './logger.js'
 import { startManagementApi } from './management-api.js'
@@ -56,6 +57,7 @@ import {
   kFullId,
   kHealthCheckTimer,
   kId,
+  kInterceptorReadyPromise,
   kITC,
   kLastHealthCheckELU,
   kStderrMarker,
@@ -63,8 +65,7 @@ import {
   kWorkerId,
   kWorkersBroadcast,
   kWorkerStartTime,
-  kWorkerStatus,
-  kInterceptorReadyPromise
+  kWorkerStatus
 } from './worker/symbols.js'
 
 const kWorkerFile = join(import.meta.dirname, 'worker/main.js')
@@ -89,7 +90,7 @@ function parseOrigins (origins) {
   })
 }
 
-const MAX_CONCURRENCY = 5
+const MAX_CONCURRENCY = availableParallelism()
 const MAX_BOOTSTRAP_ATTEMPTS = 5
 const IMMEDIATE_RESTART_MAX_THRESHOLD = 10
 const MAX_WORKERS = 100
@@ -497,7 +498,7 @@ export class Runtime extends EventEmitter {
     await executeInParallel(this.#setupApplication.bind(this), setupInvocations, this.#concurrency)
 
     for (const application of applications) {
-      this.logger.info(`Added application "${application.id}"${application.entrypoint ? ' (entrypoint)' : ''}.`)
+      this.logger.debug(`Added application "${application.id}"${application.entrypoint ? ' (entrypoint)' : ''}.`)
       this.emitAndNotify('application:added', application)
     }
 
@@ -534,7 +535,7 @@ export class Runtime extends EventEmitter {
     }
 
     for (const application of applications) {
-      this.logger.info(`Removed application "${application}".`)
+      this.logger.warn(`Removed application "${application}".`)
       this.emitAndNotify('application:removed', application)
     }
 
@@ -2058,7 +2059,7 @@ export class Runtime extends EventEmitter {
 
         if (workerUrl === kTimeout) {
           this.emitAndNotify('application:worker:startTimeout', eventPayload)
-          this.logger.info(`The ${label} failed to start in ${config.startTimeout}ms. Forcefully killing the thread.`)
+          this.logger.error(`The ${label} failed to start in ${config.startTimeout}ms. Forcefully killing the thread.`)
           worker.terminate()
           throw new ApplicationStartTimeoutError(id, config.startTimeout)
         }
@@ -2072,7 +2073,11 @@ export class Runtime extends EventEmitter {
         this.#url = workerUrl
       }
 
-      await this.#waitForWorkerInterceptor(worker)
+      // Wait for the interceptor to be ready
+      const interceptorResult = await executeWithTimeout(worker[kInterceptorReadyPromise], config.startTimeout)
+      if (interceptorResult === kTimeout) {
+        throw new WorkerInterceptorJoinTimeoutError(label, config.startTimeout)
+      }
 
       worker[kWorkerStatus] = 'started'
       worker[kWorkerStartTime] = Date.now()
@@ -2983,24 +2988,4 @@ export class Runtime extends EventEmitter {
 
     this.#loggerContext.updatePrefixes(ids)
   }
-
-  async #waitForWorkerInterceptor (worker, timeout = 10000) {
-    const workerId = worker[kId]
-    const applicationId = worker[kApplicationId]
-
-    const interceptorReadyTimeout = setTimeout(() => {
-      this.logger.error(
-        { applicationId, workerId },
-        'The worker interceptor is not ready after 10s'
-      )
-      throw new WorkerInterceptorNotReadyError(applicationId)
-    }, timeout)
-
-    try {
-      await worker[kInterceptorReadyPromise]
-      worker[kInterceptorReadyPromise] = null
-    } finally {
-      clearTimeout(interceptorReadyTimeout)
-    }
-  }
 }

package/lib/worker/itc.js

@@ -20,6 +20,58 @@ import { updateUndiciInterceptors } from './interceptors.js'
 import { MessagingITC } from './messaging.js'
 import { kApplicationId, kITC, kId, kWorkerId } from './symbols.js'
 
+function startSubprocessRepl (port, childManager, clientWs, controller) {
+  // Start the REPL in the child process
+  childManager.send(clientWs, 'startRepl').catch(err => {
+    port.postMessage({ type: 'output', data: `Error starting REPL: ${err.message}\n` })
+    port.postMessage({ type: 'exit' })
+    port.close()
+  })
+
+  // Listen for repl:output notifications from the child process
+  function handleReplOutput ({ data }) {
+    port.postMessage({ type: 'output', data })
+  }
+
+  // Listen for repl:exit notifications from the child process
+  function handleReplExit () {
+    cleanup()
+    port.postMessage({ type: 'exit' })
+    port.close()
+  }
+
+  function cleanup () {
+    childManager.removeListener('repl:output', handleReplOutput)
+    childManager.removeListener('repl:exit', handleReplExit)
+  }
+
+  childManager.on('repl:output', handleReplOutput)
+  childManager.on('repl:exit', handleReplExit)
+
+  // Forward input from MessagePort to child process
+  port.on('message', (message) => {
+    if (message.type === 'input') {
+      childManager.send(clientWs, 'replInput', { data: message.data }).catch(() => {
+        // Ignore errors if the child process has exited
+      })
+    } else if (message.type === 'close') {
+      childManager.send(clientWs, 'replClose').catch(() => {
+        // Ignore errors if the child process has exited
+      })
+      cleanup()
+    }
+  })
+
+  port.on('close', () => {
+    childManager.send(clientWs, 'replClose').catch(() => {
+      // Ignore errors if the child process has exited
+    })
+    cleanup()
+  })
+
+  return { started: true }
+}
+
 async function safeHandleInITC (worker, fn) {
   try {
     // Make sure to catch when the worker exits, otherwise we're stuck forever
@@ -241,6 +293,19 @@ export function setupITC (controller, application, dispatcher, sharedContext) {
       },
 
       async getHealth () {
+        // Check if running in subprocess mode - forward through ChildManager
+        const childManager = controller.capability?.getChildManager?.()
+        const clientWs = controller.capability?.clientWs
+
+        if (childManager && clientWs) {
+          try {
+            return await childManager.send(clientWs, 'getHealth')
+          } catch (err) {
+            throw new FailedToRetrieveHealthError(application.id, err.message)
+          }
+        }
+
+        // Existing thread implementation
         try {
           return await controller.getHealth()
         } catch (err) {
@@ -273,6 +338,14 @@ export function setupITC (controller, application, dispatcher, sharedContext) {
       },
 
       startRepl (port) {
+        // Check if running in subprocess mode - forward through ChildManager
+        const childManager = controller.capability?.getChildManager?.()
+        const clientWs = controller.capability?.clientWs
+
+        if (childManager && clientWs) {
+          return startSubprocessRepl(port, childManager, clientWs, controller)
+        }
+
         // We are loading the repl module dynamically here to avoid loading it
         // when not needed (since it pulls in domain, which is quite expensive
         // as it monkey patches EventEmitter).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "3.33.0",
+  "version": "3.34.0",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -35,14 +35,14 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/db": "3.33.0",
-    "@platformatic/gateway": "3.33.0",
-    "@platformatic/composer": "3.33.0",
-    "@platformatic/node": "3.33.0",
-    "@platformatic/service": "3.33.0",
-    "@platformatic/sql-mapper": "3.33.0",
-    "@platformatic/sql-graphql": "3.33.0",
-    "@platformatic/wattpm-pprof-capture": "3.33.0"
+    "@platformatic/db": "3.34.0",
+    "@platformatic/sql-graphql": "3.34.0",
+    "@platformatic/gateway": "3.34.0",
+    "@platformatic/service": "3.34.0",
+    "@platformatic/node": "3.34.0",
+    "@platformatic/composer": "3.34.0",
+    "@platformatic/sql-mapper": "3.34.0",
+    "@platformatic/wattpm-pprof-capture": "3.34.0"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -71,12 +71,12 @@
     "undici": "^7.0.0",
     "undici-thread-interceptor": "^1.0.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "3.33.0",
-    "@platformatic/foundation": "3.33.0",
-    "@platformatic/generators": "3.33.0",
-    "@platformatic/itc": "3.33.0",
-    "@platformatic/metrics": "3.33.0",
-    "@platformatic/telemetry": "3.33.0"
+    "@platformatic/basic": "3.34.0",
+    "@platformatic/foundation": "3.34.0",
+    "@platformatic/itc": "3.34.0",
+    "@platformatic/generators": "3.34.0",
+    "@platformatic/telemetry": "3.34.0",
+    "@platformatic/metrics": "3.34.0"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.33.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.34.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Runtime Config",
   "type": "object",
@@ -1757,6 +1757,11 @@
             }
           ],
           "default": 10000
+        },
+        "closeConnections": {
+          "type": "boolean",
+          "default": true,
+          "description": "Add Connection: close header to HTTP responses during graceful shutdown"
         }
       },
       "default": {},
@@ -2297,6 +2302,32 @@
                 "endpoint"
               ],
               "additionalProperties": false
+            },
+            "httpCustomLabels": {
+              "type": "array",
+              "description": "Custom labels to add to HTTP metrics (http_request_all_duration_seconds). Each label extracts its value from an HTTP request header.",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "The label name to use in metrics"
+                  },
+                  "header": {
+                    "type": "string",
+                    "description": "The HTTP request header to extract the value from"
+                  },
+                  "default": {
+                    "type": "string",
+                    "description": "Default value when header is missing (defaults to \"unknown\")"
+                  }
+                },
+                "required": [
+                  "name",
+                  "header"
+                ],
+                "additionalProperties": false
+              }
             }
           },
           "additionalProperties": false

package/tmp/plt-multiple-workers-1755670359398/composer/platformatic.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/composer/2.6.0.json",
+  "server": {
+    "logger": {
+      "level": "info"
+    }
+  }
+}

package/tmp/plt-multiple-workers-1755670359398/node/index.js

@@ -0,0 +1,21 @@
+import fastify from 'fastify'
+
+export function create () {
+  const app = fastify({
+    logger: {
+      name: [globalThis.platformatic.serviceId, globalThis.platformatic.workerId]
+        .filter(f => typeof f !== 'undefined')
+        .join(':'),
+      level: globalThis.platformatic?.logLevel ?? 'info'
+    }
+  })
+
+  app.get('/hello', async (request, reply) => {
+    reply.header('x-plt-port', app.server.address()?.port)
+    reply.header('x-plt-socket', request.socket.constructor.name)
+    reply.header('x-plt-worker-id', globalThis.platformatic.workerId)
+    return { from: 'node' }
+  })
+
+  return app
+}

package/tmp/plt-multiple-workers-1755670359398/node/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "index.mjs"
+}

package/tmp/plt-multiple-workers-1755670359398/node/platformatic.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/node/2.6.0.json",
+  "logger": {
+    "level": "info"
+  }
+}

package/tmp/plt-multiple-workers-1755670359398/platformatic.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/2.6.0.json",
+  "watch": false,
+  "managementApi": true,
+  "metrics": true,
+  "restartOnError": 500,
+  "autoload": {
+    "path": "."
+  },
+  "services": [
+    {
+      "id": "node",
+      "path": "./node",
+      "config": "platformatic.json",
+      "workers": 5
+    }
+  ],
+  "logger": {
+    "level": "trace"
+  },
+  "workers": 3
+}

package/tmp/plt-multiple-workers-1755670359398/service/platformatic.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/service/2.6.0.json",
+  "plugins": {
+    "paths": ["./plugin.js"]
+  },
+  "server": {
+    "logger": {
+      "level": "info"
+    }
+  }
+}

package/tmp/plt-multiple-workers-1755670359398/service/plugin.js

@@ -0,0 +1,8 @@
+module.exports = async function (app) {
+  app.get('/hello', async (request, reply) => {
+    reply.header('x-plt-port', app.server.address()?.port)
+    reply.header('x-plt-socket', request.socket.constructor.name)
+    reply.header('x-plt-worker-id', globalThis.platformatic.workerId)
+    return { from: 'service' }
+  })
+}

package/tmp/plt-multiple-workers-1755670455851/composer/platformatic.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/composer/2.6.0.json",
+  "server": {
+    "logger": {
+      "level": "info"
+    }
+  }
+}

package/tmp/plt-multiple-workers-1755670455851/logs.txt

@@ -0,0 +1,3 @@
+{"level":40,"time":1755670455936,"pid":35507,"hostname":"panda.local","msg":"\"composer\" is set as the entrypoint, but reusePort is not available in your OS; setting workers to 1 instead of 3"}
+{"level":20,"time":1755670456077,"pid":35507,"hostname":"panda.local","worker":0,"name":"node","envfile":"/Volumes/DATI/Users/Shogun/Programmazione/Work/Platformatic/oss/packages/runtime/tmp/plt-multiple-workers-1755670455851/node/.env","msg":"Loading envfile..."}
+{"level":10,"time":1755670456183,"pid":35507,"hostname":"panda.local","event":"application:worker:init","payload":{"application":"node","worker":0,"workersCount":5},"msg":"Runtime event"}

package/tmp/plt-multiple-workers-1755670455851/node/index.js

@@ -0,0 +1,23 @@
+import fastify from 'fastify'
+
+export function main () {
+  const app = fastify({
+    logger: {
+      name: [globalThis.platformatic.serviceId, globalThis.platformatic.workerId]
+        .filter(f => typeof f !== 'undefined')
+        .join(':'),
+      level: globalThis.platformatic?.logLevel ?? 'info'
+    }
+  })
+
+  app.get('/hello', async (request, reply) => {
+    reply.header('x-plt-port', app.server.address()?.port)
+    reply.header('x-plt-socket', request.socket.constructor.name)
+    reply.header('x-plt-worker-id', globalThis.platformatic.workerId)
+    return { from: 'node' }
+  })
+
+  app.listen({ port: 0 })
+}
+
+main()

package/tmp/plt-multiple-workers-1755670455851/node/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "index.mjs"
+}

package/tmp/plt-multiple-workers-1755670455851/node/platformatic.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/node/2.6.0.json",
+  "logger": {
+    "level": "info"
+  },
+  "application": {
+    "commands": {
+      "production": "node index.mjs"
+    }
+  }
+}

package/tmp/plt-multiple-workers-1755670455851/platformatic.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/2.6.0.json",
+  "watch": false,
+  "managementApi": true,
+  "metrics": true,
+  "restartOnError": 500,
+  "autoload": {
+    "path": "."
+  },
+  "services": [
+    {
+      "id": "node",
+      "path": "./node",
+      "config": "platformatic.json",
+      "workers": 5
+    }
+  ],
+  "logger": {
+    "level": "trace",
+    "transport": {
+      "target": "pino/file",
+      "options": {
+        "destination": "/Volumes/DATI/Users/Shogun/Programmazione/Work/Platformatic/oss/packages/runtime/tmp/plt-multiple-workers-1755670455851/logs.txt"
+      }
+    }
+  },
+  "workers": 3
+}

package/tmp/plt-multiple-workers-1755670455851/service/platformatic.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/service/2.6.0.json",
+  "plugins": {
+    "paths": ["./plugin.js"]
+  },
+  "server": {
+    "logger": {
+      "level": "info"
+    }
+  }
+}

package/tmp/plt-multiple-workers-1755670455851/service/plugin.js

@@ -0,0 +1,8 @@
+module.exports = async function (app) {
+  app.get('/hello', async (request, reply) => {
+    reply.header('x-plt-port', app.server.address()?.port)
+    reply.header('x-plt-socket', request.socket.constructor.name)
+    reply.header('x-plt-worker-id', globalThis.platformatic.workerId)
+    return { from: 'service' }
+  })
+}

package/tmp/plt-multiple-workers-1756217004369/composer/platformatic.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/gateway/2.69.0.json",
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  }
+}

package/tmp/plt-multiple-workers-1756217004369/first/index.mjs

@@ -0,0 +1,21 @@
+import fastify from 'fastify'
+
+export function create () {
+  const app = fastify({ logger: true })
+
+  app.get('/thread/:id', async req => {
+    const response = await globalThis.platformatic.messaging.send('second', 'thread', { request: req.params.id })
+
+    return { thread: response }
+  })
+
+  app.get('/crash', async () => {
+    setImmediate(() => {
+      throw new Error('kaboom')
+    })
+
+    return { hello: 'world' }
+  })
+
+  return app
+}

package/tmp/plt-multiple-workers-1756217004369/first/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "index.mjs"
+}

package/tmp/plt-multiple-workers-1756217004369/first/platformatic.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/node/2.69.0.json",
+  "logger": {
+    "level": "error"
+  },
+  "watch": true
+}

package/tmp/plt-multiple-workers-1756217004369/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/tmp/plt-multiple-workers-1756217004369/platformatic.1-to-n.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/2.70.0.json",
+  "watch": false,
+  "managementApi": true,
+  "metrics": false,
+  "restartOnError": 500,
+  "entrypoint": "composer",
+  "logger": {
+    "level": "info"
+  },
+  "services": [
+    {
+      "id": "first",
+      "path": "first",
+      "workers": 1
+    },
+    {
+      "id": "second",
+      "path": "second"
+    },
+    {
+      "id": "composer",
+      "path": "composer",
+      "workers": 1
+    }
+  ],
+  "messagingTimeout": 2000,
+  "workers": 3
+}