@platformatic/runtime 2.7.1-alpha.2 → 2.8.0-alpha.2

package/lib/schema.js

@@ -6,6 +6,16 @@ const {
   schemaComponents: { server, logger }
 } = require('@platformatic/utils')
 
+const workers = {
+  anyOf: [
+    {
+      type: 'number',
+      minimum: 1
+    },
+    { type: 'string' }
+  ]
+}
+
 const services = {
   type: 'array',
   items: {
@@ -27,7 +37,8 @@ const services = {
       },
       useHttp: {
         type: 'boolean'
-      }
+      },
+      workers
     }
   }
 }
@@ -90,6 +101,7 @@ const platformaticRuntimeSchema = {
       }
     },
     services,
+    workers: { ...workers, default: 1 },
     web: services,
     logger,
     server,
@@ -103,6 +115,34 @@ const platformaticRuntimeSchema = {
         }
       ]
     },
+    gracefulShutdown: {
+      type: 'object',
+      properties: {
+        runtime: {
+          anyOf: [
+            {
+              type: 'number',
+              minimum: 1
+            },
+            { type: 'string' }
+          ],
+          default: 10000
+        },
+        service: {
+          anyOf: [
+            {
+              type: 'number',
+              minimum: 1
+            },
+            { type: 'string' }
+          ],
+          default: 10000
+        }
+      },
+      default: {},
+      required: ['runtime', 'service'],
+      additionalProperties: false
+    },
     undici: {
       type: 'object',
       properties: {
@@ -145,32 +185,6 @@ const platformaticRuntimeSchema = {
         }
       }
     },
