@platformatic/runtime 1.35.5 → 1.36.1

package/fixtures/botched-start/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/botched-start/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/botched-start/services/a/plugin.js

@@ -0,0 +1,11 @@
+'use strict'
+
+const { setTimeout: sleep } = require('timers/promises')
+
+module.exports = async function (fastify, options) {
+  setImmediate(() => {
+    throw new Error('Crash!')
+  })
+
+  await sleep(1000)
+}

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

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

package/fixtures/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/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/lib/api-client.js

@@ -28,15 +28,32 @@ class RuntimeApiClient extends EventEmitter {
     super()
     this.setMaxListeners(MAX_LISTENERS_COUNT)
 
-    this.worker = worker
     this.#configManager = configManager
     this.#runtimeTmpDir = getRuntimeTmpDir(configManager.dirname)
+
+    this.setWorker(worker)
+  }
+
+  async setWorker (worker) {
+    if (!worker) {
+      throw new errors.WorkerIsRequired()
+    }
+    if (this.worker) {
+      this.worker.removeAllListeners('message')
+      // Ignore all things that happen after the worker has been replaced
+      this.#exitPromise.catch(() => {})
+    }
+    this.worker = worker
     this.#exitPromise = this.#exitHandler()
     this.worker.on('message', (message) => {
       if (message.operationId) {
         this.emit(message.operationId, message)
       }
     })
+
+    if (this.started) {
+      await this.start()
+    }
   }
 
   async #getRuntimePackageJson () {
@@ -72,11 +89,13 @@ class RuntimeApiClient extends EventEmitter {
 
   async start () {
     const address = await this.#sendCommand('plt:start-services')
+    this.started = true
     this.emit('start', address)
     return address
   }
 
   async close () {
+    this.started = false
     await this.#sendCommand('plt:stop-services')
 
     this.worker.postMessage({ command: 'plt:close' })

package/lib/errors.js

@@ -25,6 +25,7 @@ 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"'),
+  WorkerIsRequired: createError(`${ERROR_PREFIX}_REQUIRED_WORKER`, 'The worker parameter is required'),
 
   // TODO: should remove next one as it's not used anymore
   CannotRemoveServiceOnUpdateError: createError(`${ERROR_PREFIX}_CANNOT_REMOVE_SERVICE_ON_UPDATE`, 'Cannot remove service "%s" when updating a Runtime')

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/schema.js

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

package/lib/start.js

@@ -25,6 +25,18 @@ const kWorkerExecArgv = [
   kLoaderFile
 ]
 
+function startWorker ({ config, dirname, runtimeLogsDir }, env) {
+  const worker = new Worker(kWorkerFile, {
+    /* c8 ignore next */
+    execArgv: config.hotReload ? kWorkerExecArgv : [],
+    transferList: config.loggingPort ? [config.loggingPort] : [],
+    workerData: { config, dirname, runtimeLogsDir },
+    env
+  })
+
+  return worker
+}
+
 async function buildRuntime (configManager, env = process.env) {
   const config = configManager.current
 
@@ -46,60 +58,48 @@ async function buildRuntime (configManager, env = process.env) {
   // The configManager cannot be transferred to the worker, so remove it.
   delete config.configManager
 
-  const worker = new Worker(kWorkerFile, {
-    /* c8 ignore next */
-    execArgv: config.hotReload ? kWorkerExecArgv : [],
-    transferList: config.loggingPort ? [config.loggingPort] : [],
-    workerData: { config, dirname, runtimeLogsDir },
-    env
-  })
+  let worker = startWorker({ config, dirname, runtimeLogsDir }, env)
 
   let managementApi = null
 
-  let exited = null
-  let isWorkerAlive = true
-  worker.on('exit', (code) => {
-    // TODO(mcollina): refactor to not set this here
-    process.exitCode = code
-    isWorkerAlive = false
-    configManager.fileWatcher?.stopWatching()
-    managementApi?.close()
-    if (typeof exited === 'function') {
-      exited()
-    }
-  })
-
-  worker.on('error', () => {
-    // If this is the only 'error' handler, then exit the process as the default
-    // behavior. If anything else is listening for errors, then don't exit.
-    if (worker.listenerCount('error') === 1) {
-      // The error is logged in the worker.
-      process.exit(1)
-    }
-  })
-
   if (config.hotReload) {
     /* c8 ignore next 3 */
     process.on('SIGUSR2', () => {
       worker.postMessage({ signal: 'SIGUSR2' })
     })
 
-    // TODO(mcollina): refactor to not alter globals here
-    closeWithGrace((event, cb) => {
-      if (isWorkerAlive) {
-        worker.postMessage(event)
-        exited = cb
-      } else {
-        setImmediate(cb)
-      }
-    })
-
     /* c8 ignore next 3 */
     configManager.on('update', () => {
       // TODO(cjihrig): Need to clean up and restart the worker.
     })
   }
 
+  function setupExit () {
+    worker.on('exit', (code) => {
+      // runtimeApiClient.started can be false if a stop command was issued
+      // via the management API.
+      if (config.restartOnError === false || !runtimeApiClient.started) {
+        // We must stop those here in case the `closeWithGrace` callback
+        // was not called.
+        configManager.fileWatcher?.stopWatching()
+        managementApi?.close()
+        return
+      }
+
+      worker = startWorker({ config, dirname, runtimeLogsDir }, env)
+      setupExit()
+
+      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?
+        })
+      })
+    })
+  }
+
+  setupExit()
+
   await once(worker, 'message') // plt:init
 
   const runtimeApiClient = new RuntimeApiClient(
@@ -151,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 = {
@@ -176,32 +185,24 @@ async function startCommand (args) {
       await writeFile(toWrite, JSON.stringify(config, null, 2))
       return startCommand(['--config', toWrite])
     }
-    logErrorAndExit(err)
-  }
-}
 
