@platformatic/basic 3.29.1 → 3.31.0

package/config.d.ts

@@ -31,7 +31,7 @@ export interface PlatformaticBasicConfig {
         };
     workersRestartDelay?: number | string;
     logger?: {
-      level: (
+      level?: (
         | ("fatal" | "error" | "warn" | "info" | "debug" | "trace" | "silent")
         | {
             [k: string]: unknown;
@@ -414,6 +414,18 @@ export interface PlatformaticBasicConfig {
         [k: string]: string | [string, ...string[]];
       };
     };
+    compileCache?:
+      | boolean
+      | {
+          /**
+           * Enable Node.js module compile cache for faster startup
+           */
+          enabled?: boolean;
+          /**
+           * Directory to store compile cache. Defaults to .plt/compile-cache in app root
+           */
+          directory?: string;
+        };
     application?: {
       reuseTcpPorts?: boolean;
       workers?:
@@ -472,6 +484,18 @@ export interface PlatformaticBasicConfig {
         )[];
         [k: string]: unknown;
       };
+      compileCache?:
+        | boolean
+        | {
+            /**
+             * Enable Node.js module compile cache for faster startup
+             */
+            enabled?: boolean;
+            /**
+             * Directory to store compile cache. Defaults to .plt/compile-cache in app root
+             */
+            directory?: string;
+          };
     };
   };
   [k: string]: unknown;

package/lib/capability.js

@@ -7,7 +7,7 @@ import {
   kMetadata,
   kTimeout
 } from '@platformatic/foundation'
-import { client, collectMetrics, ensureMetricsGroup, setupOtlpExporter } from '@platformatic/metrics'
+import { clearRegistry, client, collectThreadMetrics, ensureMetricsGroup, setupOtlpExporter } from '@platformatic/metrics'
 import { parseCommandString } from 'execa'
 import { spawn } from 'node:child_process'
 import { tracingChannel } from 'node:diagnostics_channel'
@@ -155,6 +155,37 @@ export class BaseCapability extends EventEmitter {
     // No-op by default
   }
 
+  async updateMetricsConfig (metricsConfig) {
+    // Transform applicationLabel to idLabel (same transformation as in worker/main.js)
+    const normalizedConfig = {
+      ...metricsConfig,
+      idLabel: metricsConfig.applicationLabel || 'applicationId'
+    }
+    this.context.metricsConfig = normalizedConfig
+
+    // If running in subprocess mode, send the update to the child process
+    if (this.childManager && this.clientWs) {
+      await this.childManager.send(this.clientWs, 'updateMetricsConfig', {
+        applicationId: this.applicationId,
+        workerId: this.workerId,
+        metricsConfig: normalizedConfig
+      })
+      return
+    }
+
+    if (this.metricsRegistry) {
+      // We must clear the registry to stop prom-client from collecting metrics in the background,
+      // and because prom-client doesn't support changing labels on existing metrics.
+      // This will lose all previously collected metrics.
+      clearRegistry(this.metricsRegistry)
+
+      if (metricsConfig.enabled !== false) {
+        this.#metricsCollected = false
+        await this._collectMetrics()
+      }
+    }
+  }
+
   start () {
     throw new Error('BaseCapability.start must be overriden by the subclasses')
   }
@@ -547,7 +578,8 @@ export class BaseCapability extends EventEmitter {
               backlog: this.serverConfig.backlog
             }
           : {},
-      telemetryConfig: this.telemetryConfig
+      telemetryConfig: this.telemetryConfig,
+      compileCache: this.config.compileCache ?? this.runtimeConfig?.compileCache
     }
   }
 
@@ -708,7 +740,9 @@ export class BaseCapability extends EventEmitter {
       return
     }
 
