@platformatic/runtime 3.0.0-alpha.6 → 3.0.0-rc.1

package/lib/worker/itc.js

@@ -69,8 +69,8 @@ export async function waitEventFromITC (worker, event) {
   return safeHandleInITC(worker, () => once(worker[kITC], event))
 }
 
-export function setupITC (instance, application, dispatcher, sharedContext) {
-  const messaging = new MessagingITC(instance.appConfig.id, workerData.config)
+export function setupITC (controller, application, dispatcher, sharedContext) {
+  const messaging = new MessagingITC(controller.appConfig.id, workerData.config)
 
   Object.assign(globalThis.platformatic ?? {}, {
     messaging: {
@@ -80,55 +80,61 @@ export function setupITC (instance, application, dispatcher, sharedContext) {
   })
 
   const itc = new ITC({
-    name: instance.appConfig.id + '-worker',
+    name: controller.appConfig.id + '-worker',
     port: parentPort,
     handlers: {
       async start () {
-        const status = instance.getStatus()
+        const status = controller.getStatus()
 
         if (status === 'starting') {
-          await once(instance, 'start')
+          await once(controller, 'start')
         } else {
           // This gives a chance to a capability to perform custom logic
           globalThis.platformatic.events.emit('start')
 
           try {
-            await instance.start()
+            await controller.start()
           } catch (e) {
-            await instance.stop(true)
-            await closeITC(dispatcher, itc, messaging)
+            await controller.stop(true)
+
+            // Reply to the runtime that the start failed, so it can cleanup
+            once(itc, 'application:worker:start:processed').then(() => {
+              closeITC(dispatcher, itc, messaging).catch(() => {})
+            })
 
             throw ensureLoggableError(e)
           }
         }
 
         if (application.entrypoint) {
-          await instance.listen()
+          await controller.listen()
         }
 
-        dispatcher.replaceServer(await instance.capability.getDispatchTarget())
-        return application.entrypoint ? instance.capability.getUrl() : null
+        dispatcher.replaceServer(await controller.capability.getDispatchTarget())
+        return application.entrypoint ? controller.capability.getUrl() : null
       },
 
-      async stop () {
-        const status = instance.getStatus()
+      async stop ({ force, dependents }) {
+        const status = controller.getStatus()
 
-        if (status === 'starting') {
-          await once(instance, 'start')
+        if (!force && status === 'starting') {
+          await once(controller, 'start')
         }
 
-        if (status.startsWith('start')) {
+        if (force || status.startsWith('start')) {
           // This gives a chance to a capability to perform custom logic
           globalThis.platformatic.events.emit('stop')
 
-          await instance.stop()
+          await controller.stop(force, dependents)
         }
 
-        await closeITC(dispatcher, itc, messaging)
+        once(itc, 'application:worker:stop:processed').then(() => {
+          closeITC(dispatcher, itc, messaging).catch(() => {})
+        })
       },
 
       async build () {
-        return instance.capability.build()
+        return controller.capability.build()
       },
 
       async removeFromMesh () {
@@ -136,7 +142,7 @@ export function setupITC (instance, application, dispatcher, sharedContext) {
       },
 
       inject (injectParams) {
-        return instance.capability.inject(injectParams)
+        return controller.capability.inject(injectParams)
       },
 
       async updateUndiciInterceptors (undiciConfig) {
@@ -150,27 +156,27 @@ export function setupITC (instance, application, dispatcher, sharedContext) {
       },
 
       getStatus () {
-        return instance.getStatus()
+        return controller.getStatus()
       },
 
       getApplicationInfo () {
-        return instance.capability.getInfo()
+        return controller.capability.getInfo()
       },
 
       async getApplicationConfig () {
-        const current = await instance.capability.getConfig()
+        const current = await controller.capability.getConfig()
         // Remove all undefined keys from the config
         return JSON.parse(JSON.stringify(current))
       },
 
       async getApplicationEnv () {
         // Remove all undefined keys from the config
-        return JSON.parse(JSON.stringify({ ...process.env, ...(await instance.capability.getEnv()) }))
+        return JSON.parse(JSON.stringify({ ...process.env, ...(await controller.capability.getEnv()) }))
       },
 
       async getApplicationOpenAPISchema () {
         try {
-          return await instance.capability.getOpenapiSchema()
+          return await controller.capability.getOpenapiSchema()
         } catch (err) {
           throw new FailedToRetrieveOpenAPISchemaError(application.id, err.message)
         }
@@ -178,7 +184,7 @@ export function setupITC (instance, application, dispatcher, sharedContext) {
 
       async getApplicationGraphQLSchema () {
         try {
-          return await instance.capability.getGraphqlSchema()
+          return await controller.capability.getGraphqlSchema()
         } catch (err) {
           throw new FailedToRetrieveGraphQLSchemaError(application.id, err.message)
         }
@@ -186,7 +192,7 @@ export function setupITC (instance, application, dispatcher, sharedContext) {
 
       async getApplicationMeta () {
         try {
-          return await instance.capability.getMeta()
+          return await controller.capability.getMeta()
         } catch (err) {
           throw new FailedToRetrieveMetaError(application.id, err.message)
         }
@@ -194,7 +200,7 @@ export function setupITC (instance, application, dispatcher, sharedContext) {
 
       async getMetrics (format) {
         try {
-          return await instance.getMetrics({ format })
+          return await controller.getMetrics({ format })
         } catch (err) {
           throw new FailedToRetrieveMetricsError(application.id, err.message)
         }
@@ -202,7 +208,7 @@ export function setupITC (instance, application, dispatcher, sharedContext) {
 
       async getHealth () {
         try {
-          return await instance.getHealth()
+          return await controller.getHealth()
         } catch (err) {
           throw new FailedToRetrieveHealthError(application.id, err.message)
         }
@@ -210,7 +216,7 @@ export function setupITC (instance, application, dispatcher, sharedContext) {
 
       async getCustomHealthCheck () {
         try {
-          return await instance.capability.getCustomHealthCheck()
+          return await controller.capability.getCustomHealthCheck()
         } catch (err) {
           throw new FailedToPerformCustomHealthCheckError(application.id, err.message)
         }
@@ -218,7 +224,7 @@ export function setupITC (instance, application, dispatcher, sharedContext) {
 
       async getCustomReadinessCheck () {
         try {
-          return await instance.capability.getCustomReadinessCheck()
+          return await controller.capability.getCustomReadinessCheck()
         } catch (err) {
           throw new FailedToPerformCustomReadinessCheckError(application.id, err.message)
         }
@@ -234,7 +240,7 @@ export function setupITC (instance, application, dispatcher, sharedContext) {
     }
   })
 
-  instance.on('changed', () => {
+  controller.on('changed', () => {
     itc.notify('changed')
   })
 

package/lib/worker/main.js

@@ -166,7 +166,7 @@ async function main () {
   }
 
   // Create the application
-  const app = new Controller(
+  const controller = new Controller(
     application,
     workerData.worker.count > 1 ? workerData.worker.index : undefined,
     application.telemetry,
@@ -177,13 +177,23 @@ async function main () {
     !!config.watch
   )
 
-  process.on('uncaughtException', handleUnhandled.bind(null, app, 'uncaught exception'))
-  process.on('unhandledRejection', handleUnhandled.bind(null, app, 'unhandled rejection'))
+  if (config.exitOnUnhandledErrors) {
+    process.on('uncaughtException', handleUnhandled.bind(null, controller, 'uncaught exception'))
+    process.on('unhandledRejection', handleUnhandled.bind(null, controller, 'unhandled rejection'))
 
-  await app.init()
+    process.on('newListener', event => {
+      if (event === 'uncaughtException' || event === 'unhandledRejection') {
+        globalThis.platformatic.logger.warn(
+          `A listener has been added for the "process.${event}" event. This listener will be never triggered as Watt default behavior will kill the process before.\n To disable this behavior, set "exitOnUnhandledErrors" to false in the runtime config.`
+        )
+      }
+    })
+  }
+
+  await controller.init()
 
   if (application.entrypoint && config.basePath) {
-    const meta = await app.capability.getMeta()
+    const meta = await controller.capability.getMeta()
     if (!meta.gateway.wantsAbsoluteUrls) {
       stripBasePath(config.basePath)
     }
@@ -197,12 +207,10 @@ async function main () {
   }
 
   // Setup interaction with parent port
-  const itc = setupITC(app, application, threadDispatcher, sharedContext)
+  const itc = setupITC(controller, application, threadDispatcher, sharedContext)
   globalThis[kITC] = itc
 
-  // Get the dependencies
-  const dependencies = await app.getBootstrapDependencies()
-  itc.notify('init', { dependencies })
+  itc.notify('init')
 }
 
 function stripBasePath (basePath) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "3.0.0-alpha.6",
+  "version": "3.0.0-rc.1",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -34,23 +34,24 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/gateway": "3.0.0-alpha.6",
-    "@platformatic/db": "3.0.0-alpha.6",
-    "@platformatic/node": "3.0.0-alpha.6",
-    "@platformatic/sql-mapper": "3.0.0-alpha.6",
-    "@platformatic/sql-graphql": "3.0.0-alpha.6",
-    "@platformatic/service": "3.0.0-alpha.6"
+    "@platformatic/db": "3.0.0-rc.1",
+    "@platformatic/composer": "3.0.0-rc.1",
+    "@platformatic/gateway": "3.0.0-rc.1",
+    "@platformatic/node": "3.0.0-rc.1",
+    "@platformatic/sql-graphql": "3.0.0-rc.1",
+    "@platformatic/service": "3.0.0-rc.1",
+    "@platformatic/sql-mapper": "3.0.0-rc.1",
+    "@platformatic/wattpm-pprof-capture": "3.0.0-rc.1"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
     "@fastify/error": "^4.0.0",
     "@fastify/websocket": "^11.0.0",
-    "@hapi/topo": "^6.0.2",
     "@opentelemetry/api": "^1.9.0",
     "@platformatic/undici-cache-memory": "^0.8.1",
     "@watchable/unpromise": "^1.0.2",
     "change-case-all": "^2.1.0",
-    "close-with-grace": "^2.0.0",
+    "close-with-grace": "^2.2.0",
     "colorette": "^2.0.20",
     "cron": "^4.1.0",
     "debounce": "^2.0.0",
@@ -69,18 +70,18 @@
     "undici": "^7.0.0",
     "undici-thread-interceptor": "^0.14.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "3.0.0-alpha.6",
-    "@platformatic/itc": "3.0.0-alpha.6",
-    "@platformatic/foundation": "3.0.0-alpha.6",
-    "@platformatic/metrics": "3.0.0-alpha.6",
-    "@platformatic/generators": "3.0.0-alpha.6",
-    "@platformatic/telemetry": "3.0.0-alpha.6"
+    "@platformatic/basic": "3.0.0-rc.1",
+    "@platformatic/foundation": "3.0.0-rc.1",
+    "@platformatic/generators": "3.0.0-rc.1",
+    "@platformatic/metrics": "3.0.0-rc.1",
+    "@platformatic/telemetry": "3.0.0-rc.1",
+    "@platformatic/itc": "3.0.0-rc.1"
   },
   "engines": {
     "node": ">=22.18.0"
   },
   "scripts": {
-    "test": "node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/*.test.js test/**/*.test.js",
+    "test": "npm run test:main && npm run test:api && npm run test:cli && npm run test:start && npm run test:multiple-workers",
     "test:main": "node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/*.test.js test/versions/*.test.js",
     "test:api": "node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/api/*.test.js test/management-api/*.test.js",
     "test:cli": "node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/cli/*.test.js test/cli/**/*.test.js",
@@ -88,7 +89,7 @@
     "test:multiple-workers": "node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/multiple-workers/*.test.js",
     "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",
+    "build": "npm run gen-schema && npm run gen-types",
     "lint": "eslint"
   }
 }

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.0.0-alpha.6.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.0.0-rc.1.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Runtime Config",
   "type": "object",
@@ -186,6 +186,12 @@
                   }
                 ]
               },
+              "dependencies": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
               "arguments": {
                 "type": "array",
                 "items": {
@@ -347,6 +353,13 @@
             },
             "additionalProperties": false
           },
+          "dependencies": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "default": []
+          },
           "arguments": {
             "type": "array",
             "items": {
@@ -576,6 +589,13 @@
             },
             "additionalProperties": false
           },
+          "dependencies": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "default": []
+          },
           "arguments": {
             "type": "array",
             "items": {
@@ -805,6 +825,13 @@
             },
             "additionalProperties": false
           },
+          "dependencies": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "default": []
+          },
           "arguments": {
             "type": "array",
             "items": {
@@ -1190,6 +1217,10 @@
         }
       ]
     },
+    "exitOnUnhandledErrors": {
+      "default": true,
+      "type": "boolean"
+    },
     "gracefulShutdown": {
       "type": "object",
       "properties": {

package/lib/dependencies.js

@@ -1,63 +0,0 @@
-import { Sorter } from '@hapi/topo'
-import { closest } from 'fastest-levenshtein'
-import { MissingDependencyError } from './errors.js'
-import { RoundRobinMap } from './worker/round-robin-map.js'
-
-function missingDependencyErrorMessage (clientName, application, applications) {
-  const allNames = applications
-    .map(s => s.id)
-    .filter(id => id !== application.id)
-    .sort()
-  const closestName = closest(clientName, allNames)
-  let errorMsg = `application '${application.id}' has unknown dependency: '${clientName}'.`
-  if (closestName) {
-    errorMsg += ` Did you mean '${closestName}'?`
-  }
-  if (allNames.length) {
-    errorMsg += ` Known applications are: ${allNames.join(', ')}.`
-  }
-  return errorMsg
-}
-
-export function checkDependencies (applications) {
-  const allApplications = new Set(applications.map(s => s.id))
-
-  for (const application of applications) {
-    for (const dependency of application.dependencies) {
-      if (dependency.local && !allApplications.has(dependency.id)) {
-        throw new MissingDependencyError(missingDependencyErrorMessage(dependency.id, application, applications))
-      }
-    }
-  }
-}
-
-export function topologicalSort (workers, config) {
-  const topo = new Sorter()
-
-  for (const application of config.applications) {
-    const localDependencyIds = Array.from(application.dependencies)
-      .filter(dep => dep.local)
-      .map(dep => dep.id)
-
-    topo.add(application, {
-      group: application.id,
-      after: localDependencyIds,
-      manual: true
-    })
-  }
-
-  config.applications = topo.sort()
-
-  return new RoundRobinMap(
-    Array.from(workers.entries()).sort((a, b) => {
-      if (a[0] === b[0]) {
-        return 0
-      }
-
-      const aIndex = config.applications.findIndex(s => s.id === a[0])
-      const bIndex = config.applications.findIndex(s => s.id === b[0])
-      return aIndex - bIndex
-    }),
-    workers.configuration
-  )
-}