@platformatic/runtime 2.0.0-alpha.8 → 2.0.0

package/lib/runtime.js

@@ -7,12 +7,8 @@ const inspector = require('node:inspector')
 const { join } = require('node:path')
 const { setTimeout: sleep } = require('node:timers/promises')
 const { Worker } = require('node:worker_threads')
-
 const { ITC } = require('@platformatic/itc')
-const {
-  errors: { ensureLoggableError },
-  executeWithTimeout
-} = require('@platformatic/utils')
+const { ensureLoggableError, executeWithTimeout } = require('@platformatic/utils')
 const ts = require('tail-file-stream')
 const { createThreadInterceptor } = require('undici-thread-interceptor')
 
@@ -22,7 +18,7 @@ const { createLogger } = require('./logger')
 const { startManagementApi } = require('./management-api')
 const { startPrometheusServer } = require('./prom-server')
 const { getRuntimeTmpDir } = require('./utils')
-const { sendViaITC } = require('./worker/itc')
+const { sendViaITC, waitEventFromITC } = require('./worker/itc')
 const { kId, kITC, kConfig } = require('./worker/symbols')
 
 const platformaticVersion = require('../package.json').version
@@ -151,7 +147,7 @@ class Runtime extends EventEmitter {
       this.startCollectingMetrics()
     }
 
-    this.logger.info(`Platformatic is now listening at ${this.#url}`)
+    this.#showUrl()
     return this.#url
   }
 
@@ -176,7 +172,6 @@ class Runtime extends EventEmitter {
 
     this.emit('restarted')
 
-    this.logger.info(`Platformatic is now listening at ${this.#url}`)
     return this.#url
   }
 
@@ -458,6 +453,10 @@ class Runtime extends EventEmitter {
     }
   }
 
+  getRuntimeEnv () {
+    return this.#configManager.env
+  }
+
   getRuntimeConfig () {
     return this.#configManager.current
   }
@@ -530,6 +529,12 @@ class Runtime extends EventEmitter {
     return sendViaITC(service, 'getServiceConfig')
   }
 
