@platformatic/runtime 1.45.1 → 1.47.0

package/fixtures/configs/service-with-env-port.json

@@ -0,0 +1,33 @@
+{
+    "$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
+    "entrypoint": "serviceApp",
+    "allowCycles": true,
+    "hotReload": false,
+    "managementApi": false,
+    "autoload": {
+      "path": "../monorepo",
+      "exclude": [
+        "docs",
+        "composerApp"
+      ],
+      "mappings": {
+        "serviceAppWithLogger": {
+          "id": "with-logger",
+          "config": "platformatic.service.json"
+        },
+        "serviceAppWithMultiplePlugins": {
+          "id": "multi-plugin-service",
+          "config": "platformatic.service.json"
+        },
+        "dbApp": {
+          "id": "db-app",
+          "config": "platformatic.db.json"
+        }
+      }
+    },
+    "server":{
+        "hostname":"127.0.0.1",
+        "port":"{PORT}"
+    }
+  }
+  

package/lib/api-client.js

@@ -265,6 +265,7 @@ class RuntimeApiClient extends EventEmitter {
         metrics = await this.getFormattedMetrics()
       } catch (error) {
         if (!(error instanceof errors.RuntimeExitedError)) {
+          // TODO(mcollina): use the logger
           console.error('Error collecting metrics', error)
         }
         return
@@ -449,19 +450,22 @@ class RuntimeApiClient extends EventEmitter {
 
   async #sendCommand (command, params = {}) {
     const operationId = randomUUID()
-
     this.worker.postMessage({ operationId, command, params })
     const [message] = await Promise.race(
       [once(this, operationId), this.#exitPromise]
     )
 
     if (this.#exitCode !== undefined) {
+      if (this.exitCode === 1) {
+        throw new errors.AddressInUseError()
+      }
       throw new errors.RuntimeExitedError()
     }
-
-    const { error, data } = message
+    const { error, data, code } = message
     if (error !== null) {
-      throw new Error(error)
+      const err = new Error(error)
+      err.code = code
+      throw err
     }
 
     return JSON.parse(data)

package/lib/api.js

@@ -105,7 +105,7 @@ class RuntimeApi {
       const res = await this.#runCommandHandler(command, params)
       return { operationId, error: null, data: JSON.stringify(res || null) }
     } catch (err) {
-      return { operationId, error: err.message }
+      return { operationId, error: err.message, code: err.code }
     }
   }
 

package/lib/app.js

@@ -133,7 +133,8 @@ class PlatformaticApp extends EventEmitter {
         /* c8 ignore next 5 */
       } catch (err) {
         this.server.log.error({ err })
-        process.exit(1)
+        this.#starting = false
+        throw err
       }
     } else {
       // Make sure the server has run all the onReady hooks before returning.

package/lib/errors.js

@@ -5,6 +5,7 @@ const createError = require('@fastify/error')
 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'),
   UnknownRuntimeAPICommandError: createError(`${ERROR_PREFIX}_UNKNOWN_RUNTIME_API_COMMAND`, 'Unknown Runtime API command "%s"'),
   ServiceNotFoundError: createError(`${ERROR_PREFIX}_SERVICE_NOT_FOUND`, 'Service not found. Available services are: %s'),

package/lib/start.js

@@ -16,6 +16,8 @@ const { parseInspectorOptions, wrapConfigInRuntimeConfig } = require('./config')
 const { RuntimeApiClient, getRuntimeLogsDir } = require('./api-client.js')
 const errors = require('./errors')
 const pkg = require('../package.json')
+const pino = require('pino')
+const pretty = require('pino-pretty')
 
 const kLoaderFile = pathToFileURL(join(__dirname, 'loader.mjs')).href
 const kWorkerFile = join(__dirname, 'worker.js')
@@ -138,21 +140,58 @@ async function start (args) {
   return serviceStart(config.app, args)
 }
 
+async function setupAndStartRuntime (config) {
+  const MAX_PORT = 65535
+  let runtimeConfig
+
+  if (config.configType === 'runtime') {
+    config.configManager.args = config.args
+    runtimeConfig = config.configManager
+  } else {
+    const wrappedConfig = await wrapConfigInRuntimeConfig(config)
+    wrappedConfig.args = config.args
+    runtimeConfig = wrappedConfig
+  }
+
+  let runtime = await buildRuntime(runtimeConfig)
+
+  let address = null
+  let startErr = null
+  const originalPort = runtimeConfig.current.server?.port || 0
+  while (address === null) {
+    try {
+      address = await runtime.start()
+    } catch (err) {
+      startErr = err
+      if (err.code === 'EADDRINUSE') {
+        await runtime.close()
+        if (runtimeConfig.current.server.port > MAX_PORT) throw err
+        runtimeConfig.current.server.port++
+        runtime = await buildRuntime(runtimeConfig)
+      } else {
+        throw err
+      }
+    }
+  }
+  if (startErr?.code === 'PLT_RUNTIME_EADDR_IN_USE') {
+    const logger = pino(pretty({
+      translateTime: 'SYS:HH:MM:ss',
+      ignore: 'hostname,pid'
+    }))
+    logger.warn(`Port: ${originalPort} is already in use!`)
+    logger.warn(`Starting service on port: ${runtimeConfig.current.server.port}`)
+  }
+  return { address, runtime }
+}
+
 async function startCommand (args) {
   try {
     const config = await loadConfig({}, args)
-    let runtime
-
-    if (config.configType === 'runtime') {
-      config.configManager.args = config.args
-      runtime = await buildRuntime(config.configManager)
-    } else {
-      const wrappedConfig = await wrapConfigInRuntimeConfig(config)
-      wrappedConfig.args = config.args
-      runtime = await buildRuntime(wrappedConfig)
-    }
 
-    const res = await runtime.start()
+    const startResult = await setupAndStartRuntime(config)
+
+    const runtime = startResult.runtime
+    const res = startResult.address
 
     closeWithGrace(async (event) => {
       if (event.err instanceof Error) {
@@ -206,4 +245,4 @@ async function startCommand (args) {
   }
 }
 
-module.exports = { buildRuntime, start, startCommand }
+module.exports = { buildRuntime, start, startCommand, setupAndStartRuntime }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "1.45.1",
+  "version": "1.47.0",
   "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.14.0",
+    "borp": "^0.15.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.45.1",
-    "@platformatic/sql-mapper": "1.45.1"
+    "@platformatic/sql-graphql": "1.47.0",
+    "@platformatic/sql-mapper": "1.47.0"
   },
   "dependencies": {
     "@fastify/error": "^3.4.1",
@@ -63,13 +63,13 @@
     "undici": "^6.9.0",
     "why-is-node-running": "^2.2.2",
     "ws": "^8.16.0",
-    "@platformatic/composer": "1.45.1",
-    "@platformatic/config": "1.45.1",
-    "@platformatic/generators": "1.45.1",
-    "@platformatic/db": "1.45.1",
-    "@platformatic/telemetry": "1.45.1",
-    "@platformatic/service": "1.45.1",
-    "@platformatic/utils": "1.45.1"
+    "@platformatic/composer": "1.47.0",
+    "@platformatic/config": "1.47.0",
+    "@platformatic/service": "1.47.0",
+    "@platformatic/db": "1.47.0",
+    "@platformatic/telemetry": "1.47.0",
+    "@platformatic/generators": "1.47.0",
+    "@platformatic/utils": "1.47.0"
   },
   "standard": {
     "ignore": [