@platformatic/runtime 1.36.0 → 1.36.2

package/fixtures/do-not-restart-on-crash/platformatic.runtime.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v1.20.0/runtime",
+  "entrypoint": "a",
+  "autoload": {
+    "path": "./services"
+  },
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": "{PORT}",
+    "logger": {
+      "level": "info"
+    }
+  }
+}

package/fixtures/do-not-restart-on-crash/services/a/platformatic.service.json

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

package/fixtures/do-not-restart-on-crash/services/a/plugin.js

@@ -0,0 +1,9 @@
+'use strict'
+
+module.exports = async function (fastify, options) {
+  fastify.post('/crash', async (_, reply) => {
+    setImmediate(() => {
+      throw new Error('Crash!')
+    })
+  })
+}

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

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v1.20.0/runtime",
+  "$schema": "https://platformatic.dev/schemas/v1.36.0/runtime",
   "entrypoint": "a",
   "autoload": {
     "path": "./services"

package/lib/api-client.js

@@ -88,8 +88,8 @@ class RuntimeApiClient extends EventEmitter {
   }
 
   async start () {
-    this.started = true
     const address = await this.#sendCommand('plt:start-services')
+    this.started = true
     this.emit('start', address)
     return address
   }

package/lib/errors.js

@@ -25,7 +25,6 @@ module.exports = {
   FailedToUnlinkManagementApiSocket: createError(`${ERROR_PREFIX}_FAILED_TO_UNLINK_MANAGEMENT_API_SOCKET`, 'Failed to unlink management API socket "%s"'),
   LogFileNotFound: createError(`${ERROR_PREFIX}_LOG_FILE_NOT_FOUND`, 'Log file with index %s not found', 404),
   CannotFindGeneratorForTemplateError: createError(`${ERROR_PREFIX}_CANNOT_FIND_GENERATOR_FOR_TEMPLATE`, 'Cannot find a generator for template "%s"'),
-  WorkerExitCodeError: createError(`${ERROR_PREFIX}_WORKER_EXIT_CODE`, 'The worker exited with non-zero exit code "%s"'),
   WorkerIsRequired: createError(`${ERROR_PREFIX}_REQUIRED_WORKER`, 'The worker parameter is required'),
 
   // TODO: should remove next one as it's not used anymore

package/lib/generator/runtime-generator.js

@@ -90,7 +90,7 @@ class RuntimeGenerator extends BaseGenerator {
     this.addServicesDependencies()
 
     this.addEnvVars({
-      PLT_SERVER_HOSTNAME: '0.0.0.0',
+      PLT_SERVER_HOSTNAME: '127.0.0.1',
       PORT: this.config.port || 3042,
       PLT_SERVER_LOGGER_LEVEL: this.config.logLevel || 'info',
       PLT_MANAGEMENT_API: true

package/lib/management-api.js

@@ -11,8 +11,7 @@ const errors = require('./errors')
 
 const PLATFORMATIC_TMP_DIR = join(tmpdir(), 'platformatic', 'runtimes')
 
-async function createManagementApi (runtimeApiClient) {
-  const app = fastify()
+async function managementApiPlugin (app, opts) {
   app.log.warn(
     'Runtime Management API is in the experimental stage. ' +
     'The feature is not subject to semantic versioning rules. ' +
@@ -20,174 +19,170 @@ async function createManagementApi (runtimeApiClient) {
     'Use of the feature is not recommended in production environments.'
   )
 
-  app.register(require('@fastify/websocket'))
-
-  app.register(async (app) => {
-    app.get('/metadata', async () => {
-      return runtimeApiClient.getRuntimeMetadata()
-    })
-
-    app.get('/config', async () => {
-      return runtimeApiClient.getRuntimeConfig()
-    })
-
-    app.get('/env', async () => {
-      return process.env
-    })
-
-    app.post('/stop', async () => {
-      app.log.debug('stop services')
-      await runtimeApiClient.close()
-    })
-
-    app.post('/reload', async () => {
-      app.log.debug('reload services')
-      await runtimeApiClient.restart()
-    })
-
-    app.get('/services', async () => {
-      return runtimeApiClient.getServices()
-    })
-
-    app.get('/services/:id', async (request) => {
-      const { id } = request.params
-      app.log.debug('get service details', { id })
-      return runtimeApiClient.getServiceDetails(id)
-    })
-
-    app.get('/services/:id/config', async (request) => {
-      const { id } = request.params
-      app.log.debug('get service config', { id })
-      return runtimeApiClient.getServiceConfig(id)
-    })
-
-    app.post('/services/:id/start', async (request) => {
-      const { id } = request.params
-      app.log.debug('start service', { id })
-      await runtimeApiClient.startService(id)
-    })
+  const runtime = opts.runtime
+
+  app.get('/metadata', async () => {
+    return runtime.getRuntimeMetadata()
+  })
+
+  app.get('/config', async () => {
+    return runtime.getRuntimeConfig()
+  })
+
+  app.get('/env', async () => {
+    return process.env
+  })
+
+  app.post('/stop', async () => {
+    app.log.debug('stop services')
+    await runtime.close()
+  })
+
+  app.post('/reload', async () => {
+    app.log.debug('reload services')
+    await runtime.restart()
+  })
+
+  app.get('/services', async () => {
+    return runtime.getServices()
+  })
+
+  app.get('/services/:id', async (request) => {
+    const { id } = request.params
+    app.log.debug('get service details', { id })
+    return runtime.getServiceDetails(id)
+  })
+
+  app.get('/services/:id/config', async (request) => {
+    const { id } = request.params
+    app.log.debug('get service config', { id })
+    return runtime.getServiceConfig(id)
+  })
+
+  app.post('/services/:id/start', async (request) => {
+    const { id } = request.params
+    app.log.debug('start service', { id })
+    await runtime.startService(id)
+  })
+
+  app.post('/services/:id/stop', async (request) => {
+    const { id } = request.params
+    app.log.debug('stop service', { id })
+    await runtime.stopService(id)
+  })
+
+  app.all('/services/:id/proxy/*', async (request, reply) => {
+    const { id, '*': requestUrl } = request.params
+    app.log.debug('proxy request', { id, requestUrl })
+
+    delete request.headers.connection
+    delete request.headers['content-length']
+    delete request.headers['content-encoding']
+    delete request.headers['transfer-encoding']
+
+    const injectParams = {
+      method: request.method,
+      url: requestUrl || '/',
+      headers: request.headers,
+      query: request.query,
+      body: request.body
+    }
 
-    app.post('/services/:id/stop', async (request) => {
-      const { id } = request.params
-      app.log.debug('stop service', { id })
-      await runtimeApiClient.stopService(id)
-    })
+    const res = await runtime.inject(id, injectParams)
+
+    reply
+      .code(res.statusCode)
+      .headers(res.headers)
+      .send(res.body)
+  })
+
+  app.get('/metrics/live', { websocket: true }, async (socket) => {
+    const cachedMetrics = runtime.getCachedMetrics()
+    if (cachedMetrics.length > 0) {
+      const serializedMetrics = cachedMetrics
+        .map((metric) => JSON.stringify(metric))
+        .join('\n')
+      socket.send(serializedMetrics + '\n')
+    }
 
-    app.all('/services/:id/proxy/*', async (request, reply) => {
-      const { id, '*': requestUrl } = request.params
-      app.log.debug('proxy request', { id, requestUrl })
-
-      delete request.headers.connection
-      delete request.headers['content-length']
-      delete request.headers['content-encoding']
-      delete request.headers['transfer-encoding']
-
-      const injectParams = {
-        method: request.method,
-        url: requestUrl || '/',
-        headers: request.headers,
-        query: request.query,
-        body: request.body
-      }
+    const eventHandler = (metrics) => {
+      const serializedMetrics = JSON.stringify(metrics)
+      socket.send(serializedMetrics + '\n')
+    }
 
-      const res = await runtimeApiClient.inject(id, injectParams)
+    runtime.on('metrics', eventHandler)
 
-      reply
-        .code(res.statusCode)
-        .headers(res.headers)
-        .send(res.body)
+    socket.on('error', () => {
+      runtime.off('metrics', eventHandler)
     })
 
-    app.get('/metrics/live', { websocket: true }, async (socket) => {
-      const cachedMetrics = runtimeApiClient.getCachedMetrics()
-      if (cachedMetrics.length > 0) {
-        const serializedMetrics = cachedMetrics
-          .map((metric) => JSON.stringify(metric))
-          .join('\n')
-        socket.send(serializedMetrics + '\n')
-      }
-
-      const eventHandler = (metrics) => {
-        const serializedMetrics = JSON.stringify(metrics)
-        socket.send(serializedMetrics + '\n')
-      }
-
-      runtimeApiClient.on('metrics', eventHandler)
-
-      socket.on('error', () => {
-        runtimeApiClient.off('metrics', eventHandler)
-      })
-
-      socket.on('close', () => {
-        runtimeApiClient.off('metrics', eventHandler)
-      })
+    socket.on('close', () => {
+      runtime.off('metrics', eventHandler)
     })
+  })
 
-    app.get('/logs/live', { websocket: true }, async (socket, req) => {
-      const startLogId = req.query.start ? parseInt(req.query.start) : null
+  app.get('/logs/live', { websocket: true }, async (socket, req) => {
+    const startLogId = req.query.start ? parseInt(req.query.start) : null
 
-      if (startLogId) {
-        const logIds = await runtimeApiClient.getLogIds()
-        if (!logIds.includes(startLogId)) {
-          throw new errors.LogFileNotFound(startLogId)
-        }
+    if (startLogId) {
+      const logIds = await runtime.getLogIds()
+      if (!logIds.includes(startLogId)) {
+        throw new errors.LogFileNotFound(startLogId)
       }
+    }
 
-      const stream = ws.createWebSocketStream(socket)
-      runtimeApiClient.pipeLogsStream(stream, req.log, startLogId)
-    })
-
-    app.get('/logs/indexes', async (req) => {
-      const returnAllIds = req.query.all === 'true'
+    const stream = ws.createWebSocketStream(socket)
+    runtime.pipeLogsStream(stream, req.log, startLogId)
+  })
 
-      if (returnAllIds) {
-        const runtimesLogsIds = await runtimeApiClient.getAllLogIds()
-        return runtimesLogsIds
-      }
+  app.get('/logs/indexes', async (req) => {
+    const returnAllIds = req.query.all === 'true'
 
-      const runtimeLogsIds = await runtimeApiClient.getLogIds()
-      return { indexes: runtimeLogsIds }
-    })
+    if (returnAllIds) {
+      const runtimesLogsIds = await runtime.getAllLogIds()
+      return runtimesLogsIds
+    }
 
-    app.get('/logs/all', async (req, reply) => {
-      const runtimePID = parseInt(req.query.pid) || process.pid
+    const runtimeLogsIds = await runtime.getLogIds()
+    return { indexes: runtimeLogsIds }
+  })
 
-      const logsIds = await runtimeApiClient.getLogIds(runtimePID)
-      const startLogId = logsIds.at(0)
-      const endLogId = logsIds.at(-1)
+  app.get('/logs/all', async (req, reply) => {
+    const runtimePID = parseInt(req.query.pid) || process.pid
 
-      reply.hijack()
+    const logsIds = await runtime.getLogIds(runtimePID)
+    const startLogId = logsIds.at(0)
+    const endLogId = logsIds.at(-1)
 
-      runtimeApiClient.pipeLogsStream(
-        reply.raw,
-        req.log,
-        startLogId,
-        endLogId,
-        runtimePID
-      )
-    })
+    reply.hijack()
 
-    app.get('/logs/:id', async (req) => {
-      const logId = parseInt(req.params.id)
-      const runtimePID = parseInt(req.query.pid) || process.pid
+    runtime.pipeLogsStream(
+      reply.raw,
+      req.log,
+      startLogId,
+      endLogId,
+      runtimePID
+    )
+  })
 
-      const logIds = await runtimeApiClient.getLogIds(runtimePID)
-      if (!logIds || !logIds.includes(logId)) {
-        throw new errors.LogFileNotFound(logId)
-      }
+  app.get('/logs/:id', async (req) => {
+    const logId = parseInt(req.params.id)
+    const runtimePID = parseInt(req.query.pid) || process.pid
 
-      const logFileStream = await runtimeApiClient.getLogFileStream(
-        logId,
-        runtimePID
-      )
-      return logFileStream
-    })
-  }, { prefix: '/api/v1' })
+    const logIds = await runtime.getLogIds(runtimePID)
+    if (!logIds || !logIds.includes(logId)) {
+      throw new errors.LogFileNotFound(logId)
+    }
 
-  return app
+    const logFileStream = await runtime.getLogFileStream(
+      logId,
+      runtimePID
+    )
+    return logFileStream
+  })
 }
 
-async function startManagementApi (runtimeApiClient, configManager) {
+async function startManagementApi (runtime, configManager) {
   const runtimePID = process.pid
 
   try {
@@ -208,7 +203,9 @@ async function startManagementApi (runtimeApiClient, configManager) {
       socketPath = join(runtimePIDDir, 'socket')
     }
 
-    const managementApi = await createManagementApi(runtimeApiClient)
+    const managementApi = fastify()
+    managementApi.register(require('@fastify/websocket'))
+    managementApi.register(managementApiPlugin, { runtime, prefix: '/api/v1' })
 
     managementApi.addHook('onClose', async () => {
       if (platform() !== 'win32') {
@@ -225,4 +222,4 @@ async function startManagementApi (runtimeApiClient, configManager) {
   }
 }
 
-module.exports = { startManagementApi, createManagementApi }
+module.exports = { startManagementApi, managementApiPlugin }

package/lib/schema.js

@@ -172,6 +172,13 @@ const platformaticRuntimeSchema = {
         }
       ]
     },
+    restartOnError: {
+      default: true,
+      anyOf: [
+        { type: 'boolean' },
+        { type: 'string' }
+      ]
+    },
     services: {
       type: 'array',
       items: {

package/lib/start.js

@@ -4,7 +4,6 @@ const { once } = require('node:events')
 const inspector = require('node:inspector')
 const { join, resolve, dirname } = require('node:path')
 const { writeFile } = require('node:fs/promises')
-const { setTimeout: sleep } = require('node:timers/promises')
 const { pathToFileURL } = require('node:url')
 const { Worker } = require('node:worker_threads')
 const { start: serviceStart } = require('@platformatic/service')
@@ -13,7 +12,6 @@ const closeWithGrace = require('close-with-grace')
 const { loadConfig } = require('./load-config')
 const { startManagementApi } = require('./management-api')
 const { startPrometheusServer } = require('./prom-server.js')
-const { WorkerExitCodeError } = require('./errors')
 const { parseInspectorOptions, wrapConfigInRuntimeConfig } = require('./config')
 const { RuntimeApiClient, getRuntimeLogsDir } = require('./api-client.js')
 const errors = require('./errors')
@@ -64,19 +62,6 @@ async function buildRuntime (configManager, env = process.env) {
 
   let managementApi = null
 
-  let exiting = false
-  closeWithGrace((event, cb) => {
-    exiting = true
-    worker.postMessage(event)
-    worker.once('exit', (code) => {
-      if (code !== 0) {
-        cb(new WorkerExitCodeError(code))
-        return
-      }
-      cb()
-    })
-  })
-
   if (config.hotReload) {
     /* c8 ignore next 3 */
     process.on('SIGUSR2', () => {
@@ -93,7 +78,7 @@ async function buildRuntime (configManager, env = process.env) {
     worker.on('exit', (code) => {
       // runtimeApiClient.started can be false if a stop command was issued
       // via the management API.
-      if (exiting || !runtimeApiClient.started) {
+      if (config.restartOnError === false || !runtimeApiClient.started) {
         // We must stop those here in case the `closeWithGrace` callback
         // was not called.
         configManager.fileWatcher?.stopWatching()
@@ -103,8 +88,12 @@ async function buildRuntime (configManager, env = process.env) {
 
       worker = startWorker({ config, dirname, runtimeLogsDir }, env)
       setupExit()
-      once(worker, 'message').then(() => {
-        runtimeApiClient.setWorker(worker)
+
+      once(worker, 'message').then((msg) => {
+        runtimeApiClient.setWorker(worker).catch(() => {
+          // TODO: currently we restart if the worker fails to start intermitently
+          // should we limit this to a number of retries?
+        })
       })
     })
   }
@@ -162,7 +151,16 @@ async function startCommand (args) {
       runtime = await buildRuntime(wrappedConfig)
     }
 
-    return await runtime.start()
+    const res = await runtime.start()
+
+    closeWithGrace(async (event) => {
+      if (event.err instanceof Error) {
+        console.error(event.err)
+      }
+      await runtime.close()
+    })
+
+    return res
   } catch (err) {
     if (err.code === 'PLT_CONFIG_NO_CONFIG_FILE_FOUND' && args.length === 1) {
       const config = {
@@ -188,12 +186,6 @@ async function startCommand (args) {
       return startCommand(['--config', toWrite])
     }
 
-    if (err.code === 'PLT_RUNTIME_RUNTIME_EXIT') {
-      console.log('Runtime exited before startup was completed, restarting')
-      await sleep(1000)
-      return startCommand(args)
-    }
-
     if (err.filenames) {
       console.error(`Missing config file!
   Be sure to have a config file with one of the following names:
@@ -207,12 +199,7 @@ async function startCommand (args) {
       process.exit(1)
     }
 
-    delete err?.stack
-    console.error(err?.message)
-
-    if (err?.cause) {
-      console.error(`${err.cause}`)
-    }
+    console.error(err)
 
     process.exit(1)
   }

package/lib/versions/v1.36.0.js

@@ -0,0 +1,11 @@
+'use strict'
+
+module.exports = {
+  version: '1.36.0',
+  up: function (config) {
+    if (config.restartOnError === undefined) {
+      config.restartOnError = false
+    }
+    return config
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "1.36.0",
+  "version": "1.36.2",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -20,7 +20,7 @@
     "@fastify/express": "^3.0.0",
     "@fastify/formbody": "^7.4.0",
     "@matteo.collina/tspl": "^0.1.1",
-    "borp": "^0.11.0",
+    "borp": "^0.12.0",
     "c8": "^9.1.0",
     "execa": "^8.0.1",
     "express": "^4.18.3",
@@ -34,8 +34,8 @@
     "typescript": "^5.4.2",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/sql-graphql": "1.36.0",
-    "@platformatic/sql-mapper": "1.36.0"
+    "@platformatic/sql-mapper": "1.36.2",
+    "@platformatic/sql-graphql": "1.36.2"
   },
   "dependencies": {
     "@fastify/error": "^3.4.1",
@@ -56,20 +56,20 @@
     "help-me": "^5.0.0",
     "minimist": "^1.2.8",
     "pino": "^8.19.0",
-    "pino-pretty": "^10.3.1",
+    "pino-pretty": "^11.0.0",
     "pino-roll": "^1.0.0",
     "semgrator": "^0.3.0",
     "tail-file-stream": "^0.1.0",
     "undici": "^6.9.0",
     "why-is-node-running": "^2.2.2",
     "ws": "^8.16.0",
-    "@platformatic/db": "1.36.0",
-    "@platformatic/config": "1.36.0",
-    "@platformatic/composer": "1.36.0",
-    "@platformatic/service": "1.36.0",
-    "@platformatic/generators": "1.36.0",
-    "@platformatic/telemetry": "1.36.0",
-    "@platformatic/utils": "1.36.0"
+    "@platformatic/composer": "1.36.2",
+    "@platformatic/config": "1.36.2",
+    "@platformatic/db": "1.36.2",
+    "@platformatic/generators": "1.36.2",
+    "@platformatic/service": "1.36.2",
+    "@platformatic/telemetry": "1.36.2",
+    "@platformatic/utils": "1.36.2"
   },
   "standard": {
     "ignore": [