-    await collectMetrics(this.applicationId, this.workerId, metricsConfig, this.metricsRegistry)
+    // Use thread-specific metrics collection - process-level metrics are collected
+    // by the main runtime thread and duplicated with worker labels
+    await collectThreadMetrics(this.applicationId, this.workerId, metricsConfig, this.metricsRegistry)
   }
 
   #setHttpCacheMetrics () {

package/lib/worker/child-process.js

@@ -5,14 +5,15 @@ import {
   ensureLoggableError
 } from '@platformatic/foundation'
 import { ITC } from '@platformatic/itc/lib/index.js'
-import { client, collectMetrics } from '@platformatic/metrics'
+import { clearRegistry, client, collectThreadMetrics } from '@platformatic/metrics'
 import diagnosticChannel, { tracingChannel } from 'node:diagnostics_channel'
 import { EventEmitter, once } from 'node:events'
 import { readFile } from 'node:fs/promises'
 import { ServerResponse } from 'node:http'
 import { register } from 'node:module'
 import { hostname, platform, tmpdir } from 'node:os'
-import { basename, resolve } from 'node:path'
+import { basename, join, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
 import pino from 'pino'
 import { Agent, Pool, setGlobalDispatcher } from 'undici'
 import { WebSocket } from 'ws'
@@ -84,6 +85,9 @@ export class ChildProcess extends ITC {
         collectMetrics: (...args) => {
           return this.#collectMetrics(...args)
         },
+        updateMetricsConfig: (...args) => {
+          return this.#updateMetricsConfig(...args)
+        },
         getMetrics: (...args) => {
           return this.#getMetrics(...args)
         },
@@ -217,10 +221,23 @@ export class ChildProcess extends ITC {
   }
 
   async #collectMetrics ({ applicationId, workerId, metricsConfig }) {
-    await collectMetrics(applicationId, workerId, metricsConfig, this.#metricsRegistry)
+    // Use thread-specific metrics collection - process-level metrics are collected
+    // by the main runtime thread and duplicated with worker labels
+    await collectThreadMetrics(applicationId, workerId, metricsConfig, this.#metricsRegistry)
     this.#setHttpCacheMetrics()
   }
 
+  async #updateMetricsConfig ({ applicationId, workerId, metricsConfig }) {
+    clearRegistry(this.#metricsRegistry)
+
+    if (metricsConfig.enabled !== false) {
+      // Use thread-specific metrics collection - process-level metrics are collected
+      // by the main runtime thread and duplicated with worker labels
+      await collectThreadMetrics(applicationId, workerId, metricsConfig, this.#metricsRegistry)
+      this.#setHttpCacheMetrics()
+    }
+  }
+
   #setHttpCacheMetrics () {
     const { client, registry } = globalThis.platformatic.prometheus
 
@@ -491,12 +508,60 @@ function stripBasePath (basePath) {
   }
 }
 
+// Enable compile cache if configured (Node.js 22.1.0+)
+async function setupCompileCache (contextData) {
+  const config = contextData?.compileCache
+
+  // Normalize boolean shorthand
+  const normalizeConfig = cfg => {
+    if (cfg === true) return { enabled: true }
+    if (cfg === false) return { enabled: false }
+    return cfg
+  }
+
+  const normalizedConfig = normalizeConfig(config)
+  if (!normalizedConfig?.enabled) {
+    return
+  }
+
+  // Check if API is available (Node.js 22.1.0+)
+  let moduleApi
+  try {
+    moduleApi = await import('node:module')
+    if (typeof moduleApi.enableCompileCache !== 'function') {
+      return
+    }
+  } catch {
+    return
+  }
+
+  // Use root from context data (capability's this.root as URL)
+  const root = contextData?.root ? fileURLToPath(contextData.root) : null
+  if (!root) {
+    return
+  }
+
+  const cacheDir =
+    typeof normalizedConfig === 'object' && normalizedConfig.directory
+      ? normalizedConfig.directory
+      : join(root, '.plt', 'compile-cache')
+
+  try {
+    moduleApi.enableCompileCache(cacheDir)
+  } catch {
+    // Silently ignore - cache is optional optimization
+  }
+}
+
 async function main () {
   const executable = basename(process.argv[1] ?? '')
 
   const dataPath = resolve(tmpdir(), 'platformatic', 'runtimes', `${process.env.PLT_MANAGER_ID}.json`)
   const { data, loader, scripts } = JSON.parse(await readFile(dataPath))
 
+  // Enable compile cache early before loading user modules
+  await setupCompileCache(data)
+
   globalThis.platformatic = Object.assign(globalThis.platformatic ?? {}, data)
   globalThis.platformatic.events = new ForwardingEventEmitter()
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/basic",
-  "version": "3.29.1",
+  "version": "3.31.0",
   "description": "",
   "main": "index.js",
   "types": "index.d.ts",
@@ -25,16 +25,16 @@
     "split2": "^4.2.0",
     "undici": "^7.0.0",
     "ws": "^8.18.0",
-    "@platformatic/foundation": "3.29.1",
-    "@platformatic/itc": "3.29.1",
-    "@platformatic/telemetry": "3.29.1",
-    "@platformatic/metrics": "3.29.1"
+    "@platformatic/foundation": "3.31.0",
+    "@platformatic/itc": "3.31.0",
+    "@platformatic/metrics": "3.31.0",
+    "@platformatic/telemetry": "3.31.0"
   },
   "devDependencies": {
     "cleaner-spec-reporter": "^0.5.0",
     "eslint": "9",
     "express": "^4.19.2",
-    "fastify": "^5.0.0",
+    "fastify": "^5.7.0",
     "get-port": "^7.1.0",
     "json-schema-to-typescript": "^15.0.0",
     "neostandard": "^0.12.0",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/basic/3.29.1.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/basic/3.31.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Basic Config",
   "type": "object",
@@ -336,6 +336,28 @@
                     }
                   }
                 }
+              },
+              "compileCache": {
+                "anyOf": [
+                  {
+                    "type": "boolean"
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "enabled": {
+                        "type": "boolean",
+                        "default": true,
+                        "description": "Enable Node.js module compile cache for faster startup"
+                      },
+                      "directory": {
+                        "type": "string",
+                        "description": "Directory to store compile cache. Defaults to .plt/compile-cache in app root"
+                      }
+                    },
+                    "additionalProperties": false
+                  }
+                ]
               }
             }
           }
