@platformatic/runtime 1.53.3 → 2.0.0-alpha.10

package/lib/config.js

@@ -1,18 +1,25 @@
 'use strict'
-const { readFile, readdir } = require('node:fs/promises')
+
+const { readdir } = require('node:fs/promises')
 const { join, resolve: pathResolve } = require('node:path')
-const { closest } = require('fastest-levenshtein')
-const Topo = require('@hapi/topo')
+
 const ConfigManager = require('@platformatic/config')
-const { schema } = require('./schema')
+
 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()
+    }
+
     const { exclude = [], mappings = {} } = config.autoload
     let { path } = config.autoload
 
@@ -53,8 +60,6 @@ async function _transformConfig (configManager) {
     }
   }
 
-  configManager.current.allowCycles = !!configManager.current.allowCycles
-
   configManager.current.serviceMap = new Map()
   configManager.current.inspectorOptions = undefined
 
@@ -63,13 +68,12 @@ async function _transformConfig (configManager) {
   for (let i = 0; i < services.length; ++i) {
     const service = services[i]
 
-    if (configManager._fixPaths) {
+    if (configManager._fixPaths && service.config) {
       service.config = pathResolve(service.path, service.config)
     }
     service.entrypoint = service.id === config.entrypoint
-    service.hotReload = !!config.hotReload
+    service.watch = !!config.watch
     service.dependencies = []
-    service.dependents = []
     service.localServiceEnvVars = new Map()
     service.localUrl = `http://${service.id}.plt.local`
 
@@ -85,126 +89,11 @@ async function _transformConfig (configManager) {
   }
 
   configManager.current.services = services
+  configManager.current.services[kServicesAutoloaded] = true
 
-  await parseClientsAndComposer(configManager)
-
-  if (!configManager.current.allowCycles) {
-    topologicalSort(configManager)
-  }
-}
-
-function missingDependencyErrorMessage (clientName, service, configManager) {
-  const closestName = closest(clientName, [...configManager.current.serviceMap.keys()])
-  let errorMsg = `service '${service.id}' has unknown dependency: '${clientName}'.`
-  if (closestName) {
-    errorMsg += ` Did you mean '${closestName}'?`
-  }
-  return errorMsg
-}
-
-async function parseClientsAndComposer (configManager) {
-  for (const service of configManager.current.services) {
-    const cm = new ConfigManager({ source: service.config })
-    const configString = await cm.load()
-    const serviceConfig = cm._parser(configString)
-
-    async function parseConfigUrl (urlString) {
-      if (!urlString) {
-        return { url: null, envVar: null }
-      }
-
-      try {
-        const url = await cm.replaceEnv(urlString)
-        return { url, envVar: null }
-      } catch (err) {
-        // The MissingValueError is an error coming from pupa
-        // https://github.com/sindresorhus/pupa#missingvalueerror
-        // All other errors are simply re-thrown.
-        if (err.name !== 'MissingValueError' || urlString !== `{${err.key}}`) {
-          throw err
-        }
-        return { url: null, envVar: err.key }
-      }
-    }
-
-    async function addServiceDependency (service, dependencyId, urlString) {
-      let { url, envVar } = await parseConfigUrl(urlString)
-      if (url !== null) {
-        service.dependencies.push({ id: dependencyId, url, local: false })
-        return
-      }
-
-      const depService = configManager.current.serviceMap.get(dependencyId)
-      if (depService === undefined) {
-        throw new errors.MissingDependencyError(
-          missingDependencyErrorMessage(dependencyId, service, configManager)
-        )
-      }
-
-      url = `http://${dependencyId}.plt.local`
-
-      if (envVar !== null) {
-        service.localServiceEnvVars.set(envVar, url)
-      }
-
-      depService.dependents.push(service.id)
-      service.dependencies.push({ id: dependencyId, url, local: true })
-    }
-
-    const composedServices = serviceConfig.composer?.services
-    if (Array.isArray(composedServices)) {
-      await Promise.all(
-        composedServices.map(async (composedService) =>
-          addServiceDependency(
-            service,
-            composedService.id,
-            composedService.origin
-          )
-        )
-      )
-    }
-
-    if (Array.isArray(serviceConfig.clients)) {
-      await Promise.all(
-        serviceConfig.clients.map(async (client) => {
-          let clientServiceId = client.serviceId
-          if (!clientServiceId) {
-            try {
-              const clientPath = pathResolve(service.path, client.path)
-              const clientPackageJsonPath = join(clientPath, 'package.json')
-              const clientPackageJSONFile = await readFile(clientPackageJsonPath, 'utf8')
-              const clientPackageJSON = JSON.parse(clientPackageJSONFile)
-              clientServiceId = clientPackageJSON.name ?? ''
-            } catch (err) {
-              if (client.url === undefined || client.name === undefined) {
-                throw err
-              }
-            }
-          }
-          await addServiceDependency(service, clientServiceId, client.url)
-        })
-      )
-    }
-  }
-}
-
-function topologicalSort (configManager) {
-  const { services } = configManager.current
-  const topo = new Topo.Sorter()
-
-  for (const service of services) {
-    const localDependencyIds = service.dependencies
-      .filter(dep => dep.local)
-      .map(dep => dep.id)
-
-    topo.add(service, {
-      group: service.id,
-      after: localDependencyIds,
-      manual: true
-    })
+  if (configManager.current.restartOnError === true) {
+    configManager.current.restartOnError = 5000
   }
-
-  configManager.current.services = topo.sort()
 }
 
 async function platformaticRuntime () {
@@ -222,12 +111,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 }) {
@@ -246,15 +135,14 @@ async function wrapConfigInRuntimeConfig ({ configManager, args }) {
   const wrapperConfig = {
     $schema: schema.$id,
     entrypoint: serviceId,
-    allowCycles: false,
-    hotReload: true,
+    watch: true,
     services: [
       {
         id: serviceId,
         path: configManager.dirname,
-        config: configManager.fullPath
-      }
-    ]
+        config: configManager.fullPath,
+      },
+    ],
   }
   const cm = new ConfigManager({
     source: wrapperConfig,
@@ -263,9 +151,9 @@ 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()
@@ -317,15 +205,15 @@ function parseInspectorOptions (configManager) {
       host,
       port,
       breakFirstLine: hasInspectBrk,
-      hotReloadDisabled: !!current.hotReload
+      watchDisabled: !!current.watch,
     }
 
-    current.hotReload = false
+    current.watch = false
   }
 }
 
 module.exports = {
   parseInspectorOptions,
   platformaticRuntime,
-  wrapConfigInRuntimeConfig
+  wrapConfigInRuntimeConfig,
 }

package/lib/dependencies.js

@@ -0,0 +1,59 @@
+'use strict'
+
+const Topo = require('@hapi/topo')
+const { closest } = require('fastest-levenshtein')
+
+const errors = require('./errors')
+
+function missingDependencyErrorMessage (clientName, service, services) {
+  const closestName = closest(clientName, [...services.keys()])
+  let errorMsg = `service '${service.id}' has unknown dependency: '${clientName}'.`
+  if (closestName) {
+    errorMsg += ` Did you mean '${closestName}'?`
+  }
+  return errorMsg
+}
+
+function checkDependencies (services) {
+  const allServices = new Set(services.map(s => s.id))
+
+  for (const service of services) {
+    for (const dependency of service.dependencies) {
+      if (dependency.local && !allServices.has(dependency.id)) {
+        throw new errors.MissingDependencyError(
+          missingDependencyErrorMessage(dependency.id, service, services)
+        )
+      }
+    }
+  }
+}
+
+function topologicalSort (services, config) {
+  const topo = new Topo.Sorter()
+
+  for (const service of config.services) {
+    const localDependencyIds = Array.from(service.dependencies)
+      .filter(dep => dep.local)
+      .map(dep => dep.id)
+
+    topo.add(service, {
+      group: service.id,
+      after: localDependencyIds,
+      manual: true,
+    })
+  }
+
+  config.services = topo.sort()
+
+  return new Map(Array.from(services.entries()).sort((a, b) => {
+    if (a[0] === b[0]) {
+      return 0
+    }
+
+    const aIndex = config.services.findIndex(s => s.id === a[0])
+    const bIndex = config.services.findIndex(s => s.id === b[0])
+    return aIndex - bIndex
+  }))
+}
+
+module.exports = { checkDependencies, topologicalSort }

package/lib/errors.js

@@ -7,16 +7,20 @@ 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'),
+  ServiceExitedError: createError(`${ERROR_PREFIX}_SERVICE_EXIT`, '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 not found. Available services are: %s'),
+  ServiceNotFoundError: createError(`${ERROR_PREFIX}_SERVICE_NOT_FOUND`, 'Service %s not found. Available services are: %s'),
   ServiceNotStartedError: createError(`${ERROR_PREFIX}_SERVICE_NOT_STARTED`, "Service with id '%s' is not started"),
   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'),
   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"),
+  InvalidAutoloadWithServicesError: createError(`${ERROR_PREFIX}_INVALID_AUTOLOAD_WITH_SERVICES`, 'Autoload cannot be used when services is 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'),
@@ -28,5 +32,5 @@ module.exports = {
   WorkerIsRequired: createError(`${ERROR_PREFIX}_REQUIRED_WORKER`, 'The worker parameter is required'),
 
   // 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')
+  CannotRemoveServiceOnUpdateError: createError(`${ERROR_PREFIX}_CANNOT_REMOVE_SERVICE_ON_UPDATE`, 'Cannot remove service "%s" when updating a Runtime'),
 }

package/lib/generator/errors.js

@@ -6,5 +6,5 @@ const ERROR_PREFIX = 'PLT_RUNTIME_GEN'
 
 module.exports = {
   NoServiceNamedError: createError(`${ERROR_PREFIX}_NO_SERVICE_FOUND`, 'No service named \'%s\' has been added to this runtime.'),
-  NoEntryPointError: createError(`${ERROR_PREFIX}_NO_ENTRYPOINT`, 'No entrypoint had been defined.')
+  NoEntryPointError: createError(`${ERROR_PREFIX}_NO_ENTRYPOINT`, 'No entrypoint had been defined.'),
 }

package/lib/generator/runtime-generator.d.ts

@@ -1,5 +1,5 @@
-import { BaseGenerator } from "@platformatic/generators"
-import { FileGenerator } from "@platformatic/generators/lib/file-generator"
+import { BaseGenerator } from '@platformatic/generators'
+import { FileGenerator } from '@platformatic/generators/lib/file-generator'
 
 type Service = {
   config: FileGenerator.FileGenerator | BaseGenerator.BaseGenerator
@@ -13,7 +13,7 @@ type KeyValue = {
   [key: string]: string
 }
 
-type RuntimeGeneratorOptions =  BaseGenerator.BaseGeneratorOptions & {
+type RuntimeGeneratorOptions = BaseGenerator.BaseGeneratorOptions & {
   logLevel: string
 }
 
@@ -21,17 +21,17 @@ export namespace RuntimeGenerator {
   export class RuntimeGenerator extends BaseGenerator.BaseGenerator {
     services: Service[]
     entryPoint: Service
-    constructor(opts?: RuntimeGeneratorOptions)
-  
-    addService(service: Service, name: string): Promise<void>
-  
-    setEntryPoint(entryPoint: string): void
-  
-    setServicesDirectory(): void
-  
-    setServicesConfig(configToOverride: object): void
-  
-    getRuntimeEnv(): KeyValue
-    writeServicesFiles(): Promise<GeneratorMetadata>
+    constructor (opts?: RuntimeGeneratorOptions)
+
+    addService (service: Service, name: string): Promise<void>
+
+    setEntryPoint (entryPoint: string): void
+
+    setServicesDirectory (): void
+
+    setServicesConfig (configToOverride: object): void
+
+    getRuntimeEnv (): KeyValue
+    writeServicesFiles (): Promise<GeneratorMetadata>
   }
 }