@platformatic/runtime 2.0.0-alpha.1 → 2.0.0-alpha.3

package/lib/api.js

@@ -1,420 +0,0 @@
-'use strict'
-
-const { once } = require('node:events')
-const { getGlobalDispatcher, setGlobalDispatcher } = require('undici')
-const { createFastifyInterceptor } = require('fastify-undici-dispatcher')
-const { PlatformaticApp } = require('./app')
-const errors = require('./errors')
-const { checkDependencies, topologicalSort } = require('./dependencies')
-const { printSchema } = require('graphql')
-
-class RuntimeApi {
-  #services
-  #dispatcher
-  #interceptor
-  #logger
-  #config
-  #bootstrapDependenciesResolved
-
-  constructor (config, logger, loaderPort, composedInterceptors = []) {
-    this.#config = config
-    this.#services = new Map()
-    this.#logger = logger
-
-    const telemetryConfig = config.telemetry
-    const metricsConfig = config.metrics
-
-    for (let i = 0; i < config.services.length; ++i) {
-      const service = config.services[i]
-      const serviceTelemetryConfig = telemetryConfig
-        ? {
-            ...telemetryConfig,
-            serviceName: `${telemetryConfig.serviceName}-${service.id}`
-          }
-        : null
-
-      // If the service is an entrypoint and runtime server config is defined, use it.
-      let serverConfig = null
-      if (config.server && service.entrypoint) {
-        serverConfig = config.server
-      } else if (service.useHttp) {
-        serverConfig = {
-          port: 0,
-          host: '127.0.0.1',
-          keepAliveTimeout: 5000
-        }
-      }
-
-      const app = new PlatformaticApp(service, loaderPort, logger, serviceTelemetryConfig, serverConfig, !!config.managementApi, metricsConfig)
-
-      this.#services.set(service.id, app)
-    }
-
-    this.#interceptor = createFastifyInterceptor({
-      // setting the domain here allows for fail-fast scenarios
-      domain: '.plt.local'
-    })
-
-    composedInterceptors.unshift(this.#interceptor)
-
-    this.#dispatcher = getGlobalDispatcher().compose(composedInterceptors)
-    setGlobalDispatcher(this.#dispatcher)
-  }
-
-  async startListening (parentPort) {
-    parentPort.on('message', async (message) => {
-      const command = message?.command
-      if (command) {
-        if (command === 'plt:close') {
-          // We close everything because they might be using
-          // a FinalizationRegistry and it may stuck us in an infinite loop.
-          // This is a workaround for
-          // https://github.com/nodejs/node/issues/47748
-          // https://github.com/nodejs/node/issues/49344
-          // Remove once https://github.com/nodejs/node/pull/51290 is released
-          // on all lines.
-          // Likely to be removed when we drop support for Node.js 18.
-          if (this.#dispatcher) {
-            await this.#dispatcher.close()
-          }
-          setImmediate(process.exit) // Exit the worker thread.
-          return
-        }
-
-        const res = await this.#executeCommand(message)
-        parentPort.postMessage(res)
-        return
-      }
-      await this.#handleProcessLevelEvent(message)
-    })
-  }
-
-  async #handleProcessLevelEvent (message) {
-    const services = [...this.#services.values()]
-    await Promise.allSettled(services.map(async (service) => {
-      await service.handleProcessLevelEvent(message)
-    }))
-
-    for (const service of services) {
-      const serviceStatus = service.getStatus()
-      if (
-        serviceStatus === 'starting' ||
-        serviceStatus === 'started'
-      ) return
-    }
-
-    if (this.#dispatcher) {
-      await this.#dispatcher.close()
-    }
-
-    process.exit() // Exit the worker thread if all services are stopped
-  }
-
-  async #executeCommand (message) {
-    const { operationId, command, params } = message
-    try {
-      const res = await this.#runCommandHandler(command, params)
-      return { operationId, error: null, data: JSON.stringify(res || null) }
-    } catch (err) {
-      return { operationId, error: err.message, code: err.code }
-    }
-  }
-
-  async #runCommandHandler (command, params) {
-    switch (command) {
-      case 'plt:start-services':
-        return this.startServices(params)
-      case 'plt:stop-services':
-        return this.stopServices(params)
-      case 'plt:restart-services':
-        return this.#restartServices(params)
-      case 'plt:get-entrypoint-details':
-        return this.#getEntrypointDetails(params)
-      case 'plt:get-services':
-        return this.#getServices(params)
-      case 'plt:get-service-details':
-        return this.#getServiceDetails(params)
-      case 'plt:get-service-config':
-        return this.#getServiceConfig(params)
-      case 'plt:get-service-openapi-schema':
-        return this.#getServiceOpenapiSchema(params)
-      case 'plt:get-service-graphql-schema':
-        return this.#getServiceGraphqlSchema(params)
-      case 'plt:get-metrics':
-        return this.#getMetrics(params)
-      case 'plt:start-service':
-        return this.#startService(params)
-      case 'plt:stop-service':
-        return this.#stopService(params)
-      case 'plt:inject':
-        return this.#inject(params)
-      /* c8 ignore next 2 */
-      default:
-        throw new errors.UnknownRuntimeAPICommandError(command)
-    }
-  }
-
-  async startServices () {
-    if (!this.#bootstrapDependenciesResolved) {
-      await this._resolveBootstrapDependencies()
-      this.#bootstrapDependenciesResolved = true
-    }
-
-    let entrypoint
-    for (const service of this.#services.values()) {
-      await service.start()
-
-      if (service.appConfig.entrypoint) {
-        entrypoint = service
-      }
-
-      const serviceUrl = new URL(service.appConfig.localUrl)
-      this.#interceptor.route(serviceUrl.host, service.server)
-    }
-
-    await entrypoint?.listen()
-    return entrypoint?.server.url
-  }
-
-  async stopServices () {
-    const stopServiceReqs = []
-    for (const service of this.#services.values()) {
-      const serviceStatus = service.getStatus()
-      if (serviceStatus === 'starting') {
-        stopServiceReqs.push(
-          once(service, 'start').then(() => service.stop())
-        )
-      }
-      if (serviceStatus === 'started') {
-        stopServiceReqs.push(service.stop())
-      }
-    }
-
-    await Promise.all(stopServiceReqs)
-  }
-
-  async _resolveBootstrapDependencies () {
-    if (this.#config.autoload) {
-      for (const service of this.#config.services) {
-        const dependencies = await this.#services.get(service.id).getBootstrapDependencies()
-        service.dependencies = dependencies
-
-        for (const { envVar, url } of dependencies) {
-          if (envVar) {
-            service.localServiceEnvVars.set(envVar, url)
-          }
-        }
-      }
-
-      checkDependencies(this.#config.services)
-      this.#services = topologicalSort(this.#services, this.#config)
-    }
-
-    return this.#services
-  }
-
-  async #restartServices () {
-    let entrypoint
-    for (const service of this.#services.values()) {
-      const serviceStatus = service.getStatus()
-
-      if (service.appConfig.entrypoint) {
-        entrypoint = service
-      }
-
-      if (serviceStatus === 'starting') {
-        await once(service, 'start')
-      }
-
-      await service.restart()
-
-      const serviceUrl = new URL(service.appConfig.localUrl)
-      this.#interceptor.route(serviceUrl.host, service.server)
-    }
-
-    return entrypoint?.server.url
-  }
-
-  #getEntrypointDetails () {
-    for (const service of this.#services.values()) {
-      if (service.appConfig.entrypoint) {
-        return this.#getServiceDetails({ id: service.appConfig.id })
-      }
-    }
-    return null
-  }
-
-  #getServices () {
-    const services = { services: [] }
-
-    for (const service of this.#services.values()) {
-      const serviceId = service.appConfig.id
-      const serviceDetails = this.#getServiceDetails({ id: serviceId })
-      if (serviceDetails.entrypoint) {
-        services.entrypoint = serviceId
-      }
-      services.services.push(serviceDetails)
-    }
-
-    return services
-  }
-
-  #getServiceById (id) {
-    const service = this.#services.get(id)
-
-    if (!service) {
-      const listOfServices = this.#getServices().services.map(svc => svc.id).join(', ')
-      throw new errors.ServiceNotFoundError(listOfServices)
-    }
-
-    return service
-  }
-
-  #getServiceDetails ({ id }) {
-    const service = this.#getServiceById(id)
-    const status = service.getStatus()
-
-    const type = service.config?.configType
-    const version = service.config?.app?.configManagerConfig.version ?? null
-    const { entrypoint, dependencies, localUrl } = service.appConfig
-
-    const serviceDetails = {
-      id,
-      type,
-      status,
-      version,
-      localUrl,
-      entrypoint,
-      dependencies
-    }
-
-    if (entrypoint) {
-      serviceDetails.url = status === 'started' ? service.server.url : null
-    }
-
-    return serviceDetails
-  }
-
-  #getServiceConfig ({ id }) {
-    const service = this.#getServiceById(id)
-
-    const serviceStatus = service.getStatus()
-    if (serviceStatus !== 'started') {
-      throw new errors.ServiceNotStartedError(id)
-    }
-
-    return service.config.configManager.current
-  }
-
-  async #getServiceOpenapiSchema ({ id }) {
-    const service = this.#getServiceById(id)
-
-    const serviceStatus = service.getStatus()
-    if (serviceStatus !== 'started') {
-      throw new errors.ServiceNotStartedError(id)
-    }
-
-    if (typeof service.server.swagger !== 'function') {
-      return null
-    }
-
-    try {
-      await service.server.ready()
-      const openapiSchema = service.server.swagger()
-      return openapiSchema
-    } catch (err) {
-      throw new errors.FailedToRetrieveOpenAPISchemaError(id, err.message)
-    }
-  }
-
-  async #getServiceGraphqlSchema ({ id }) {
-    const service = this.#getServiceById(id)
-
-    const serviceStatus = service.getStatus()
-    if (serviceStatus !== 'started') {
-      throw new errors.ServiceNotStartedError(id)
-    }
-
-    if (typeof service.server.graphql !== 'function') {
-      return null
-    }
-
-    try {
-      await service.server.ready()
-      const graphqlSchema = printSchema(service.server.graphql.schema)
-      return graphqlSchema
-    } catch (err) {
-      throw new errors.FailedToRetrieveGraphQLSchemaError(id, err.message)
-    }
-  }
-
-  async #getMetrics ({ format }) {
-    let metrics = null
-
-    for (const service of this.#services.values()) {
-      const serviceId = service.appConfig.id
-      const serviceStatus = service.getStatus()
-      if (serviceStatus !== 'started') {
-        throw new errors.ServiceNotStartedError(serviceId)
-      }
-
-      const promRegister = service.server.metrics?.client?.register
-
-      if (promRegister) {
-        if (metrics === null) {
-          metrics = format === 'json' ? [] : ''
-        }
-        if (format === 'json') {
-          metrics.push(...await promRegister.getMetricsAsJSON())
-        } else {
-          const serviceMetrics = await promRegister.metrics()
-          metrics += serviceMetrics
-        }
-      }
-    }
-
-    return { metrics }
-  }
-
-  async #startService ({ id }) {
-    const service = this.#getServiceById(id)
-    const serviceStatus = service.getStatus()
-
-    if (serviceStatus === 'starting') {
-      await once(service, 'start')
-    } else {
-      await service.start()
-    }
-  }
-
-  async #stopService ({ id }) {
-    const service = this.#getServiceById(id)
-    const serviceStatus = service.getStatus()
-
-    if (serviceStatus === 'starting') {
-      await once(service, 'start')
-    }
-
-    await service.stop()
-  }
-
-  async #inject ({ id, injectParams }) {
-    const service = this.#getServiceById(id)
-
-    const serviceStatus = service.getStatus()
-    if (serviceStatus !== 'started') {
-      throw new errors.ServiceNotStartedError(id)
-    }
-
-    const res = await service.server.inject(injectParams)
-    // Return only serializable properties.
-    return {
-      statusCode: res.statusCode,
-      statusMessage: res.statusMessage,
-      headers: res.headers,
-      body: res.body
-    }
-  }
-}
-
-module.exports = RuntimeApi