@@ -415,7 +437,6 @@
           "properties": {
             "level": {
               "type": "string",
-              "default": "info",
               "oneOf": [
                 {
                   "enum": [
@@ -558,9 +579,6 @@
               "additionalProperties": true
             }
           },
-          "required": [
-            "level"
-          ],
           "default": {},
           "additionalProperties": true
         },
@@ -1602,6 +1620,28 @@
           ],
           "additionalProperties": false
         },
+        "compileCache": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "enabled": {
+                  "type": "boolean",
+                  "default": true,
+                  "description": "Enable Node.js module compile cache for faster startup"
+                },
+                "directory": {
+                  "type": "string",
+                  "description": "Directory to store compile cache. Defaults to .plt/compile-cache in app root"
+                }
+              },
+              "additionalProperties": false
+            }
+          ]
+        },
         "application": {
           "type": "object",
           "properties": {
@@ -1866,6 +1906,28 @@
                   }
                 }
               }
+            },
+            "compileCache": {
+              "anyOf": [
+                {
+                  "type": "boolean"
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "enabled": {
+                      "type": "boolean",
+                      "default": true,
+                      "description": "Enable Node.js module compile cache for faster startup"
+                    },
+                    "directory": {
+                      "type": "string",
+                      "description": "Directory to store compile cache. Defaults to .plt/compile-cache in app root"
+                    }
+                  },
+                  "additionalProperties": false
+                }
+              ]
             }
           },
           "additionalProperties": false