-    httpCache: {
-      oneOf: [
-        {
-          type: 'boolean'
-        },
-        {
-          type: 'object',
-          properties: {
-            store: {
-              type: 'string'
-            },
-            methods: {
-              type: 'array',
-              items: {
-                type: 'string'
-              },
-              default: ['GET', 'HEAD'],
-              minItems: 1
-            },
-            cacheTagsHeader: {
-              type: 'string'
-            }
-          }
-        }
-      ]
-    },
     watch: {
       anyOf: [
         {

package/lib/start.js

@@ -18,6 +18,16 @@ const { Runtime } = require('./runtime')
 const errors = require('./errors')
 const { getRuntimeLogsDir, loadConfig } = require('./utils')
 
+async function restartRuntime (runtime) {
+  runtime.logger.info('Received SIGUSR2, restarting all services ...')
+
+  try {
+    await runtime.restart()
+  } catch (err) {
+    runtime.logger.error({ err: ensureLoggableError(err) }, 'Failed to restart services.')
+  }
+}
+
 async function buildRuntime (configManager, env) {
   env = env || process.env
 
@@ -35,14 +45,10 @@ async function buildRuntime (configManager, env) {
   const runtime = new Runtime(configManager, runtimeLogsDir, env)
 
   /* c8 ignore next 3 */
-  process.on('SIGUSR2', async () => {
-    runtime.logger.info('Received SIGUSR2, restarting all services ...')
-
-    try {
-      await runtime.restart()
-    } catch (err) {
-      runtime.logger.error({ err: ensureLoggableError(err) }, 'Failed to restart services.')
-    }
+  const restartListener = restartRuntime.bind(null, runtime)
+  process.on('SIGUSR2', restartListener)
+  runtime.on('closed', () => {
+    process.removeListener('SIGUSR2', restartListener)
   })
 
   try {
@@ -109,7 +115,7 @@ async function setupAndStartRuntime (config) {
       })
     )
     logger.warn(`Port: ${originalPort} is already in use!`)
-    logger.warn(`Starting service on port: ${runtimeConfig.current.server.port}`)
+    logger.warn(`Changing the port to ${runtimeConfig.current.server.port}`)
   }
   return { address, runtime }
 }

package/lib/worker/app.js

@@ -3,6 +3,7 @@
 const { existsSync } = require('node:fs')
 const { EventEmitter } = require('node:events')
 const { resolve } = require('node:path')
+const { workerData } = require('node:worker_threads')
 const { ConfigManager } = require('@platformatic/config')
 const { FileWatcher } = require('@platformatic/utils')
 const { getGlobalDispatcher, setGlobalDispatcher } = require('undici')
@@ -21,9 +22,20 @@ class PlatformaticApp extends EventEmitter {
   #debouncedRestart
   #context
 
-  constructor (appConfig, telemetryConfig, loggerConfig, serverConfig, metricsConfig, hasManagementApi, watch) {
+  constructor (
+    appConfig,
+    workerId,
+    telemetryConfig,
+    loggerConfig,
+    serverConfig,
+    metricsConfig,
+    hasManagementApi,
+    watch
+  ) {
     super()
     this.appConfig = appConfig
+    this.serviceId = this.appConfig.id
+    this.workerId = workerId
     this.#watch = watch
     this.#starting = false
     this.#started = false
@@ -32,7 +44,8 @@ class PlatformaticApp extends EventEmitter {
     this.#fileWatcher = null
 
     this.#context = {
-      serviceId: this.appConfig.id,
+      serviceId: this.serviceId,
+      workerId: this.workerId,
       directory: this.appConfig.path,
       isEntrypoint: this.appConfig.entrypoint,
       isProduction: this.appConfig.isProduction,
@@ -40,6 +53,7 @@ class PlatformaticApp extends EventEmitter {
       metricsConfig,
       loggerConfig,
       serverConfig,
+      worker: workerData?.worker,
       hasManagementApi: !!hasManagementApi,
       localServiceEnvVars: this.appConfig.localServiceEnvVars
     }

package/lib/worker/itc.js

@@ -7,7 +7,7 @@ const { ITC } = require('@platformatic/itc')
 const { Unpromise } = require('@watchable/unpromise')
 
 const errors = require('../errors')
-const { kITC, kId } = require('./symbols')
+const { kITC, kId, kServiceId, kWorkerId } = require('./symbols')
 
 async function safeHandleInITC (worker, fn) {
   try {
@@ -23,7 +23,11 @@ async function safeHandleInITC (worker, fn) {
     ])
 
     if (typeof exitCode === 'number') {
-      throw new errors.ServiceExitedError(worker[kId], exitCode)
+      if (typeof worker[kWorkerId] !== 'undefined') {
+        throw new errors.WorkerExitedError(worker[kWorkerId], worker[kServiceId], exitCode)
+      } else {
+        throw new errors.ServiceExitedError(worker[kId], exitCode)
+      }
     } else {
       ac.abort()
     }
@@ -156,6 +160,7 @@ function setupITC (app, service, dispatcher) {
     itc.notify('changed')
   })
 
+  itc.listen()
   return itc
 }
 

package/lib/worker/main.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const { createRequire } = require('node:module')
+const { hostname } = require('node:os')
 const { join } = require('node:path')
 const { parentPort, workerData, threadId } = require('node:worker_threads')
 const { pathToFileURL } = require('node:url')
@@ -9,11 +10,9 @@ const diagnosticChannel = require('node:diagnostics_channel')
 const { ServerResponse } = require('node:http')
 
 const pino = require('pino')
-const { fetch, setGlobalDispatcher, getGlobalDispatcher, Agent } = require('undici')
+const { fetch, setGlobalDispatcher, Agent } = require('undici')
 const { wire } = require('undici-thread-interceptor')
-const undici = require('undici')
 
-const RemoteCacheStore = require('./http-cache')
 const { PlatformaticApp } = require('./app')
 const { setupITC } = require('./itc')
 const loadInterceptors = require('./interceptors')
@@ -32,14 +31,17 @@ globalThis.fetch = fetch
 globalThis[kId] = threadId
 
 let app
+
 const config = workerData.config
 globalThis.platformatic = Object.assign(globalThis.platformatic ?? {}, { logger: createLogger() })
 
 function handleUnhandled (type, err) {
-  globalThis.platformatic.logger.error(
-    { err: ensureLoggableError(err) },
-    `Service ${workerData.serviceConfig.id} threw an ${type}.`
-  )
+  const label =
+    workerData.worker.count > 1
+      ? `worker ${workerData.worker.index} of the service "${workerData.serviceConfig.id}"`
+      : `service "${workerData.serviceConfig.id}"`
+
+  globalThis.platformatic.logger.error({ err: ensureLoggableError(err) }, `The ${label} threw an ${type}.`)
 
   executeWithTimeout(app?.stop(), 1000)
     .catch()
@@ -50,7 +52,13 @@ function handleUnhandled (type, err) {
 
 function createLogger () {
   const destination = new MessagePortWritable({ port: workerData.loggingPort })
-  const loggerInstance = pino({ level: 'trace', name: workerData.serviceConfig.id }, destination)
+  const pinoOptions = { level: 'trace', name: workerData.serviceConfig.id }
+
+  if (typeof workerData.worker?.index !== 'undefined') {
+    pinoOptions.base = { pid: process.pid, hostname: hostname(), worker: workerData.worker.index }
+  }
+
+  const loggerInstance = pino(pinoOptions, destination)
 
   Reflect.defineProperty(process, 'stdout', { value: createPinoWritable(loggerInstance, 'info') })
   Reflect.defineProperty(process, 'stderr', { value: createPinoWritable(loggerInstance, 'error') })
@@ -82,34 +90,10 @@ async function main () {
     }
   }
 
-  const dispatcherOpts = { ...config.undici }
-
-  if (Object.keys(interceptors).length > 0) {
-    const clientInterceptors = []
-    const poolInterceptors = []
-
-    if (interceptors.Agent) {
-      clientInterceptors.push(...interceptors.Agent)
-      poolInterceptors.push(...interceptors.Agent)
-    }
-
-    if (interceptors.Pool) {
-      poolInterceptors.push(...interceptors.Pool)
-    }
-
-    if (interceptors.Client) {
-      clientInterceptors.push(...interceptors.Client)
-    }
-
-    dispatcherOpts.factory = (origin, opts) => {
-      return opts && opts.connections === 1
-        ? new undici.Client(origin, opts).compose(clientInterceptors)
-        : new undici.Pool(origin, opts).compose(poolInterceptors)
-    }
-  }
-
-  const globalDispatcher = new Agent(dispatcherOpts)
-    .compose(composedInterceptors)
+  const globalDispatcher = new Agent({
+    ...config.undici,
+    interceptors
+  }).compose(composedInterceptors)
 
   setGlobalDispatcher(globalDispatcher)
 
@@ -118,15 +102,6 @@ async function main () {
   // TODO: make this configurable
   const threadDispatcher = wire({ port: parentPort, useNetwork: service.useHttp, timeout: 5 * 60 * 1000 })
 
-  if (config.httpCache) {
-    setGlobalDispatcher(
-      getGlobalDispatcher().compose(undici.interceptors.cache({
-        store: new RemoteCacheStore(),
-        methods: config.httpCache.methods ?? ['GET', 'HEAD']
-      }))
-    )
-  }
-
   // If the service is an entrypoint and runtime server config is defined, use it.
   let serverConfig = null
   if (config.server && service.entrypoint) {
@@ -168,6 +143,7 @@ async function main () {
   // Create the application
   app = new PlatformaticApp(
     service,
+    workerData.worker.count > 1 ? workerData.worker.index : undefined,
     telemetryConfig,
     config.logger,
     serverConfig,
@@ -187,13 +163,11 @@ async function main () {
 
   // Setup interaction with parent port
   const itc = setupITC(app, service, threadDispatcher)
+  globalThis[kITC] = itc
 
   // Get the dependencies
   const dependencies = config.autoload ? await app.getBootstrapDependencies() : []
   itc.notify('init', { dependencies })
-  itc.listen()
-
-  globalThis[kITC] = itc
 }
 
 function stripBasePath (basePath) {

package/lib/worker/round-robin-map.js

@@ -0,0 +1,61 @@
+'use strict'
+
+class RoundRobinMap extends Map {
+  #instances
+
+  constructor (iterable, instances) {
+    super(iterable)
+    this.#instances = instances
+  }
+
+  get configuration () {
+    return { ...this.#instances }
+  }
+
+  // In development or for the entrypoint always use 1 worker
+  configure (services, defaultInstances, production) {
+    this.#instances = {}
+
+    for (const service of services) {
+      let count = service.workers ?? defaultInstances
+
+      if (service.entrypoint || !production) {
+        count = 1
+      }
+
+      this.#instances[service.id] = { next: 0, count }
+    }
+  }
+
+  getCount (service) {
+    return this.#instances[service].count
+  }
+
+  next (service) {
+    if (!this.#instances[service]) {
+      return undefined
+    }
+
+    let worker
+    let { next, count } = this.#instances[service]
+
+    // Try count times to get the next worker. This is to handle the case where a worker is being restarted.
+    for (let i = 0; i < count; i++) {
+      const current = next++
+      if (next >= count) {
+        next = 0
+      }
+
+      worker = this.get(`${service}:${current}`)
+
+      if (worker) {
+        break
+      }
+    }
+
+    this.#instances[service].next = next
+    return worker
+  }
+}
+
+module.exports = { RoundRobinMap }

package/lib/worker/symbols.js

@@ -2,6 +2,11 @@
 
 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 kServiceId = Symbol.for('plt.runtime.service.id')
+const kWorkerId = Symbol.for('plt.runtime.worker.id')
 const kITC = Symbol.for('plt.runtime.itc')
+const kLoggerDestination = Symbol.for('plt.runtime.loggerDestination')
+const kLoggingPort = Symbol.for('plt.runtime.logginPort')
+const kWorkerStatus = Symbol('plt.runtime.worker.status')
 
-module.exports = { kConfig, kId, kITC }
+module.exports = { kConfig, kId, kServiceId, kWorkerId, kITC, kLoggerDestination, kLoggingPort, kWorkerStatus }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.7.1-alpha.2",
+  "version": "2.8.0-alpha.2",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -35,19 +35,18 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/db": "2.7.1-alpha.2",
-    "@platformatic/composer": "2.7.1-alpha.2",
-    "@platformatic/service": "2.7.1-alpha.2",
-    "@platformatic/node": "2.7.1-alpha.2",
-    "@platformatic/sql-graphql": "2.7.1-alpha.2",
-    "@platformatic/sql-mapper": "2.7.1-alpha.2"
+    "@platformatic/composer": "2.8.0-alpha.2",
+    "@platformatic/db": "2.8.0-alpha.2",
+    "@platformatic/service": "2.8.0-alpha.2",
+    "@platformatic/node": "2.8.0-alpha.2",
+    "@platformatic/sql-mapper": "2.8.0-alpha.2",
+    "@platformatic/sql-graphql": "2.8.0-alpha.2"
   },
   "dependencies": {
     "@fastify/error": "^4.0.0",
     "@fastify/websocket": "^11.0.0",
     "@hapi/topo": "^6.0.2",
     "@platformatic/http-metrics": "^0.2.1",
-    "@platformatic/undici-cache-memory": "^0.3.0",
     "@watchable/unpromise": "^1.0.2",
     "boring-name-generator": "^1.0.3",
     "change-case-all": "^2.1.0",
@@ -69,20 +68,26 @@
     "semgrator": "^0.3.0",
     "tail-file-stream": "^0.2.0",
     "thread-cpu-usage": "^0.2.0",
-    "undici": "7.0.0-alpha.3",
+    "undici": "^6.9.0",
     "undici-thread-interceptor": "^0.7.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.7.1-alpha.2",
-    "@platformatic/config": "2.7.1-alpha.2",
-    "@platformatic/itc": "2.7.1-alpha.2",
-    "@platformatic/ts-compiler": "2.7.1-alpha.2",
-    "@platformatic/telemetry": "2.7.1-alpha.2",
-    "@platformatic/generators": "2.7.1-alpha.2",
-    "@platformatic/utils": "2.7.1-alpha.2"
+    "@platformatic/config": "2.8.0-alpha.2",
+    "@platformatic/generators": "2.8.0-alpha.2",
+    "@platformatic/basic": "2.8.0-alpha.2",
+    "@platformatic/itc": "2.8.0-alpha.2",
+    "@platformatic/telemetry": "2.8.0-alpha.2",
+    "@platformatic/ts-compiler": "2.8.0-alpha.2",
+    "@platformatic/utils": "2.8.0-alpha.2"
   },
   "scripts": {
-    "test": "npm run lint && borp --concurrency=1 --timeout=180000 && tsd",
-    "coverage": "npm run lint && borp -X fixtures -X test -C --concurrency=1 --timeout=180000 && tsd",
+    "test": "npm run lint && borp --concurrency=1 --timeout=300000 && tsd",
+    "test:main": "borp --concurrency=1 --timeout=300000 test/*.test.js test/versions/*.test.js",
+    "test:api": "borp --concurrency=1 --timeout=300000 test/api/*.test.js test/management-api/*.test.js",
+    "test:cli": "borp --concurrency=1 --timeout=300000 test/cli/*.test.js test/cli/**/*.test.js",
+    "test:start": "borp --concurrency=1 --timeout=300000 test/start/*.test.js",
+    "test:multiple-workers": "borp --concurrency=1 --timeout=300000 test/multiple-workers/*.test.js",
+    "test:types": "tsd",
+    "coverage": "npm run lint && borp -X fixtures -X test -C --concurrency=1 --timeout=300000 && tsd",
     "gen-schema": "node lib/schema.js > schema.json",
     "gen-types": "json2ts > config.d.ts < schema.json",
     "build": "pnpm run gen-schema && pnpm run gen-types",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.7.1-alpha.2.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.8.0-alpha.2.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
@@ -91,10 +91,33 @@
           },
           "useHttp": {
             "type": "boolean"
+          },
+          "workers": {
+            "anyOf": [
+              {
+                "type": "number",
+                "minimum": 1
+              },
+              {
+                "type": "string"
+              }
+            ]
           }
         }
       }
     },
+    "workers": {
+      "anyOf": [
+        {
+          "type": "number",
+          "minimum": 1
+        },
+        {
+          "type": "string"
+        }
+      ],
+      "default": 1
+    },
     "web": {
       "type": "array",
       "items": {
@@ -129,6 +152,17 @@
           },
           "useHttp": {
             "type": "boolean"
+          },
+          "workers": {
+            "anyOf": [
+              {
+                "type": "number",
+                "minimum": 1
+              },
+              {
+                "type": "string"
+              }
+            ]
           }
         }
       }
@@ -340,6 +374,41 @@
         }
       ]
     },
+    "gracefulShutdown": {
+      "type": "object",
+      "properties": {
+        "runtime": {
+          "anyOf": [
+            {
+              "type": "number",
+              "minimum": 1
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "default": 10000
+        },
+        "service": {
+          "anyOf": [
+            {
+              "type": "number",
+              "minimum": 1
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "default": 10000
+        }
+      },
+      "default": {},
+      "required": [
+        "runtime",
+        "service"
+      ],
+      "additionalProperties": false
+    },
     "undici": {
       "type": "object",
       "properties": {
@@ -382,35 +451,6 @@
         }
       }
     },
-    "httpCache": {
-      "oneOf": [
-        {
-          "type": "boolean"
-        },
-        {
-          "type": "object",
-          "properties": {
-            "store": {
-              "type": "string"
-            },
-            "methods": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              },
-              "default": [
-                "GET",
-                "HEAD"
-              ],
-              "minItems": 1
-            },
-            "cacheTagsHeader": {
-              "type": "string"
-            }
-          }
-        }
-      ]
-    },
     "watch": {
       "anyOf": [
         {

package/lib/shared-http-cache.js

@@ -1,45 +0,0 @@
-'use strict'
-
-const { join } = require('node:path')
-const { createRequire } = require('node:module')
-const MemoryCacheStore = require('@platformatic/undici-cache-memory')
-
-function createSharedStore (projectDir, httpCacheConfig = {}) {
-  const runtimeRequire = createRequire(join(projectDir, 'file'))
-
-  const { store, ...storeConfig } = httpCacheConfig
-  const CacheStore = store ? runtimeRequire(store) : MemoryCacheStore
-
-  class SharedCacheStore extends CacheStore {
-    async getValue (req) {
-      const readStream = await this.createReadStream(req)
-      if (!readStream) return null
-
-      let payload = ''
-      for await (const chunk of readStream) {
-        payload += chunk
-      }
-
-      const response = this.#sanitizeResponse(readStream.value)
-      return { response, payload }
-    }
-
-    setValue (req, opts, data) {
-      const writeStream = this.createWriteStream(req, opts)
-      writeStream.write(data)
-      writeStream.end()
-      return null
-    }
-
-    #sanitizeResponse (response) {
-      return {
-        ...response,
-        rawHeaders: response.rawHeaders.map(header => header.toString())
-      }
-    }
-  }
-
-  return new SharedCacheStore(storeConfig)
-}
-
-module.exports = { createSharedStore }