@platformatic/runtime 2.67.0-alpha.2 → 2.67.0

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime2670Alpha2Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime2670Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;

package/lib/errors.js

@@ -38,6 +38,7 @@ module.exports = {
   FailedToUnlinkManagementApiSocket: createError(`${ERROR_PREFIX}_FAILED_TO_UNLINK_MANAGEMENT_API_SOCKET`, 'Failed to unlink management API socket "%s"'),
   LogFileNotFound: createError(`${ERROR_PREFIX}_LOG_FILE_NOT_FOUND`, 'Log file with index %s not found', 404),
   WorkerIsRequired: createError(`${ERROR_PREFIX}_REQUIRED_WORKER`, 'The worker parameter is required'),
+  InvalidArgumentError: createError(`${ERROR_PREFIX}_INVALID_ARGUMENT`, 'Invalid argument: "%s"'),
 
   // TODO: should remove next one as it's not used anymore
   CannotRemoveServiceOnUpdateError: createError(`${ERROR_PREFIX}_CANNOT_REMOVE_SERVICE_ON_UPDATE`, 'Cannot remove service "%s" when updating a Runtime'),

package/lib/generator/runtime-generator.js

@@ -150,6 +150,9 @@ class RuntimeGenerator extends BaseGenerator {
       this.config.port = configManager.env.PORT
       this.entryPoint = configManager.current.services.find(svc => svc.entrypoint)
       this.existingServices = configManager.current.services.map(s => s.id)
+
+      this.updateRuntimeConfig(this.existingConfigRaw)
+      this.updateRuntimeEnv(await readFile(join(this.targetDirectory, '.env'), 'utf-8'))
     }
   }
 
@@ -204,11 +207,7 @@ class RuntimeGenerator extends BaseGenerator {
       ...servicesEnv
     })
 
-    this.addFile({
-      path: '',
-      file: '.env',
-      contents: envObjectToString(this.config.env)
-    })
+    this.updateRuntimeEnv(envObjectToString(this.config.env))
 
     this.addFile({
       path: '',
@@ -227,12 +226,21 @@ class RuntimeGenerator extends BaseGenerator {
   }
 
   async writeFiles () {
+    for (const { service } of this.services) {
+      await service._beforeWriteFiles?.(this)
+    }
+
     await super.writeFiles()
+
     if (!this.config.isUpdating) {
       for (const { service } of this.services) {
         await service.writeFiles()
       }
     }
+
+    for (const { service } of this.services) {
+      await service._afterWriteFiles?.(this)
+    }
   }
 
   async prepareQuestions () {
@@ -275,6 +283,7 @@ class RuntimeGenerator extends BaseGenerator {
       } else {
         basePath = join(this.targetDirectory, this.config.autoload || this.servicesFolder)
       }
+      this.servicesBasePath = basePath
       service.setTargetDirectory(join(basePath, service.config.serviceName))
     })
   }
@@ -496,16 +505,59 @@ class RuntimeGenerator extends BaseGenerator {
 
       this.setEntryPoint(newEntrypoint)
       runtimePkgConfigFileData.entrypoint = newEntrypoint
-      this.addFile({
-        path: '',
-        file: this.runtimeConfig,
-        contents: JSON.stringify(runtimePkgConfigFileData, null, 2)
-      })
+      this.updateRuntimeConfig(runtimePkgConfigFileData)
     }
     await this.writeFiles()
     // save new env
     await envTool.save()
   }
