@platformatic/runtime 1.53.3 → 2.0.0-alpha.10

package/lib/generator/runtime-generator.js

@@ -5,7 +5,7 @@ const { NoEntryPointError, NoServiceNamedError } = require('./errors')
 const generateName = require('boring-name-generator')
 const { join } = require('node:path')
 const { envObjectToString } = require('@platformatic/generators/lib/utils')
-const { readFile, readdir, stat, rm } = require('node:fs/promises')
+const { readFile, readdir, stat } = require('node:fs/promises')
 const { ConfigManager } = require('@platformatic/config')
 const { platformaticRuntime } = require('../config')
 const { getServiceTemplateFromSchemaUrl } = require('@platformatic/generators/lib/utils')
@@ -13,12 +13,13 @@ const { DotEnvTool } = require('dotenv-tool')
 const { getArrayDifference } = require('../utils')
 const { createRequire } = require('node:module')
 const { pathToFileURL } = require('node:url')
+const { safeRemove } = require('@platformatic/utils')
 
 class RuntimeGenerator extends BaseGenerator {
   constructor (opts) {
     super({
       ...opts,
-      module: '@platformatic/runtime'
+      module: '@platformatic/runtime',
     })
     this.runtimeName = opts.name
     this.services = []
@@ -32,14 +33,14 @@ class RuntimeGenerator extends BaseGenerator {
     const newConfig = {
       ...originalConfig,
       isRuntimeContext: true,
-      serviceName
+      serviceName,
     }
     // reset all files previously generated by the service
     service.reset()
     service.setConfig(newConfig)
     this.services.push({
       name: serviceName,
-      service
+      service,
     })
 
     if (typeof service.setRuntime === 'function') {
@@ -48,7 +49,7 @@ class RuntimeGenerator extends BaseGenerator {
   }
 
   setEntryPoint (entryPoint) {
-    const service = this.services.find((svc) => svc.name === entryPoint)
+    const service = this.services.find(svc => svc.name === entryPoint)
     if (!service) {
       throw new NoServiceNamedError(entryPoint)
     }
@@ -60,23 +61,24 @@ class RuntimeGenerator extends BaseGenerator {
       name: `${this.runtimeName}`,
       workspaces: ['services/*'],
       scripts: {
-        start: 'platformatic start'
+        start: 'platformatic start',
       },
       devDependencies: {
         fastify: `^${this.fastifyVersion}`,
-        borp: `${this.pkgData.devDependencies.borp}`
+        borp: `${this.pkgData.devDependencies.borp}`,
       },
       dependencies: {
         '@platformatic/runtime': `^${this.platformaticVersion}`,
         platformatic: `^${this.platformaticVersion}`,
-        ...this.config.dependencies
+        ...this.config.dependencies,
       },
       engines: {
-        node: '^18.8.0 || >=20.6.0'
-      }
+        node: '^18.8.0 || >=20.6.0',
+      },
     }
     if (this.config.typescript) {
-      const typescriptVersion = JSON.parse(await readFile(join(__dirname, '..', '..', 'package.json'), 'utf-8')).devDependencies.typescript
+      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'
       template.devDependencies.typescript = typescriptVersion
@@ -89,18 +91,21 @@ 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(
+      {
+        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 }
+    )
   }
 
   addServicesDependencies () {
     this.services.forEach(({ service }) => {
       if (service.config.dependencies) {
-        Object.entries(service.config.dependencies).forEach((kv) => {
+        Object.entries(service.config.dependencies).forEach(kv => {
           this.config.dependencies[kv[0]] = kv[1]
         })
       }
@@ -116,13 +121,13 @@ class RuntimeGenerator extends BaseGenerator {
     if (existingConfigFile) {
       const configManager = new ConfigManager({
         ...platformaticRuntime.configManagerConfig,
-        source: join(this.targetDirectory, existingConfigFile)
+        source: join(this.targetDirectory, existingConfigFile),
       })
       await configManager.parse()
       this.existingConfig = configManager.current
       this.config.env = configManager.env
       this.config.port = configManager.env.PORT
-      this.entryPoint = configManager.current.services.find((svc) => svc.entrypoint)
+      this.entryPoint = configManager.current.services.find(svc => svc.entrypoint)
     }
   }
 
@@ -134,7 +139,7 @@ class RuntimeGenerator extends BaseGenerator {
       await this._afterPrepare()
       return {
         env: this.config.env,
-        targetDirectory: this.targetDirectory
+        targetDirectory: this.targetDirectory,
       }
     } else {
       return await super.prepare()
@@ -153,22 +158,21 @@ class RuntimeGenerator extends BaseGenerator {
 
   async _getConfigFileContents () {
     const config = {
-      $schema: `https://platformatic.dev/schemas/v${this.platformaticVersion}/runtime`,
+      $schema: `https://schemas.platformatic.dev/@platformatic/runtime/${this.platformaticVersion}.json`,
       entrypoint: this.entryPoint.name,
-      allowCycles: false,
-      hotReload: true,
+      watch: true,
       autoload: {
         path: 'services',
-        exclude: ['docs']
+        exclude: ['docs'],
       },
       server: {
         hostname: '{PLT_SERVER_HOSTNAME}',
         port: '{PORT}',
         logger: {
-          level: '{PLT_SERVER_LOGGER_LEVEL}'
-        }
+          level: '{PLT_SERVER_LOGGER_LEVEL}',
+        },
       },
-      managementApi: '{PLT_MANAGEMENT_API}'
+      managementApi: '{PLT_MANAGEMENT_API}',
     }
 
     return config
@@ -182,28 +186,28 @@ class RuntimeGenerator extends BaseGenerator {
     this.addEnvVars({
       ...this.config.env,
       ...this.getRuntimeEnv(),
-      ...servicesEnv
+      ...servicesEnv,
     })
 
     this.addFile({
       path: '',
       file: '.env',
-      contents: envObjectToString(this.config.env)
+      contents: envObjectToString(this.config.env),
     })
 
     this.addFile({
       path: '',
       file: '.env.sample',
-      contents: envObjectToString(this.config.env)
+      contents: envObjectToString(this.config.env),
     })
 
     if (!this.existingConfig) {
-      this.addFile({ path: '', file: 'README.md', contents: await readFile(join(__dirname, 'README.md')) })
+      this.addFile({ path: '', file: 'README.md', contents: await readFile(join(__dirname, 'README.md'), 'utf-8') })
     }
 
     return {
       targetDirectory: this.targetDirectory,
-      env: servicesEnv
+      env: servicesEnv,
     }
   }
 
@@ -225,7 +229,10 @@ class RuntimeGenerator extends BaseGenerator {
       name: 'typescript',
       message: 'Do you want to use TypeScript?',
       default: false,
-      choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
+      choices: [
+        { name: 'yes', value: true },
+        { name: 'no', value: false },
+      ],
     })
 
     if (this.existingConfig) {
@@ -237,7 +244,7 @@ class RuntimeGenerator extends BaseGenerator {
       type: 'input',
       name: 'port',
       default: 3042,
-      message: 'What port do you want to use?'
+      message: 'What port do you want to use?',
     })
   }
 
@@ -252,11 +259,11 @@ class RuntimeGenerator extends BaseGenerator {
   }
 
   setServicesConfig (configToOverride) {
-    this.services.forEach((service) => {
+    this.services.forEach(service => {
       const originalConfig = service.config
       service.setConfig({
         ...originalConfig,
-        ...configToOverride
+        ...configToOverride,
       })
     })
   }
@@ -267,12 +274,12 @@ class RuntimeGenerator extends BaseGenerator {
       // Propagate TypeScript
       svc.service.setConfig({
         ...svc.service.config,
-        typescript: this.config.typescript
+        typescript: this.config.typescript,
       })
       const svcEnv = await svc.service.prepare()
       servicesEnv = {
         ...servicesEnv,
-        ...svcEnv.env
+        ...svcEnv.env,
       }
     }
     return servicesEnv
@@ -288,7 +295,7 @@ class RuntimeGenerator extends BaseGenerator {
 
   getRuntimeEnv () {
     return {
-      PORT: this.config.port
+      PORT: this.config.port,
     }
   }
 
@@ -306,9 +313,11 @@ class RuntimeGenerator extends BaseGenerator {
 
   async loadFromDir () {
     const output = {
-      services: []
+      services: [],
     }
-    const runtimePkgConfigFileData = JSON.parse(await readFile(join(this.targetDirectory, 'platformatic.json'), 'utf-8'))
+    const runtimePkgConfigFileData = JSON.parse(
+      await readFile(join(this.targetDirectory, 'platformatic.json'), 'utf-8')
+    )
     const servicesPath = join(this.targetDirectory, runtimePkgConfigFileData.autoload.path)
 
     // load all services
@@ -324,7 +333,7 @@ class RuntimeGenerator extends BaseGenerator {
         const template = servicePltJson.module || getServiceTemplateFromSchemaUrl(servicePltJson.$schema)
         const Generator = await this._getGeneratorForTemplate(currentServicePath, template)
         const instance = new Generator({
-          logger: this.logger
+          logger: this.logger,
         })
         this.addService(instance, s)
         output.services.push(await instance.loadFromDir(s, this.targetDirectory))
@@ -341,11 +350,11 @@ class RuntimeGenerator extends BaseGenerator {
     const currrentPackageJson = JSON.parse(await readFile(join(this.targetDirectory, 'package.json'), 'utf-8'))
     const currentRuntimeDependencies = currrentPackageJson.dependencies
     // check all services are present with the same template
-    const allCurrentServicesNames = this.services.map((s) => s.name)
-    const allNewServicesNames = newConfig.services.map((s) => s.name)
+    const allCurrentServicesNames = this.services.map(s => s.name)
+    const allNewServicesNames = newConfig.services.map(s => s.name)
     // load dotenv tool
     const envTool = new DotEnvTool({
-      path: join(this.targetDirectory, '.env')
+      path: join(this.targetDirectory, '.env'),
     })
 
     await envTool.load()
@@ -356,24 +365,25 @@ class RuntimeGenerator extends BaseGenerator {
         // handle service delete
 
         // delete env variables
-        const s = this.services.find((f) => f.name === removedService)
+        const s = this.services.find(f => f.name === removedService)
         const allKeys = envTool.getKeys()
-        allKeys.forEach((k) => {
+        allKeys.forEach(k => {
           if (k.startsWith(`PLT_${s.service.config.envPrefix}`)) {
             envTool.deleteKey(k)
           }
         })
 
         // delete dependencies
-        const servicePackageJson = JSON.parse(await readFile(join(this.targetDirectory, 'services', s.name, 'platformatic.json')))
+        const servicePackageJson = JSON.parse(
+          await readFile(join(this.targetDirectory, 'services', s.name, 'platformatic.json'), 'utf-8')
+        )
         if (servicePackageJson.plugins && servicePackageJson.plugins.packages) {
-          servicePackageJson.plugins.packages
-            .forEach((p) => {
-              delete (currrentPackageJson.dependencies[p.name])
-            })
+          servicePackageJson.plugins.packages.forEach(p => {
+            delete currrentPackageJson.dependencies[p.name]
+          })
         }
         // delete directory
-        await rm(join(this.targetDirectory, 'services', s.name), { recursive: true })
+        await safeRemove(join(this.targetDirectory, 'services', s.name))
       }
       // throw new CannotRemoveServiceOnUpdateError(removedServices.join(', '))
     }
@@ -381,15 +391,18 @@ class RuntimeGenerator extends BaseGenerator {
     // handle new services
     for (const newService of newConfig.services) {
       // create generator for the service
-      const ServiceGenerator = await this._getGeneratorForTemplate(join(this.targetDirectory, 'package.json'), newService.template)
+      const ServiceGenerator = await this._getGeneratorForTemplate(
+        join(this.targetDirectory, 'package.json'),
+        newService.template
+      )
       const serviceInstance = new ServiceGenerator({
-        logger: this.logger
+        logger: this.logger,
       })
       const baseConfig = {
         isRuntimeContext: true,
         targetDirectory: join(this.targetDirectory, 'services', newService.name),
         serviceName: newService.name,
-        plugin: true
+        plugin: true,
       }
       if (allCurrentServicesNames.includes(newService.name)) {
         // update existing services env values
@@ -398,15 +411,15 @@ class RuntimeGenerator extends BaseGenerator {
 
         // handle service's plugin differences
         const oldServiceMetadata = await serviceInstance.loadFromDir(newService.name, this.targetDirectory)
-        const oldServicePackages = oldServiceMetadata.plugins.map((meta) => meta.name)
-        const newServicePackages = newService.plugins.map((meta) => meta.name)
+        const oldServicePackages = oldServiceMetadata.plugins.map(meta => meta.name)
+        const newServicePackages = newService.plugins.map(meta => meta.name)
         const pluginsToRemove = getArrayDifference(oldServicePackages, newServicePackages)
-        pluginsToRemove.forEach((p) => delete currentRuntimeDependencies[p])
+        pluginsToRemove.forEach(p => delete currentRuntimeDependencies[p])
       } else {
         // add service to the generator
         this.services.push({
           name: newService.name,
-          service: serviceInstance
+          service: serviceInstance,
         })
       }
       serviceInstance.setConfig(baseConfig)
@@ -431,7 +444,7 @@ class RuntimeGenerator extends BaseGenerator {
       await serviceInstance.writeFiles()
       // cleanup runtime env removing keys not present anymore in service plugins
       const allKeys = envTool.getKeys()
-      allKeys.forEach((k) => {
+      allKeys.forEach(k => {
         if (k.startsWith(`${serviceEnvPrefix}_FST_PLUGIN`) && !runtimeAddedEnvKeys.includes(k)) {
           envTool.deleteKey(k)
         }
@@ -445,26 +458,28 @@ class RuntimeGenerator extends BaseGenerator {
     // update runtime package.json dependencies
     currrentPackageJson.dependencies = {
       ...currrentPackageJson.dependencies,
-      ...allServicesDependencies
+      ...allServicesDependencies,
     }
     this.addFile({
       path: '',
       file: 'package.json',
-      contents: JSON.stringify(currrentPackageJson, null, 2)
+      contents: JSON.stringify(currrentPackageJson, null, 2),
     })
 
     // set new entrypoint if specified
     const newEntrypoint = newConfig.entrypoint
     if (newEntrypoint) {
       // load platformatic.json runtime config
-      const runtimePkgConfigFileData = JSON.parse(await readFile(join(this.targetDirectory, 'platformatic.json'), 'utf-8'))
+      const runtimePkgConfigFileData = JSON.parse(
+        await readFile(join(this.targetDirectory, 'platformatic.json'), 'utf-8')
+      )
 
       this.setEntryPoint(newEntrypoint)
       runtimePkgConfigFileData.entrypoint = newEntrypoint
       this.addFile({
         path: '',
         file: 'platformatic.json',
-        contents: JSON.stringify(runtimePkgConfigFileData, null, 2)
+        contents: JSON.stringify(runtimePkgConfigFileData, null, 2),
       })
     }
     await this.writeFiles()

package/lib/logger.js

@@ -0,0 +1,55 @@
+'use strict'
+
+const { join } = require('node:path')
+const { isatty } = require('node:tty')
+
+const pino = require('pino')
+const pretty = require('pino-pretty')
+
+function createLogger (config, runtimeLogsDir) {
+  const loggerConfig = { ...config.server?.logger }
+  const cliStream = isatty(1) ? pretty() : pino.destination(1)
+
+  if (!config.managementApi) {
+    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 })
+  }
+
+  if (config.managementApi) {
+    const logsFileMb = 5
+    const logsLimitMb = config.managementApi?.logs?.maxSize || 200
+
+    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,
+        },
+      },
+    })
+
+    multiStream.add({ level: 'trace', stream: pinoRoll })
+  }
+
+  return [pino({ level: 'trace' }, multiStream), multiStream]
+}
+
+module.exports = { createLogger }

package/lib/management-api.js

@@ -1,22 +1,23 @@
 'use strict'
 
-const { tmpdir } = require('node:os')
-const { platform } = require('node:os')
+const { platform, tmpdir } = require('node:os')
 const { join } = require('node:path')
-const { mkdir, rm } = require('node:fs/promises')
+const { createDirectory, safeRemove } = require('@platformatic/utils')
+
 const fastify = require('fastify')
 const ws = require('ws')
-const { getRuntimeLogsDir } = require('./api-client.js')
+
 const errors = require('./errors')
+const { getRuntimeLogsDir } = require('./utils')
 
 const PLATFORMATIC_TMP_DIR = join(tmpdir(), 'platformatic', 'runtimes')
 
 async function managementApiPlugin (app, opts) {
   app.log.warn(
     'Runtime Management API is in the experimental stage. ' +
-    'The feature is not subject to semantic versioning rules. ' +
-    'Non-backward compatible changes or removal may occur in any future release. ' +
-    'Use of the feature is not recommended in production environments.'
+      'The feature is not subject to semantic versioning rules. ' +
+      'Non-backward compatible changes or removal may occur in any future release. ' +
+      'Use of the feature is not recommended in production environments.'
   )
 
   const runtime = opts.runtime
@@ -35,7 +36,7 @@ async function managementApiPlugin (app, opts) {
 
   app.post('/stop', async () => {
     app.log.debug('stop services')
-    await runtime.close()
+    await runtime.close(true)
   })
 
   app.post('/reload', async () => {
@@ -47,40 +48,40 @@ async function managementApiPlugin (app, opts) {
     return runtime.getServices()
   })
 
-  app.get('/services/:id', async (request) => {
+  app.get('/services/:id', async request => {
     const { id } = request.params
     app.log.debug('get service details', { id })
     return runtime.getServiceDetails(id)
   })
 
-  app.get('/services/:id/config', async (request) => {
+  app.get('/services/:id/config', async request => {
     const { id } = request.params
     app.log.debug('get service config', { id })
     return runtime.getServiceConfig(id)
   })
 
-  app.get('/services/:id/openapi-schema', async (request) => {
+  app.get('/services/:id/openapi-schema', async request => {
     const { id } = request.params
     app.log.debug('get openapi-schema', { id })
     return runtime.getServiceOpenapiSchema(id)
   })
 
-  app.get('/services/:id/graphql-schema', async (request) => {
+  app.get('/services/:id/graphql-schema', async request => {
     const { id } = request.params
     app.log.debug('get graphql-schema', { id })
     return runtime.getServiceGraphqlSchema(id)
   })
 
-  app.post('/services/:id/start', async (request) => {
+  app.post('/services/:id/start', async request => {
     const { id } = request.params
     app.log.debug('start service', { id })
     await runtime.startService(id)
   })
 
-  app.post('/services/:id/stop', async (request) => {
+  app.post('/services/:id/stop', async request => {
     const { id } = request.params
     app.log.debug('stop service', { id })
-    await runtime.stopService(id)
+    await runtime._stopService(id)
   })
 
   app.all('/services/:id/proxy/*', async (request, reply) => {
@@ -97,27 +98,22 @@ 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)
 
-    reply
-      .code(res.statusCode)
-      .headers(res.headers)
-      .send(res.body)
+    reply.code(res.statusCode).headers(res.headers).send(res.body)
   })
 
-  app.get('/metrics/live', { websocket: true }, async (socket) => {
+  app.get('/metrics/live', { websocket: true }, async socket => {
     const cachedMetrics = runtime.getCachedMetrics()
     if (cachedMetrics.length > 0) {
-      const serializedMetrics = cachedMetrics
-        .map((metric) => JSON.stringify(metric))
-        .join('\n')
+      const serializedMetrics = cachedMetrics.map(metric => JSON.stringify(metric)).join('\n')
       socket.send(serializedMetrics + '\n')
     }
 
-    const eventHandler = (metrics) => {
+    const eventHandler = metrics => {
       const serializedMetrics = JSON.stringify(metrics)
       socket.send(serializedMetrics + '\n')
     }
@@ -147,7 +143,7 @@ async function managementApiPlugin (app, opts) {
     runtime.pipeLogsStream(stream, req.log, startLogId)
   })
 
-  app.get('/logs/indexes', async (req) => {
+  app.get('/logs/indexes', async req => {
     const returnAllIds = req.query.all === 'true'
 
     if (returnAllIds) {
@@ -168,16 +164,10 @@ async function managementApiPlugin (app, opts) {
 
     reply.hijack()
 
-    runtime.pipeLogsStream(
-      reply.raw,
-      req.log,
-      startLogId,
-      endLogId,
-      runtimePID
-    )
+    runtime.pipeLogsStream(reply.raw, req.log, startLogId, endLogId, runtimePID)
   })
 
-  app.get('/logs/:id', async (req) => {
+  app.get('/logs/:id', async req => {
     const logId = parseInt(req.params.id)
     const runtimePID = parseInt(req.query.pid) || process.pid
 
@@ -186,10 +176,7 @@ async function managementApiPlugin (app, opts) {
       throw new errors.LogFileNotFound(logId)
     }
 
-    const logFileStream = await runtime.getLogFileStream(
-      logId,
-      runtimePID
-    )
+    const logFileStream = await runtime.getLogFileStream(logId, runtimePID)
     return logFileStream
   })
 }
@@ -200,13 +187,11 @@ async function startManagementApi (runtime, configManager) {
   try {
     const runtimePIDDir = join(PLATFORMATIC_TMP_DIR, runtimePID.toString())
     if (platform() !== 'win32') {
-      await rm(runtimePIDDir, { recursive: true, force: true }).catch()
-      await mkdir(runtimePIDDir, { recursive: true })
+      await createDirectory(runtimePIDDir, true)
     }
 
     const runtimeLogsDir = getRuntimeLogsDir(configManager.dirname, process.pid)
-    await rm(runtimeLogsDir, { recursive: true, force: true }).catch()
-    await mkdir(runtimeLogsDir, { recursive: true })
+    await createDirectory(runtimeLogsDir, true)
 
     let socketPath = null
     if (platform() === 'win32') {
@@ -221,13 +206,13 @@ async function startManagementApi (runtime, configManager) {
 
     managementApi.addHook('onClose', async () => {
       if (platform() !== 'win32') {
-        await rm(runtimePIDDir, { recursive: true, force: true }).catch()
+        await safeRemove(runtimePIDDir)
       }
     })
 
     await managementApi.listen({ path: socketPath })
     return managementApi
-  /* c8 ignore next 4 */
+    /* c8 ignore next 4 */
   } catch (err) {
     console.error(err)
     process.exit(1)