+  async getServiceEnv (id) {
+    const service = await this.#getServiceById(id, true)
+
+    return sendViaITC(service, 'getServiceEnv')
+  }
+
   async getServiceOpenapiSchema (id) {
     const service = await this.#getServiceById(id, true)
 
@@ -724,6 +729,10 @@ class Runtime extends EventEmitter {
     this.emit(status)
   }
 
+  #showUrl () {
+    this.logger.info(`Platformatic is now listening at ${this.#url}`)
+  }
+
   async #setupService (serviceConfig) {
     if (this.#status === 'stopping' || this.#status === 'closed') return
 
@@ -778,7 +787,9 @@ class Runtime extends EventEmitter {
 
       // Wait for the next tick so that crashed from the thread are logged first
       setImmediate(() => {
-        this.logger.warn(`Service "${id}" unexpectedly exited with code ${code}.`)
+        if (!config.watch || code !== 0) {
+          this.logger.warn(`Service "${id}" unexpectedly exited with code ${code}.`)
+        }
 
         // Restart the service if it was started
         if (started && this.#status === 'started') {
@@ -822,6 +833,10 @@ class Runtime extends EventEmitter {
         }
 
         this.logger?.info(`Service ${id} has been successfully reloaded ...`)
+
+        if (serviceConfig.entrypoint) {
+          this.#showUrl()
+        }
       } catch (e) {
         this.logger?.error(e)
       }
@@ -839,7 +854,7 @@ class Runtime extends EventEmitter {
     this.#interceptor.route(id, service)
 
     // Store dependencies
-    const [{ dependencies }] = await once(service[kITC], 'init')
+    const [{ dependencies }] = await waitEventFromITC(service, 'init')
 
     if (autoload) {
       serviceConfig.dependencies = dependencies

package/lib/schema.js

@@ -3,10 +3,37 @@
 
 const telemetry = require('@platformatic/telemetry').schema
 const {
-  schemaComponents: { server }
+  schemaComponents: { server, logger }
 } = require('@platformatic/utils')
 
+const services = {
+  type: 'array',
+  items: {
+    type: 'object',
+    anyOf: [{ required: ['id', 'path'] }, { required: ['id', 'url'] }],
+    properties: {
+      id: {
+        type: 'string'
+      },
+      path: {
+        type: 'string',
+        resolvePath: true
+      },
+      config: {
+        type: 'string'
+      },
+      url: {
+        type: 'string'
+      },
+      useHttp: {
+        type: 'boolean'
+      }
+    }
+  }
+}
+
 const pkg = require('../package.json')
+
 const platformaticRuntimeSchema = {
   $id: `https://schemas.platformatic.dev/@platformatic/runtime/${pkg.version}.json`,
   $schema: 'http://json-schema.org/draft-07/schema#',
@@ -19,6 +46,9 @@ const platformaticRuntimeSchema = {
       type: 'string',
       resolvePath: true
     },
+    entrypoint: {
+      type: 'string'
+    },
     autoload: {
       type: 'object',
       additionalProperties: false,
@@ -56,38 +86,20 @@ const platformaticRuntimeSchema = {
         }
       }
     },
-    telemetry,
+    services,
+    web: services,
+    logger,
     server,
-    entrypoint: {
-      type: 'string'
-    },
-    watch: {
+    restartOnError: {
+      default: true,
       anyOf: [
+        { type: 'boolean' },
         {
-          type: 'boolean'
-        },
-        {
-          type: 'string'
+          type: 'number',
+          minimum: 100
         }
       ]
     },
-    inspectorOptions: {
-      type: 'object',
-      properties: {
-        host: {
-          type: 'string'
-        },
-        port: {
-          type: 'number'
-        },
-        breakFirstLine: {
-          type: 'boolean'
-        },
-        watchDisabled: {
-          type: 'boolean'
-        }
-      }
-    },
     undici: {
       type: 'object',
       properties: {
@@ -130,6 +142,16 @@ const platformaticRuntimeSchema = {
         }
       }
     },
+    watch: {
+      anyOf: [
+        {
+          type: 'boolean'
+        },
+        {
+          type: 'string'
+        }
+      ]
+    },
     managementApi: {
       anyOf: [
         { type: 'boolean' },
@@ -138,11 +160,15 @@ const platformaticRuntimeSchema = {
           type: 'object',
           properties: {
             logs: {
-              maxSize: {
-                type: 'number',
-                minimum: 5,
-                default: 200
-              }
+              type: 'object',
+              properties: {
+                maxSize: {
+                  type: 'number',
+                  minimum: 5,
+                  default: 200
+                }
+              },
+              additionalProperties: false
             }
           },
           additionalProperties: false
@@ -179,43 +205,30 @@ const platformaticRuntimeSchema = {
         }
       ]
     },
-    restartOnError: {
-      default: true,
-      anyOf: [
-        { type: 'boolean' },
-        {
-          type: 'number',
-          minimum: 100
-        }
-      ]
-    },
-    services: {
-      type: 'array',
-      items: {
-        type: 'object',
-        anyOf: [{ required: ['id', 'path'] }, { required: ['id', 'url'] }],
-        properties: {
-          id: {
-            type: 'string'
-          },
-          path: {
-            type: 'string',
-            resolvePath: true
-          },
-          config: {
-            type: 'string'
-          },
-          url: {
-            type: 'string'
-          },
-          useHttp: {
-            type: 'boolean'
-          }
+    telemetry,
+    inspectorOptions: {
+      type: 'object',
+      properties: {
+        host: {
+          type: 'string'
+        },
+        port: {
+          type: 'number'
+        },
+        breakFirstLine: {
+          type: 'boolean'
+        },
+        watchDisabled: {
+          type: 'boolean'
         }
       }
     }
   },
-  anyOf: [{ required: ['autoload', 'entrypoint'] }, { required: ['services', 'entrypoint'] }],
+  anyOf: [
+    { required: ['autoload', 'entrypoint'] },
+    { required: ['services', 'entrypoint'] },
+    { required: ['web', 'entrypoint'] }
+  ],
   additionalProperties: false,
   $defs: {
     undiciInterceptor: {

package/lib/start.js

@@ -45,7 +45,13 @@ async function buildRuntime (configManager, env) {
     }
   })
 
-  await runtime.init()
+  try {
+    await runtime.init()
+  } catch (e) {
+    await runtime.close()
+    throw e
+  }
+
   return runtime
 }
 
@@ -108,7 +114,7 @@ async function setupAndStartRuntime (config) {
   return { address, runtime }
 }
 
-async function startCommand (args) {
+async function startCommand (args, throwAllErrors = false, returnRuntime = false) {
   try {
     const config = await loadConfig(
       {
@@ -132,8 +138,12 @@ async function startCommand (args) {
       await runtime.close()
     })
 
-    return res
+    return returnRuntime ? runtime : res
   } catch (err) {
+    if (throwAllErrors) {
+      throw err
+    }
+
     if (err.code === 'PLT_CONFIG_NO_CONFIG_FILE_FOUND' && args.length === 1) {
       const config = {
         $schema: `https://schemas.platformatic.dev/@platformatic/service/${pkg.version}.json`,

package/lib/upgrade.js

@@ -2,8 +2,6 @@
 
 const { join } = require('node:path')
 
-const pkg = require('../package.json')
-
 module.exports = async function upgrade (config, version) {
   const { semgrator } = await import('semgrator')
 
@@ -20,7 +18,5 @@ module.exports = async function upgrade (config, version) {
     result = updated.result
   }
 
-  result.$schema = `https://schemas.platformatic.dev/@platformatic/runtime/${pkg.version}.json`
-
   return result
 }

package/lib/utils.js

@@ -7,7 +7,7 @@ const { join } = require('node:path')
 const {
   Store,
   loadConfig: pltConfigLoadConfig,
-  loadEmptyConfig: pltConfigLoadEmptyConfig,
+  loadEmptyConfig: pltConfigLoadEmptyConfig
 } = require('@platformatic/config')
 
 const { platformaticRuntime } = require('./config')
@@ -37,6 +37,22 @@ async function loadConfig (minimistConfig, args, overrides, replaceEnv = true) {
   const { default: platformaticBasic } = await import('@platformatic/basic')
   const store = new Store()
   store.add(platformaticRuntime)
+
+  const id = platformaticRuntime.schema.$id.replace('@platformatic/runtime', 'wattpm')
+  const schema = {
+    ...platformaticRuntime.schema,
+    $id: id
+  }
+  const configManagerConfig = {
+    ...platformaticRuntime.configManagerConfig,
+    schema
+  }
+  const wattpm = {
+    ...platformaticRuntime,
+    schema,
+    configManagerConfig
+  }
+  store.add(wattpm)
   store.add(platformaticBasic)
 
   return pltConfigLoadConfig(minimistConfig, args, store, overrides, replaceEnv)
@@ -54,5 +70,5 @@ module.exports = {
   getRuntimeTmpDir,
   getServiceUrl,
   loadConfig,
-  loadEmptyConfig,
+  loadEmptyConfig
 }

package/lib/versions/v2.0.0.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const pkg = require('../../package.json')
+
 module.exports = {
   version: '1.99.0', // This is to account alpha versions as well
   up: function (config) {
@@ -12,6 +14,13 @@ module.exports = {
       delete config.hotReload
     }
 
+    config.$schema = `https://schemas.platformatic.dev/@platformatic/runtime/${pkg.version}.json`
+
+    if (config.server?.logger) {
+      config.logger = config.server.logger
+      delete config.server.logger
+    }
+
     return config
-  },
+  }
 }

package/lib/worker/app.js

@@ -20,7 +20,7 @@ class PlatformaticApp extends EventEmitter {
   #debouncedRestart
   #context
 
-  constructor (appConfig, telemetryConfig, serverConfig, hasManagementApi, watch, metricsConfig) {
+  constructor (appConfig, telemetryConfig, loggerConfig, serverConfig, metricsConfig, hasManagementApi, watch) {
     super()
     this.appConfig = appConfig
     this.#watch = watch
@@ -38,6 +38,7 @@ class PlatformaticApp extends EventEmitter {
       isProduction: this.appConfig.isProduction,
       telemetryConfig,
       metricsConfig,
+      loggerConfig,
       serverConfig,
       hasManagementApi: !!hasManagementApi,
       localServiceEnvVars: this.appConfig.localServiceEnvVars
@@ -102,16 +103,17 @@ class PlatformaticApp extends EventEmitter {
 
       const metricsConfig = this.#context.metricsConfig
       if (metricsConfig !== false) {
-        this.#metricsRegistry = await collectMetrics(
-          this.stackable,
-          this.appConfig.id,
-          metricsConfig
-        )
+        this.#metricsRegistry = await collectMetrics(this.stackable, this.appConfig.id, metricsConfig)
       }
 
       this.#updateDispatcher()
     } catch (err) {
-      this.#logAndExit(err)
+      if (err.validationErrors) {
+        console.error('Validation errors:', err.validationErrors)
+        process.exit(1)
+      } else {
+        this.#logAndExit(err)
+      }
     }
   }
 
@@ -183,9 +185,7 @@ class PlatformaticApp extends EventEmitter {
   async getMetrics ({ format }) {
     if (!this.#metricsRegistry) return null
 
-    return format === 'json'
-      ? this.#metricsRegistry.getMetricsAsJSON()
-      : this.#metricsRegistry.metrics()
+    return format === 'json' ? this.#metricsRegistry.getMetricsAsJSON() : this.#metricsRegistry.metrics()
   }
 
   #fetchServiceUrl (key, { parent, context: service }) {

package/lib/worker/default-stackable.js

@@ -10,6 +10,7 @@ const defaultStackable = {
   getUrl: () => null,
   updateContext: () => {},
   getConfig: () => null,
+  getEnv: () => null,
   getInfo: () => null,
   getDispatchFunc: () => null,
   getOpenapiSchema: () => null,
@@ -17,7 +18,7 @@ const defaultStackable = {
   getMeta: () => ({}),
   collectMetrics: () => ({
     defaultMetrics: true,
-    httpMetrics: true,
+    httpMetrics: true
   }),
   inject: () => {
     throw new Error('Stackable inject not implemented')
@@ -26,7 +27,7 @@ const defaultStackable = {
     console.log(message)
   },
   getBootstrapDependencies: () => [],
-  getWatchConfig: () => ({ enabled: false }),
+  getWatchConfig: () => ({ enabled: false })
 }
 
 module.exports = defaultStackable

package/lib/worker/itc.js

@@ -9,14 +9,14 @@ const { Unpromise } = require('@watchable/unpromise')
 const errors = require('../errors')
 const { kITC, kId } = require('./symbols')
 
-async function sendViaITC (worker, name, message) {
+async function safeHandleInITC (worker, fn) {
   try {
     // Make sure to catch when the worker exits, otherwise we're stuck forever
     const ac = new AbortController()
     let exitCode
 
     const response = await Unpromise.race([
-      worker[kITC].send(name, message),
+      fn(),
       once(worker, 'exit', { signal: ac.signal }).then(([code]) => {
         exitCode = code
       })
@@ -42,6 +42,14 @@ async function sendViaITC (worker, name, message) {
   }
 }
 
+async function sendViaITC (worker, name, message) {
+  return safeHandleInITC(worker, () => worker[kITC].send(name, message))
+}
+
+async function waitEventFromITC (worker, event) {
+  return safeHandleInITC(worker, () => once(worker[kITC], event))
+}
+
 function setupITC (app, service, dispatcher) {
   const itc = new ITC({
     name: app.appConfig.id + '-worker',
@@ -101,6 +109,11 @@ function setupITC (app, service, dispatcher) {
         return JSON.parse(JSON.stringify(current))
       },
 
+      async getServiceEnv () {
+        // Remove all undefined keys from the config
+        return JSON.parse(JSON.stringify({ ...process.env, ...(await app.stackable.getEnv()) }))
+      },
+
       async getServiceOpenAPISchema () {
         try {
           return await app.stackable.getOpenapiSchema()
@@ -146,4 +159,4 @@ function setupITC (app, service, dispatcher) {
   return itc
 }
 
-module.exports = { sendViaITC, setupITC }
+module.exports = { sendViaITC, setupITC, waitEventFromITC }

package/lib/worker/main.js

@@ -12,7 +12,12 @@ const { wire } = require('undici-thread-interceptor')
 const { PlatformaticApp } = require('./app')
 const { setupITC } = require('./itc')
 const loadInterceptors = require('./interceptors')
-const { MessagePortWritable, createPinoWritable, executeWithTimeout, errors } = require('@platformatic/utils')
+const {
+  MessagePortWritable,
+  createPinoWritable,
+  executeWithTimeout,
+  ensureLoggableError
+} = require('@platformatic/utils')
 const { kId, kITC } = require('./symbols')
 
 process.on('uncaughtException', handleUnhandled.bind(null, 'uncaught exception'))
@@ -27,7 +32,7 @@ globalThis.platformatic = Object.assign(globalThis.platformatic ?? {}, { logger:
 
 function handleUnhandled (type, err) {
   globalThis.platformatic.logger.error(
-    { err: errors.ensureLoggableError(err) },
+    { err: ensureLoggableError(err) },
     `Service ${workerData.serviceConfig.id} threw an ${type}.`
   )
 
@@ -106,10 +111,11 @@ async function main () {
   app = new PlatformaticApp(
     service,
     telemetryConfig,
+    config.logger,
     serverConfig,
+    config.metrics,
     !!config.managementApi,
-    !!config.watch,
-    config.metrics
+    !!config.watch
   )
 
   await app.init()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.0.0-alpha.8",
+  "version": "2.0.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -17,8 +17,8 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
-    "@fastify/express": "^3.0.0",
-    "@fastify/formbody": "^7.4.0",
+    "@fastify/express": "^4.0.0",
+    "@fastify/formbody": "^8.0.0",
     "borp": "^0.17.0",
     "c8": "^10.0.0",
     "eslint": "9",
@@ -28,21 +28,21 @@
     "get-port": "^7.1.0",
     "json-schema-to-typescript": "^15.0.0",
     "neostandard": "^0.11.1",
-    "pino-abstract-transport": "^1.1.0",
+    "pino-abstract-transport": "^2.0.0",
     "split2": "^4.2.0",
     "tsd": "^0.31.0",
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.0.0-alpha.8",
-    "@platformatic/service": "2.0.0-alpha.8",
-    "@platformatic/sql-graphql": "2.0.0-alpha.8",
-    "@platformatic/sql-mapper": "2.0.0-alpha.8",
-    "@platformatic/db": "2.0.0-alpha.8"
+    "@platformatic/composer": "2.0.0",
+    "@platformatic/db": "2.0.0",
+    "@platformatic/service": "2.0.0",
+    "@platformatic/sql-graphql": "2.0.0",
+    "@platformatic/sql-mapper": "2.0.0"
   },
   "dependencies": {
-    "@fastify/error": "^3.4.1",
-    "@fastify/websocket": "^10.0.0",
+    "@fastify/error": "^4.0.0",
+    "@fastify/websocket": "^11.0.0",
     "@hapi/topo": "^6.0.2",
     "@platformatic/http-metrics": "^0.1.0",
     "@watchable/unpromise": "^1.0.2",
@@ -55,31 +55,30 @@
     "dotenv-tool": "^0.1.1",
     "es-main": "^1.3.0",
     "fastest-levenshtein": "^1.0.16",
-    "fastify": "^4.26.2",
-    "fastify-undici-dispatcher": "^0.6.0",
+    "fastify": "^5.0.0",
     "graphql": "^16.8.1",
     "help-me": "^5.0.0",
     "minimist": "^1.2.8",
     "pino": "^8.19.0",
     "pino-pretty": "^11.0.0",
-    "pino-roll": "^1.0.0",
+    "pino-roll": "^2.0.0",
     "prom-client": "^15.1.2",
     "semgrator": "^0.3.0",
     "tail-file-stream": "^0.2.0",
     "undici": "^6.9.0",
     "undici-thread-interceptor": "^0.6.1",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.0.0-alpha.8",
-    "@platformatic/config": "2.0.0-alpha.8",
-    "@platformatic/generators": "2.0.0-alpha.8",
-    "@platformatic/itc": "2.0.0-alpha.8",
-    "@platformatic/telemetry": "2.0.0-alpha.8",
-    "@platformatic/ts-compiler": "2.0.0-alpha.8",
-    "@platformatic/utils": "2.0.0-alpha.8"
+    "@platformatic/basic": "2.0.0",
+    "@platformatic/config": "2.0.0",
+    "@platformatic/generators": "2.0.0",
+    "@platformatic/itc": "2.0.0",
+    "@platformatic/telemetry": "2.0.0",
+    "@platformatic/ts-compiler": "2.0.0",
+    "@platformatic/utils": "2.0.0"
   },
   "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",
+    "coverage": "npm run lint && borp -X fixtures -X test -C --concurrency=1 --timeout=180000 && tsd",
     "gen-schema": "node lib/schema.js > schema.json",
     "gen-types": "json2ts > config.d.ts < schema.json",
     "build": "pnpm run gen-schema && pnpm run gen-types",