-function logErrorAndExit (err) {
-  if (err.filenames) {
-    console.error(`Missing config file!
-Be sure to have a config file with one of the following names:
+    if (err.filenames) {
+      console.error(`Missing config file!
+  Be sure to have a config file with one of the following names:
 
-${err.filenames.map((s) => ' * ' + s).join('\n')}
+  ${err.filenames.map((s) => ' * ' + s).join('\n')}
 
-In alternative run "npm create platformatic@latest" to generate a basic plt service config.`)
-    process.exit(1)
-  } else if (err.validationErrors) {
-    printConfigValidationErrors(err)
-    process.exit(1)
-  }
+  In alternative run "npm create platformatic@latest" to generate a basic plt service config.`)
+      process.exit(1)
+    } else if (err.validationErrors) {
+      printConfigValidationErrors(err)
+      process.exit(1)
+    }
 
-  delete err?.stack
-  console.error(err?.message)
+    console.error(err)
 
-  if (err?.cause) {
-    console.error(`${err.cause}`)
+    process.exit(1)
   }
-
-  process.exit(1)
 }
 
 module.exports = { buildRuntime, start, startCommand }

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/lib/worker.js

@@ -98,10 +98,10 @@ process.on('uncaughtException', (err) => {
 
   if (stop) {
     stop().then(() => {
-      process.exit(1)
+      setImmediate(process.exit.bind(process), 1)
     })
   } else {
-    process.exit(1)
+    setImmediate(process.exit.bind(process), 1)
   }
 })
 
@@ -112,10 +112,10 @@ process.on('unhandledRejection', (err) => {
 
   if (stop) {
     stop().then(() => {
-      process.exit(1)
+      setImmediate(process.exit.bind(process), 1)
     })
   } else {
-    process.exit(1)
+    setImmediate(process.exit.bind(process), 1)
   }
 })
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "1.35.5",
+  "version": "1.36.1",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -17,7 +17,7 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
-    "@fastify/express": "^2.3.0",
+    "@fastify/express": "^3.0.0",
     "@fastify/formbody": "^7.4.0",
     "@matteo.collina/tspl": "^0.1.1",
     "borp": "^0.11.0",
@@ -25,6 +25,7 @@
     "execa": "^8.0.1",
     "express": "^4.18.3",
     "fast-jwt": "^3.3.3",
+    "get-port": "^7.1.0",
     "pino-abstract-transport": "^1.1.0",
     "snazzy": "^9.0.0",
     "split2": "^4.2.0",
@@ -33,11 +34,10 @@
     "typescript": "^5.4.2",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/sql-graphql": "1.35.5",
-    "@platformatic/sql-mapper": "1.35.5"
+    "@platformatic/sql-graphql": "1.36.1",
+    "@platformatic/sql-mapper": "1.36.1"
   },
   "dependencies": {
-    "ws": "^8.16.0",
     "@fastify/error": "^3.4.1",
     "@fastify/websocket": "^10.0.0",
     "@hapi/topo": "^6.0.2",
@@ -57,18 +57,19 @@
     "minimist": "^1.2.8",
     "pino": "^8.19.0",
     "pino-pretty": "^10.3.1",
-    "semgrator": "^0.3.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",
-    "@platformatic/config": "1.35.5",
-    "@platformatic/generators": "1.35.5",
-    "@platformatic/db": "1.35.5",
-    "@platformatic/service": "1.35.5",
-    "@platformatic/utils": "1.35.5",
-    "@platformatic/telemetry": "1.35.5",
-    "@platformatic/composer": "1.35.5"
+    "ws": "^8.16.0",
+    "@platformatic/composer": "1.36.1",
+    "@platformatic/config": "1.36.1",
+    "@platformatic/db": "1.36.1",
+    "@platformatic/generators": "1.36.1",
+    "@platformatic/service": "1.36.1",
+    "@platformatic/telemetry": "1.36.1",
+    "@platformatic/utils": "1.36.1"
   },
   "standard": {
     "ignore": [