@platformatic/runtime 2.44.5 → 2.46.0

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime2445Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime2460Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;
@@ -163,6 +163,7 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime2445Json = {
     | boolean
     | {
         port?: number | string;
+        enabled?: boolean | string;
         hostname?: string;
         endpoint?: string;
         auth?: {

package/lib/config.js

@@ -70,7 +70,7 @@ async function _transformConfig (configManager, args) {
         config = join(entryPath, configFilename)
       }
 
-      const service = { id, config, path: entryPath, useHttp: !!mapping.useHttp }
+      const service = { id, config, path: entryPath, useHttp: !!mapping.useHttp, health: mapping.health }
       const existingServiceId = services.findIndex(service => service.id === id)
 
       if (existingServiceId !== -1) {

package/lib/management-api.js

@@ -36,7 +36,7 @@ async function managementApiPlugin (app, opts) {
 
   app.post('/stop', async () => {
     app.log.debug('stop services')
-    await runtime.close(true)
+    await runtime.close()
   })
 
   app.post('/restart', async () => {

package/lib/prom-server.js

@@ -3,6 +3,9 @@
 const fastify = require('fastify')
 
 async function startPrometheusServer (runtime, opts) {
+  if (opts.enabled === false) {
+    return
+  }
   const host = opts.hostname ?? '0.0.0.0'
   const port = opts.port ?? 9090
   const metricsEndpoint = opts.endpoint ?? '/metrics'

package/lib/runtime.js

@@ -26,6 +26,7 @@ const { sendViaITC, waitEventFromITC } = require('./worker/itc')
 const { RoundRobinMap } = require('./worker/round-robin-map.js')
 const {
   kId,
+  kFullId,
   kServiceId,
   kWorkerId,
   kITC,
@@ -274,10 +275,22 @@ class Runtime extends EventEmitter {
       await this.#inspectorServer.close()
     }
 
-    for (const service of this.#servicesIds) {
+    // Stop the entrypoint first so that no new requests are accepted
+    if (this.#entrypointId) {
+      await this.stopService(this.#entrypointId, silent)
+    }
+
+    // Stop services in reverse order to ensure services which depend on others are stopped first
+    for (const service of this.#servicesIds.reverse()) {
+      // The entrypoint has been stopped above
+      if (service === this.#entrypointId) {
+        continue
+      }
+
       await this.stopService(service, silent)
     }
 
+    await this.#meshInterceptor.close()
     this.#updateStatus('stopped')
   }
 
@@ -285,6 +298,7 @@ class Runtime extends EventEmitter {
     this.emit('restarting')
 
     await this.stop()
+    this.#meshInterceptor.restart()
     await this.start()
 
     this.emit('restarted')
@@ -296,7 +310,7 @@ class Runtime extends EventEmitter {
     return this.#status
   }
 
-  async close (fromManagementApi = false, silent = false) {
+  async close (silent = false) {
     this.#updateStatus('closing')
 
     clearInterval(this.#metricsTimeout)
@@ -304,14 +318,10 @@ class Runtime extends EventEmitter {
     await this.stop(silent)
 
     if (this.#managementApi) {
-      if (fromManagementApi) {
-        // This allow a close request coming from the management API to correctly be handled
-        setImmediate(() => {
-          this.#managementApi.close()
-        })
-      } else {
-        await this.#managementApi.close()
-      }
+      // This allow a close request coming from the management API to correctly be handled
+      setImmediate(() => {
+        this.#managementApi.close()
+      })
     }
 
     if (this.#prometheusServer) {
@@ -1006,7 +1016,7 @@ class Runtime extends EventEmitter {
     this.emit('service:init', id)
   }
 
-  async #setupWorker (config, serviceConfig, workersCount, serviceId, index) {
+  async #setupWorker (config, serviceConfig, workersCount, serviceId, index, enabled = true) {
     const { restartOnError } = config
     const workerId = `${serviceId}:${index}`
 
@@ -1096,7 +1106,7 @@ class Runtime extends EventEmitter {
       worker[kWorkerStatus] = 'exited'
       this.emit('service:worker:exited', eventPayload)
 
-      this.#cleanupWorker(workerId, worker)
+      this.#cleanupWorker(worker)
 
       if (this.#status === 'stopping') {
         return
@@ -1130,8 +1140,10 @@ class Runtime extends EventEmitter {
     })
 
     worker[kId] = workersCount > 1 ? workerId : serviceId
+    worker[kFullId] = workerId
     worker[kServiceId] = serviceId
     worker[kWorkerId] = workersCount > 1 ? index : undefined
+    worker[kWorkerStatus] = 'boot'
     worker[kForwardEvents] = false
 
     if (inspectorOptions) {
@@ -1190,19 +1202,21 @@ class Runtime extends EventEmitter {
       })
     }
 
-    // Store locally
-    this.#workers.set(workerId, worker)
+    if (enabled) {
+      // Store locally
+      this.#workers.set(workerId, worker)
 
-    if (serviceConfig.entrypoint) {
-      this.#entrypointId = serviceId
+      // Setup the interceptor
+      this.#meshInterceptor.route(serviceId, worker)
     }
 
-    // Setup the interceptor
-    this.#meshInterceptor.route(serviceId, worker)
-
     // Store dependencies
     const [{ dependencies }] = await waitEventFromITC(worker, 'init')
 
+    if (serviceConfig.entrypoint) {
+      this.#entrypointId = serviceId
+    }
+
     serviceConfig.dependencies = dependencies
     for (const { envVar, url } of dependencies) {
       if (envVar) {
@@ -1212,11 +1226,13 @@ class Runtime extends EventEmitter {
 
     // This must be done here as the dependencies are filled above
     worker[kConfig] = { ...serviceConfig, health }
-    worker[kWorkerStatus] = 'boot'
-    this.emit('service:worker:boot', eventPayload)
+    worker[kWorkerStatus] = 'init'
+    this.emit('service:worker:init', eventPayload)
+
+    return worker
   }
 
-  #setupHealthCheck (worker, errorLabel) {
+  #setupHealthCheck (config, serviceConfig, workersCount, id, index, workerId, worker, errorLabel) {
     // Clear the timeout when exiting
     worker.on('exit', () => clearTimeout(worker[kHealthCheckTimer]))
 
@@ -1229,9 +1245,10 @@ class Runtime extends EventEmitter {
       const memoryUsage = heapUsed / maxHeapTotal
       const unhealthy = elu > maxELU || memoryUsage > maxHeapUsed
 
+      const serviceId = worker[kServiceId]
       this.emit('health', {
         id: worker[kId],
-        service: worker[kServiceId],
+        service: serviceId,
         worker: worker[kWorkerId],
         currentHealth: health,
         unhealthy,
@@ -1256,20 +1273,39 @@ class Runtime extends EventEmitter {
         unhealthyChecks = 0
       }
 
-      if (unhealthyChecks >= maxUnhealthyChecks) {
-        this.logger.error(
-          { elu, maxELU, memoryUsage, maxMemoryUsage: maxHeapUsed },
-          `The ${errorLabel} is unhealthy. Forcefully terminating it ...`
-        )
-        worker.terminate()
-        return
-      }
+      if (unhealthyChecks === maxUnhealthyChecks) {
+        try {
+          this.logger.error(
+            { elu, maxELU, memoryUsage, maxMemoryUsage: maxHeapUsed },
+            `The ${errorLabel} is unhealthy. Replacing it ...`
+          )
+
+          await this.#replaceWorker(config, serviceConfig, workersCount, id, index, workerId, worker)
+        } catch (e) {
+          this.logger.error(
+            { elu, maxELU, memoryUsage, maxMemoryUsage: maxHeapUsed },
+            `Cannot replace the ${errorLabel}. Forcefully terminating it ...`
+          )
 
-      worker[kHealthCheckTimer].refresh()
+          worker.terminate()
+        }
+      } else {
+        worker[kHealthCheckTimer].refresh()
+      }
     }, interval)
   }
 
-  async #startWorker (config, serviceConfig, workersCount, id, index, silent, bootstrapAttempt = 0) {
+  async #startWorker (
+    config,
+    serviceConfig,
+    workersCount,
+    id,
+    index,
+    silent,
+    bootstrapAttempt = 0,
+    worker = undefined,
+    disableRestartAttempts = false
+  ) {
     const workerId = `${id}:${index}`
     const label = this.#workerExtendedLabel(id, index, workersCount)
 
@@ -1277,7 +1313,10 @@ class Runtime extends EventEmitter {
       this.logger?.info(`Starting the ${label}...`)
     }
 
-    let worker = await this.#getWorkerById(id, index, false, false)
+    if (!worker) {
+      worker = await this.#getWorkerById(id, index, false, false)
+    }
+
     const eventPayload = { service: id, worker: index, workersCount }
 
     // The service was stopped, recreate the thread
@@ -1321,7 +1360,7 @@ class Runtime extends EventEmitter {
       if (enabled && config.restartOnError > 0) {
         worker[kHealthCheckTimer] = setTimeout(
           () => {
-            this.#setupHealthCheck(worker, label)
+            this.#setupHealthCheck(config, serviceConfig, workersCount, id, index, workerId, worker, label)
           },
           gracePeriod > 0 ? gracePeriod : 1
         )
@@ -1330,7 +1369,7 @@ class Runtime extends EventEmitter {
       // TODO: handle port allocation error here
       if (error.code === 'EADDRINUSE') throw error
 
-      this.#cleanupWorker(workerId, worker)
+      this.#cleanupWorker(worker)
 
       if (worker[kWorkerStatus] !== 'exited') {
         // This prevent the exit handler to restart service
@@ -1346,7 +1385,7 @@ class Runtime extends EventEmitter {
 
       const restartOnError = config.restartOnError
 
-      if (!restartOnError) {
+      if (disableRestartAttempts || !restartOnError) {
         throw error
       }
 
@@ -1369,13 +1408,20 @@ class Runtime extends EventEmitter {
     }
   }
 
-  async #stopWorker (workersCount, id, index, silent) {
-    const worker = await this.#getWorkerById(id, index, false, false)
+  async #stopWorker (workersCount, id, index, silent, worker = undefined) {
+    if (!worker) {
+      worker = await this.#getWorkerById(id, index, false, false)
+    }
 
     if (!worker) {
       return
     }
 
+    // Boot should be aborted, discard the worker
+    if (worker[kWorkerStatus] === 'boot') {
+      return this.#discardWorker(worker)
+    }
+
     const eventPayload = { service: id, worker: index, workersCount }
 
     worker[kWorkerStatus] = 'stopping'
@@ -1419,12 +1465,24 @@ class Runtime extends EventEmitter {
     this.emit('service:worker:stopped', eventPayload)
   }
 
-  #cleanupWorker (workerId, worker) {
-    this.#workers.delete(workerId)
+  #cleanupWorker (worker) {
+    clearTimeout(worker[kHealthCheckTimer])
+
+    const currentWorker = this.#workers.get(worker[kFullId])
+
+    if (currentWorker === worker) {
+      this.#workers.delete(worker[kFullId])
+    }
 
     worker[kITC].close()
+  }
 
-    clearTimeout(worker[kHealthCheckTimer])
+  async #discardWorker (worker) {
+    this.#meshInterceptor.unroute(worker[kServiceId], worker, true)
+    worker.removeAllListeners('exit')
+    await worker.terminate()
+
+    return this.#cleanupWorker(worker)
   }
 
   #workerExtendedLabel (serviceId, workerId, workersCount) {
@@ -1476,6 +1534,39 @@ class Runtime extends EventEmitter {
     await restartPromise
   }
 
+  async #replaceWorker (config, serviceConfig, workersCount, serviceId, index, workerId, worker) {
+    let newWorker
+
+    try {
+      // Create a new worker
+      newWorker = await this.#setupWorker(config, serviceConfig, workersCount, serviceId, index, false)
+
+      // Make sure the runtime hasn't been stopped in the meanwhile
+      if (this.#status !== 'started') {
+        return this.#discardWorker(newWorker)
+      }
+
+      // Add the worker to the mesh
+      await this.#startWorker(config, serviceConfig, workersCount, serviceId, index, false, 0, newWorker, true)
+
+      // Make sure the runtime hasn't been stopped in the meanwhile
+      if (this.#status !== 'started') {
+        return this.#discardWorker(newWorker)
+      }
+
+      this.#workers.set(workerId, newWorker)
+      this.#meshInterceptor.route(serviceId, newWorker)
+
+      // Remove the old worker and then kill it
+      await sendViaITC(worker, 'removeFromMesh')
+    } catch (e) {
+      newWorker?.terminate?.()
+      throw e
+    }
+
+    await this.#stopWorker(workersCount, serviceId, index, false, worker)
+  }
+
   async #getServiceById (serviceId, ensureStarted = false, mustExist = true) {
     // If the serviceId includes the worker, properly split
     let workerId

package/lib/schema.js

@@ -3,7 +3,7 @@
 
 const telemetry = require('@platformatic/telemetry').schema
 const {
-  schemaComponents: { server, logger, health }
+  schemaComponents: { server, logger, health, healthWithoutDefaults }
 } = require('@platformatic/utils')
 
 const env = {
@@ -65,7 +65,7 @@ const services = {
         type: 'boolean'
       },
       workers,
-      health: { ...health, default: undefined },
+      health: { ...healthWithoutDefaults, default: undefined },
       arguments: {
         type: 'array',
         items: {
@@ -174,7 +174,7 @@ const platformaticRuntimeSchema = {
                 type: 'boolean'
               },
               workers,
-              health: { ...health, default: undefined },
+              health: { ...healthWithoutDefaults, default: undefined },
               preload,
               arguments: {
                 type: 'array',
@@ -359,6 +359,13 @@ const platformaticRuntimeSchema = {
             port: {
               anyOf: [{ type: 'integer' }, { type: 'string' }]
             },
+            enabled: {
+              anyOf: [{
+                type: 'boolean'
+              }, {
+                type: 'string'
+              }]
+            },
             hostname: { type: 'string' },
             endpoint: { type: 'string' },
             auth: {

package/lib/worker/itc.js

@@ -86,14 +86,14 @@ function setupITC (app, service, dispatcher) {
           await once(app, 'start')
         }
 
-        if (status !== 'stopped') {
+        if (status.startsWith('start')) {
           // This gives a chance to a stackable to perform custom logic
           globalThis.platformatic.events.emit('stop')
 
           await app.stop()
         }
 
-        dispatcher.interceptor.close()
+        await dispatcher.interceptor.close()
         itc.close()
       },
 
@@ -101,6 +101,14 @@ function setupITC (app, service, dispatcher) {
         return app.stackable.build()
       },
 
+      async removeFromMesh () {
+        return dispatcher.interceptor.close()
+      },
+
+      inject (injectParams) {
+        return app.stackable.inject(injectParams)
+      },
+
       getStatus () {
         return app.getStatus()
       },
@@ -158,10 +166,6 @@ function setupITC (app, service, dispatcher) {
         } catch (err) {
           throw new errors.FailedToRetrieveHealthError(service.id, err.message)
         }
-      },
-
-      inject (injectParams) {
-        return app.stackable.inject(injectParams)
       }
     }
   })

package/lib/worker/symbols.js

@@ -2,6 +2,7 @@
 
 const kConfig = Symbol.for('plt.runtime.config')
 const kId = Symbol.for('plt.runtime.id') // This is also used to detect if we are running in a Platformatic runtime thread
+const kFullId = Symbol.for('plt.runtime.fullId')
 const kServiceId = Symbol.for('plt.runtime.service.id')
 const kWorkerId = Symbol.for('plt.runtime.worker.id')
 const kITC = Symbol.for('plt.runtime.itc')
@@ -14,6 +15,7 @@ const kStderrMarker = '\ue002'
 module.exports = {
   kConfig,
   kId,
+  kFullId,
   kServiceId,
   kWorkerId,
   kITC,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.44.5",
+  "version": "2.46.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -20,6 +20,7 @@
     "@fastify/compress": "^8.0.0",
     "@fastify/express": "^4.0.0",
     "@fastify/formbody": "^8.0.0",
+    "autocannon": "^8.0.0",
     "borp": "^0.19.0",
     "c8": "^10.0.0",
     "eslint": "9",
@@ -36,12 +37,12 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.44.5",
-    "@platformatic/db": "2.44.5",
-    "@platformatic/service": "2.44.5",
-    "@platformatic/sql-graphql": "2.44.5",
-    "@platformatic/node": "2.44.5",
-    "@platformatic/sql-mapper": "2.44.5"
+    "@platformatic/db": "2.46.0",
+    "@platformatic/composer": "2.46.0",
+    "@platformatic/node": "2.46.0",
+    "@platformatic/sql-mapper": "2.46.0",
+    "@platformatic/sql-graphql": "2.46.0",
+    "@platformatic/service": "2.46.0"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -73,15 +74,15 @@
     "tail-file-stream": "^0.2.0",
     "thread-cpu-usage": "^0.2.0",
     "undici": "^7.0.0",
-    "undici-thread-interceptor": "^0.11.0",
+    "undici-thread-interceptor": "^0.13.1",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.44.5",
-    "@platformatic/generators": "2.44.5",
-    "@platformatic/config": "2.44.5",
-    "@platformatic/telemetry": "2.44.5",
-    "@platformatic/ts-compiler": "2.44.5",
-    "@platformatic/itc": "2.44.5",
-    "@platformatic/utils": "2.44.5"
+    "@platformatic/basic": "2.46.0",
+    "@platformatic/config": "2.46.0",
+    "@platformatic/generators": "2.46.0",
+    "@platformatic/telemetry": "2.46.0",
+    "@platformatic/itc": "2.46.0",
+    "@platformatic/ts-compiler": "2.46.0",
+    "@platformatic/utils": "2.46.0"
   },
   "scripts": {
     "test": "npm run lint && borp --concurrency=1 --timeout=300000 && tsd",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.44.5.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.46.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
@@ -78,7 +78,6 @@
                 "type": "object",
                 "properties": {
                   "enabled": {
-                    "default": true,
                     "anyOf": [
                       {
                         "type": "boolean"
@@ -89,7 +88,6 @@
                     ]
                   },
                   "interval": {
-                    "default": 30000,
                     "anyOf": [
                       {
                         "type": "number",
@@ -101,7 +99,6 @@
                     ]
                   },
                   "gracePeriod": {
-                    "default": 30000,
                     "anyOf": [
                       {
                         "type": "number",
@@ -113,7 +110,6 @@
                     ]
                   },
                   "maxUnhealthyChecks": {
-                    "default": 10,
                     "anyOf": [
                       {
                         "type": "number",
@@ -125,7 +121,6 @@
                     ]
                   },
                   "maxELU": {
-                    "default": 0.99,
                     "anyOf": [
                       {
                         "type": "number",
@@ -138,7 +133,6 @@
                     ]
                   },
                   "maxHeapUsed": {
-                    "default": 0.99,
                     "anyOf": [
                       {
                         "type": "number",
@@ -151,7 +145,6 @@
                     ]
                   },
                   "maxHeapTotal": {
-                    "default": 4294967296,
                     "anyOf": [
                       {
                         "type": "number",
@@ -249,7 +242,6 @@
             "type": "object",
             "properties": {
               "enabled": {
-                "default": true,
                 "anyOf": [
                   {
                     "type": "boolean"
@@ -260,7 +252,6 @@
                 ]
               },
               "interval": {
-                "default": 30000,
                 "anyOf": [
                   {
                     "type": "number",
@@ -272,7 +263,6 @@
                 ]
               },
               "gracePeriod": {
-                "default": 30000,
                 "anyOf": [
                   {
                     "type": "number",
@@ -284,7 +274,6 @@
                 ]
               },
               "maxUnhealthyChecks": {
-                "default": 10,
                 "anyOf": [
                   {
                     "type": "number",
@@ -296,7 +285,6 @@
                 ]
               },
               "maxELU": {
-                "default": 0.99,
                 "anyOf": [
                   {
                     "type": "number",
@@ -309,7 +297,6 @@
                 ]
               },
               "maxHeapUsed": {
-                "default": 0.99,
                 "anyOf": [
                   {
                     "type": "number",
@@ -322,7 +309,6 @@
                 ]
               },
               "maxHeapTotal": {
-                "default": 4294967296,
                 "anyOf": [
                   {
                     "type": "number",
@@ -485,7 +471,6 @@
             "type": "object",
             "properties": {
               "enabled": {
-                "default": true,
                 "anyOf": [
                   {
                     "type": "boolean"
@@ -496,7 +481,6 @@
                 ]
               },
               "interval": {
-                "default": 30000,
                 "anyOf": [
                   {
                     "type": "number",
@@ -508,7 +492,6 @@
                 ]
               },
               "gracePeriod": {
-                "default": 30000,
                 "anyOf": [
                   {
                     "type": "number",
@@ -520,7 +503,6 @@
                 ]
               },
               "maxUnhealthyChecks": {
-                "default": 10,
                 "anyOf": [
                   {
                     "type": "number",
@@ -532,7 +514,6 @@
                 ]
               },
               "maxELU": {
-                "default": 0.99,
                 "anyOf": [
                   {
                     "type": "number",
@@ -545,7 +526,6 @@
                 ]
               },
               "maxHeapUsed": {
-                "default": 0.99,
                 "anyOf": [
                   {
                     "type": "number",
@@ -558,7 +538,6 @@
                 ]
               },
               "maxHeapTotal": {
-                "default": 4294967296,
                 "anyOf": [
                   {
                     "type": "number",
@@ -1137,6 +1116,16 @@
                 }
               ]
             },
+            "enabled": {
+              "anyOf": [
+                {
+                  "type": "boolean"
+                },
+                {
+                  "type": "string"
+                }
+              ]
+            },
             "hostname": {
               "type": "string"
             },