@platformatic/runtime 3.9.0 → 3.10.0

package/config.d.ts

@@ -31,10 +31,39 @@ export type PlatformaticRuntimeConfig = {
           maxHeapTotal?: number | string;
           maxYoungGeneration?: number | string;
         };
-        preload?: string | string[];
         dependencies?: string[];
         arguments?: string[];
+        env?: {
+          [k: string]: string;
+        };
+        envfile?: string;
+        sourceMaps?: boolean;
+        packageManager?: "npm" | "pnpm" | "yarn";
+        preload?: string | string[];
         nodeOptions?: string;
+        permissions?: {
+          fs?: {
+            read?: string[];
+            write?: string[];
+          };
+        };
+        telemetry?: {
+          /**
+           * An array of instrumentations loaded if telemetry is enabled
+           */
+          instrumentations?: (
+            | string
+            | {
+                package: string;
+                exportName?: string;
+                options?: {
+                  [k: string]: unknown;
+                };
+                [k: string]: unknown;
+              }
+          )[];
+          [k: string]: unknown;
+        };
       };
     };
   };
@@ -255,6 +284,7 @@ export type PlatformaticRuntimeConfig = {
               };
             };
         plugins?: string[];
+        timeout?: number | string;
       };
   telemetry?: {
     enabled?: boolean | string;
@@ -343,6 +373,7 @@ export type PlatformaticRuntimeConfig = {
     timeWindowSec?: number;
     cooldownSec?: number;
     scaleIntervalSec?: number;
+    gracePeriod?: number;
     applications?: {
       [k: string]: {
         minWorkers?: number;

package/lib/config.js

@@ -45,7 +45,7 @@ function raiseInvalidWorkersError (location, received, hint) {
   throw new InvalidArgumentError(`${location} workers must be a positive integer; received "${received}"${extra}`)
 }
 
-export function autoDetectPprofCapture (config) {
+export function pprofCapturePreloadPath () {
   const require = createRequire(import.meta.url)
 
   let pprofCapturePath
@@ -55,6 +55,12 @@ export function autoDetectPprofCapture (config) {
     // No-op
   }
 
+  return pprofCapturePath
+}
+
+export function autoDetectPprofCapture (config) {
+  const pprofCapturePath = pprofCapturePreloadPath()
+
   // Add to preload if not already present
   if (!config.preload) {
     config.preload = []
@@ -192,14 +198,7 @@ export async function transform (config, _, context) {
         config = join(entryPath, configFilename)
       }
 
-      const application = {
-        id,
-        config,
-        path: entryPath,
-        useHttp: !!mapping.useHttp,
-        health: mapping.health,
-        dependencies: mapping.dependencies
-      }
+      const application = { id, config, path: entryPath, ...mapping }
       const existingApplicationId = applications.findIndex(application => application.id === id)
 
       if (existingApplicationId !== -1) {
@@ -336,6 +335,13 @@ export async function transform (config, _, context) {
     // like adding other applications.
   }
 
+  if (config.metrics === true) {
+    config.metrics = {
+      enabled: true,
+      timeout: 1000
+    }
+  }
+
   config.applications = applications
   config.web = undefined
   config.services = undefined

package/lib/runtime.js

@@ -9,7 +9,6 @@ import {
   kTimeout,
   parseMemorySize
 } from '@platformatic/foundation'
-import os from 'node:os'
 import { ITC } from '@platformatic/itc'
 import fastify from 'fastify'
 import { EventEmitter, once } from 'node:events'
@@ -17,13 +16,15 @@ import { existsSync } from 'node:fs'
 import { readFile } from 'node:fs/promises'
 import { STATUS_CODES } from 'node:http'
 import { createRequire } from 'node:module'
-import { join } from 'node:path'
+import os 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'
 import { Worker } from 'node:worker_threads'
 import SonicBoom from 'sonic-boom'
 import { Agent, request, interceptors as undiciInterceptors } from 'undici'
 import { createThreadInterceptor } from 'undici-thread-interceptor'
+import { pprofCapturePreloadPath } from './config.js'
 import {
   ApplicationAlreadyStartedError,
   ApplicationNotFoundError,
@@ -40,12 +41,12 @@ import {
 import { abstractLogger, createLogger } from './logger.js'
 import { startManagementApi } from './management-api.js'
 import { startPrometheusServer } from './prom-server.js'
+import ScalingAlgorithm from './scaling-algorithm.js'
 import { startScheduler } from './scheduler.js'
 import { createSharedStore } from './shared-http-cache.js'
 import { version } from './version.js'
 import { sendViaITC, waitEventFromITC } from './worker/itc.js'
 import { RoundRobinMap } from './worker/round-robin-map.js'
-import ScalingAlgorithm from './scaling-algorithm.js'
 import {
   kApplicationId,
   kConfig,
@@ -57,7 +58,8 @@ import {
   kStderrMarker,
   kWorkerId,
   kWorkersBroadcast,
-  kWorkerStatus
+  kWorkerStatus,
+  kWorkerStartTime
 } from './worker/symbols.js'
 
 const kWorkerFile = join(import.meta.dirname, 'worker/main.js')
@@ -277,7 +279,7 @@ export class Runtime extends EventEmitter {
     }
 
     if (this.#config.verticalScaler?.enabled) {
-      this.#setupVerticalScaler()
+      await this.#setupVerticalScaler()
     }
 
     this.#showUrl()
@@ -891,8 +893,12 @@ export class Runtime extends EventEmitter {
           continue
         }
 
-        const applicationMetrics = await sendViaITC(worker, 'getMetrics', format)
-        if (applicationMetrics) {
+        const applicationMetrics = await executeWithTimeout(
+          sendViaITC(worker, 'getMetrics', format),
+          this.#config.metrics?.timeout ?? 10000
+        )
+
+        if (applicationMetrics && applicationMetrics !== kTimeout) {
           if (metrics === null) {
             metrics = format === 'json' ? [] : ''
           }
@@ -1315,6 +1321,17 @@ export class Runtime extends EventEmitter {
       execArgv.push('--enable-source-maps')
     }
 
+    if (applicationConfig.permissions?.fs) {
+      execArgv.push(...this.#setupPermissions(applicationConfig))
+    }
+
+    let preload = config.preload
+    if (execArgv.includes('--permission')) {
+      // Remove wattpm-pprof-capture from preload since it is not supported
+      const pprofCapturePath = pprofCapturePreloadPath()
+      preload = preload.filter(p => p !== pprofCapturePath)
+    }
+
     const workerEnv = structuredClone(this.#env)
 
     if (applicationConfig.nodeOptions?.trim().length > 0) {
@@ -1337,7 +1354,10 @@ export class Runtime extends EventEmitter {
 
     const worker = new Worker(kWorkerFile, {
       workerData: {
-        config,
+        config: {
+          ...config,
+          preload
+        },
         applicationConfig: {
           ...applicationConfig,
           isProduction: this.#isProduction,
@@ -1642,6 +1662,8 @@ export class Runtime extends EventEmitter {
       }
 
       worker[kWorkerStatus] = 'started'
+      worker[kWorkerStartTime] = Date.now()
+
       this.emitAndNotify('application:worker:started', eventPayload)
       this.#broadcastWorkers()
 
@@ -2441,9 +2463,14 @@ export class Runtime extends EventEmitter {
     }
   }
 
-  #setupVerticalScaler () {
-    const isWorkersFixed = this.#config.workers !== undefined
-    if (isWorkersFixed) return
+  async #setupVerticalScaler () {
+    const fixedWorkersCount = this.#config.workers
+    if (fixedWorkersCount !== undefined) {
+      this.logger.warn(
+        `Vertical scaler disabled because the "workers" configuration is set to ${fixedWorkersCount}`
+      )
+      return
+    }
 
     const scalerConfig = this.#config.verticalScaler
 
@@ -2456,6 +2483,7 @@ export class Runtime extends EventEmitter {
     scalerConfig.minELUDiff ??= 0.2
     scalerConfig.scaleIntervalSec ??= 60
     scalerConfig.timeWindowSec ??= 60
+    scalerConfig.gracePeriod ??= 30 * 1000
     scalerConfig.applications ??= {}
 
     const maxTotalWorkers = scalerConfig.maxTotalWorkers
@@ -2468,9 +2496,18 @@ export class Runtime extends EventEmitter {
     const scaleIntervalSec = scalerConfig.scaleIntervalSec
     const timeWindowSec = scalerConfig.timeWindowSec
     const applicationsConfigs = scalerConfig.applications
+    const gracePeriod = scalerConfig.gracePeriod
+    const healthCheckInterval = 1000
+
+    const initialResourcesUpdates = []
 
     for (const application of this.#config.applications) {
       if (application.entrypoint && !features.node.reusePort) {
+        this.logger.warn(
+          `The "${application.id}" application cannot be scaled because it is an entrypoint` +
+          ' and the "reusePort" feature is not available in your OS.'
+        )
+
         applicationsConfigs[application.id] = {
           minWorkers: 1,
           maxWorkers: 1
@@ -2478,6 +2515,10 @@ export class Runtime extends EventEmitter {
         continue
       }
       if (application.workers !== undefined) {
+        this.logger.warn(
+          `The "${application.id}" application cannot be scaled because` +
+          ` it has a fixed number of workers (${application.workers}).`
+        )
         applicationsConfigs[application.id] = {
           minWorkers: application.workers,
           maxWorkers: application.workers
@@ -2488,12 +2529,22 @@ export class Runtime extends EventEmitter {
       applicationsConfigs[application.id] ??= {}
       applicationsConfigs[application.id].minWorkers ??= minWorkers
       applicationsConfigs[application.id].maxWorkers ??= maxWorkers
+
+      const appMinWorkers = applicationsConfigs[application.id].minWorkers
+      if (appMinWorkers > 1) {
+        initialResourcesUpdates.push({
+          application: application.id,
+          workers: minWorkers
+        })
+      }
+    }
+
+    if (initialResourcesUpdates.length > 0) {
+      await this.updateApplicationsResources(initialResourcesUpdates)
     }
 
     for (const applicationId in applicationsConfigs) {
-      const application = this.#config.applications.find(
-        app => app.id === applicationId
-      )
+      const application = this.#config.applications.find(app => app.id === applicationId)
       if (!application) {
         delete applicationsConfigs[applicationId]
 
@@ -2512,18 +2563,43 @@ export class Runtime extends EventEmitter {
       applications: applicationsConfigs
     })
 
-    this.on('application:worker:health', async (healthInfo) => {
-      if (!healthInfo) {
-        this.logger.error('No health info received')
-        return
-      }
+    const healthCheckTimeout = setTimeout(async () => {
+      let shouldCheckForScaling = false
+
+      const now = Date.now()
 
-      scalingAlgorithm.addWorkerHealthInfo(healthInfo)
+      for (const worker of this.#workers.values()) {
+        if (
+          worker[kWorkerStatus] !== 'started' ||
+          worker[kWorkerStartTime] + gracePeriod > now
+        ) {
+          continue
+        }
+
+        try {
+          const health = await this.#getHealth(worker)
+          if (!health) continue
+
+          scalingAlgorithm.addWorkerHealthInfo({
+            workerId: worker[kId],
+            applicationId: worker[kApplicationId],
+            elu: health.elu
+          })
 
-      if (healthInfo.currentHealth.elu > scaleUpELU) {
+          if (health.elu > scaleUpELU) {
+            shouldCheckForScaling = true
+          }
+        } catch (err) {
+          this.logger.error({ err }, 'Failed to get health for worker')
+        }
+      }
+
+      if (shouldCheckForScaling) {
         await checkForScaling()
       }
-    })
+
+      healthCheckTimeout.refresh()
+    }, healthCheckInterval).unref()
 
     let isScaling = false
     let lastScaling = 0
@@ -2548,16 +2624,16 @@ export class Runtime extends EventEmitter {
         const recommendations = scalingAlgorithm.getRecommendations(appsWorkersInfo)
         if (recommendations.length > 0) {
           await applyRecommendations(recommendations)
+          lastScaling = Date.now()
         }
       } catch (err) {
         this.logger.error({ err }, 'Failed to scale applications')
       } finally {
         isScaling = false
-        lastScaling = Date.now()
       }
     }
 
-    const applyRecommendations = async (recommendations) => {
+    const applyRecommendations = async recommendations => {
       const resourcesUpdates = []
       for (const recommendation of recommendations) {
         const { applicationId, workersCount, direction } = recommendation
@@ -2574,4 +2650,48 @@ export class Runtime extends EventEmitter {
     // Interval for periodic scaling checks
     setInterval(checkForScaling, scaleIntervalSec * 1000).unref()
   }
+
+  #setupPermissions (applicationConfig) {
+    const argv = []
+    const allows = new Set()
+    const { read, write } = applicationConfig.permissions.fs
+
+    if (read?.length) {
+      for (const p of read) {
+        allows.add(`--allow-fs-read=${isAbsolute(p) ? p : join(applicationConfig.path, p)}`)
+      }
+    }
+
+    if (write?.length) {
+      for (const p of write) {
+        allows.add(`--allow-fs-write=${isAbsolute(p) ? p : join(applicationConfig.path, p)}`)
+      }
+    }
+
+    if (allows.size === 0) {
+      return argv
+    }
+
+    // We need to allow read access to the node_modules folder both at the runtime level and at the application level
+    allows.add(`--allow-fs-read=${join(this.#root, 'node_modules', '*')}`)
+    allows.add(`--allow-fs-read=${join(applicationConfig.path, 'node_modules', '*')}`)
+
+    // Since we can't really predict how dependencies are installed (symlinks, pnpm store, and so forth), we also
+    // add any node_modules folder found in the ancestors of the current file
+    let lastPath = import.meta.dirname
+    let currentPath = import.meta.dirname
+
+    do {
+      lastPath = currentPath
+      const nodeModules = join(currentPath, 'node_modules')
+      if (existsSync(nodeModules)) {
+        allows.add(`--allow-fs-read=${join(nodeModules, '*')}`)
+      }
+
+      currentPath = dirname(currentPath)
+    } while (lastPath !== currentPath)
+
+    argv.push('--permission', ...allows)
+    return argv
+  }
 }

package/lib/scaling-algorithm.js

@@ -19,9 +19,7 @@ class ScalingAlgorithm {
   }
 
   addWorkerHealthInfo (healthInfo) {
-    const workerId = healthInfo.id
-    const applicationId = healthInfo.application
-    const elu = healthInfo.currentHealth.elu
+    const { workerId, applicationId, elu } = healthInfo
     const timestamp = Date.now()
 
     if (!this.#appsELUs[applicationId]) {
@@ -59,6 +57,27 @@ class ScalingAlgorithm {
 
     for (const { applicationId, elu, workersCount } of appsInfo) {
       const appMinWorkers = this.#appsConfigs[applicationId]?.minWorkers ?? 1
+      const appMaxWorkers = this.#appsConfigs[applicationId]?.maxWorkers ?? this.#maxTotalWorkers
+
+      if (workersCount < appMinWorkers) {
+        recommendations.push({
+          applicationId,
+          workersCount: appMinWorkers,
+          direction: 'up'
+        })
+        totalWorkersCount += appMinWorkers - workersCount
+        continue
+      }
+
+      if (workersCount > appMaxWorkers) {
+        recommendations.push({
+          applicationId,
+          workersCount: appMaxWorkers,
+          direction: 'down'
+        })
+        totalWorkersCount -= workersCount - appMaxWorkers
+        continue
+      }
 
       if (elu < this.#scaleDownELU && workersCount > appMinWorkers) {
         recommendations.push({
@@ -75,6 +94,12 @@ class ScalingAlgorithm {
 
       const { applicationId, workersCount } = scaleUpCandidate
 
+      const isScaled = recommendations.some(
+        r => r.applicationId === applicationId &&
+          r.direction === 'up'
+      )
+      if (isScaled) continue
+
       const appMaxWorkers = this.#appsConfigs[applicationId]?.maxWorkers ?? this.#maxTotalWorkers
       if (workersCount >= appMaxWorkers) continue
 

package/lib/worker/symbols.js

@@ -6,6 +6,7 @@ export const kWorkerId = Symbol.for('plt.runtime.worker.id')
 export const kITC = Symbol.for('plt.runtime.itc')
 export const kHealthCheckTimer = Symbol.for('plt.runtime.worker.healthCheckTimer')
 export const kWorkerStatus = Symbol('plt.runtime.worker.status')
+export const kWorkerStartTime = Symbol.for('plt.runtime.worker.startTime')
 export const kInterceptors = Symbol.for('plt.runtime.worker.interceptors')
 export const kLastELU = Symbol.for('plt.runtime.worker.lastELU')
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "3.9.0",
+  "version": "3.10.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/composer": "3.9.0",
-    "@platformatic/db": "3.9.0",
-    "@platformatic/gateway": "3.9.0",
-    "@platformatic/sql-graphql": "3.9.0",
-    "@platformatic/node": "3.9.0",
-    "@platformatic/sql-mapper": "3.9.0",
-    "@platformatic/service": "3.9.0",
-    "@platformatic/wattpm-pprof-capture": "3.9.0"
+    "@platformatic/composer": "3.10.0",
+    "@platformatic/db": "3.10.0",
+    "@platformatic/node": "3.10.0",
+    "@platformatic/gateway": "3.10.0",
+    "@platformatic/service": "3.10.0",
+    "@platformatic/sql-graphql": "3.10.0",
+    "@platformatic/sql-mapper": "3.10.0",
+    "@platformatic/wattpm-pprof-capture": "3.10.0"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -72,12 +72,12 @@
     "undici": "^7.0.0",
     "undici-thread-interceptor": "^0.14.0",
     "ws": "^8.16.0",
-    "@platformatic/foundation": "3.9.0",
-    "@platformatic/generators": "3.9.0",
-    "@platformatic/itc": "3.9.0",
-    "@platformatic/basic": "3.9.0",
-    "@platformatic/metrics": "3.9.0",
-    "@platformatic/telemetry": "3.9.0"
+    "@platformatic/basic": "3.10.0",
+    "@platformatic/foundation": "3.10.0",
+    "@platformatic/itc": "3.10.0",
+    "@platformatic/generators": "3.10.0",
+    "@platformatic/metrics": "3.10.0",
+    "@platformatic/telemetry": "3.10.0"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.9.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.10.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Runtime Config",
   "type": "object",
@@ -171,6 +171,40 @@
                 },
                 "additionalProperties": false
               },
+              "dependencies": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "default": []
+              },
+              "arguments": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "env": {
+                "type": "object",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "envfile": {
+                "type": "string"
+              },
+              "sourceMaps": {
+                "type": "boolean",
+                "default": false
+              },
+              "packageManager": {
+                "type": "string",
+                "enum": [
+                  "npm",
+                  "pnpm",
+                  "yarn"
+                ]
+              },
               "preload": {
                 "anyOf": [
                   {
@@ -186,20 +220,66 @@
                   }
                 ]
               },
-              "dependencies": {
-                "type": "array",
-                "items": {
-                  "type": "string"
-                }
-              },
-              "arguments": {
-                "type": "array",
-                "items": {
-                  "type": "string"
-                }
-              },
               "nodeOptions": {
                 "type": "string"
+              },
+              "permissions": {
+                "type": "object",
+                "properties": {
+                  "fs": {
+                    "type": "object",
+                    "properties": {
+                      "read": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        }
+                      },
+                      "write": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        }
+                      }
+                    },
+                    "additionalProperties": false
+                  }
+                },
+                "additionalProperties": false
+              },
+              "telemetry": {
+                "type": "object",
+                "properties": {
+                  "instrumentations": {
+                    "type": "array",
+                    "description": "An array of instrumentations loaded if telemetry is enabled",
+                    "items": {
+                      "oneOf": [
+                        {
+                          "type": "string"
+                        },
+                        {
+                          "type": "object",
+                          "properties": {
+                            "package": {
+                              "type": "string"
+                            },
+                            "exportName": {
+                              "type": "string"
+                            },
+                            "options": {
+                              "type": "object",
+                              "additionalProperties": true
+                            }
+                          },
+                          "required": [
+                            "package"
+                          ]
+                        }
+                      ]
+                    }
+                  }
+                }
               }
             }
           }
@@ -405,6 +485,30 @@
           "nodeOptions": {
             "type": "string"
           },
+          "permissions": {
+            "type": "object",
+            "properties": {
+              "fs": {
+                "type": "object",
+                "properties": {
+                  "read": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "write": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                },
+                "additionalProperties": false
+              }
+            },
+            "additionalProperties": false
+          },
           "telemetry": {
             "type": "object",
             "properties": {
@@ -641,6 +745,30 @@
           "nodeOptions": {
             "type": "string"
           },
+          "permissions": {
+            "type": "object",
+            "properties": {
+              "fs": {
+                "type": "object",
+                "properties": {
+                  "read": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "write": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                },
+                "additionalProperties": false
+              }
+            },
+            "additionalProperties": false
+          },
           "telemetry": {
             "type": "object",
             "properties": {
@@ -877,6 +1005,30 @@
           "nodeOptions": {
             "type": "string"
           },
+          "permissions": {
+            "type": "object",
+            "properties": {
+              "fs": {
+                "type": "object",
+                "properties": {
+                  "read": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "write": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                },
+                "additionalProperties": false
+              }
+            },
+            "additionalProperties": false
+          },
           "telemetry": {
             "type": "object",
             "properties": {
@@ -1691,6 +1843,17 @@
                   }
                 ]
               }
+            },
+            "timeout": {
+              "anyOf": [
+                {
+                  "type": "integer"
+                },
+                {
+                  "type": "string"
+                }
+              ],
+              "default": 10000
             }
           },
           "additionalProperties": false
@@ -1873,6 +2036,10 @@
           "type": "number",
           "minimum": 0
         },
+        "gracePeriod": {
+          "type": "number",
+          "minimum": 0
+        },
         "applications": {
           "type": "object",
           "additionalProperties": {