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

package/config.d.ts

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

package/fixtures/crash-on-bootstrap/platformatic.runtime.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "service-1",
+  "autoload": {
+    "path": "./services"
+  },
+  "restartOnError": 100,
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": "0",
+    "logger": {
+      "level": "info"
+    }
+  }
+}

package/fixtures/crash-on-bootstrap/services/service-1/platformatic.service.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/service/1.52.0.json",
+  "server": {
+    "logger": {
+      "level": "warn"
+    }
+  },
+  "plugins": {
+    "paths": [{
+      "path": "plugin.js",
+      "encapsulate": false
+    }]
+  }
+}

package/fixtures/crash-on-bootstrap/services/service-1/plugin.js

@@ -0,0 +1,5 @@
+'use strict'
+
+module.exports = async function (app) {
+  app.log.info('Service 1 plugin')
+}

package/fixtures/crash-on-bootstrap/services/service-2/platformatic.service.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/service/1.52.0.json",
+  "server": {
+    "logger": {
+      "level": "warn"
+    }
+  },
+  "plugins": {
+    "paths": [{
+      "path": "plugin.js",
+      "encapsulate": false
+    }]
+  }
+}

package/fixtures/crash-on-bootstrap/services/service-2/plugin.js

@@ -0,0 +1,5 @@
+'use strict'
+
+module.exports = async function () {
+  throw new Error('Crash!')
+}

package/fixtures/telemetry/services/echo/routes/span.js

@@ -1,8 +1,22 @@
 'use strict'
+
+const { request } = require('undici')
+
 module.exports = async function (fastify, opts) {
   // This returns the traceId set on the span by the service
-  fastify.get('/', async (request, reply) => {
-    const traceId = request.span.spanContext().traceId
+  fastify.get('/', async (req, reply) => {
+    const traceId = req.span.spanContext().traceId
     return { traceId }
   })
+
+  fastify.get('/service-1/echo-headers', async (req, reply) => {
+    const res = await request('http://service-1.plt.local/echo-headers', {
+      method: 'GET',
+      headers: {
+        'content-type': 'application/json',
+      },
+    })
+    const body = await res.body.json()
+    return body
+  })
 }

package/fixtures/telemetry/services/service-1/platformatic.service.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/service/1.52.0.json",
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": "0",
+    "logger": {
+      "level": "info"
+    }
+  },
+  "service": {
+    "openapi": true
+  },
+  "plugins": {
+    "paths": [
+      "./routes"
+    ],
+    "typescript": false
+  }
+}

package/fixtures/telemetry/services/service-1/routes/echo.js

@@ -0,0 +1,7 @@
+'use strict'
+module.exports = async function (fastify, opts) {
+  // This returns the traceId set on the span by the service
+  fastify.get('/echo-headers', async (request, reply) => {
+    return { headers: request.headers }
+  })
+}

package/lib/runtime.js

@@ -28,6 +28,8 @@ const MAX_LISTENERS_COUNT = 100
 const MAX_METRICS_QUEUE_LENGTH = 5 * 60 // 5 minutes in seconds
 const COLLECT_METRICS_TIMEOUT = 1000
 
