@platformatic/runtime 2.0.0-alpha.4 → 2.0.0-alpha.6

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha4Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha6Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;
@@ -201,10 +201,6 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha4Json = {
       };
   restartOnError?: boolean | number;
   services?: {
-    id: string;
-    path: string;
-    config?: string;
-    useHttp?: boolean;
     [k: string]: unknown;
   }[];
 };

package/lib/errors.js

@@ -13,6 +13,7 @@ module.exports = {
   ServiceNotStartedError: createError(`${ERROR_PREFIX}_SERVICE_NOT_STARTED`, "Service with id '%s' is not started"),
   FailedToRetrieveOpenAPISchemaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_OPENAPI_SCHEMA`, 'Failed to retrieve OpenAPI schema for service with id "%s": %s'),
   FailedToRetrieveGraphQLSchemaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_GRAPHQL_SCHEMA`, 'Failed to retrieve GraphQL schema for service with id "%s": %s'),
+  FailedToRetrieveMetaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_META`, 'Failed to retrieve metadata for service with id "%s": %s'),
   ApplicationAlreadyStartedError: createError(`${ERROR_PREFIX}_APPLICATION_ALREADY_STARTED`, 'Application is already started'),
   ApplicationNotStartedError: createError(`${ERROR_PREFIX}_APPLICATION_NOT_STARTED`, 'Application has not been started'),
   ConfigPathMustBeStringError: createError(`${ERROR_PREFIX}_CONFIG_PATH_MUST_BE_STRING`, 'Config path must be a string'),

package/lib/generator/runtime-generator.js

@@ -202,7 +202,7 @@ class RuntimeGenerator extends BaseGenerator {
     })
 
     if (!this.existingConfig) {
-      this.addFile({ path: '', file: 'README.md', contents: await readFile(join(__dirname, 'README.md')) })
+      this.addFile({ path: '', file: 'README.md', contents: await readFile(join(__dirname, 'README.md'), 'utf-8') })
     }
 
     return {
@@ -375,7 +375,7 @@ class RuntimeGenerator extends BaseGenerator {
 
         // delete dependencies
         const servicePackageJson = JSON.parse(
-          await readFile(join(this.targetDirectory, 'services', s.name, 'platformatic.json'))
+          await readFile(join(this.targetDirectory, 'services', s.name, 'platformatic.json'), 'utf-8')
         )
         if (servicePackageJson.plugins && servicePackageJson.plugins.packages) {
           servicePackageJson.plugins.packages.forEach(p => {

package/lib/runtime.js

@@ -9,6 +9,7 @@ const { setTimeout: sleep } = require('node:timers/promises')
 const { Worker } = require('node:worker_threads')
 
 const { ITC } = require('@platformatic/itc')
+const { Unpromise } = require('@watchable/unpromise')
 const ts = require('tail-file-stream')
 const { createThreadInterceptor } = require('undici-thread-interceptor')
 
@@ -240,17 +241,20 @@ class Runtime extends EventEmitter {
       const config = this.#configManager.current
       const restartOnError = config.restartOnError
 
+      if (!restartOnError) {
+        this.logger.error(`Failed to start service "${id}".`)
+        throw error
+      }
+
       let bootstrapAttempt = this.#bootstrapAttempts.get(id)
       if (bootstrapAttempt++ >= MAX_BOOTSTRAP_ATTEMPTS || restartOnError === 0) {
-        this.logger.error(
-          `Failed to start service "${id}" after ${MAX_BOOTSTRAP_ATTEMPTS} attempts.`
-        )
+        this.logger.error(`Failed to start service "${id}" after ${MAX_BOOTSTRAP_ATTEMPTS} attempts.`)
         throw error
       }
 
       this.logger.warn(
         `Starting a service "${id}" in ${restartOnError}ms. ` +
-        `Attempt ${bootstrapAttempt} of ${MAX_BOOTSTRAP_ATTEMPTS}...`
+          `Attempt ${bootstrapAttempt} of ${MAX_BOOTSTRAP_ATTEMPTS}...`
       )
 
       this.#bootstrapAttempts.set(id, bootstrapAttempt)
@@ -272,13 +276,13 @@ class Runtime extends EventEmitter {
 
     // Always send the stop message, it will shut down workers that only had ITC and interceptors setup
     try {
-      await Promise.race([sendViaITC(service, 'stop'), sleep(10000, 'timeout', { ref: false })])
+      await Unpromise.race([sendViaITC(service, 'stop'), sleep(10000, 'timeout', { ref: false })])
     } catch (error) {
       this.logger?.info(`Failed to stop service "${id}". Killing a worker thread.`, error)
     }
 
     // Wait for the worker thread to finish, we're going to create a new one if the service is ever restarted
-    const res = await Promise.race([once(service, 'exit'), sleep(10000, 'timeout', { ref: false })])
+    const res = await Unpromise.race([once(service, 'exit'), sleep(10000, 'timeout', { ref: false })])
 
     // If the worker didn't exit in time, kill it
     if (res === 'timeout') {
@@ -419,7 +423,7 @@ class Runtime extends EventEmitter {
       packageName: packageJson.name ?? null,
       packageVersion: packageJson.version ?? null,
       url: entrypointDetails?.url ?? null,
-      platformaticVersion,
+      platformaticVersion
     }
   }
 
@@ -446,7 +450,7 @@ class Runtime extends EventEmitter {
   async getServices () {
     return {
       entrypoint: this.#entrypointId,
-      services: await Promise.all(this.#servicesIds.map(id => this.getServiceDetails(id))),
+      services: await Promise.all(this.#servicesIds.map(id => this.getServiceDetails(id)))
     }
   }
 
@@ -475,7 +479,7 @@ class Runtime extends EventEmitter {
       version,
       localUrl,
       entrypoint,
-      dependencies,
+      dependencies
     }
 
     if (entrypoint) {
@@ -607,9 +611,9 @@ class Runtime extends EventEmitter {
             p50: p50Value,
             p90: p90Value,
             p95: p95Value,
-            p99: p99Value,
-          },
-        },
+            p99: p99Value
+          }
+        }
       }
 
       return formattedMetrics
@@ -646,7 +650,7 @@ class Runtime extends EventEmitter {
       }
       runtimesLogsIds.push({
         pid: runtime.runtimePID,
-        indexes: runtimeLogIds,
+        indexes: runtimeLogIds
       })
     }
 
@@ -684,7 +688,7 @@ class Runtime extends EventEmitter {
         serviceConfig,
         dirname: this.#configManager.dirname,
         runtimeLogsDir: this.#runtimeLogsDir,
-        loggingPort,
+        loggingPort
       },
       execArgv: [], // Avoid side effects
       env: this.#env,
@@ -697,7 +701,7 @@ class Runtime extends EventEmitter {
         The author of this (Paolo and Matteo) are not proud of the solution. Forgive us.
       */
       stdout: true,
-      stderr: true,
+      stderr: true
     })
 
     // Make sure the listener can handle a lot of API requests at once before raising a warning
@@ -720,7 +724,7 @@ class Runtime extends EventEmitter {
         if (started && this.#status === 'started') {
           if (restartOnError > 0) {
             this.logger.warn(`Restarting a service "${id}" in ${restartOnError}ms...`)
-            this.#restartCrashedService(id).catch((err) => {
+            this.#restartCrashedService(id).catch(err => {
               this.logger.error({ err }, `Failed to restart service "${id}".`)
             })
           } else {
@@ -734,9 +738,13 @@ class Runtime extends EventEmitter {
     service[kConfig] = serviceConfig
 
     // Setup ITC
-    service[kITC] = new ITC({ port: service })
+    service[kITC] = new ITC({
+      port: service,
+      handlers: {
+        getServiceMeta: this.getServiceMeta.bind(this)
+      }
+    })
     service[kITC].listen()
-    service[kITC].handle('getServiceMeta', this.#getServiceMeta.bind(this))
 
     // Handle services changes
     // This is not purposely activated on when this.#configManager.current.watch === true
@@ -838,7 +846,7 @@ class Runtime extends EventEmitter {
     return service
   }
 
-  async #getServiceMeta (id) {
+  async getServiceMeta (id) {
     const service = this.#services.get(id)
 
     if (!service) {
@@ -901,7 +909,7 @@ class Runtime extends EventEmitter {
       runtimesLogFiles.push({
         runtimePID: parseInt(runtimePID),
         runtimeLogFiles,
-        lastModified,
+        lastModified
       })
     }
 

package/lib/schema.js

@@ -191,7 +191,10 @@ const platformaticRuntimeSchema = {
       type: 'array',
       items: {
         type: 'object',
-        required: ['id', 'path'],
+        anyOf: [
+          { required: ['id', 'path'] },
+          { required: ['id', 'url'] },
+        ],
         properties: {
           id: {
             type: 'string',
@@ -203,6 +206,9 @@ const platformaticRuntimeSchema = {
           config: {
             type: 'string',
           },
+          url: {
+            type: 'string',
+          },
           useHttp: {
             type: 'boolean',
           },

package/lib/worker/app.js

@@ -205,21 +205,14 @@ class PlatformaticApp extends EventEmitter {
 
   #logAndExit (err) {
     // Runtime logs here with console.error because stackable is not initialized
-    console.error(
-      JSON.stringify({
-        msg: err.message,
-        name: this.appConfig.id,
-      })
-    )
+    console.error(err.message)
     process.exit(1)
   }
 
   #wrapStackable (stackable) {
     const newStackable = {}
     for (const method of Object.keys(defaultStackable)) {
-      newStackable[method] = stackable[method]
-        ? stackable[method].bind(stackable)
-        : defaultStackable[method]
+      newStackable[method] = stackable[method] ? stackable[method].bind(stackable) : defaultStackable[method]
     }
     return newStackable
   }
@@ -240,8 +233,7 @@ class PlatformaticApp extends EventEmitter {
       }
     }
 
-    const dispatcher = getGlobalDispatcher()
-      .compose(interceptor)
+    const dispatcher = getGlobalDispatcher().compose(interceptor)
 
     setGlobalDispatcher(dispatcher)
   }

package/lib/worker/default-stackable.js

@@ -13,6 +13,7 @@ const defaultStackable = {
   getDispatchFunc: () => null,
   getOpenapiSchema: () => null,
   getGraphqlSchema: () => null,
+  getMeta: () => ({}),
   getMetrics: () => null,
   inject: () => {
     throw new Error('Stackable inject not implemented')

package/lib/worker/itc.js

@@ -4,6 +4,7 @@ const { once } = require('node:events')
 const { parentPort } = require('node:worker_threads')
 
 const { ITC } = require('@platformatic/itc')
+const { Unpromise } = require('@watchable/unpromise')
 
 const errors = require('../errors')
 const { kITC, kId } = require('./symbols')
@@ -14,11 +15,11 @@ async function sendViaITC (worker, name, message) {
     const ac = new AbortController()
     let exitCode
 
-    const response = await Promise.race([
+    const response = await Unpromise.race([
       worker[kITC].send(name, message),
       once(worker, 'exit', { signal: ac.signal }).then(([code]) => {
         exitCode = code
-      }),
+      })
     ])
 
     if (typeof exitCode === 'number') {
@@ -42,80 +43,91 @@ async function sendViaITC (worker, name, message) {
 }
 
 function setupITC (app, service, dispatcher) {
-  const itc = new ITC({ port: parentPort })
-
-  itc.handle('start', async () => {
-    const status = app.getStatus()
-
-    if (status === 'starting') {
-      await once(app, 'start')
-    } else {
-      await app.start()
-    }
-
-    if (service.entrypoint) {
-      await app.listen()
-    }
-
-    const url = app.stackable.getUrl()
-
-    const dispatchFunc = await app.stackable.getDispatchFunc()
-    dispatcher.replaceServer(url ?? dispatchFunc)
-
-    return service.entrypoint ? url : null
-  })
-
-  itc.handle('stop', async () => {
-    const status = app.getStatus()
-
-    if (status === 'starting') {
-      await once(app, 'start')
+  const itc = new ITC({
+    port: parentPort,
+    handlers: {
+      async start () {
+        const status = app.getStatus()
+
+        if (status === 'starting') {
+          await once(app, 'start')
+        } else {
+          await app.start()
+        }
+
+        if (service.entrypoint) {
+          await app.listen()
+        }
+
+        const url = app.stackable.getUrl()
+
+        const dispatchFunc = await app.stackable.getDispatchFunc()
+        dispatcher.replaceServer(url ?? dispatchFunc)
+
+        return service.entrypoint ? url : null
+      },
+
+      async stop () {
+        const status = app.getStatus()
+
+        if (status === 'starting') {
+          await once(app, 'start')
+        }
+
+        if (status !== 'stopped') {
+          await app.stop()
+        }
+
+        dispatcher.interceptor.close()
+        itc.close()
+      },
+
+      getStatus () {
+        return app.getStatus()
+      },
+
+      getServiceInfo () {
+        return app.stackable.getInfo()
+      },
+
+      async getServiceConfig () {
+        const current = await app.stackable.getConfig()
+        // Remove all undefined keys from the config
+        return JSON.parse(JSON.stringify(current))
+      },
+
+      async getServiceOpenAPISchema () {
+        try {
+          return await app.stackable.getOpenapiSchema()
+        } catch (err) {
+          throw new errors.FailedToRetrieveOpenAPISchemaError(service.id, err.message)
+        }
+      },
+
+      async getServiceGraphQLSchema () {
+        try {
+          return await app.stackable.getGraphqlSchema()
+        } catch (err) {
+          throw new errors.FailedToRetrieveGraphQLSchemaError(service.id, err.message)
+        }
+      },
+
+      async getServiceMeta () {
+        try {
+          return await app.stackable.getMeta()
+        } catch (err) {
+          throw new errors.FailedToRetrieveMetaError(service.id, err.message)
+        }
+      },
+
+      getMetrics (format) {
+        return app.stackable.getMetrics({ format })
+      },
+
+      inject (injectParams) {
+        return app.stackable.inject(injectParams)
+      }
     }
-
-    if (status !== 'stopped') {
-      await app.stop()
-    }
-
-    dispatcher.interceptor.close()
-    itc.close()
-  })
-
-  itc.handle('getStatus', async () => {
-    return app.getStatus()
-  })
-
-  itc.handle('getServiceInfo', async () => {
-    return app.stackable.getInfo()
-  })
-
-  itc.handle('getServiceConfig', async () => {
-    const current = await app.stackable.getConfig()
-    // Remove all undefined keys from the config
-    return JSON.parse(JSON.stringify(current))
-  })
-
-  itc.handle('getServiceOpenAPISchema', async () => {
-    try {
-      return app.stackable.getOpenapiSchema()
-    } catch (err) {
-      throw new errors.FailedToRetrieveOpenAPISchemaError(service.id, err.message)
-    }
-  })
-
-  itc.handle('getServiceGraphQLSchema', async () => {
-    try {
-      return app.stackable.getGraphqlSchema()
-    } catch (err) {
-      throw new errors.FailedToRetrieveGraphQLSchemaError(service.id, err.message)
-    }
-  })
-
-  itc.handle('getMetrics', async format => {
-    return app.stackable.getMetrics({ format })
-  })
-
-  itc.handle('inject', async injectParams => {
-    return app.stackable.inject(injectParams)
   })
 
   app.on('changed', () => {

package/lib/worker/main.js

@@ -6,6 +6,7 @@ const { setTimeout: sleep } = require('node:timers/promises')
 const { parentPort, workerData, threadId } = require('node:worker_threads')
 const { pathToFileURL } = require('node:url')
 
+const { Unpromise } = require('@watchable/unpromise')
 const pino = require('pino')
 const { fetch, setGlobalDispatcher, Agent } = require('undici')
 const { wire } = require('undici-thread-interceptor')
@@ -29,7 +30,7 @@ const logger = createLogger()
 function handleUnhandled (type, err) {
   logger.error({ err }, `application ${type}`)
 
-  Promise.race([app?.stop(), sleep(1000, 'timeout', { ref: false })])
+  Unpromise.race([app?.stop(), sleep(1000, 'timeout', { ref: false })])
     .catch()
     .finally(() => {
       process.exit(1)
@@ -38,7 +39,7 @@ function handleUnhandled (type, err) {
 
 function createLogger () {
   const destination = new MessagePortWritable({ port: workerData.loggingPort })
-  const loggerInstance = pino({ level: 'trace' }, destination)
+  const loggerInstance = pino({ level: 'trace', name: workerData.serviceConfig.id }, destination)
 
   Reflect.defineProperty(process, 'stdout', { value: createPinoWritable(loggerInstance, 'info') })
   Reflect.defineProperty(process, 'stderr', { value: createPinoWritable(loggerInstance, 'error') })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.0.0-alpha.4",
+  "version": "2.0.0-alpha.6",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -34,19 +34,20 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.0.0-alpha.4",
-    "@platformatic/db": "2.0.0-alpha.4",
-    "@platformatic/service": "2.0.0-alpha.4",
-    "@platformatic/sql-graphql": "2.0.0-alpha.4",
-    "@platformatic/sql-mapper": "2.0.0-alpha.4"
+    "@platformatic/composer": "2.0.0-alpha.6",
+    "@platformatic/service": "2.0.0-alpha.6",
+    "@platformatic/sql-graphql": "2.0.0-alpha.6",
+    "@platformatic/sql-mapper": "2.0.0-alpha.6",
+    "@platformatic/db": "2.0.0-alpha.6"
   },
   "dependencies": {
     "@fastify/error": "^3.4.1",
     "@fastify/websocket": "^10.0.0",
     "@hapi/topo": "^6.0.2",
+    "@watchable/unpromise": "^1.0.2",
     "boring-name-generator": "^1.0.3",
     "change-case-all": "^2.1.0",
-    "close-with-grace": "^1.3.0",
+    "close-with-grace": "^2.0.0",
     "commist": "^3.2.0",
     "debounce": "^2.0.0",
     "desm": "^1.3.1",
@@ -64,15 +65,15 @@
     "semgrator": "^0.3.0",
     "tail-file-stream": "^0.2.0",
     "undici": "^6.9.0",
-    "undici-thread-interceptor": "^0.5.0",
+    "undici-thread-interceptor": "^0.5.1",
     "ws": "^8.16.0",
-    "@platformatic/config": "2.0.0-alpha.4",
-    "@platformatic/basic": "2.0.0-alpha.4",
-    "@platformatic/generators": "2.0.0-alpha.4",
-    "@platformatic/itc": "2.0.0-alpha.4",
-    "@platformatic/telemetry": "2.0.0-alpha.4",
-    "@platformatic/ts-compiler": "2.0.0-alpha.4",
-    "@platformatic/utils": "2.0.0-alpha.4"
+    "@platformatic/basic": "2.0.0-alpha.6",
+    "@platformatic/generators": "2.0.0-alpha.6",
+    "@platformatic/config": "2.0.0-alpha.6",
+    "@platformatic/utils": "2.0.0-alpha.6",
+    "@platformatic/itc": "2.0.0-alpha.6",
+    "@platformatic/ts-compiler": "2.0.0-alpha.6",
+    "@platformatic/telemetry": "2.0.0-alpha.6"
   },
   "scripts": {
     "test": "npm run lint && borp --concurrency=1 --timeout=180000 && tsd",

package/runtime.mjs

@@ -33,7 +33,7 @@ export async function run (argv) {
   })
 
   if (args.version) {
-    console.log('v' + JSON.parse(await readFile(join(import.meta.url, 'package.json'))).version)
+    console.log('v' + JSON.parse(await readFile(join(import.meta.url, 'package.json'), 'utf-8')).version)
     process.exit(0)
   }
 

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.0.0-alpha.4.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.0.0-alpha.6.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
@@ -766,9 +766,19 @@
       "type": "array",
       "items": {
         "type": "object",
-        "required": [
-          "id",
-          "path"
+        "anyOf": [
+          {
+            "required": [
+              "id",
+              "path"
+            ]
+          },
+          {
+            "required": [
+              "id",
+              "url"
+            ]
+          }
         ],
         "properties": {
           "id": {
@@ -781,6 +791,9 @@
           "config": {
             "type": "string"
           },
+          "url": {
+            "type": "string"
+          },
           "useHttp": {
             "type": "boolean"
           }