@platformatic/runtime 3.67.0 → 3.69.0

package/config.d.ts

@@ -45,6 +45,7 @@ export type PlatformaticRuntimeConfig = {
             };
         config?: string;
         useHttp?: boolean;
+        websocket?: boolean;
         reuseTcpPorts?: boolean;
         workers?:
           | number

package/index.d.ts

@@ -250,6 +250,7 @@ export declare class ManagementClient {
   getApplicationOpenapiSchema (id: string): Promise<unknown>
   getApplicationGraphqlSchema (id: string): Promise<unknown>
   getMetrics (format?: string): Promise<{ metrics: unknown }>
+  getScheduler (): Promise<SchedulerJob[]>
   getSchedulerJobs (): Promise<SchedulerJob[]>
   pauseSchedulerJob (name: string): Promise<SchedulerJob>
   resumeSchedulerJob (name: string): Promise<SchedulerJob>
@@ -462,6 +463,7 @@ export declare class Runtime extends EventEmitter {
   off (event: 'application:worker:health:metrics', listener: (event: HealthMetricsEvent) => void): this
   off (event: string | symbol, listener: (...args: any[]) => void): this
 
+  getScheduler (): SchedulerJob[]
   getSchedulerJobs (): SchedulerJob[]
   pauseSchedulerJob (name: string): Promise<SchedulerJob>
   resumeSchedulerJob (name: string): Promise<SchedulerJob>

package/lib/config.js

@@ -9,11 +9,13 @@ import {
   omitProperties,
   runtimeUnwrappablePropertiesList
 } from '@platformatic/foundation'
+import { realpathSync } from 'node:fs'
 import { readdir, readFile } from 'node:fs/promises'
 import { createRequire } from 'node:module'
 import { isAbsolute, join, resolve as resolvePath } from 'node:path'
 
 import {
+  ApplicationIdCollisionError,
   InspectAndInspectBrkError,
   InspectorHostError,
   InspectorPortError,
@@ -295,6 +297,40 @@ export async function prepareApplication (config, application, defaultWorkers) {
   return application
 }
 
+function canonicalPath (path) {
+  try {
+    return realpathSync(path)
+  } catch {
+    return resolvePath(path)
+  }
+}
+
+// An autoloaded directory and an explicitly configured entry with the same id are the same application
+// only when they point to the same place: either the configured path resolves to the autoloaded
+// directory, or the entry is external and the autoloaded directory is where "resolve" would put it.
+// When they don't, returns a description of the configured entry to report in the error.
+function conflictingApplicationSource (root, resolvedApplicationsPath, existing, entryPath) {
+  if (existing.path) {
+    // The path still contains a placeholder, which means the environment variable was not replaced.
+    // There is nothing to compare in that case.
+    if (existing.path.match(/^\{.*\}$/)) {
+      return null
+    }
+
+    const existingPath = isAbsolute(existing.path) ? existing.path : resolvePath(root, existing.path)
+
+    return canonicalPath(existingPath) === canonicalPath(entryPath) ? null : `the path "${existing.path}"`
+  }
+
+  if (existing.url) {
+    const resolvedPath = join(resolvedApplicationsPath, existing.id)
+
+    return canonicalPath(resolvedPath) === canonicalPath(entryPath) ? null : `the URL "${existing.url}"`
+  }
+
+  return null
+}
+
 function isApplicationEnabled (application, environment) {
   const { enabled } = application
 
@@ -378,7 +414,11 @@ export async function transform (config, _, context) {
     const { exclude = [], mappings = {} } = config.autoload
     let { path } = config.autoload
 
-    path = resolvePath(config[kMetadata].root, path)
+    // Capture these before the loop, as config is shadowed in its body
+    const root = config[kMetadata].root
+    const resolvedApplicationsPath = resolvePath(root, config.resolvedApplicationsBasePath ?? 'external')
+
+    path = resolvePath(root, path)
     const entries = await readdir(path, { withFileTypes: true })
 
     for (let i = 0; i < entries.length; ++i) {
@@ -403,7 +443,21 @@ export async function transform (config, _, context) {
       const existingApplicationId = applications.findIndex(application => application.id === id)
 
       if (existingApplicationId !== -1) {
-        applications[existingApplicationId] = { ...application, ...applications[existingApplicationId] }
+        const existing = applications[existingApplicationId]
+
+        // Merging on the id alone can boot local code where the configuration named a repository, as
+        // the autoloaded path survives next to the configured url. Reject the duplicate instead: an id
+        // is the mesh hostname, the injected PLT_<ID>_URL name, the metrics label and the argument of
+        // "wattpm inject", so two different applications cannot share one.
+        if (isApplicationEnabled(existing, environment)) {
+          const source = conflictingApplicationSource(root, resolvedApplicationsPath, existing, entryPath)
+
+          if (source) {
+            throw new ApplicationIdCollisionError(id, entryPath, source)
+          }
+        }
+
+        applications[existingApplicationId] = { ...application, ...existing }
       } else {
         applications.push(application)
       }

package/lib/errors.js

@@ -102,6 +102,10 @@ export const InvalidEntrypointError = createError(
   `${ERROR_PREFIX}_INVALID_ENTRYPOINT`,
   "Invalid entrypoint: '%s' does not exist"
 )
+export const ApplicationIdCollisionError = createError(
+  `${ERROR_PREFIX}_APPLICATION_ID_COLLISION`,
+  'The application id "%s" is used by the autoloaded directory "%s" and by a different application defined in the configuration file via %s. Application ids must be unique.'
+)
 export const MissingEntrypointError = createError(
   `${ERROR_PREFIX}_MISSING_ENTRYPOINT`,
   'Missing application entrypoint.'

package/lib/runtime.js

@@ -2192,6 +2192,10 @@ export class Runtime extends EventEmitter {
     return this.#scheduler?.getJobs() ?? []
   }
 
+  getScheduler () {
+    return this.getSchedulerJobs()
+  }
+
   pauseSchedulerJob (name) {
     return this.#schedulerOrThrow().pauseJob(name)
   }
@@ -2861,7 +2865,21 @@ export class Runtime extends EventEmitter {
     // 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)
+    //
+    // It is stored, not awaited: #startWorker awaits it later, and only if the
+    // worker is actually started. A worker that is discarded or torn down
+    // before that — a replacement abandoned because the runtime stopped
+    // mid-restart, for instance — leaves the promise with nobody to observe
+    // it. Closing the mesh interceptor rejects any routing still in flight
+    // ('The dispatcher has been closed.'), so that is a routine shutdown
+    // outcome, not an exotic one, and it surfaced as an unhandledRejection
+    // that could take the process down before graceful shutdown finished.
+    //
+    // Attaching a no-op handler marks the rejection observed WITHOUT
+    // swallowing it: the await in #startWorker still sees and reports it.
+    const interceptorReady = this.#meshInterceptor.route(applicationId, worker)
+    interceptorReady.catch(() => {})
+    worker[kInterceptorReadyPromise] = interceptorReady
 
     // Wait for initialization
     try {

package/lib/worker/controller.js

@@ -1,4 +1,5 @@
 import {
+  convertApplicationNameToPrefix,
   ensureLoggableError,
   FileWatcher,
   kHandledError,
@@ -28,12 +29,27 @@ import { ApplicationAlreadyStartedError, exitCodes, RuntimeNotStartedError } fro
 import { getApplicationUrl } from '../utils.js'
 import { markAsPlatformaticDispatcher, refreshGlobalDispatcher } from './interceptors.js'
 
-function fetchApplicationUrl (application, key) {
-  if (!key.endsWith('_URL') || !application.id) {
-    return null
+/**
+ * Resolves {PLT_<APPLICATION>_URL} placeholders that no environment variable defines, so that
+ * applications can reference each other without the user having to set a variable per pair.
+ *
+ * The mapping is built forwards, from the ids of the applications that actually exist in the runtime
+ * to the variable name each of them owns. Parsing the variable name instead would be ambiguous, both
+ * because the id to prefix conversion is not reversible ("with-logger" and "with_logger" share a
+ * prefix) and because plenty of _URL variables do not name an application at all: a connection string
+ * fragment like {VALKEY_URL} or a DSN like {PLT_DATABASE_URL} must keep resolving to nothing rather
+ * than silently becoming an HTTP URL.
+ */
+function buildApplicationUrlResolver (applications) {
+  const urls = new Map()
+
+  for (const { id } of applications ?? []) {
+    if (id) {
+      urls.set(`PLT_${convertApplicationNameToPrefix(id)}_URL`, getApplicationUrl(id))
+    }
   }
 
-  return getApplicationUrl(application.id)
+  return key => urls.get(key) ?? null
 }
 
 function handleUnhandled (app, event, listeners, timeout, err, ...args) {
@@ -78,6 +94,8 @@ export class Controller extends EventEmitter {
     this.capability = null
     this.#fileWatcher = null
 
+    const onMissingEnv = buildApplicationUrlResolver(runtimeConfig.applications)
+
     this.#context = {
       controller: this,
       runtimeConfig: this.runtimeConfig,
@@ -95,7 +113,10 @@ export class Controller extends EventEmitter {
       worker: workerData?.worker,
       resourceLimits: workerData?.resourceLimits,
       hasManagementApi: !!runtimeConfig.managementApi,
-      fetchApplicationUrl: fetchApplicationUrl.bind(null, applicationConfig),
+      fetchApplicationUrl: onMissingEnv,
+      // Capabilities spread the whole context into their loadConfiguration call, which is what makes
+      // the configuration they load resolve application references like the throwaway load below.
+      onMissingEnv,
       strictEnv: runtimeConfig.strictEnv
     }
   }
@@ -140,10 +161,15 @@ export class Controller extends EventEmitter {
       }
 
       if (appConfig.config) {
-        // Parse the configuration file the first time to obtain the schema
+        // Parse the configuration file the first time to obtain the schema. This load is thrown away:
+        // the capability loads the configuration again below and that is the configuration the
+        // application actually runs on. This one only has to yield $schema and module, so it must not
+        // diverge from the second load in any way the user can observe: it resolves environment
+        // variables identically, and leaves the strictEnv report to the load the application is
+        // built from, which would otherwise be duplicated for every application.
         const unvalidatedConfig = await loadConfiguration(appConfig.config, null, {
-          onMissingEnv: this.#context.fetchApplicationUrl,
-          strictEnv: this.#context.strictEnv
+          onMissingEnv: this.#context.onMissingEnv,
+          strictEnv: false
         })
         const pkg = await loadConfigurationModule(appConfig.path, unvalidatedConfig)
         this.capability = await pkg.create(appConfig.path, appConfig.config, this.#context)
@@ -215,7 +241,7 @@ export class Controller extends EventEmitter {
       }
     }
 
-    const listen = !!this.applicationConfig.useHttp
+    const listen = !!(this.applicationConfig.useHttp || this.applicationConfig.websocket)
 
     try {
       await this.capability.start({ listen })
@@ -264,7 +290,12 @@ export class Controller extends EventEmitter {
 
   async listen () {
     // This server is not an entrypoint or already listened in start. Behave as no-op.
-    if (!this.applicationConfig.entrypoint || this.applicationConfig.useHttp || this.#listening) {
+    if (
+      !this.applicationConfig.entrypoint ||
+      this.applicationConfig.useHttp ||
+      this.applicationConfig.websocket ||
+      this.#listening
+    ) {
       return
     }
 

package/lib/worker/main.js

@@ -274,7 +274,7 @@ async function main () {
   let serverConfig = null
   if (runtimeConfig.server && applicationConfig.entrypoint) {
     serverConfig = runtimeConfig.server
-  } else if (applicationConfig.useHttp) {
+  } else if (applicationConfig.useHttp || applicationConfig.websocket) {
     serverConfig = {
       port: 0,
       hostname: '127.0.0.1',

package/lib/worker/management.js

@@ -74,6 +74,10 @@ export class ManagementClient {
     return this.#send('getSchedulerJobs')
   }
 
+  getScheduler () {
+    return this.getSchedulerJobs()
+  }
+
   pauseSchedulerJob (name) {
     return this.#send('pauseSchedulerJob', { name })
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "3.67.0",
+  "version": "3.69.0",
   "description": "Platformatic runtime",
   "main": "index.js",
   "type": "module",
@@ -35,18 +35,18 @@
     "pino-abstract-transport": "^2.0.0",
     "pino-sentry-transport": "^1.6.0",
     "split2": "^4.2.0",
-    "tstyche": "^6.2.0",
+    "tstyche": "^7.0.0",
     "typescript": "~6.0.3",
     "undici-oidc-interceptor": "^0.9.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "3.67.0",
-    "@platformatic/db": "3.67.0",
-    "@platformatic/node": "3.67.0",
-    "@platformatic/service": "3.67.0",
-    "@platformatic/sql-graphql": "3.67.0",
-    "@platformatic/sql-mapper": "3.67.0",
-    "@platformatic/wattpm-pprof-capture": "3.67.0",
-    "@platformatic/gateway": "3.67.0"
+    "@platformatic/composer": "3.69.0",
+    "@platformatic/db": "3.69.0",
+    "@platformatic/gateway": "3.69.0",
+    "@platformatic/node": "3.69.0",
+    "@platformatic/service": "3.69.0",
+    "@platformatic/sql-graphql": "3.69.0",
+    "@platformatic/sql-mapper": "3.69.0",
+    "@platformatic/wattpm-pprof-capture": "3.69.0"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -77,13 +77,13 @@
     "undici": "^7.27.2",
     "undici-thread-interceptor": "^1.3.1",
     "ws": "^8.16.0",
-    "@platformatic/basic": "3.67.0",
-    "@platformatic/generators": "3.67.0",
-    "@platformatic/foundation": "3.67.0",
-    "@platformatic/itc": "3.67.0",
-    "@platformatic/globals": "3.67.0",
-    "@platformatic/telemetry": "3.67.0",
-    "@platformatic/metrics": "3.67.0"
+    "@platformatic/basic": "3.69.0",
+    "@platformatic/foundation": "3.69.0",
+    "@platformatic/globals": "3.69.0",
+    "@platformatic/metrics": "3.69.0",
+    "@platformatic/generators": "3.69.0",
+    "@platformatic/telemetry": "3.69.0",
+    "@platformatic/itc": "3.69.0"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.67.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.69.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Runtime Config",
   "type": "object",
@@ -142,6 +142,9 @@
               "useHttp": {
                 "type": "boolean"
               },
+              "websocket": {
+                "type": "boolean"
+              },
               "reuseTcpPorts": {
                 "type": "boolean",
                 "default": true
@@ -574,6 +577,9 @@
           "useHttp": {
             "type": "boolean"
           },
+          "websocket": {
+            "type": "boolean"
+          },
           "reuseTcpPorts": {
             "type": "boolean",
             "default": true
@@ -1004,6 +1010,9 @@
           "useHttp": {
             "type": "boolean"
           },
+          "websocket": {
+            "type": "boolean"
+          },
           "reuseTcpPorts": {
             "type": "boolean",
             "default": true
@@ -1434,6 +1443,9 @@
           "useHttp": {
             "type": "boolean"
           },
+          "websocket": {
+            "type": "boolean"
+          },
           "reuseTcpPorts": {
             "type": "boolean",
             "default": true