@platformatic/runtime 2.19.0 → 2.20.0-alpha.2

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime2190Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime2200Alpha2Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;
@@ -176,6 +176,7 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime2190Json = {
     [k: string]: unknown;
   };
   serviceTimeout?: number | string;
+  resolvedServicesBasePath?: string;
 };
 
 export interface UndiciInterceptor {

package/lib/config.js

@@ -87,8 +87,9 @@ async function _transformConfig (configManager, args) {
   for (let i = 0; i < services.length; ++i) {
     const service = services[i]
 
-    // We need to have absolut paths here, ot the `loadConfig` will fail
-    if (!isAbsolute(service.path)) {
+    // We need to have absolute paths here, ot the `loadConfig` will fail
+    // Make sure we don't resolve if env var was not replaced
+    if (service.path && !isAbsolute(service.path) && !service.path.match(/^\{.*\}$/)) {
       service.path = pathResolve(configManager.dirname, service.path)
     }
 

package/lib/errors.js

@@ -7,6 +7,7 @@ const ERROR_PREFIX = 'PLT_RUNTIME'
 module.exports = {
   AddressInUseError: createError(`${ERROR_PREFIX}_EADDR_IN_USE`, 'The current port is in use by another application'),
   RuntimeExitedError: createError(`${ERROR_PREFIX}_RUNTIME_EXIT`, 'The runtime exited before the operation completed'),
+  RuntimeAbortedError: createError(`${ERROR_PREFIX}_RUNTIME_ABORT`, 'The runtime aborted the operation'),
   // The following two use the same code as we only need to differentiate the label
   ServiceExitedError: createError(`${ERROR_PREFIX}_SERVICE_EXIT`, 'The service "%s" exited prematurely with error code %d'),
   WorkerExitedError: createError(`${ERROR_PREFIX}_SERVICE_EXIT`, 'The worker %s of the service "%s" exited prematurely with error code %d'),

package/lib/runtime.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const { once, EventEmitter } = require('node:events')
-const { createReadStream, watch } = require('node:fs')
+const { createReadStream, watch, existsSync } = require('node:fs')
 const { readdir, readFile, stat, access } = require('node:fs/promises')
 const { join } = require('node:path')
 const { setTimeout: sleep } = require('node:timers/promises')
@@ -124,6 +124,31 @@ class Runtime extends EventEmitter {
 
     // Create all services, each in is own worker thread
     for (const serviceConfig of config.services) {
+      // If there is no service path, check if the service was resolved
+      if (!serviceConfig.path) {
+        if (serviceConfig.url) {
+          // Try to backfill the path for external services
+          serviceConfig.path = join(this.#configManager.dirname, config.resolvedServicesBasePath, serviceConfig.id)
+
+          if (!existsSync(serviceConfig.path)) {
+            const executable = globalThis.platformatic?.executable ?? 'platformatic'
+            this.logger.error(
+              `The path for service "%s" does not exist. Please run "${executable} resolve" and try again.`,
+              serviceConfig.id
+            )
+
+            throw new errors.RuntimeAbortedError()
+          }
+        } else {
+          this.logger.error(
+            'The service "%s" has no path defined. Please check your configuration and try again.',
+            serviceConfig.id
+          )
+
+          throw new errors.RuntimeAbortedError()
+        }
+      }
+
       await this.#setupService(serviceConfig)
     }
 
@@ -137,6 +162,21 @@ class Runtime extends EventEmitter {
 
       // Recompute the list of services after sorting
       this.#servicesIds = config.services.map(service => service.id)
+
+      // When autoloading is disabled, add a warning if a service is defined before its dependencies
+      if (!autoloadEnabled) {
+        for (let i = 0; i < config.services.length; i++) {
+          const current = config.services[i]
+
+          for (const dep of current.dependencies ?? []) {
+            if (config.services.findIndex(s => s.id === dep.id) > i) {
+              this.logger.warn(
+                `Service "${current.id}" depends on service "${dep.id}", but it is defined and it will be started before it. Please check your configuration file.`
+              )
+            }
+          }
+        }
+      }
     } catch (e) {
       await this.close()
       throw e
@@ -282,7 +322,7 @@ class Runtime extends EventEmitter {
     this.#updateStatus('closed')
   }
 
-  async startService (id, silent) {
+  async startService (id, silent = false) {
     // Since when a service is stopped the worker is deleted, we consider a service start if its first service
     // is no longer in the init phase
     const firstWorker = this.#workers.get(`${id}:0`)
@@ -304,7 +344,7 @@ class Runtime extends EventEmitter {
     }
   }
 
-  async stopService (id, silent) {
+  async stopService (id, silent = false) {
     const config = this.#configManager.current
     const serviceConfig = config.services.find(s => s.id === id)
 
@@ -795,7 +835,7 @@ class Runtime extends EventEmitter {
   }
 
   async #setupWorker (config, serviceConfig, workersCount, serviceId, index) {
-    const { autoload, restartOnError } = config
+    const { restartOnError } = config
     const workerId = `${serviceId}:${index}`
 
     const { port1: loggerDestination, port2: loggingPort } = new MessageChannel()
@@ -969,12 +1009,10 @@ class Runtime extends EventEmitter {
     // Store dependencies
     const [{ dependencies }] = await waitEventFromITC(worker, 'init')
 
-    if (autoload) {
-      serviceConfig.dependencies = dependencies
-      for (const { envVar, url } of dependencies) {
-        if (envVar) {
-          serviceConfig.localServiceEnvVars.set(envVar, url)
-        }
+    serviceConfig.dependencies = dependencies
+    for (const { envVar, url } of dependencies) {
+      if (envVar) {
+        serviceConfig.localServiceEnvVars.set(envVar, url)
       }
     }
 

package/lib/schema.js

@@ -27,6 +27,8 @@ const services = {
       },
       path: {
         type: 'string',
+        // This is required for the resolve command to allow empty paths after environment variable replacement
+        allowEmptyPaths: true,
         resolvePath: true
       },
       config: {
@@ -310,6 +312,10 @@ const platformaticRuntimeSchema = {
         { type: 'string' }
       ],
       default: 300000 // 5 minutes
+    },
+    resolvedServicesBasePath: {
+      type: 'string',
+      default: 'external'
     }
   },
   anyOf: [{ required: ['autoload'] }, { required: ['services'] }, { required: ['web'] }],

package/lib/start.js

@@ -146,7 +146,7 @@ async function startCommand (args, throwAllErrors = false, returnRuntime = false
 
     return returnRuntime ? runtime : res
   } catch (err) {
-    if (throwAllErrors) {
+    if (throwAllErrors && err.code !== 'PLT_RUNTIME_RUNTIME_ABORT') {
       throw err
     }
 
@@ -187,7 +187,9 @@ async function startCommand (args, throwAllErrors = false, returnRuntime = false
       process.exit(1)
     }
 
-    console.error(err)
+    if (err.code !== 'PLT_RUNTIME_RUNTIME_ABORT') {
+      console.error(err)
+    }
 
     process.exit(1)
   }

package/lib/worker/main.js

@@ -1,5 +1,6 @@
 'use strict'
 
+const { EventEmitter } = require('node:events')
 const { createRequire } = require('node:module')
 const { hostname } = require('node:os')
 const { join } = require('node:path')
@@ -37,7 +38,10 @@ globalThis[kId] = threadId
 let app
 
 const config = workerData.config
-globalThis.platformatic = Object.assign(globalThis.platformatic ?? {}, { logger: createLogger() })
+globalThis.platformatic = Object.assign(globalThis.platformatic ?? {}, {
+  logger: createLogger(),
+  events: new EventEmitter()
+})
 
 function handleUnhandled (type, err) {
   const label =
@@ -200,7 +204,7 @@ async function main () {
   globalThis[kITC] = itc
 
   // Get the dependencies
-  const dependencies = config.autoload ? await app.getBootstrapDependencies() : []
+  const dependencies = await app.getBootstrapDependencies()
   itc.notify('init', { dependencies })
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.19.0",
+  "version": "2.20.0-alpha.2",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -35,12 +35,12 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.19.0",
-    "@platformatic/db": "2.19.0",
-    "@platformatic/node": "2.19.0",
-    "@platformatic/service": "2.19.0",
-    "@platformatic/sql-graphql": "2.19.0",
-    "@platformatic/sql-mapper": "2.19.0"
+    "@platformatic/composer": "2.20.0-alpha.2",
+    "@platformatic/node": "2.20.0-alpha.2",
+    "@platformatic/sql-mapper": "2.20.0-alpha.2",
+    "@platformatic/service": "2.20.0-alpha.2",
+    "@platformatic/db": "2.20.0-alpha.2",
+    "@platformatic/sql-graphql": "2.20.0-alpha.2"
   },
   "dependencies": {
     "@fastify/error": "^4.0.0",
@@ -72,13 +72,13 @@
     "undici": "^7.0.0",
     "undici-thread-interceptor": "^0.10.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.19.0",
-    "@platformatic/config": "2.19.0",
-    "@platformatic/generators": "2.19.0",
-    "@platformatic/itc": "2.19.0",
-    "@platformatic/telemetry": "2.19.0",
-    "@platformatic/utils": "2.19.0",
-    "@platformatic/ts-compiler": "2.19.0"
+    "@platformatic/basic": "2.20.0-alpha.2",
+    "@platformatic/config": "2.20.0-alpha.2",
+    "@platformatic/generators": "2.20.0-alpha.2",
+    "@platformatic/telemetry": "2.20.0-alpha.2",
+    "@platformatic/ts-compiler": "2.20.0-alpha.2",
+    "@platformatic/itc": "2.20.0-alpha.2",
+    "@platformatic/utils": "2.20.0-alpha.2"
   },
   "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.19.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.20.0-alpha.2.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
@@ -183,6 +183,7 @@
           },
           "path": {
             "type": "string",
+            "allowEmptyPaths": true,
             "resolvePath": true
           },
           "config": {
@@ -335,6 +336,7 @@
           },
           "path": {
             "type": "string",
+            "allowEmptyPaths": true,
             "resolvePath": true
           },
           "config": {
@@ -1107,6 +1109,10 @@
         }
       ],
       "default": 300000
+    },
+    "resolvedServicesBasePath": {
+      "type": "string",
+      "default": "external"
     }
   },
   "anyOf": [