@platformatic/runtime 2.72.0 → 3.0.0-alpha.1

package/lib/errors.js

@@ -4,113 +4,155 @@ 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'),
-  RuntimeAbortedError: createError(`${ERROR_PREFIX}_RUNTIME_ABORT`, 'The runtime aborted the operation'),
-  // The following two use the same code as we only need to differentiate the label
-  ServiceExitedError: createError(
-    `${ERROR_PREFIX}_SERVICE_EXIT`,
-    'The service "%s" exited prematurely with error code %d'
-  ),
-  WorkerExitedError: createError(
-    `${ERROR_PREFIX}_SERVICE_EXIT`,
-    'The worker %s of the service "%s" exited prematurely with error code %d'
-  ),
-  UnknownRuntimeAPICommandError: createError(
-    `${ERROR_PREFIX}_UNKNOWN_RUNTIME_API_COMMAND`,
-    'Unknown Runtime API command "%s"'
-  ),
-  ServiceNotFoundError: createError(
-    `${ERROR_PREFIX}_SERVICE_NOT_FOUND`,
-    'Service %s not found. Available services are: %s'
-  ),
-  WorkerNotFoundError: createError(
-    `${ERROR_PREFIX}_WORKER_NOT_FOUND`,
-    'Worker %s of service %s not found. Available services are: %s'
-  ),
-  ServiceNotStartedError: createError(`${ERROR_PREFIX}_SERVICE_NOT_STARTED`, "Service with id '%s' is not started"),
-  ServiceStartTimeoutError: createError(
-    `${ERROR_PREFIX}_SERVICE_START_TIMEOUT`,
-    "Service with id '%s' failed to start in %dms."
-  ),
-  FailedToRetrieveOpenAPISchemaError: createError(
-    `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_OPENAPI_SCHEMA`,
-    'Failed to retrieve OpenAPI schema for service with id "%s": %s'
-  ),
-  FailedToRetrieveGraphQLSchemaError: createError(
-    `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_GRAPHQL_SCHEMA`,
-    'Failed to retrieve GraphQL schema for service with id "%s": %s'
-  ),
-  FailedToRetrieveMetaError: createError(
-    `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_META`,
-    'Failed to retrieve metadata for service with id "%s": %s'
-  ),
-  FailedToRetrieveMetricsError: createError(
-    `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_METRICS`,
-    'Failed to retrieve metrics for service with id "%s": %s'
-  ),
-  FailedToRetrieveHealthError: createError(
-    `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_HEALTH`,
-    'Failed to retrieve health for service with id "%s": %s'
-  ),
-  FailedToPerformCustomHealthCheckError: createError(
-    `${ERROR_PREFIX}_FAILED_TO_PERFORM_CUSTOM_HEALTH_CHECK`,
-    'Failed to perform custom healthcheck for service with id "%s": %s'
-  ),
-  FailedToPerformCustomReadinessCheckError: createError(
-    `${ERROR_PREFIX}_FAILED_TO_PERFORM_CUSTOM_READINESS_CHECK`,
-    'Failed to perform custom readiness check for service with id "%s": %s'
-  ),
-  ApplicationAlreadyStartedError: createError(
-    `${ERROR_PREFIX}_APPLICATION_ALREADY_STARTED`,
-    'Application is already started'
-  ),
-  ApplicationNotStartedError: createError(
-    `${ERROR_PREFIX}_APPLICATION_NOT_STARTED`,
-    'Application has not been started'
-  ),
-  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"),
-  MissingEntrypointError: createError(`${ERROR_PREFIX}_MISSING_ENTRYPOINT`, 'Missing application entrypoint.'),
-  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'
-  ),
-  InspectorHostError: createError(`${ERROR_PREFIX}_INSPECTOR_HOST`, 'Inspector host cannot be empty'),
-  CannotMapSpecifierToAbsolutePathError: createError(
-    `${ERROR_PREFIX}_CANNOT_MAP_SPECIFIER_TO_ABSOLUTE_PATH`,
-    'Cannot map "%s" to an absolute path'
-  ),
-  NodeInspectorFlagsNotSupportedError: createError(
-    `${ERROR_PREFIX}_NODE_INSPECTOR_FLAGS_NOT_SUPPORTED`,
-    "The Node.js inspector flags are not supported. Please use 'platformatic start --inspect' instead."
-  ),
-  FailedToUnlinkManagementApiSocket: createError(
-    `${ERROR_PREFIX}_FAILED_TO_UNLINK_MANAGEMENT_API_SOCKET`,
-    'Failed to unlink management API socket "%s"'
-  ),
-  LogFileNotFound: createError(`${ERROR_PREFIX}_LOG_FILE_NOT_FOUND`, 'Log file with index %s not found', 404),
-  WorkerIsRequired: createError(`${ERROR_PREFIX}_REQUIRED_WORKER`, 'The worker parameter is required'),
-  InvalidArgumentError: createError(`${ERROR_PREFIX}_INVALID_ARGUMENT`, 'Invalid argument: "%s"'),
-  MessagingError: createError(`${ERROR_PREFIX}_MESSAGING_ERROR`, 'Cannot send a message to service "%s": %s'),
+const AddressInUseError = createError(
+  `${ERROR_PREFIX}_EADDR_IN_USE`,
+  'The current port is in use by another application'
+)
+const RuntimeExitedError = createError(
+  `${ERROR_PREFIX}_RUNTIME_EXIT`,
+  'The runtime exited before the operation completed'
+)
+const RuntimeAbortedError = createError(`${ERROR_PREFIX}_RUNTIME_ABORT`, 'The runtime aborted the operation')
+// The following two use the same code as we only need to differentiate the label
+const ServiceExitedError = createError(
+  `${ERROR_PREFIX}_SERVICE_EXIT`,
+  'The service "%s" exited prematurely with error code %d'
+)
+const WorkerExitedError = createError(
+  `${ERROR_PREFIX}_SERVICE_EXIT`,
+  'The worker %s of the service "%s" exited prematurely with error code %d'
+)
+const UnknownRuntimeAPICommandError = createError(
+  `${ERROR_PREFIX}_UNKNOWN_RUNTIME_API_COMMAND`,
+  'Unknown Runtime API command "%s"'
+)
+const ServiceNotFoundError = createError(
+  `${ERROR_PREFIX}_SERVICE_NOT_FOUND`,
+  'Service %s not found. Available services are: %s'
+)
+const WorkerNotFoundError = createError(
+  `${ERROR_PREFIX}_WORKER_NOT_FOUND`,
+  'Worker %s of service %s not found. Available services are: %s'
+)
+const ServiceNotStartedError = createError(`${ERROR_PREFIX}_SERVICE_NOT_STARTED`, "Service with id '%s' is not started")
+const ServiceStartTimeoutError = createError(
+  `${ERROR_PREFIX}_SERVICE_START_TIMEOUT`,
+  "Service with id '%s' failed to start in %dms."
+)
+const FailedToRetrieveOpenAPISchemaError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_OPENAPI_SCHEMA`,
+  'Failed to retrieve OpenAPI schema for service with id "%s": %s'
+)
+const FailedToRetrieveGraphQLSchemaError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_GRAPHQL_SCHEMA`,
+  'Failed to retrieve GraphQL schema for service with id "%s": %s'
+)
+const FailedToRetrieveMetaError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_META`,
+  'Failed to retrieve metadata for service with id "%s": %s'
+)
+const FailedToRetrieveMetricsError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_METRICS`,
+  'Failed to retrieve metrics for service with id "%s": %s'
+)
+const FailedToRetrieveHealthError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_HEALTH`,
+  'Failed to retrieve health for service with id "%s": %s'
+)
+const FailedToPerformCustomHealthCheckError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_PERFORM_CUSTOM_HEALTH_CHECK`,
+  'Failed to perform custom healthcheck for service with id "%s": %s'
+)
+const FailedToPerformCustomReadinessCheckError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_PERFORM_CUSTOM_READINESS_CHECK`,
+  'Failed to perform custom readiness check for service with id "%s": %s'
+)
+const ApplicationAlreadyStartedError = createError(
+  `${ERROR_PREFIX}_APPLICATION_ALREADY_STARTED`,
+  'Application is already started'
+)
+const ApplicationNotStartedError = createError(
+  `${ERROR_PREFIX}_APPLICATION_NOT_STARTED`,
+  'Application has not been started'
+)
+const ConfigPathMustBeStringError = createError(
+  `${ERROR_PREFIX}_CONFIG_PATH_MUST_BE_STRING`,
+  'Config path must be a string'
+)
+const NoConfigFileFoundError = createError(
+  `${ERROR_PREFIX}_NO_CONFIG_FILE_FOUND`,
+  "No config file found for service '%s'"
+)
+const InvalidEntrypointError = createError(
+  `${ERROR_PREFIX}_INVALID_ENTRYPOINT`,
+  "Invalid entrypoint: '%s' does not exist"
+)
+const MissingEntrypointError = createError(`${ERROR_PREFIX}_MISSING_ENTRYPOINT`, 'Missing application entrypoint.')
+const InvalidServicesWithWebError = createError(
+  `${ERROR_PREFIX}_INVALID_SERVICES_WITH_WEB`,
+  'The "services" property cannot be used when the "web" property is also defined'
+)
+const MissingDependencyError = createError(`${ERROR_PREFIX}_MISSING_DEPENDENCY`, 'Missing dependency: "%s"')
+const InspectAndInspectBrkError = createError(
+  `${ERROR_PREFIX}_INSPECT_AND_INSPECT_BRK`,
+  '--inspect and --inspect-brk cannot be used together'
+)
+const InspectorPortError = createError(
+  `${ERROR_PREFIX}_INSPECTOR_PORT`,
+  'Inspector port must be 0 or in range 1024 to 65535'
+)
+const InspectorHostError = createError(`${ERROR_PREFIX}_INSPECTOR_HOST`, 'Inspector host cannot be empty')
+const CannotMapSpecifierToAbsolutePathError = createError(
+  `${ERROR_PREFIX}_CANNOT_MAP_SPECIFIER_TO_ABSOLUTE_PATH`,
+  'Cannot map "%s" to an absolute path'
+)
+const NodeInspectorFlagsNotSupportedError = createError(
+  `${ERROR_PREFIX}_NODE_INSPECTOR_FLAGS_NOT_SUPPORTED`,
+  "The Node.js inspector flags are not supported. Please use 'platformatic start --inspect' instead."
+)
+const FailedToUnlinkManagementApiSocket = createError(
+  `${ERROR_PREFIX}_FAILED_TO_UNLINK_MANAGEMENT_API_SOCKET`,
+  'Failed to unlink management API socket "%s"'
+)
+const LogFileNotFound = createError(`${ERROR_PREFIX}_LOG_FILE_NOT_FOUND`, 'Log file with index %s not found', 404)
+const WorkerIsRequired = createError(`${ERROR_PREFIX}_REQUIRED_WORKER`, 'The worker parameter is required')
+const InvalidArgumentError = createError(`${ERROR_PREFIX}_INVALID_ARGUMENT`, 'Invalid argument: "%s"')
+const MessagingError = createError(`${ERROR_PREFIX}_MESSAGING_ERROR`, 'Cannot send a message to service "%s": %s')
 
-  // TODO: should remove next one as it's not used anymore
-  CannotRemoveServiceOnUpdateError: createError(
-    `${ERROR_PREFIX}_CANNOT_REMOVE_SERVICE_ON_UPDATE`,
-    'Cannot remove service "%s" when updating a Runtime'
-  )
+module.exports = {
+  AddressInUseError,
+  RuntimeExitedError,
+  RuntimeAbortedError,
+  ServiceExitedError,
+  WorkerExitedError,
+  UnknownRuntimeAPICommandError,
+  ServiceNotFoundError,
+  WorkerNotFoundError,
+  ServiceNotStartedError,
+  ServiceStartTimeoutError,
+  FailedToRetrieveOpenAPISchemaError,
+  FailedToRetrieveGraphQLSchemaError,
+  FailedToRetrieveMetaError,
+  FailedToRetrieveMetricsError,
+  FailedToRetrieveHealthError,
+  FailedToPerformCustomHealthCheckError,
+  FailedToPerformCustomReadinessCheckError,
+  ApplicationAlreadyStartedError,
+  ApplicationNotStartedError,
+  ConfigPathMustBeStringError,
+  NoConfigFileFoundError,
+  InvalidEntrypointError,
+  MissingEntrypointError,
+  InvalidServicesWithWebError,
+  MissingDependencyError,
+  InspectAndInspectBrkError,
+  InspectorPortError,
+  InspectorHostError,
+  CannotMapSpecifierToAbsolutePathError,
+  NodeInspectorFlagsNotSupportedError,
+  FailedToUnlinkManagementApiSocket,
+  LogFileNotFound,
+  WorkerIsRequired,
+  InvalidArgumentError,
+  MessagingError
 }

package/lib/{generator/runtime-generator.js → generator.js}

@@ -1,18 +1,25 @@
 'use strict'
 
+const createError = require('@fastify/error')
 const { BaseGenerator } = require('@platformatic/generators')
-const { NoEntryPointError, NoServiceNamedError } = require('./errors')
 const { existsSync } = require('node:fs')
 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')
-const { platformaticRuntime } = require('../config')
+const { transform } = require('./config')
 const { getServiceTemplateFromSchemaUrl } = require('@platformatic/generators/lib/utils')
 const { DotEnvTool } = require('dotenv-tool')
-const { getArrayDifference } = require('../utils')
+const { getArrayDifference } = require('./utils')
+const { schema } = require('./schema')
 const { pathToFileURL } = require('node:url')
-const { safeRemove, generateDashedName, DEFAULT_PACKAGE_MANAGER } = require('@platformatic/utils')
+const {
+  safeRemove,
+  generateDashedName,
+  findConfigurationFile,
+  loadConfiguration,
+  loadConfigurationFile,
+  kMetadata
+} = require('@platformatic/utils')
 const { createRequire } = require('node:module')
 
 const wrappableProperties = {
@@ -27,9 +34,17 @@ const wrappableProperties = {
 }
 
 const engines = {
-  node: '^18.8.0 || >=20.6.0'
+  node: '>=22.16.0'
 }
 
+const ERROR_PREFIX = 'PLT_RUNTIME_GEN'
+
+const NoServiceNamedError = createError(
+  `${ERROR_PREFIX}_NO_SERVICE_FOUND`,
+  "No service named '%s' has been added to this runtime."
+)
+const NoEntryPointError = createError(`${ERROR_PREFIX}_NO_ENTRYPOINT`, 'No entrypoint had been defined.')
+
 function getRuntimeBaseEnvVars (config) {
   return {
     PLT_SERVER_HOSTNAME: '127.0.0.1',
@@ -50,7 +65,6 @@ class RuntimeGenerator extends BaseGenerator {
     this.services = []
     this.existingServices = []
     this.entryPoint = null
-    this.packageManager = opts.packageManager ?? DEFAULT_PACKAGE_MANAGER
   }
 
   async addService (service, name) {
@@ -86,6 +100,7 @@ class RuntimeGenerator extends BaseGenerator {
   async generatePackageJson () {
     const template = {
       name: `${this.runtimeName}`,
+      workspaces: [this.servicesFolder + '/*'],
       scripts: {
         dev: this.config.devCommand,
         build: this.config.buildCommand,
@@ -103,13 +118,8 @@ class RuntimeGenerator extends BaseGenerator {
       },
       engines
     }
-
-    if (this.packageManager === 'npm' || this.packageManager === 'yarn') {
-      template.workspaces = [this.servicesFolder + '/*']
-    }
-
     if (this.config.typescript) {
-      const typescriptVersion = JSON.parse(await readFile(join(__dirname, '..', '..', 'package.json'), 'utf-8'))
+      const typescriptVersion = JSON.parse(await readFile(join(__dirname, '..', 'package.json'), 'utf-8'))
         .devDependencies.typescript
       template.scripts.clean = 'rm -fr ./dist'
       template.scripts.build = 'platformatic compile'
@@ -141,21 +151,19 @@ class RuntimeGenerator extends BaseGenerator {
       return
     }
     this._hasCheckedForExistingConfig = true
-    const existingConfigFile =
-      this.runtimeConfig ?? (await ConfigManager.findConfigFile(this.targetDirectory, 'runtime'))
+    const existingConfigFile = this.runtimeConfig ?? (await findConfigurationFile(this.targetDirectory, 'runtime'))
     if (existingConfigFile && existsSync(join(this.targetDirectory, existingConfigFile))) {
-      const configManager = new ConfigManager({
-        ...platformaticRuntime.configManagerConfig,
-        source: join(this.targetDirectory, existingConfigFile)
+      this.existingConfigRaw = await loadConfigurationFile(join(this.targetDirectory, existingConfigFile))
+      this.existingConfig = await loadConfiguration(join(this.targetDirectory, existingConfigFile), schema, {
+        transform,
+        ignoreProcessEnv: true
       })
-      await configManager.parse()
 
-      this.existingConfig = configManager.current
-      this.existingConfigRaw = configManager.currentRaw
-      this.config.env = configManager.env
-      this.config.port = configManager.env.PORT
-      this.entryPoint = configManager.current.services.find(svc => svc.entrypoint)
-      this.existingServices = configManager.current.services.map(s => s.id)
+      const { PLT_ROOT, ...existingEnvironment } = this.existingConfig[kMetadata].env
+      this.config.env = existingEnvironment
+      this.config.port = this.config.env.PORT
+      this.entryPoint = this.existingConfig.services.find(svc => svc.entrypoint)
+      this.existingServices = this.existingConfig.services.map(s => s.id)
 
       this.updateRuntimeConfig(this.existingConfigRaw)
       this.updateRuntimeEnv(await readFile(join(this.targetDirectory, '.env'), 'utf-8'))
@@ -218,13 +226,9 @@ class RuntimeGenerator extends BaseGenerator {
     this.addFile({
       path: '',
       file: '.env.sample',
-      contents: envObjectToString(this.config.defaultEnv)
+      contents: envObjectToString(this.config.env)
     })
 
-    if (!this.existingConfig) {
-      this.addFile({ path: '', file: 'README.md', contents: await readFile(join(__dirname, 'README.md'), 'utf-8') })
-    }
-
     return {
       targetDirectory: this.targetDirectory,
       env: servicesEnv
@@ -362,7 +366,7 @@ class RuntimeGenerator extends BaseGenerator {
       const dirStat = await stat(currentServicePath)
       if (dirStat.isDirectory()) {
         // load the service config
-        const configFile = await ConfigManager.findConfigFile(currentServicePath)
+        const configFile = await findConfigurationFile(currentServicePath)
         const servicePltJson = JSON.parse(await readFile(join(currentServicePath, configFile), 'utf-8'))
         // get module to load
         const template = servicePltJson.module || getServiceTemplateFromSchemaUrl(servicePltJson.$schema)
@@ -410,7 +414,7 @@ class RuntimeGenerator extends BaseGenerator {
 
         // delete dependencies
         const servicePath = join(this.targetDirectory, this.servicesFolder, s.name)
-        const configFile = await ConfigManager.findConfigFile(servicePath)
+        const configFile = await findConfigurationFile(servicePath)
         const servicePackageJson = JSON.parse(await readFile(join(servicePath, configFile), 'utf-8'))
         if (servicePackageJson.plugins && servicePackageJson.plugins.packages) {
           servicePackageJson.plugins.packages.forEach(p => {
@@ -586,7 +590,7 @@ class WrappedGenerator extends BaseGenerator {
     this.addFile({
       path: '',
       file: '.env.sample',
-      contents: (await this.#readExistingFile('.env.sample', '', '\n')) + envObjectToString(this.config.defaultEnv)
+      contents: (await this.#readExistingFile('.env.sample', '', '\n')) + envObjectToString(this.config.env)
     })
   }
 

package/lib/logger.js

@@ -5,7 +5,7 @@ const { join } = require('node:path')
 const { isatty } = require('node:tty')
 const pino = require('pino')
 const pretty = require('pino-pretty')
-const { buildPinoFormatters, buildPinoTimestamp } = require('@platformatic/utils')
+const { abstractLogger, buildPinoFormatters, buildPinoTimestamp } = require('@platformatic/utils')
 
 const customPrettifiers = {
   name (name, _, obj) {
@@ -79,4 +79,4 @@ async function createLogger (config, runtimeLogsDir) {
   return [pino(loggerConfig, multiStream), multiStream]
 }
 
-module.exports = { createLogger }
+module.exports = { abstractLogger, createLogger }

package/lib/management-api.js

@@ -203,7 +203,7 @@ async function managementApiPlugin (app, opts) {
   })
 }
 
-async function startManagementApi (runtime, configManager) {
+async function startManagementApi (runtime, root) {
   const runtimePID = process.pid
 
   try {
@@ -212,7 +212,7 @@ async function startManagementApi (runtime, configManager) {
       await createDirectory(runtimePIDDir, true)
     }
 
-    const runtimeLogsDir = getRuntimeLogsDir(configManager.dirname, process.pid)
+    const runtimeLogsDir = getRuntimeLogsDir(root, process.pid)
     await createDirectory(runtimeLogsDir, true)
 
     let socketPath = null

package/lib/prom-server.js

@@ -77,7 +77,6 @@ async function startPrometheusServer (runtime, opts) {
   const auth = opts.auth ?? null
 
   const promServer = fastify({ name: 'Prometheus server' })
-  promServer.register(require('@fastify/accepts'))
 
   let onRequestHook
   if (auth) {
@@ -123,12 +122,9 @@ async function startPrometheusServer (runtime, opts) {
     logLevel: 'warn',
     onRequest: onRequestHook,
     handler: async (req, reply) => {
-      const accepts = req.accepts()
-      const reqType = !accepts.type('text/plain') && accepts.type('application/json') ? 'json' : 'text'
-      if (reqType === 'text') {
-        reply.type('text/plain')
-      }
-      return (await runtime.getMetrics(reqType)).metrics
+      reply.type('text/plain')
+      const { metrics } = await runtime.getMetrics('text')
+      return metrics
     },
   })