@platformatic/runtime 2.65.0 → 2.66.0

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime2650Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime2660Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;
@@ -85,6 +85,14 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime2650Json = {
       paths: string[];
       censor?: string;
     };
+    base?: {
+      [k: string]: unknown;
+    } | null;
+    messageKey?: string;
+    customLevels?: {
+      [k: string]: unknown;
+    };
+    captureStdio?: boolean;
     [k: string]: unknown;
   };
   server?: {
@@ -140,11 +148,35 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime2650Json = {
       [k: string]: unknown;
     };
     interceptors?:
-      | UndiciInterceptor[]
       | {
-          Client?: UndiciInterceptor[];
-          Pool?: UndiciInterceptor[];
-          Agent?: UndiciInterceptor[];
+          module: string;
+          options: {
+            [k: string]: unknown;
+          };
+          [k: string]: unknown;
+        }[]
+      | {
+          Client?: {
+            module: string;
+            options: {
+              [k: string]: unknown;
+            };
+            [k: string]: unknown;
+          }[];
+          Pool?: {
+            module: string;
+            options: {
+              [k: string]: unknown;
+            };
+            [k: string]: unknown;
+          }[];
+          Agent?: {
+            module: string;
+            options: {
+              [k: string]: unknown;
+            };
+            [k: string]: unknown;
+          }[];
           [k: string]: unknown;
         };
     [k: string]: unknown;
@@ -215,7 +247,82 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime2650Json = {
         additionalProperties?: never;
         [k: string]: unknown;
       };
-  telemetry?: OpenTelemetry;
+  telemetry?: {
+    enabled?: boolean | string;
+    /**
+     * The name of the service. Defaults to the folder name if not specified.
+     */
+    serviceName: string;
+    /**
+     * The version of the service (optional)
+     */
+    version?: string;
+    /**
+     * An array of paths to skip when creating spans. Useful for health checks and other endpoints that do not need to be traced.
+     */
+    skip?: {
+      /**
+       * The path to skip. Can be a string or a regex.
+       */
+      path?: string;
+      /**
+       * HTTP method to skip
+       */
+      method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
+      [k: string]: unknown;
+    }[];
+    exporter?:
+      | {
+          type?: "console" | "otlp" | "zipkin" | "memory" | "file";
+          /**
+           * Options for the exporter. These are passed directly to the exporter.
+           */
+          options?: {
+            /**
+             * The URL to send the traces to. Not used for console or memory exporters.
+             */
+            url?: string;
+            /**
+             * Headers to send to the exporter. Not used for console or memory exporters.
+             */
+            headers?: {
+              [k: string]: unknown;
+            };
+            /**
+             * The path to write the traces to. Only for file exporter.
+             */
+            path?: string;
+            [k: string]: unknown;
+          };
+          additionalProperties?: never;
+          [k: string]: unknown;
+        }[]
+      | {
+          type?: "console" | "otlp" | "zipkin" | "memory" | "file";
+          /**
+           * Options for the exporter. These are passed directly to the exporter.
+           */
+          options?: {
+            /**
+             * The URL to send the traces to. Not used for console or memory exporters.
+             */
+            url?: string;
+            /**
+             * Headers to send to the exporter. Not used for console or memory exporters.
+             */
+            headers?: {
+              [k: string]: unknown;
+            };
+            /**
+             * The path to write the traces to. Only for file exporter.
+             */
+            path?: string;
+            [k: string]: unknown;
+          };
+          additionalProperties?: never;
+          [k: string]: unknown;
+        };
+  };
   inspectorOptions?: {
     host?: string;
     port?: number;
@@ -247,87 +354,3 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime2650Json = {
     [k: string]: unknown;
   }[];
 };
-
-export interface UndiciInterceptor {
-  module: string;
-  options: {
-    [k: string]: unknown;
-  };
-  [k: string]: unknown;
-}
-export interface OpenTelemetry {
-  enabled?: boolean | string;
-  /**
-   * The name of the service. Defaults to the folder name if not specified.
-   */
-  serviceName: string;
-  /**
-   * The version of the service (optional)
-   */
-  version?: string;
-  /**
-   * An array of paths to skip when creating spans. Useful for health checks and other endpoints that do not need to be traced.
-   */
-  skip?: {
-    /**
-     * The path to skip. Can be a string or a regex.
-     */
-    path?: string;
-    /**
-     * HTTP method to skip
-     */
-    method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
-    [k: string]: unknown;
-  }[];
-  exporter?:
-    | {
-        type?: "console" | "otlp" | "zipkin" | "memory" | "file";
-        /**
-         * Options for the exporter. These are passed directly to the exporter.
-         */
-        options?: {
-          /**
-           * The URL to send the traces to. Not used for console or memory exporters.
-           */
-          url?: string;
-          /**
-           * Headers to send to the exporter. Not used for console or memory exporters.
-           */
-          headers?: {
-            [k: string]: unknown;
-          };
-          /**
-           * The path to write the traces to. Only for file exporter.
-           */
-          path?: string;
-          [k: string]: unknown;
-        };
-        additionalProperties?: never;
-        [k: string]: unknown;
-      }[]
-    | {
-        type?: "console" | "otlp" | "zipkin" | "memory" | "file";
-        /**
-         * Options for the exporter. These are passed directly to the exporter.
-         */
-        options?: {
-          /**
-           * The URL to send the traces to. Not used for console or memory exporters.
-           */
-          url?: string;
-          /**
-           * Headers to send to the exporter. Not used for console or memory exporters.
-           */
-          headers?: {
-            [k: string]: unknown;
-          };
-          /**
-           * The path to write the traces to. Only for file exporter.
-           */
-          path?: string;
-          [k: string]: unknown;
-        };
-        additionalProperties?: never;
-        [k: string]: unknown;
-      };
-}

package/index.js

@@ -4,7 +4,7 @@ const { buildServer } = require('./lib/build-server')
 const { compile } = require('./lib/compile')
 const errors = require('./lib/errors')
 const { platformaticRuntime, wrapConfigInRuntimeConfig } = require('./lib/config')
-const RuntimeGenerator = require('./lib/generator/runtime-generator')
+const { RuntimeGenerator, WrappedGenerator } = require('./lib/generator/runtime-generator')
 const { Runtime } = require('./lib/runtime')
 const { buildRuntime, start, startCommand } = require('./lib/start')
 const symbols = require('./lib/worker/symbols')
@@ -17,6 +17,7 @@ module.exports.buildRuntime = buildRuntime
 module.exports.compile = compile
 module.exports.errors = errors
 module.exports.Generator = RuntimeGenerator
+module.exports.WrappedGenerator = WrappedGenerator
 module.exports.getRuntimeLogsDir = getRuntimeLogsDir
 module.exports.loadConfig = loadConfig
 module.exports.platformaticRuntime = platformaticRuntime

package/lib/config.js

@@ -2,8 +2,12 @@
 
 const { readdir } = require('node:fs/promises')
 const { join, resolve: pathResolve, isAbsolute } = require('node:path')
-
-const { createRequire, loadModule } = require('@platformatic/utils')
+const {
+  createRequire,
+  loadModule,
+  omitProperties,
+  schemaComponents: { runtimeUnwrappablePropertiesList }
+} = require('@platformatic/utils')
 const ConfigManager = require('@platformatic/config')
 const { Store } = require('@platformatic/config')
 
@@ -259,11 +263,13 @@ async function wrapConfigInRuntimeConfig ({ configManager, args }) {
     // on purpose, the package.json might be missing
   }
 
+  // Important: do not change the order of the properties in this object
   /* c8 ignore next */
   const wrapperConfig = {
     $schema: schema.$id,
-    entrypoint: serviceId,
     watch: true,
+    ...omitProperties(configManager.current.runtime ?? {}, runtimeUnwrappablePropertiesList),
+    entrypoint: serviceId,
     services: [
       {
         id: serviceId,
@@ -272,6 +278,7 @@ async function wrapConfigInRuntimeConfig ({ configManager, args }) {
       }
     ]
   }
+
   const cm = new ConfigManager({
     source: wrapperConfig,
     schema,
@@ -287,6 +294,7 @@ async function wrapConfigInRuntimeConfig ({ configManager, args }) {
   })
 
   await cm.parseAndValidate()
+
   return cm
 }
 

package/lib/generator/runtime-generator.js

@@ -3,7 +3,7 @@
 const { BaseGenerator } = require('@platformatic/generators')
 const { NoEntryPointError, NoServiceNamedError } = require('./errors')
 const { existsSync } = require('node:fs')
-const { join } = require('node:path')
+const { join, basename } = require('node:path')
 const { envObjectToString } = require('@platformatic/generators/lib/utils')
 const { readFile, readdir, stat } = require('node:fs/promises')
 const { ConfigManager } = require('@platformatic/config')
@@ -14,6 +14,30 @@ const { getArrayDifference } = require('../utils')
 const { pathToFileURL } = require('node:url')
 const { createRequire, safeRemove, generateDashedName } = require('@platformatic/utils')
 
+const wrappableProperties = {
+  logger: {
+    level: '{PLT_SERVER_LOGGER_LEVEL}'
+  },
+  server: {
+    hostname: '{PLT_SERVER_HOSTNAME}',
+    port: '{PORT}'
+  },
+  managementApi: '{PLT_MANAGEMENT_API}'
+}
+
+const engines = {
+  node: '^18.8.0 || >=20.6.0'
+}
+
+function getRuntimeBaseEnvVars (config) {
+  return {
+    PLT_SERVER_HOSTNAME: '127.0.0.1',
+    PORT: config.port || 3042,
+    PLT_SERVER_LOGGER_LEVEL: config.logLevel || 'info',
+    PLT_MANAGEMENT_API: true
+  }
+}
+
 class RuntimeGenerator extends BaseGenerator {
   constructor (opts) {
     super({
@@ -62,7 +86,9 @@ class RuntimeGenerator extends BaseGenerator {
       name: `${this.runtimeName}`,
       workspaces: [this.servicesFolder + '/*'],
       scripts: {
-        start: 'platformatic start'
+        dev: this.config.devCommand,
+        build: this.config.buildCommand,
+        start: this.config.startCommand ?? 'platformatic start'
       },
       devDependencies: {
         fastify: `^${this.fastifyVersion}`,
@@ -74,9 +100,7 @@ class RuntimeGenerator extends BaseGenerator {
         wattpm: `^${this.platformaticVersion}`,
         ...this.config.dependencies
       },
-      engines: {
-        node: '^18.8.0 || >=20.6.0'
-      }
+      engines
     }
     if (this.config.typescript) {
       const typescriptVersion = JSON.parse(await readFile(join(__dirname, '..', '..', 'package.json'), 'utf-8'))
@@ -93,15 +117,7 @@ class RuntimeGenerator extends BaseGenerator {
     this.setServicesConfigValues()
     this.addServicesDependencies()
 
-    this.addEnvVars(
-      {
-        PLT_SERVER_HOSTNAME: '127.0.0.1',
-        PORT: this.config.port || 3042,
-        PLT_SERVER_LOGGER_LEVEL: this.config.logLevel || 'info',
-        PLT_MANAGEMENT_API: true
-      },
-      { overwrite: false, default: true }
-    )
+    this.addEnvVars(getRuntimeBaseEnvVars(this.config), { overwrite: false, default: true })
   }
 
   addServicesDependencies () {
@@ -119,7 +135,8 @@ class RuntimeGenerator extends BaseGenerator {
       return
     }
     this._hasCheckedForExistingConfig = true
-    const existingConfigFile = this.runtimeConfig ?? await ConfigManager.findConfigFile(this.targetDirectory, 'runtime')
+    const existingConfigFile =
+      this.runtimeConfig ?? (await ConfigManager.findConfigFile(this.targetDirectory, 'runtime'))
     if (existingConfigFile && existsSync(join(this.targetDirectory, existingConfigFile))) {
       const configManager = new ConfigManager({
         ...platformaticRuntime.configManagerConfig,
@@ -170,14 +187,7 @@ class RuntimeGenerator extends BaseGenerator {
         path: this.config.autoload || this.servicesFolder,
         exclude: ['docs']
       },
-      logger: {
-        level: '{PLT_SERVER_LOGGER_LEVEL}'
-      },
-      server: {
-        hostname: '{PLT_SERVER_HOSTNAME}',
-        port: '{PORT}'
-      },
-      managementApi: '{PLT_MANAGEMENT_API}'
+      ...wrappableProperties
     }
 
     return config
@@ -326,9 +336,7 @@ class RuntimeGenerator extends BaseGenerator {
     const output = {
       services: []
     }
-    const runtimePkgConfigFileData = JSON.parse(
-      await readFile(join(this.targetDirectory, this.runtimeConfig), 'utf-8')
-    )
+    const runtimePkgConfigFileData = JSON.parse(await readFile(join(this.targetDirectory, this.runtimeConfig), 'utf-8'))
     const servicesPath = join(this.targetDirectory, runtimePkgConfigFileData.autoload.path)
 
     // load all services
@@ -388,9 +396,7 @@ class RuntimeGenerator extends BaseGenerator {
         // delete dependencies
         const servicePath = join(this.targetDirectory, this.servicesFolder, s.name)
         const configFile = await ConfigManager.findConfigFile(servicePath)
-        const servicePackageJson = JSON.parse(
-          await readFile(join(servicePath, configFile), 'utf-8')
-        )
+        const servicePackageJson = JSON.parse(await readFile(join(servicePath, configFile), 'utf-8'))
         if (servicePackageJson.plugins && servicePackageJson.plugins.packages) {
           servicePackageJson.plugins.packages.forEach(p => {
             delete currrentPackageJson.dependencies[p.name]
@@ -502,5 +508,96 @@ class RuntimeGenerator extends BaseGenerator {
   }
 }
 
-module.exports = RuntimeGenerator
-module.exports.RuntimeGenerator = RuntimeGenerator
+class WrappedGenerator extends BaseGenerator {
+  async prepare () {
+    await this.getPlatformaticVersion()
+    await this.#updateEnvironment()
+    await this.#updatePackageJson()
+    await this.#createConfigFile()
+  }
+
+  async #updateEnvironment () {
+    this.addEnvVars(getRuntimeBaseEnvVars(this.config), { overwrite: false, default: true })
+
+    this.addFile({
+      path: '',
+      file: '.env',
+      contents: (await this.#readExistingFile('.env', '', '\n')) + envObjectToString(this.config.env)
+    })
+
+    this.addFile({
+      path: '',
+      file: '.env.sample',
+      contents: (await this.#readExistingFile('.env.sample', '', '\n')) + envObjectToString(this.config.env)
+    })
+  }
+
+  async #updatePackageJson () {
+    // Manipulate the package.json, if any
+    const packageJson = JSON.parse(await this.#readExistingFile('package.json', '{}'))
+    let { name, dependencies, devDependencies, scripts, engines: packageJsonEngines, ...rest } = packageJson
+
+    // Add the dependencies
+    dependencies = {
+      ...dependencies,
+      [this.module]: `^${this.platformaticVersion}`,
+      platformatic: `^${this.platformaticVersion}`,
+      wattpm: `^${this.platformaticVersion}`
+    }
+
+    // For easier readbility, sort dependencies and devDependencies by name
+    dependencies = Object.fromEntries(Object.entries(dependencies).sort(([a], [b]) => a.localeCompare(b)))
+    devDependencies = Object.fromEntries(Object.entries(devDependencies ?? {}).sort(([a], [b]) => a.localeCompare(b)))
+
+    scripts ??= {}
+    scripts.dev ??= this.config.devCommand
+    scripts.build ??= this.config.buildCommand
+    scripts.start ??= this.config.startCommand ?? 'platformatic start'
+
+    this.addFile({
+      path: '',
+      file: 'package.json',
+      contents: JSON.stringify(
+        {
+          name: name ?? this.projectName ?? this.runtimeName ?? basename(this.targetDirectory),
+          scripts,
+          dependencies,
+          devDependencies,
+          ...rest,
+          engines: { ...packageJsonEngines, ...engines }
+        },
+        null,
+        2
+      )
+    })
+  }
+
+  async #createConfigFile () {
+    const config = {
+      $schema: `https://schemas.platformatic.dev/${this.module}/${this.platformaticVersion}.json`,
+      runtime: wrappableProperties
+    }
+
+    this.addFile({
+      path: '',
+      file: 'watt.json',
+      contents: JSON.stringify(config, null, 2)
+    })
+  }
+
+  async #readExistingFile (path, emptyContents = '', suffix = '') {
+    const filePath = join(this.targetDirectory, path)
+
+    if (!existsSync(filePath)) {
+      return emptyContents
+    }
+
+    const contents = await readFile(filePath, 'utf-8')
+    return contents + suffix
+  }
+}
+
+module.exports = {
+  RuntimeGenerator,
+  WrappedGenerator
+}

package/lib/logger.js

@@ -20,15 +20,22 @@ const customPrettifiers = {
 
 // Create the runtime logger
 async function createLogger (config, runtimeLogsDir) {
-  const loggerConfig = { ...config.logger }
+  const loggerConfig = { ...config.logger, transport: undefined }
+  if (config.logger.base === null) {
+    loggerConfig.base = undefined
+  }
 
   // PLT_RUNTIME_LOGGER_STDOUT is used in test to reduce verbosity
-  const cliStream = process.env.PLT_RUNTIME_LOGGER_STDOUT
+  let cliStream = process.env.PLT_RUNTIME_LOGGER_STDOUT
     ? pino.destination(process.env.PLT_RUNTIME_LOGGER_STDOUT)
     : isatty(1)
       ? pretty({ customPrettifiers })
       : pino.destination(1)
 
+  if (config.logger.transport) {
+    cliStream = pino.transport(config.logger.transport)
+  }
+
   if (loggerConfig.formatters) {
     loggerConfig.formatters = buildPinoFormatters(loggerConfig.formatters)
   }
@@ -40,43 +47,36 @@ async function createLogger (config, runtimeLogsDir) {
     return [pino(loggerConfig, cliStream), cliStream]
   }
 
-  const multiStream = pino.multistream([{ stream: cliStream, level: loggerConfig.level || 'info' }])
-
-  if (loggerConfig.transport) {
-    const transport = pino.transport(loggerConfig.transport)
-    multiStream.add({ level: loggerConfig.level || 'info', stream: transport })
-  }
+  const multiStream = pino.multistream([{ stream: cliStream, level: loggerConfig.level }])
 
-  if (config.managementApi) {
-    const logsFileMb = 5
-    const logsLimitMb = config.managementApi?.logs?.maxSize || 200
+  const logsFileMb = 5
+  const logsLimitMb = config.managementApi?.logs?.maxSize || 200
 
-    let logsLimitCount = Math.ceil(logsLimitMb / logsFileMb) - 1
-    if (logsLimitCount < 1) {
-      logsLimitCount = 1
-    }
+  let logsLimitCount = Math.ceil(logsLimitMb / logsFileMb) - 1
+  if (logsLimitCount < 1) {
+    logsLimitCount = 1
+  }
 
-    const pinoRoll = pino.transport({
-      target: 'pino-roll',
-      options: {
-        file: join(runtimeLogsDir, 'logs'),
-        mode: 0o600,
-        size: logsFileMb + 'm',
-        mkdir: true,
-        fsync: true,
-        limit: {
-          count: logsLimitCount
-        }
+  const pinoRoll = pino.transport({
+    target: 'pino-roll',
+    options: {
+      file: join(runtimeLogsDir, 'logs'),
+      mode: 0o600,
+      size: logsFileMb + 'm',
+      mkdir: true,
+      fsync: true,
+      limit: {
+        count: logsLimitCount
       }
-    })
+    }
+  })
 
-    multiStream.add({ level: 'trace', stream: pinoRoll })
+  multiStream.add({ level: loggerConfig.level, stream: pinoRoll })
 
-    // Make sure there is a file before continuing otherwise the management API log endpoint might bail out
-    await once(pinoRoll, 'ready')
-  }
+  // Make sure there is a file before continuing otherwise the management API log endpoint might bail out
+  await once(pinoRoll, 'ready')
 
-  return [pino({ level: 'trace' }, multiStream), multiStream]
+  return [pino(loggerConfig, multiStream), multiStream]
 }
 
 module.exports = { createLogger }