@platformatic/runtime 3.28.2 → 3.29.1

package/config.d.ts

@@ -28,6 +28,8 @@ export type PlatformaticRuntimeConfig = {
               static?: number;
               minimum?: number;
               maximum?: number;
+              scaleUpELU?: number;
+              scaleDownELU?: number;
               [k: string]: unknown;
             };
         health?: {
@@ -100,6 +102,8 @@ export type PlatformaticRuntimeConfig = {
         maxMemory?: number;
         cooldown?: number;
         gracePeriod?: number;
+        scaleUpELU?: number;
+        scaleDownELU?: number;
         [k: string]: unknown;
       };
   workersRestartDelay?: number | string;
@@ -433,13 +437,7 @@ export type PlatformaticRuntimeConfig = {
     maxWorkers?: number;
     cooldownSec?: number;
     gracePeriod?: number;
-    /**
-     * @deprecated
-     */
     scaleUpELU?: number;
-    /**
-     * @deprecated
-     */
     scaleDownELU?: number;
     /**
      * @deprecated
@@ -457,6 +455,8 @@ export type PlatformaticRuntimeConfig = {
       [k: string]: {
         minWorkers?: number;
         maxWorkers?: number;
+        scaleUpELU?: number;
+        scaleDownELU?: number;
       };
     };
   };

package/lib/config.js

@@ -298,12 +298,40 @@ export async function transform (config, _, context) {
     config.workers.maximum ??= config.verticalScaler.maxWorkers ?? config.verticalScaler.maxTotalWorkers ?? 1
     config.workers.maxMemory ??= config.verticalScaler.maxTotalMemory
 
-    if (typeof config.workers.cooldown === 'undefined' && typeof config.verticalScaler.cooldownSec === 'number') {
-      config.workers.cooldown = config.verticalScaler.cooldownSec * 1000
+    if (config.verticalScaler.cooldownSec) {
+      config.workers.cooldown ??= config.verticalScaler.cooldownSec * 1000
     }
+    if (config.verticalScaler.gracePeriod) {
+      config.workers.gracePeriod ??= config.verticalScaler.gracePeriod
+    }
+    if (config.verticalScaler.scaleUpELU) {
+      config.workers.scaleUpELU ??= config.verticalScaler.scaleUpELU
+    }
+    if (config.verticalScaler.scaleDownELU) {
+      config.workers.scaleDownELU ??= config.verticalScaler.scaleDownELU
+    }
+
+    if (config.verticalScaler.applications) {
+      for (const appId in config.verticalScaler.applications) {
+        let appConfig = applications.find((app) => app.id === appId)
+        if (!appConfig) {
+          appConfig = { id: appId, workers: {} }
+          applications.push(appConfig)
+        }
 
-    if (typeof config.workers.gracePeriod === 'undefined' && typeof config.verticalScaler.gracePeriod === 'number') {
-      config.workers.gracePeriod = config.verticalScaler.gracePeriod
+        const scaleConfig = config.verticalScaler.applications[appId]
+        const workersConfig = appConfig.workers
+
+        workersConfig.minimum ??= scaleConfig.minWorkers ?? config.workers.minimum
+        workersConfig.maximum ??= scaleConfig.maxWorkers ?? config.workers.maximum
+
+        if (scaleConfig.scaleUpELU) {
+          workersConfig.scaleUpELU ??= scaleConfig.scaleUpELU
+        }
+        if (scaleConfig.scaleDownELU) {
+          workersConfig.scaleDownELU ??= scaleConfig.scaleDownELU
+        }
+      }
     }
 
     config.verticalScaler = undefined

package/lib/errors.js

@@ -144,3 +144,7 @@ export const CannotRemoveEntrypointError = createError(
   `${ERROR_PREFIX}_CANNOT_REMOVE_ENTRYPOINT`,
   'Cannot remove the entrypoint application.'
 )
+export const WorkerInterceptorNotReadyError = createError(
+  `${ERROR_PREFIX}_WORKER_INTERCEPTOR_NOT_READY`,
+  'The "%s" application worker interceptor is not ready'
+)

package/lib/runtime.js

@@ -35,7 +35,8 @@ import {
   MissingEntrypointError,
   MissingPprofCapture,
   RuntimeAbortedError,
-  WorkerNotFoundError
+  WorkerNotFoundError,
+  WorkerInterceptorNotReadyError
 } from './errors.js'
 import { abstractLogger, createLogger } from './logger.js'
 import { startManagementApi } from './management-api.js'
@@ -61,7 +62,8 @@ import {
   kWorkerId,
   kWorkersBroadcast,
   kWorkerStartTime,
-  kWorkerStatus
+  kWorkerStatus,
+  kInterceptorReadyPromise
 } from './worker/symbols.js'
 
 const kWorkerFile = join(import.meta.dirname, 'worker/main.js')
@@ -1640,11 +1642,13 @@ export class Runtime extends EventEmitter {
     if (enabled) {
       // Store locally
       this.#workers.set(workerId, worker)
-
-      // Setup the interceptor
-      this.#meshInterceptor.route(applicationId, worker)
     }
 
+    // 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)
+
     // Wait for initialization
     await waitEventFromITC(worker, 'init')
 
@@ -1884,6 +1888,8 @@ export class Runtime extends EventEmitter {
         this.#url = workerUrl
       }
 
+      await this.#waitForWorkerInterceptor(worker)
+
       worker[kWorkerStatus] = 'started'
       worker[kWorkerStartTime] = Date.now()
 
@@ -2034,7 +2040,7 @@ export class Runtime extends EventEmitter {
   }
 
   async #discardWorker (worker) {
-    this.#meshInterceptor.unroute(worker[kApplicationId], worker, true)
+    await this.#meshInterceptor.unroute(worker[kApplicationId], worker, true)
     worker.removeAllListeners('exit')
     await worker.terminate()
 
@@ -2128,7 +2134,6 @@ export class Runtime extends EventEmitter {
       }
 
       this.#workers.set(workerId, newWorker)
-      this.#meshInterceptor.route(applicationId, newWorker)
     } catch (e) {
       newWorker?.terminate?.()
       throw e
@@ -2336,7 +2341,7 @@ export class Runtime extends EventEmitter {
 
       let pinoLog
 
-      if (typeof message === 'object') {
+      if (message !== null && typeof message === 'object') {
         pinoLog =
           typeof message.level === 'number' &&
           // We want to accept both pino raw time (number) and time as formatted string
@@ -2794,4 +2799,24 @@ 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/scaling-algorithm.js

@@ -1,5 +1,3 @@
-export const scaleUpELUThreshold = 0.8
-export const scaleDownELUThreshold = 0.2
 export const scaleUpTimeWindow = 10_000
 export const scaleDownTimeWindow = 60_000
 
@@ -7,15 +5,23 @@ export class ScalingAlgorithm {
   #maxTotalWorkers
   #appsMetrics
   #appsConfigs
+  #scaleUpELU
+  #scaleDownELU
 
   constructor (options = {}) {
     this.#maxTotalWorkers = options.maxTotalWorkers ?? Infinity
     this.#appsConfigs = options.applications ?? {}
     this.#appsMetrics = {}
+    this.#scaleUpELU = options.scaleUpELU ?? 0.8
+    this.#scaleDownELU = options.scaleDownELU ?? 0.2
   }
 
-  addApplication (id, config) {
+  addApplication (id, config = {}) {
+    config.scaleUpELU ??= this.#scaleUpELU
+    config.scaleDownELU ??= this.#scaleDownELU
+
     this.#appsConfigs[id] = config
+    this.#appsMetrics[id] ??= {}
   }
 
   removeApplication (id) {
@@ -28,8 +34,9 @@ export class ScalingAlgorithm {
     const timestamp = Date.now()
 
     if (!this.#appsMetrics[applicationId]) {
-      this.#appsMetrics[applicationId] = {}
+      throw new Error(`Missing application "${applicationId}" in the scaling algorithm.`)
     }
+
     if (!this.#appsMetrics[applicationId][workerId]) {
       this.#appsMetrics[applicationId][workerId] = []
     }
@@ -234,12 +241,13 @@ export class ScalingAlgorithm {
     const { elu: scaleUpELU } = this.#calculateAppAvgMetrics(applicationId, { timeWindow: scaleUpTimeWindow })
     const { elu: scaleDownELU } = this.#calculateAppAvgMetrics(applicationId, { timeWindow: scaleDownTimeWindow })
     const { heapUsed: avgHeapUsage } = this.#calculateAppAvgMetrics(applicationId)
+    const config = this.#appsConfigs[applicationId]
 
     let recommendation = null
-    if (scaleUpELU > scaleUpELUThreshold) {
+    if (scaleUpELU > config.scaleUpELU) {
       recommendation = 'scaleUp'
     }
-    if (scaleDownELU < scaleDownELUThreshold) {
+    if (scaleDownELU < config.scaleDownELU) {
       recommendation = 'scaleDown'
     }
 

package/lib/schema.js

@@ -22,7 +22,9 @@ schemaComponents.runtimeProperties.verticalScaler.properties.applications = {
     type: 'object',
     properties: {
       minWorkers: { type: 'number', minimum: 1 },
-      maxWorkers: { type: 'number', minimum: 1 }
+      maxWorkers: { type: 'number', minimum: 1 },
+      scaleUpELU: { type: 'number', minimum: 0, maximum: 1 },
+      scaleDownELU: { type: 'number', minimum: 0, maximum: 1 }
     },
     additionalProperties: false
   }

package/lib/worker/symbols.js

@@ -11,6 +11,7 @@ export const kWorkerStartTime = Symbol.for('plt.runtime.worker.startTime')
 export const kInterceptors = Symbol.for('plt.runtime.worker.interceptors')
 export const kLastHealthCheckELU = Symbol.for('plt.runtime.worker.lastHealthCheckELU')
 export const kLastWorkerScalerELU = Symbol.for('plt.runtime.worker.lastWorkerScalerELU')
+export const kInterceptorReadyPromise = Symbol.for('plt.runtime.worker.interceptorReadyPromise')
 
 // This string marker should be safe to use since it belongs to Unicode private area
 export const kStderrMarker = '\ue002'

package/lib/worker-scaler.js

@@ -1,7 +1,7 @@
 import { features } from '@platformatic/foundation'
 import { availableParallelism } from 'node:os'
 import { getMemoryInfo } from './metrics.js'
-import { ScalingAlgorithm, scaleUpELUThreshold } from './scaling-algorithm.js'
+import { ScalingAlgorithm } from './scaling-algorithm.js'
 import { kApplicationId, kId, kLastWorkerScalerELU, kWorkerStartTime, kWorkerStatus } from './worker/symbols.js'
 
 const healthCheckInterval = 1000
@@ -20,6 +20,8 @@ export class DynamicWorkersScaler {
   #maxTotalWorkers
   #maxWorkers
   #minWorkers
+  #scaleUpELU
+  #scaleDownELU
   #cooldown
   #gracePeriod
 
@@ -29,6 +31,7 @@ export class DynamicWorkersScaler {
   #checkScalingInterval
   #isScaling
   #lastScaling
+  #appsConfigs
 
   constructor (runtime, config) {
     this.#runtime = runtime
@@ -37,15 +40,22 @@ export class DynamicWorkersScaler {
     this.#maxTotalWorkers = config.total ?? availableParallelism()
     this.#maxWorkers = config.maximum ?? this.#maxTotalWorkers
     this.#minWorkers = config.minimum ?? 1
+    this.#scaleUpELU = config.scaleUpELU ?? 0.8
+    this.#scaleDownELU = config.scaleDownELU ?? 0.2
     this.#cooldown = config.cooldown ?? defaultCooldown
     this.#gracePeriod = config.gracePeriod ?? defaultGracePeriod
 
-    this.#algorithm = new ScalingAlgorithm({ maxTotalWorkers: this.#maxTotalWorkers })
+    this.#algorithm = new ScalingAlgorithm({
+      maxTotalWorkers: this.#maxTotalWorkers,
+      scaleUpELU: this.#scaleUpELU,
+      scaleDownELU: this.#scaleDownELU
+    })
 
     this.#isScaling = false
     this.#lastScaling = 0
     this.#initialUpdates = []
     this.#status = 'init'
+    this.#appsConfigs = {}
   }
 
   getConfig () {
@@ -100,10 +110,14 @@ export class DynamicWorkersScaler {
     } else {
       config.minWorkers = application.workers.minimum
       config.maxWorkers = application.workers.maximum
+      config.scaleUpELU = application.workers.scaleUpELU
+      config.scaleDownELU = application.workers.scaleDownELU
     }
 
     config.minWorkers ??= this.#minWorkers
     config.maxWorkers ??= this.#maxWorkers
+    config.scaleUpELU ??= this.#scaleUpELU
+    config.scaleDownELU ??= this.#scaleDownELU
 
     if (config.minWorkers > 1) {
       const update = { application: application.id, workers: config.minWorkers }
@@ -115,6 +129,7 @@ export class DynamicWorkersScaler {
       }
     }
 
+    this.#appsConfigs[application.id] = config
     this.#algorithm.addApplication(application.id, config)
   }
 
@@ -143,15 +158,20 @@ export class DynamicWorkersScaler {
 
         worker[kLastWorkerScalerELU] = health.currentELU
 
+        const workerId = worker[kId]
+        const applicationId = worker[kApplicationId]
+        const scaleConfig = this.#appsConfigs[applicationId]
+        if (!scaleConfig) continue
+
         this.#algorithm.addWorkerHealthInfo({
-          workerId: worker[kId],
-          applicationId: worker[kApplicationId],
+          workerId,
+          applicationId,
           elu: health.elu,
           heapUsed: health.heapUsed,
           heapTotal: health.heapTotal
         })
 
-        if (health.elu > scaleUpELUThreshold) {
+        if (health.elu > scaleConfig.scaleUpELU) {
           shouldCheckForScaling = true
         }
       } catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "3.28.2",
+  "version": "3.29.1",
   "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.28.2",
-    "@platformatic/composer": "3.28.2",
-    "@platformatic/gateway": "3.28.2",
-    "@platformatic/node": "3.28.2",
-    "@platformatic/sql-graphql": "3.28.2",
-    "@platformatic/service": "3.28.2",
-    "@platformatic/sql-mapper": "3.28.2",
-    "@platformatic/wattpm-pprof-capture": "3.28.2"
+    "@platformatic/composer": "3.29.1",
+    "@platformatic/db": "3.29.1",
+    "@platformatic/node": "3.29.1",
+    "@platformatic/gateway": "3.29.1",
+    "@platformatic/service": "3.29.1",
+    "@platformatic/sql-graphql": "3.29.1",
+    "@platformatic/sql-mapper": "3.29.1",
+    "@platformatic/wattpm-pprof-capture": "3.29.1"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -69,14 +69,14 @@
     "sonic-boom": "^4.2.0",
     "systeminformation": "^5.27.11",
     "undici": "^7.0.0",
-    "undici-thread-interceptor": "^0.15.0",
+    "undici-thread-interceptor": "^1.0.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "3.28.2",
-    "@platformatic/generators": "3.28.2",
-    "@platformatic/foundation": "3.28.2",
-    "@platformatic/itc": "3.28.2",
-    "@platformatic/metrics": "3.28.2",
-    "@platformatic/telemetry": "3.28.2"
+    "@platformatic/basic": "3.29.1",
+    "@platformatic/generators": "3.29.1",
+    "@platformatic/itc": "3.29.1",
+    "@platformatic/foundation": "3.29.1",
+    "@platformatic/metrics": "3.29.1",
+    "@platformatic/telemetry": "3.29.1"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.28.2.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.29.1.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Runtime Config",
   "type": "object",
@@ -90,6 +90,16 @@
                       "maximum": {
                         "type": "number",
                         "minimum": 0
+                      },
+                      "scaleUpELU": {
+                        "type": "number",
+                        "minimum": 0,
+                        "maximum": 1
+                      },
+                      "scaleDownELU": {
+                        "type": "number",
+                        "minimum": 0,
+                        "maximum": 1
                       }
                     }
                   }
@@ -394,6 +404,16 @@
                   "maximum": {
                     "type": "number",
                     "minimum": 0
+                  },
+                  "scaleUpELU": {
+                    "type": "number",
+                    "minimum": 0,
+                    "maximum": 1
+                  },
+                  "scaleDownELU": {
+                    "type": "number",
+                    "minimum": 0,
+                    "maximum": 1
                   }
                 }
               }
@@ -696,6 +716,16 @@
                   "maximum": {
                     "type": "number",
                     "minimum": 0
+                  },
+                  "scaleUpELU": {
+                    "type": "number",
+                    "minimum": 0,
+                    "maximum": 1
+                  },
+                  "scaleDownELU": {
+                    "type": "number",
+                    "minimum": 0,
+                    "maximum": 1
                   }
                 }
               }
@@ -998,6 +1028,16 @@
                   "maximum": {
                     "type": "number",
                     "minimum": 0
+                  },
+                  "scaleUpELU": {
+                    "type": "number",
+                    "minimum": 0,
+                    "maximum": 1
+                  },
+                  "scaleDownELU": {
+                    "type": "number",
+                    "minimum": 0,
+                    "maximum": 1
                   }
                 }
               }
@@ -1277,6 +1317,16 @@
             "gracePeriod": {
               "type": "number",
               "minimum": 0
+            },
+            "scaleUpELU": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 1
+            },
+            "scaleDownELU": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 1
             }
           }
         }
@@ -2313,14 +2363,12 @@
         "scaleUpELU": {
           "type": "number",
           "minimum": 0,
-          "maximum": 1,
-          "deprecated": true
+          "maximum": 1
         },
         "scaleDownELU": {
           "type": "number",
           "minimum": 0,
-          "maximum": 1,
-          "deprecated": true
+          "maximum": 1
         },
         "timeWindowSec": {
           "type": "number",
@@ -2349,6 +2397,16 @@
               "maxWorkers": {
                 "type": "number",
                 "minimum": 1
+              },
+              "scaleUpELU": {
+                "type": "number",
+                "minimum": 0,
+                "maximum": 1
+              },
+              "scaleDownELU": {
+                "type": "number",
+                "minimum": 0,
+                "maximum": 1
               }
             },
             "additionalProperties": false