+
+  async generateConfigFile () {
+    this.updateRuntimeConfig(await super.generateConfigFile())
+  }
+
+  async generateEnv () {
+    const serialized = await super.generateEnv()
+
+    if (serialized) {
+      this.updateRuntimeEnv(serialized)
+    }
+  }
+
+  getRuntimeConfigFileObject () {
+    return this.files.find(file => file.tags?.includes('runtime-config')) ?? null
+  }
+
+  getRuntimeEnvFileObject () {
+    return this.files.find(file => file.tags?.includes('runtime-env')) ?? null
+  }
+
+  updateRuntimeConfig (config) {
+    this.addFile({
+      path: '',
+      file: this.runtimeConfig,
+      contents: JSON.stringify(config, null, 2),
+      tags: ['runtime-config']
+    })
+  }
+
+  updateRuntimeEnv (contents) {
+    this.addFile({
+      path: '',
+      file: '.env',
+      contents,
+      tags: ['runtime-env']
+    })
+  }
+
+  updateConfigEntryPoint (entrypoint) {
+    // This can return null if the generator was not supposed to modify the config
+    const configObject = this.getRuntimeConfigFileObject()
+    const config = JSON.parse(configObject.contents)
+    config.entrypoint = entrypoint
+
+    this.updateRuntimeConfig(config)
+  }
 }
 
 class WrappedGenerator extends BaseGenerator {

package/lib/runtime.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const { ITC } = require('@platformatic/itc')
-const { ensureLoggableError, executeWithTimeout, deepmerge } = require('@platformatic/utils')
+const { features, ensureLoggableError, executeWithTimeout, deepmerge } = require('@platformatic/utils')
 const { once, EventEmitter } = require('node:events')
 const { createReadStream, watch, existsSync } = require('node:fs')
 const { readdir, readFile, stat, access } = require('node:fs/promises')
@@ -50,6 +50,7 @@ const COLLECT_METRICS_TIMEOUT = 1000
 
 const MAX_BOOTSTRAP_ATTEMPTS = 5
 const IMMEDIATE_RESTART_MAX_THRESHOLD = 10
+const MAX_WORKERS = 100
 
 const telemetryPath = require.resolve('@platformatic/telemetry')
 const openTelemetrySetupPath = join(telemetryPath, '..', 'lib', 'node-telemetry.js')
@@ -129,7 +130,19 @@ class Runtime extends EventEmitter {
 
     this.#isProduction = this.#configManager.args?.production ?? false
     this.#servicesIds = config.services.map(service => service.id)
-    this.#workers.configure(config.services, this.#configManager.current.workers, this.#isProduction)
+
+    const workersConfig = []
+    for (const service of config.services) {
+      const count = service.workers ?? this.#configManager.current.workers
+      if (count > 1 && service.entrypoint && !features.node.reusePort) {
+        this.logger.warn(`"${service.id}" is set as the entrypoint, but reusePort is not available in your OS; setting workers to 1 instead of ${count}`)
+        workersConfig.push({ id: service.id, workers: 1 })
+      } else {
+        workersConfig.push({ id: service.id, workers: count })
+      }
+    }
+
+    this.#workers.configure(workersConfig)
 
     if (this.#isProduction) {
       this.#env['PLT_DEV'] = 'false'
@@ -1303,7 +1316,7 @@ class Runtime extends EventEmitter {
     }
 
     // This must be done here as the dependencies are filled above
-    worker[kConfig] = { ...serviceConfig, health }
+    worker[kConfig] = { ...serviceConfig, health, workers: workersCount }
     worker[kWorkerStatus] = 'init'
     this.emit('service:worker:init', eventPayload)
 
@@ -1833,6 +1846,86 @@ class Runtime extends EventEmitter {
       await immediate()
     }
   }
+
+  async getServiceResourcesInfo (id) {
+    const workers = this.#workers.getCount(id)
+    return { workers }
+  }
+
+  async #updateWorkerCount (serviceId, workers) {
+    this.#configManager.current.services.find(s => s.id === serviceId).workers = workers
+    const service = await this.#getServiceById(serviceId)
+    this.#workers.setCount(serviceId, workers)
+    service[kConfig].workers = workers
+
+    const promises = []
+    for (const [workerId, worker] of this.#workers.entries()) {
+      if (workerId.startsWith(`${serviceId}:`)) {
+        promises.push(sendViaITC(worker, 'updateWorkersCount', { serviceId, workers }))
+      }
+    }
+
+    const results = await Promise.allSettled(promises)
+    for (const result of results) {
+      if (result.status === 'rejected') {
+        throw result.reason
+      }
+    }
+  }
+
+  async updateServicesResources (updates) {
+    if (this.#status === 'stopping' || this.#status === 'closed') return
+
+    if (!Array.isArray(updates)) {
+      throw new errors.InvalidArgumentError('updates', 'must be an array')
+    }
+    if (updates.length === 0) {
+      throw new errors.InvalidArgumentError('updates', 'must have at least one element')
+    }
+
+    const config = this.#configManager.current
+
+    for (const update of updates) {
+      const { service: serviceId, workers } = update
+
+      if (typeof workers !== 'number') {
+        throw new errors.InvalidArgumentError('workers', 'must be a number')
+      }
+      if (!serviceId) {
+        throw new errors.InvalidArgumentError('service', 'must be a string')
+      }
+      if (workers <= 0) {
+        throw new errors.InvalidArgumentError('workers', 'must be greater than 0')
+      }
+      if (workers > MAX_WORKERS) {
+        throw new errors.InvalidArgumentError('workers', `must be less than ${MAX_WORKERS}`)
+      }
+      const serviceConfig = config.services.find(s => s.id === serviceId)
+      if (!serviceConfig) {
+        throw new errors.ServiceNotFoundError(serviceId, Array.from(this.#servicesIds).join(', '))
+      }
+
+      const { workers: currentWorkers } = await this.getServiceResourcesInfo(serviceId)
+      if (currentWorkers === workers) {
+        this.logger.warn({ serviceId, workers }, 'No change in the number of workers for service')
+        continue
+      }
+
+      if (currentWorkers < workers) {
+        await this.#updateWorkerCount(serviceId, workers)
+        for (let i = currentWorkers; i < workers; i++) {
+          await this.#setupWorker(config, serviceConfig, workers, serviceId, i)
+          await this.#startWorker(config, serviceConfig, workers, serviceId, i, false, 0)
+        }
+      } else {
+        for (let i = currentWorkers - 1; i >= workers; i--) {
+          // keep the current workers count until the workers are stopped
+          await this.#stopWorker(currentWorkers, serviceId, i, false)
+        }
+        await this.#updateWorkerCount(serviceId, workers)
+      }
+    }
+  }
 }
 
 module.exports = { Runtime }

package/lib/worker/itc.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const { once } = require('node:events')
-const { parentPort } = require('node:worker_threads')
+const { parentPort, workerData } = require('node:worker_threads')
 
 const { ITC } = require('@platformatic/itc')
 const { Unpromise } = require('@watchable/unpromise')
@@ -114,6 +114,14 @@ function setupITC (app, service, dispatcher) {
         await updateUndiciInterceptors(undiciConfig)
       },
 
+      async updateWorkersCount (data) {
+        const { serviceId, workers } = data
+        const w = workerData.config.serviceMap.get(serviceId)
+        if (w) { w.workers = workers }
+        workerData.serviceConfig.workers = workers
+        workerData.worker.count = workers
+      },
+
       getStatus () {
         return app.getStatus()
       },

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

@@ -1,7 +1,5 @@
 'use strict'
 
-const { features } = require('@platformatic/utils')
-
 class RoundRobinMap extends Map {
   #instances
 
@@ -14,18 +12,11 @@ class RoundRobinMap extends Map {
     return { ...this.#instances }
   }
 
-  // In development or for the entrypoint always use 1 worker
-  configure (services, defaultInstances, production) {
+  configure (services) {
     this.#instances = {}
 
     for (const service of services) {
-      let count = service.workers ?? defaultInstances
-
-      if (!production || (service.entrypoint && !features.node.reusePort)) {
-        count = 1
-      }
-
-      this.#instances[service.id] = { next: 0, count }
+      this.#instances[service.id] = { next: 0, count: service.workers }
     }
   }
 
@@ -33,6 +24,10 @@ class RoundRobinMap extends Map {
     return this.#instances[service].count
   }
 
+  setCount (service, count) {
+    this.#instances[service].count = count
+  }
+
   next (service) {
     if (!this.#instances[service]) {
       return undefined

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.67.0-alpha.2",
+  "version": "2.67.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -37,12 +37,12 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/db": "2.67.0-alpha.2",
-    "@platformatic/node": "2.67.0-alpha.2",
-    "@platformatic/service": "2.67.0-alpha.2",
-    "@platformatic/sql-graphql": "2.67.0-alpha.2",
-    "@platformatic/composer": "2.67.0-alpha.2",
-    "@platformatic/sql-mapper": "2.67.0-alpha.2"
+    "@platformatic/composer": "2.67.0",
+    "@platformatic/db": "2.67.0",
+    "@platformatic/node": "2.67.0",
+    "@platformatic/service": "2.67.0",
+    "@platformatic/sql-mapper": "2.67.0",
+    "@platformatic/sql-graphql": "2.67.0"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -77,21 +77,21 @@
     "undici": "^7.0.0",
     "undici-thread-interceptor": "^0.13.1",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.67.0-alpha.2",
-    "@platformatic/config": "2.67.0-alpha.2",
-    "@platformatic/generators": "2.67.0-alpha.2",
-    "@platformatic/itc": "2.67.0-alpha.2",
-    "@platformatic/telemetry": "2.67.0-alpha.2",
-    "@platformatic/ts-compiler": "2.67.0-alpha.2",
-    "@platformatic/utils": "2.67.0-alpha.2"
+    "@platformatic/basic": "2.67.0",
+    "@platformatic/config": "2.67.0",
+    "@platformatic/generators": "2.67.0",
+    "@platformatic/itc": "2.67.0",
+    "@platformatic/telemetry": "2.67.0",
+    "@platformatic/ts-compiler": "2.67.0",
+    "@platformatic/utils": "2.67.0"
   },
   "scripts": {
-    "test": "pnpm run lint && borp --concurrency=1 --timeout=300000 && tsd",
+    "test": "pnpm run lint && borp --concurrency=1 --timeout=600000 && tsd",
     "test:main": "borp --concurrency=1 --timeout=300000 test/*.test.js test/*.test.mjs test/versions/*.test.js test/versions/*.test.mjs",
     "test:api": "borp --concurrency=1 --timeout=300000 test/api/*.test.js test/api/*.test.mjs test/management-api/*.test.js test/management-api/*.test.mjs",
     "test:cli": "borp --concurrency=1 --timeout=300000 test/cli/*.test.js test/cli/*.test.mjs test/cli/**/*.test.js test/cli/**/*.test.mjs",
     "test:start": "borp --concurrency=1 --timeout=300000 test/start/*.test.js test/start/*.test.mjs",
-    "test:multiple-workers": "borp --concurrency=1 --timeout=300000 test/multiple-workers/*.test.js test/multiple-workers/*.test.mjs",
+    "test:multiple-workers": "borp --concurrency=1 --timeout=600000 test/multiple-workers/*.test.js test/multiple-workers/*.test.mjs",
     "test:types": "tsd",
     "coverage": "pnpm run lint && borp -X fixtures -X test -C --concurrency=1 --timeout=300000 && tsd",
     "gen-schema": "node lib/schema.js > schema.json",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.67.0-alpha.2.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.67.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {