@platformatic/runtime 1.46.0 → 1.48.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/fixtures/management-api-custom-labels/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "test-runtime-package",
+  "version": "1.0.42"
+}

package/fixtures/management-api-custom-labels/platformatic.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v1.22.0/runtime",
+  "entrypoint": "service-1",
+  "allowCycles": true,
+  "hotReload": false,
+  "autoload": {
+    "path": "./services"
+  },
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0
+  },
+  "managementApi": {
+    "logs": {
+      "maxSize": 15
+    }
+  },
+  "metrics": {
+    "labels": {
+      "foo": "bar"
+    }
+  }
+}

package/fixtures/management-api-custom-labels/services/service-1/platformatic.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v1.22.0/service",
+  "service": {
+    "openapi": true
+  },
+  "plugins": {
+    "paths": [
+      "plugin.js"
+    ]
+  },
+  "watch": true
+}

package/fixtures/management-api-custom-labels/services/service-1/plugin.js

@@ -0,0 +1,15 @@
+'use strict'
+
+/** @param {import('fastify').FastifyInstance} app */
+module.exports = async function (app) {
+  app.get('/hello', async () => {
+    return { service: 'service-2' }
+  })
+
+  app.get('/large-logs', async (req) => {
+    const largeLog = 'a'.repeat(100)
+    for (let i = 0; i < 500000; i++) {
+      app.log.trace(largeLog)
+    }
+  })
+}

package/fixtures/management-api-custom-labels/services/service-2/platformatic.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v1.22.0/service",
+  "service": {
+    "openapi": true
+  },
+  "plugins": {
+    "paths": ["plugin.js"]
+  }
+}

package/fixtures/management-api-custom-labels/services/service-2/plugin.js

@@ -0,0 +1,8 @@
+'use strict'
+
+/** @param {import('fastify').FastifyInstance} app */
+module.exports = async function (app, options) {
+  app.get('/hello', async () => {
+    return { service: 'service-2' }
+  })
+}

package/fixtures/management-api-custom-labels/services/service-db/migrations/001.do.sql

@@ -0,0 +1,4 @@
+CREATE TABLE IF NOT EXISTS movies (
+  id INTEGER PRIMARY KEY,
+  title TEXT NOT NULL
+);

package/fixtures/management-api-custom-labels/services/service-db/migrations/001.undo.sql

@@ -0,0 +1 @@
+DROP TABLE movies;

package/fixtures/management-api-custom-labels/services/service-db/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "@myscope/myname",
+  "version": "0.0.1",
+  "description": "test package.json"
+}

package/fixtures/management-api-custom-labels/services/service-db/platformatic.db.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.22.0/db",
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0
+  },
+  "migrations": {
+    "dir": "migrations",
+    "table": "versions",
+    "autoApply": true
+  },
+  "types": {
+    "autogenerate": false
+  },
+  "db": {
+    "connectionString": "sqlite://db.sqlite",
+    "graphql": true,
+    "ignore": {
+      "versions": true
+    },
+    "events": false
+  },
+  "plugins": {
+    "paths": [
+      "plugin.js"
+    ]
+  },
+  "watch": false
+}

package/fixtures/management-api-custom-labels/services/service-db/plugin.js

@@ -0,0 +1,12 @@
+'use strict'
+
+/** @param {import('fastify').FastifyInstance} app */
+module.exports = async function (app) {
+  app.get('/async_crash', async () => {
+    setImmediate(() => {
+      throw new Error('boom')
+    })
+
+    return 'ok'
+  })
+}

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

@@ -6,21 +6,30 @@ const { createFastifyInterceptor } = require('fastify-undici-dispatcher')
 const { PlatformaticApp } = require('./app')
 const errors = require('./errors')
 const { printSchema } = require('graphql')
+const { Bus } = require('@platformatic/bus')
 
 class RuntimeApi {
   #services
   #dispatcher
   #interceptor
   #logger
+  #bus
 
   constructor (config, logger, loaderPort, composedInterceptors = []) {
     this.#services = new Map()
     this.#logger = logger
+    this.#setupBus()
     const telemetryConfig = config.telemetry
+    const metricsConfig = config.metrics
 
     for (let i = 0; i < config.services.length; ++i) {
       const service = config.services[i]
-      const serviceTelemetryConfig = telemetryConfig ? { ...telemetryConfig, serviceName: `${telemetryConfig.serviceName}-${service.id}` } : null
+      const serviceTelemetryConfig = telemetryConfig
+        ? {
+            ...telemetryConfig,
+            serviceName: `${telemetryConfig.serviceName}-${service.id}`
+          }
+        : null
 
       // If the service is an entrypoint and runtime server config is defined, use it.
       let serverConfig = null
@@ -34,7 +43,7 @@ class RuntimeApi {
         }
       }
 
-      const app = new PlatformaticApp(service, loaderPort, logger, serviceTelemetryConfig, serverConfig, !!config.managementApi)
+      const app = new PlatformaticApp(service, loaderPort, logger, serviceTelemetryConfig, serverConfig, !!config.managementApi, metricsConfig)
 
       this.#services.set(service.id, app)
     }
@@ -105,7 +114,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 }
     }
   }
 
@@ -155,6 +164,7 @@ class RuntimeApi {
       const serviceUrl = new URL(service.appConfig.localUrl)
       this.#interceptor.route(serviceUrl.host, service.server)
     }
+    this.#bus.broadcast('runtime:services:started')
     return entrypointUrl
   }
 
@@ -172,6 +182,7 @@ class RuntimeApi {
       }
     }
     await Promise.all(stopServiceReqs)
+    this.#bus.broadcast('runtime:services:stopped')
   }
 
   async #restartServices () {
@@ -191,6 +202,7 @@ class RuntimeApi {
       const serviceUrl = new URL(service.appConfig.localUrl)
       this.#interceptor.route(serviceUrl.host, service.server)
     }
+    this.#bus.broadcast('runtime:services:restarted')
     return entrypointUrl
   }
 
@@ -308,30 +320,30 @@ class RuntimeApi {
   }
 
   async #getMetrics ({ format }) {
-    let entrypoint = null
+    let metrics = null
+
     for (const service of this.#services.values()) {
-      if (service.appConfig.entrypoint) {
-        entrypoint = service
-        break
+      const serviceId = service.appConfig.id
+      const serviceStatus = service.getStatus()
+      if (serviceStatus !== 'started') {
+        throw new errors.ServiceNotStartedError(serviceId)
       }
-    }
 
-    const entrypointStatus = entrypoint.getStatus()
-    if (entrypointStatus !== 'started') {
-      throw new errors.ServiceNotStartedError(entrypoint.id)
-    }
+      const promRegister = service.server.metrics?.client?.register
 
-    const promRegister = entrypoint.server.metrics?.client?.register
-    if (!promRegister) {
-      return { metrics: null }
+      if (promRegister) {
+        if (metrics === null) {
+          metrics = format === 'json' ? [] : ''
+        }
+        if (format === 'json') {
+          metrics.push(...await promRegister.getMetricsAsJSON())
+        } else {
+          const serviceMetrics = await promRegister.metrics()
+          metrics += serviceMetrics
+        }
+      }
     }
 
-    // All runtime services shares the same metrics registry.
-    // Getting metrics from the entrypoint returns all metrics.
-    const metrics = format === 'json'
-      ? await promRegister.getMetricsAsJSON()
-      : await promRegister.metrics()
-
     return { metrics }
   }
 
@@ -344,6 +356,7 @@ class RuntimeApi {
     } else {
       await service.start()
     }
+    this.#bus.broadcast('runtime:service:started', id)
   }
 
   async #stopService ({ id }) {
@@ -355,6 +368,7 @@ class RuntimeApi {
     }
 
     await service.stop()
+    this.#bus.broadcast('runtime:service:stopped', id)
   }
 
   async #inject ({ id, injectParams }) {
