@platformatic/runtime 2.0.0-alpha.15 → 2.0.0-alpha.17

package/config.d.ts

@@ -5,11 +5,12 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha15Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha17Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;
   preload?: string;
+  entrypoint?: string;
   autoload?: {
     path: string;
     exclude?: string[];
@@ -21,87 +22,54 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha15Json = {
       };
     };
   };
-  telemetry?: OpenTelemetry;
-  server?: {
-    hostname?: string;
-    port?: number | string;
-    pluginTimeout?: number;
-    healthCheck?:
-      | boolean
+  services?: {
+    [k: string]: unknown;
+  }[];
+  web?: {
+    [k: string]: unknown;
+  }[];
+  logger?: {
+    level: (
+      | ("fatal" | "error" | "warn" | "info" | "debug" | "trace" | "silent")
       | {
-          enabled?: boolean;
-          interval?: number;
           [k: string]: unknown;
-        };
-    ignoreTrailingSlash?: boolean;
-    ignoreDuplicateSlashes?: boolean;
-    connectionTimeout?: number;
-    keepAliveTimeout?: number;
-    maxRequestsPerSocket?: number;
-    forceCloseConnections?: boolean | string;
-    requestTimeout?: number;
-    bodyLimit?: number;
-    maxParamLength?: number;
-    disableRequestLogging?: boolean;
-    exposeHeadRoutes?: boolean;
-    logger?:
-      | boolean
+        }
+    ) &
+      string;
+    transport?:
       | {
-          level?: string;
-          transport?:
-            | {
-                target?: string;
-                options?: {
-                  [k: string]: unknown;
-                };
-              }
-            | {
-                targets?: {
-                  target?: string;
-                  options?: {
-                    [k: string]: unknown;
-                  };
-                  level?: string;
-                  additionalProperties?: never;
-                  [k: string]: unknown;
-                }[];
-                options?: {
-                  [k: string]: unknown;
-                };
-              };
-          pipeline?: {
+          target?: string;
+          options?: {
+            [k: string]: unknown;
+          };
+        }
+      | {
+          targets?: {
             target?: string;
             options?: {
               [k: string]: unknown;
             };
+            level?: string;
+            additionalProperties?: never;
+            [k: string]: unknown;
+          }[];
+          options?: {
+            [k: string]: unknown;
           };
-          [k: string]: unknown;
         };
-    loggerInstance?: {
-      [k: string]: unknown;
-    };
-    serializerOpts?: {
-      schema?: {
-        [k: string]: unknown;
-      };
-      ajv?: {
+    pipeline?: {
+      target?: string;
+      options?: {
         [k: string]: unknown;
       };
-      rounding?: "floor" | "ceil" | "round" | "trunc";
-      debugMode?: boolean;
-      mode?: "debug" | "standalone";
-      largeArraySize?: number | string;
-      largeArrayMechanism?: "default" | "json-stringify";
-      [k: string]: unknown;
     };
-    caseSensitive?: boolean;
-    requestIdHeader?: string | false;
-    requestIdLogLabel?: string;
-    jsonShorthand?: boolean;
-    trustProxy?: boolean | string | string[] | number;
+    [k: string]: unknown;
+  };
+  server?: {
+    hostname?: string;
+    port?: number | string;
     http2?: boolean;
     https?: {
-      allowHTTP1?: boolean;
       key:
         | string
         | {
@@ -124,48 +92,9 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha15Json = {
                 path?: string;
               }
           )[];
-      requestCert?: boolean;
-      rejectUnauthorized?: boolean;
     };
-    cors?: {
-      origin?:
-        | boolean
-        | string
-        | (
-            | string
-            | {
-                regexp: string;
-                [k: string]: unknown;
-              }
-          )[]
-        | {
-            regexp: string;
-            [k: string]: unknown;
-          };
-      methods?: string[];
-      /**
-       * Comma separated string of allowed headers.
-       */
-      allowedHeaders?: string;
-      exposedHeaders?: string[] | string;
-      credentials?: boolean;
-      maxAge?: number;
-      preflightContinue?: boolean;
-      optionsSuccessStatus?: number;
-      preflight?: boolean;
-      strictPreflight?: boolean;
-      hideOptionsRoute?: boolean;
-    };
-  };
-  entrypoint?: string;
-  watch?: boolean | string;
-  inspectorOptions?: {
-    host?: string;
-    port?: number;
-    breakFirstLine?: boolean;
-    watchDisabled?: boolean;
-    [k: string]: unknown;
   };
+  restartOnError?: boolean | number;
   undici?: {
     agentOptions?: {
       [k: string]: unknown;
@@ -180,12 +109,13 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha15Json = {
         };
     [k: string]: unknown;
   };
+  watch?: boolean | string;
   managementApi?:
     | boolean
     | string
     | {
         logs?: {
-          [k: string]: unknown;
+          maxSize?: number;
         };
       };
   metrics?:
@@ -202,12 +132,23 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha15Json = {
           [k: string]: string;
         };
       };
-  restartOnError?: boolean | number;
-  services?: {
+  telemetry?: OpenTelemetry;
+  inspectorOptions?: {
+    host?: string;
+    port?: number;
+    breakFirstLine?: boolean;
+    watchDisabled?: boolean;
     [k: string]: unknown;
-  }[];
+  };
 };
 
+export interface UndiciInterceptor {
+  module: string;
+  options: {
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+}
 export interface OpenTelemetry {
   /**
    * The name of the service. Defaults to the folder name if not specified.
@@ -275,10 +216,3 @@ export interface OpenTelemetry {
         [k: string]: unknown;
       };
 }
-export interface UndiciInterceptor {
-  module: string;
-  options: {
-    [k: string]: unknown;
-  };
-  [k: string]: unknown;
-}

package/fixtures/configs/{invalid-autoload-with-services.json → invalid-web-with-services.json}

@@ -3,10 +3,7 @@
   "entrypoint": "db-app",
   "autoload": {
     "path": "../monorepo",
-    "exclude": [
-      "docs",
-      "composerApp"
-    ],
+    "exclude": ["docs", "composerApp"],
     "mappings": {
       "serviceAppWithLogger": {
         "id": "with-logger",
@@ -28,5 +25,12 @@
       "path": "../monorepo/serviceAppWithLogger",
       "config": "platformatic.service.json"
     }
+  ],
+  "web": [
+    {
+      "id": "with-logger",
+      "path": "../monorepo/serviceAppWithLogger",
+      "config": "platformatic.service.json"
+    }
   ]
 }

package/fixtures/configs/monorepo-watch.json

@@ -20,10 +20,8 @@
       }
     }
   },
-  "server": {
-    "logger": {
-      "level": "trace"
-    }
+  "logger": {
+    "level": "trace"
   },
   "restartOnError": 1000
 }

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

@@ -2,13 +2,15 @@
   "$schema": "https://schemas.platformatic.dev/@platformatic/service/1.52.0.json",
   "server": {
     "logger": {
-      "level": "warn"
+      "level": "info"
     }
   },
   "plugins": {
-    "paths": [{
-      "path": "plugin.js",
-      "encapsulate": false
-    }]
+    "paths": [
+      {
+        "path": "plugin.js",
+        "encapsulate": false
+      }
+    ]
   }
 }

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

@@ -4,9 +4,12 @@
     "openapi": true
   },
   "plugins": {
-    "paths": [
-      "plugin.js"
-    ]
+    "paths": ["plugin.js"]
   },
-  "watch": true
+  "watch": true,
+  "server": {
+    "logger": {
+      "level": "trace"
+    }
+  }
 }

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

@@ -2,13 +2,15 @@
   "$schema": "https://schemas.platformatic.dev/@platformatic/service/1.52.0.json",
   "server": {
     "logger": {
-      "level": "warn"
+      "level": "info"
     }
   },
   "plugins": {
-    "paths": [{
-      "path": "plugin.js",
-      "encapsulate": false
-    }]
+    "paths": [
+      {
+        "path": "plugin.js",
+        "encapsulate": false
+      }
+    ]
   }
 }

package/index.js

@@ -10,6 +10,8 @@ const { buildRuntime, start, startCommand } = require('./lib/start')
 const symbols = require('./lib/worker/symbols')
 const { loadConfig, getRuntimeLogsDir } = require('./lib/utils')
 
+const platformaticVersion = require('./package.json').version
+
 module.exports.buildServer = buildServer
 module.exports.buildRuntime = buildRuntime
 module.exports.compile = compile
@@ -24,3 +26,4 @@ module.exports.startCommand = startCommand
 module.exports.symbols = symbols
 module.exports.Runtime = Runtime
 module.exports.wrapConfigInRuntimeConfig = wrapConfigInRuntimeConfig
+module.exports.version = platformaticVersion

package/lib/config.js

@@ -9,17 +9,21 @@ const errors = require('./errors')
 const { schema } = require('./schema')
 const upgrade = require('./upgrade')
 
-const kServicesAutoloaded = Symbol('plt.servicesAutoloaded')
-
 async function _transformConfig (configManager) {
   const config = configManager.current
-  const services = config.services ?? []
 
-  if (config.autoload) {
-    if (config.services && !config.services[kServicesAutoloaded]) {
-      throw new errors.InvalidAutoloadWithServicesError()
+  let services
+  if (config.web?.length) {
+    if (config.services?.length) {
+      throw new errors.InvalidServicesWithWebError()
     }
 
+    services = config.web
+  } else {
+    services = config.services ?? []
+  }
+
+  if (config.autoload) {
     const { exclude = [], mappings = {} } = config.autoload
     let { path } = config.autoload
 
@@ -41,13 +45,13 @@ async function _transformConfig (configManager) {
       const mapping = mappings[entry.name] ?? {}
       const id = mapping.id ?? entry.name
       const entryPath = join(path, entry.name)
-      const configFilename = mapping.config ?? await ConfigManager.findConfigFile(entryPath)
 
-      if (typeof configFilename !== 'string') {
-        throw new errors.NoConfigFileFoundError(id)
-      }
+      let config
+      const configFilename = mapping.config ?? (await ConfigManager.findConfigFile(entryPath))
 
-      const config = join(entryPath, configFilename)
+      if (typeof configFilename === 'string') {
+        config = join(entryPath, configFilename)
+      }
 
       const service = { id, config, path: entryPath, useHttp: !!mapping.useHttp }
       const existingServiceId = services.findIndex(service => service.id === id)
@@ -89,7 +93,7 @@ async function _transformConfig (configManager) {
   }
 
   configManager.current.services = services
-  configManager.current.services[kServicesAutoloaded] = true
+  configManager.current.web = undefined
 
   if (configManager.current.restartOnError === true) {
     configManager.current.restartOnError = 5000
@@ -111,12 +115,12 @@ platformaticRuntime.configManagerConfig = {
     useDefaults: true,
     coerceTypes: true,
     allErrors: true,
-    strict: false,
+    strict: false
   },
   async transformConfig () {
     await _transformConfig(this)
   },
-  upgrade,
+  upgrade
 }
 
 async function wrapConfigInRuntimeConfig ({ configManager, args }) {
@@ -140,9 +144,9 @@ async function wrapConfigInRuntimeConfig ({ configManager, args }) {
       {
         id: serviceId,
         path: configManager.dirname,
-        config: configManager.fullPath,
-      },
-    ],
+        config: configManager.fullPath
+      }
+    ]
   }
   const cm = new ConfigManager({
     source: wrapperConfig,
@@ -151,9 +155,11 @@ async function wrapConfigInRuntimeConfig ({ configManager, args }) {
       useDefaults: true,
       coerceTypes: true,
       allErrors: true,
-      strict: false,
+      strict: false
     },
-    transformConfig () { return _transformConfig(this) },
+    transformConfig () {
+      return _transformConfig(this)
+    }
   })
 
   await cm.parseAndValidate()
@@ -205,7 +211,7 @@ function parseInspectorOptions (configManager) {
       host,
       port,
       breakFirstLine: hasInspectBrk,
-      watchDisabled: !!current.watch,
+      watchDisabled: !!current.watch
     }
 
     current.watch = false
@@ -215,5 +221,5 @@ function parseInspectorOptions (configManager) {
 module.exports = {
   parseInspectorOptions,
   platformaticRuntime,
-  wrapConfigInRuntimeConfig,
+  wrapConfigInRuntimeConfig
 }

package/lib/errors.js

@@ -20,7 +20,7 @@ module.exports = {
   ConfigPathMustBeStringError: createError(`${ERROR_PREFIX}_CONFIG_PATH_MUST_BE_STRING`, 'Config path must be a string'),
   NoConfigFileFoundError: createError(`${ERROR_PREFIX}_NO_CONFIG_FILE_FOUND`, "No config file found for service '%s'"),
   InvalidEntrypointError: createError(`${ERROR_PREFIX}_INVALID_ENTRYPOINT`, "Invalid entrypoint: '%s' does not exist"),
-  InvalidAutoloadWithServicesError: createError(`${ERROR_PREFIX}_INVALID_AUTOLOAD_WITH_SERVICES`, 'Autoload cannot be used when services is defined'),
+  InvalidServicesWithWebError: createError(`${ERROR_PREFIX}_INVALID_SERVICES_WITH_WEB`, 'The "services" property cannot be used when the "web" property is also defined'),
   MissingDependencyError: createError(`${ERROR_PREFIX}_MISSING_DEPENDENCY`, 'Missing dependency: "%s"'),
   InspectAndInspectBrkError: createError(`${ERROR_PREFIX}_INSPECT_AND_INSPECT_BRK`, '--inspect and --inspect-brk cannot be used together'),
   InspectorPortError: createError(`${ERROR_PREFIX}_INSPECTOR_PORT`, 'Inspector port must be 0 or in range 1024 to 65535'),

package/lib/generator/runtime-generator.js

@@ -165,12 +165,12 @@ class RuntimeGenerator extends BaseGenerator {
         path: 'services',
         exclude: ['docs'],
       },
+      logger: {
+        level: '{PLT_SERVER_LOGGER_LEVEL}',
+      },
       server: {
         hostname: '{PLT_SERVER_HOSTNAME}',
-        port: '{PORT}',
-        logger: {
-          level: '{PLT_SERVER_LOGGER_LEVEL}',
-        },
+        port: '{PORT}'
       },
       managementApi: '{PLT_MANAGEMENT_API}',
     }

package/lib/logger.js

@@ -7,7 +7,7 @@ const pino = require('pino')
 const pretty = require('pino-pretty')
 
 function createLogger (config, runtimeLogsDir) {
-  const loggerConfig = { ...config.server?.logger }
+  const loggerConfig = { ...config.logger }
   const cliStream = isatty(1) ? pretty() : pino.destination(1)
 
   if (!config.managementApi) {

package/lib/management-api.js

@@ -31,7 +31,7 @@ async function managementApiPlugin (app, opts) {
   })
 
   app.get('/env', async () => {
-    return process.env
+    return { ...process.env, ...runtime.getRuntimeEnv() }
   })
 
   app.post('/stop', async () => {
@@ -39,8 +39,8 @@ async function managementApiPlugin (app, opts) {
     await runtime.close(true)
   })
 
-  app.post('/reload', async () => {
-    app.log.debug('reload services')
+  app.post('/restart', async () => {
+    app.log.debug('restart services')
     await runtime.restart()
   })
 
@@ -60,6 +60,12 @@ async function managementApiPlugin (app, opts) {
     return runtime.getServiceConfig(id)
   })
 
+  app.get('/services/:id/env', async request => {
+    const { id } = request.params
+    app.log.debug('get service config', { id })
+    return runtime.getServiceEnv(id)
+  })
+
   app.get('/services/:id/openapi-schema', async request => {
     const { id } = request.params
     app.log.debug('get openapi-schema', { id })
@@ -98,11 +104,14 @@ async function managementApiPlugin (app, opts) {
       url: requestUrl || '/',
       headers: request.headers,
       query: request.query,
-      body: request.body,
+      body: request.body
     }
 
     const res = await runtime.inject(id, injectParams)
 
+    delete res.headers['content-length']
+    delete res.headers['transfer-encoding']
+
     reply.code(res.statusCode).headers(res.headers).send(res.body)
   })
 

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
@@ -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)
 
@@ -778,7 +783,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') {
@@ -839,7 +846,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