+const MAX_BOOTSTRAP_ATTEMPTS = 5
+
 class Runtime extends EventEmitter {
   #configManager
   #runtimeTmpDir
@@ -46,7 +48,8 @@ class Runtime extends EventEmitter {
   #managementApi
   #prometheusServer
   #startedServices
-  #crashedServicesTimers
+  #restartPromises
+  #bootstrapAttempts
 
   constructor (configManager, runtimeLogsDir, env) {
     super()
@@ -63,7 +66,8 @@ class Runtime extends EventEmitter {
     this.#interceptor = createThreadInterceptor({ domain: '.plt.local' })
     this.#status = undefined
     this.#startedServices = new Map()
-    this.#crashedServicesTimers = new Map()
+    this.#restartPromises = new Map()
+    this.#bootstrapAttempts = new Map()
   }
 
   async init () {
@@ -126,8 +130,15 @@ class Runtime extends EventEmitter {
     this.#updateStatus('starting')
 
     // Important: do not use Promise.all here since it won't properly manage dependencies
-    for (const service of this.#servicesIds) {
-      await this.startService(service)
+    try {
+      for (const service of this.#servicesIds) {
+        await this.startService(service)
+      }
+    } catch (error) {
+      // Wait for the next tick so that the error is logged first
+      await sleep(1)
+      await this.close()
+      throw error
     }
 
     this.#updateStatus('started')
@@ -145,13 +156,7 @@ class Runtime extends EventEmitter {
     }
 
     this.#updateStatus('stopping')
-
-    for (const timer of this.#crashedServicesTimers.values()) {
-      clearTimeout(timer)
-    }
-
     this.#startedServices.clear()
-    this.#crashedServicesTimers.clear()
 
     await Promise.all(this.#servicesIds.map(service => this._stopService(service)))
 
@@ -209,12 +214,6 @@ class Runtime extends EventEmitter {
     // This is set here so that if the service fails while starting we track the status
     this.#startedServices.set(id, true)
 
-    // Make sure we don't restart twice
-    const crashedTimer = this.#crashedServicesTimers.get(id)
-    if (crashedTimer) {
-      clearTimeout(crashedTimer)
-    }
-
     let service = await this.#getServiceById(id, false, false)
 
     // The service was stopped, recreate the thread
@@ -226,10 +225,36 @@ class Runtime extends EventEmitter {
       service = await this.#getServiceById(id)
     }
 
-    const serviceUrl = await sendViaITC(service, 'start')
+    try {
+      const serviceUrl = await sendViaITC(service, 'start')
+      if (serviceUrl) {
+        this.#url = serviceUrl
+      }
+      this.#bootstrapAttempts.set(id, 0)
+    } catch (error) {
+      // TODO: handle port allocation error here
+      if (error.code === 'EADDRINUSE') throw error
 
-    if (serviceUrl) {
-      this.#url = serviceUrl
+      this.logger.error({ error }, `Failed to start service "${id}".`)
+
+      const config = this.#configManager.current
+      const restartOnError = config.restartOnError
+
+      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.`
+        )
+        throw error
+      }
+
+      this.logger.warn(
+        `Starting a service "${id}" in ${restartOnError}ms. ` +
+        `Attempt ${bootstrapAttempt} of ${MAX_BOOTSTRAP_ATTEMPTS}...`
+      )
+
+      this.#bootstrapAttempts.set(id, bootstrapAttempt)
+      await this.#restartCrashedService(id)
     }
   }
 
@@ -243,11 +268,13 @@ class Runtime extends EventEmitter {
 
     this.#startedServices.set(id, false)
 
+    this.logger?.info(`Stopping service "${id}"...`)
+
     // 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 })])
     } catch (error) {
-      this.logger.info(`Failed to stop service "${id}". Killing a worker thread.`, 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
@@ -638,6 +665,8 @@ class Runtime extends EventEmitter {
   }
 
   async #setupService (serviceConfig) {
+    if (this.#status === 'stopping' || this.#status === 'closed') return
+
     const config = this.#configManager.current
     const { autoload, restartOnError } = config
 
@@ -645,6 +674,10 @@ class Runtime extends EventEmitter {
     const { port1: loggerDestination, port2: loggingPort } = new MessageChannel()
     loggerDestination.on('message', this.#forwardThreadLog.bind(this))
 
+    if (!this.#bootstrapAttempts.has(id)) {
+      this.#bootstrapAttempts.set(id, 0)
+    }
+
     const service = new Worker(kWorkerFile, {
       workerData: {
         config,
@@ -677,16 +710,21 @@ class Runtime extends EventEmitter {
       loggerDestination.close()
       loggingPort.close()
 
+      if (this.#status === 'stopping') return
+
       // Wait for the next tick so that crashed from the thread are logged first
       setImmediate(() => {
-        // If this was started, it means it crashed
-        if (started && (this.#status === 'started' || this.#status === 'starting')) {
+        this.logger.warn(`Service "${id}" unexpectedly exited with code ${code}.`)
+
+        // Restart the service if it was started
+        if (started && this.#status === 'started') {
           if (restartOnError > 0) {
-            this.#restartCrashedService(serviceConfig, code, started)
+            this.logger.warn(`Restarting a service "${id}" in ${restartOnError}ms...`)
+            this.#restartCrashedService(id).catch((err) => {
+              this.logger.error({ err }, `Failed to restart service "${id}".`)
+            })
           } else {
-            this.logger.warn(
-              `Service ${id} unexpectedly exited with code ${code}. The service is no longer available ...`
-            )
+            this.logger.warn(`The "${id}" service is no longer available.`)
           }
         }
       })
@@ -698,6 +736,7 @@ class Runtime extends EventEmitter {
     // Setup ITC
     service[kITC] = new ITC({ port: service })
     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
@@ -713,9 +752,9 @@ class Runtime extends EventEmitter {
           await this.startService(id)
         }
 
-        this.logger.info(`Service ${id} has been successfully reloaded ...`)
+        this.logger?.info(`Service ${id} has been successfully reloaded ...`)
       } catch (e) {
-        this.logger.error(e)
+        this.logger?.error(e)
       }
     })
 
@@ -743,26 +782,38 @@ class Runtime extends EventEmitter {
     }
   }
 
-  async #restartCrashedService (serviceConfig, code, started) {
-    const restartTimeout = this.#configManager.current.restartOnError
-    const id = serviceConfig.id
+  async #restartCrashedService (id) {
+    const config = this.#configManager.current
+    const serviceConfig = config.services.find(s => s.id === id)
+
+    let restartPromise = this.#restartPromises.get(id)
+    if (restartPromise) {
+      await restartPromise
+      return
+    }
 
-    this.logger.warn(`Service ${id} unexpectedly exited with code ${code}. Restarting in ${restartTimeout}ms ...`)
+    restartPromise = new Promise((resolve, reject) => {
+      setTimeout(async () => {
+        this.#restartPromises.delete(id)
 
-    const timer = setTimeout(async () => {
-      try {
-        await this.#setupService(serviceConfig)
+        try {
+          await this.#setupService(serviceConfig)
 
-        if (started) {
-          this.#startedServices.set(id, false)
-          await this.startService(id)
+          const started = this.#startedServices.get(id)
+          if (started) {
+            this.#startedServices.set(id, false)
+            await this.startService(id)
+          }
+
+          resolve()
+        } catch (err) {
+          reject(err)
         }
-      } catch (err) {
-        this.logger.error({ err }, `Failed to restart service ${id}.`)
-      }
-    }, restartTimeout).unref()
+      }, config.restartOnError)
+    })
 
-    this.#crashedServicesTimers.set(id, timer)
+    this.#restartPromises.set(id, restartPromise)
+    await restartPromise
   }
 
   async #getServiceById (id, ensureStarted = false, mustExist = true) {
@@ -787,6 +838,25 @@ class Runtime extends EventEmitter {
     return service
   }
 
+  async #getServiceMeta (id) {
+    const service = this.#services.get(id)
+
+    if (!service) {
+      throw new errors.ServiceNotFoundError(id, Array.from(this.#services.keys()).join(', '))
+    }
+
+    try {
+      return await service[kITC].send('getServiceMeta')
+    } catch (e) {
+      // The service exports no meta, return an empty object
+      if (e.code === 'PLT_ITC_HANDLER_NOT_FOUND') {
+        return {}
+      }
+
+      throw e
+    }
+  }
+
   async #getRuntimePackageJson () {
     const runtimeDir = this.#configManager.dirname
     const packageJsonPath = join(runtimeDir, 'package.json')

package/lib/worker/app.js

@@ -2,6 +2,7 @@
 
 const { EventEmitter } = require('node:events')
 const { FileWatcher } = require('@platformatic/utils')
+const { getGlobalDispatcher, setGlobalDispatcher } = require('undici')
 const debounce = require('debounce')
 
 const errors = require('../errors')
@@ -31,6 +32,7 @@ class PlatformaticApp extends EventEmitter {
       serviceId: this.appConfig.id,
       directory: this.appConfig.path,
       isEntrypoint: this.appConfig.entrypoint,
+      isProduction: false,
       telemetryConfig,
       metricsConfig,
       serverConfig,
@@ -90,6 +92,8 @@ class PlatformaticApp extends EventEmitter {
         context: this.#context,
       })
       this.stackable = this.#wrapStackable(stackable)
+
+      this.#updateDispatcher()
     } catch (err) {
       this.#logAndExit(err)
     }
@@ -103,7 +107,7 @@ class PlatformaticApp extends EventEmitter {
     this.#starting = true
 
     try {
-      await this.stackable.init?.()
+      await this.stackable.init()
     } catch (err) {
       this.#logAndExit(err)
     }
@@ -219,6 +223,28 @@ class PlatformaticApp extends EventEmitter {
     }
     return newStackable
   }
+
+  #updateDispatcher () {
+    const telemetryConfig = this.#context.telemetryConfig
+    const telemetryId = telemetryConfig?.serviceName
+
+    const interceptor = dispatch => {
+      return function InterceptedDispatch (opts, handler) {
+        if (telemetryId) {
+          opts.headers = {
+            ...opts.headers,
+            'x-plt-telemetry-id': telemetryId,
+          }
+        }
+        return dispatch(opts, handler)
+      }
+    }
+
+    const dispatcher = getGlobalDispatcher()
+      .compose(interceptor)
+
+    setGlobalDispatcher(dispatcher)
+  }
 }
 
 module.exports = { PlatformaticApp }

package/lib/worker/main.js

@@ -13,8 +13,7 @@ const { wire } = require('undici-thread-interceptor')
 const { PlatformaticApp } = require('./app')
 const { setupITC } = require('./itc')
 const loadInterceptors = require('./interceptors')
-const { MessagePortWritable } = require('../streams/message-port-writable')
-const { createPinoWritable } = require('../streams/pino-writable')
+const { MessagePortWritable, createPinoWritable } = require('@platformatic/utils')
 const { kId, kITC } = require('./symbols')
 
 process.on('uncaughtException', handleUnhandled.bind(null, 'uncaught exception'))
@@ -88,15 +87,23 @@ async function main () {
   } else if (service.useHttp) {
     serverConfig = {
       port: 0,
-      host: '127.0.0.1',
+      hostname: '127.0.0.1',
       keepAliveTimeout: 5000,
     }
   }
 
+  let telemetryConfig = config.telemetry
+  if (telemetryConfig) {
+    telemetryConfig = {
+      ...telemetryConfig,
+      serviceName: `${telemetryConfig.serviceName}-${service.id}`,
+    }
+  }
+
   // Create the application
   app = new PlatformaticApp(
     service,
-    config.telemetry,
+    telemetryConfig,
     serverConfig,
     !!config.managementApi,
     !!config.watch,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.0.0-alpha.3",
+  "version": "2.0.0-alpha.4",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -26,6 +26,7 @@
     "express": "^4.18.3",
     "fast-jwt": "^4.0.0",
     "get-port": "^7.1.0",
+    "json-schema-to-typescript": "^15.0.0",
     "neostandard": "^0.11.1",
     "pino-abstract-transport": "^1.1.0",
     "split2": "^4.2.0",
@@ -33,11 +34,11 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.0.0-alpha.3",
-    "@platformatic/service": "2.0.0-alpha.3",
-    "@platformatic/sql-graphql": "2.0.0-alpha.3",
-    "@platformatic/db": "2.0.0-alpha.3",
-    "@platformatic/sql-mapper": "2.0.0-alpha.3"
+    "@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"
   },
   "dependencies": {
     "@fastify/error": "^3.4.1",
@@ -65,19 +66,20 @@
     "undici": "^6.9.0",
     "undici-thread-interceptor": "^0.5.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.0.0-alpha.3",
-    "@platformatic/itc": "2.0.0-alpha.3",
-    "@platformatic/telemetry": "2.0.0-alpha.3",
-    "@platformatic/generators": "2.0.0-alpha.3",
-    "@platformatic/config": "2.0.0-alpha.3",
-    "@platformatic/utils": "2.0.0-alpha.3",
-    "@platformatic/ts-compiler": "2.0.0-alpha.3"
+    "@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"
   },
   "scripts": {
     "test": "npm run lint && borp --concurrency=1 --timeout=180000 && tsd",
     "coverage": "npm run lint && borp -X=fixtures -X=test -C --concurrency=1 --timeout=180000 && tsd",
-    "lint": "eslint",
     "gen-schema": "node lib/schema.js > schema.json",
-    "gen-types": "json2ts > config.d.ts < schema.json"
+    "gen-types": "json2ts > config.d.ts < schema.json",
+    "build": "pnpm run gen-schema && pnpm run gen-types",
+    "lint": "eslint"
   }
 }

package/schema.json

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

package/lib/streams/message-port-writable.js

@@ -1,44 +0,0 @@
-'use strict'
-
-const { Writable } = require('node:stream')
-
-class MessagePortWritable extends Writable {
-  #port
-  #metadata
-
-  constructor (options) {
-    const { port, metadata, ...opts } = options
-
-    super({ ...opts, decodeStrings: false })
-    this.#port = port
-    this.#metadata = metadata
-  }
-
-  // Since this is only invoked by pino, we only receive strings
-  _write (chunk, encoding, callback) {
-    this.#port.postMessage({ metadata: this.#metadata, logs: [chunk.toString(encoding ?? 'utf-8')] })
-
-    // Important: do not remove nextTick otherwise _writev will never be used
-    process.nextTick(callback)
-  }
-
-  // Since this is only invoked by pino, we only receive strings
-  _writev (chunks, callback) {
-    this.#port.postMessage({ metadata: this.#metadata, logs: chunks.map(c => c.chunk.toString(c.encoding ?? 'utf-8')) })
-
-    // Important: do not remove nextTick otherwise _writev will never be used
-    process.nextTick(callback)
-  }
-
-  _final (callback) {
-    this.#port.close()
-    callback()
-  }
-
-  _destroy (err, callback) {
-    this.#port.close()
-    callback(err)
-  }
-}
-
-module.exports = { MessagePortWritable }

package/lib/streams/pino-writable.js

@@ -1,30 +0,0 @@
-'use strict'
-
-const { Writable } = require('node:stream')
-const inspect = require('node:util')
-
-class PinoWritable extends Writable {
-  #write
-
-  constructor (options) {
-    const { pino, level, ...opts } = options
-
-    super({ ...opts, decodeStrings: false })
-    this.#write = pino[level].bind(pino)
-  }
-
-  _write (chunk, encoding, callback) {
-    this.#write({ raw: encoding === 'buffer' ? inspect(chunk) : chunk.toString(encoding ?? 'utf-8') })
-    callback()
-  }
-
-  // We don't define _writev as we have to serialize messages one by one so batching wouldn't make any sense.
-}
-
-function createPinoWritable (pino, level) {
-  const writable = new PinoWritable({ pino, level })
-  writable.write = writable.write.bind(writable)
-  return writable
-}
-
-module.exports = { PinoWritable, createPinoWritable }