@@ -374,6 +388,10 @@ class RuntimeApi {
       body: res.body
     }
   }
+
+  #setupBus (config) {
+    this.#bus = new Bus('$root')
+  }
 }
 
 module.exports = RuntimeApi

package/lib/app.js

@@ -21,8 +21,9 @@ class PlatformaticApp extends EventEmitter {
   #serverConfig
   #debouncedRestart
   #hasManagementApi
+  #metricsConfig
 
-  constructor (appConfig, loaderPort, logger, telemetryConfig, serverConfig, hasManagementApi) {
+  constructor (appConfig, loaderPort, logger, telemetryConfig, serverConfig, hasManagementApi, metricsConfig) {
     super()
     this.appConfig = appConfig
     this.config = null
@@ -38,6 +39,7 @@ class PlatformaticApp extends EventEmitter {
       name: this.appConfig.id
     })
     this.#telemetryConfig = telemetryConfig
+    this.#metricsConfig = metricsConfig
     this.#serverConfig = serverConfig
 
     /* c8 ignore next 4 */
@@ -111,6 +113,7 @@ class PlatformaticApp extends EventEmitter {
       this.server = await buildServer({
         app: this.config.app,
         ...config,
+        id: this.appConfig.id,
         configManager
       })
     } catch (err) {
@@ -133,7 +136,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.
@@ -249,9 +253,17 @@ class PlatformaticApp extends EventEmitter {
     const { configManager } = this.config
     configManager.update({
       ...configManager.current,
-      telemetry: this.#telemetryConfig
+      telemetry: this.#telemetryConfig,
+      metrics: this.#metricsConfig
     })
 
+    if (configManager.current.metrics !== false) {
+      configManager.update({
+        ...configManager.current,
+        metrics: this.#metricsConfig
+      })
+    }
+
     if (this.#serverConfig) {
       configManager.update({
         ...configManager.current,

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

@@ -170,6 +170,10 @@ const platformaticRuntimeSchema = {
               },
               additionalProperties: false,
               required: ['username', 'password']
+            },
+            labels: {
+              type: 'object',
+              additionalProperties: { type: 'string' }
             }
           },
           additionalProperties: false

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.46.0",
+  "version": "1.48.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -21,7 +21,7 @@
     "@fastify/formbody": "^7.4.0",
     "@matteo.collina/tspl": "^0.1.1",
     "borp": "^0.15.0",
-    "c8": "^9.1.0",
+    "c8": "^10.0.0",
     "execa": "^8.0.1",
     "express": "^4.18.3",
     "fast-jwt": "^4.0.0",
@@ -34,8 +34,8 @@
     "typescript": "^5.4.2",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/sql-mapper": "1.46.0",
-    "@platformatic/sql-graphql": "1.46.0"
+    "@platformatic/sql-mapper": "1.48.0",
+    "@platformatic/sql-graphql": "1.48.0"
   },
   "dependencies": {
     "@fastify/error": "^3.4.1",
@@ -63,13 +63,14 @@
     "undici": "^6.9.0",
     "why-is-node-running": "^2.2.2",
     "ws": "^8.16.0",
-    "@platformatic/composer": "1.46.0",
-    "@platformatic/config": "1.46.0",
-    "@platformatic/service": "1.46.0",
-    "@platformatic/telemetry": "1.46.0",
-    "@platformatic/db": "1.46.0",
-    "@platformatic/generators": "1.46.0",
-    "@platformatic/utils": "1.46.0"
+    "@platformatic/bus": "1.48.0",
+    "@platformatic/composer": "1.48.0",
+    "@platformatic/db": "1.48.0",
+    "@platformatic/config": "1.48.0",
+    "@platformatic/generators": "1.48.0",
+    "@platformatic/service": "1.48.0",
+    "@platformatic/telemetry": "1.48.0",
+    "@platformatic/utils": "1.48.0"
   },
   "standard": {
     "ignore": [