@platformatic/runtime 1.29.0 → 1.30.0

package/fixtures/configs/monorepo.json

@@ -3,6 +3,7 @@
   "entrypoint": "serviceApp",
   "allowCycles": true,
   "hotReload": false,
+  "managementApi": false,
   "autoload": {
     "path": "../monorepo",
     "exclude": [

package/fixtures/management-api/services/service-1/plugin.js

@@ -7,8 +7,8 @@ module.exports = async function (app) {
   })
 
   app.get('/large-logs', async (req) => {
-    const largeLog = 'a'.repeat(5 * 1024 * 1024)
-    for (let i = 0; i < 10; i++) {
+    const largeLog = 'a'.repeat(100)
+    for (let i = 0; i < 500000; i++) {
       app.log.trace(largeLog)
     }
   })

package/lib/generator/runtime-generator.js

@@ -14,6 +14,7 @@ const ComposerGenerator = require('@platformatic/composer/lib/generator/composer
 const { CannotFindGeneratorForTemplateError, CannotRemoveServiceOnUpdateError } = require('../errors')
 const { getServiceTemplateFromSchemaUrl } = require('@platformatic/generators/lib/utils')
 const { DotEnvTool } = require('dotenv-tool')
+const { getArrayDifference } = require('../utils')
 
 class RuntimeGenerator extends BaseGenerator {
   constructor (opts) {
@@ -91,7 +92,8 @@ class RuntimeGenerator extends BaseGenerator {
     this.addEnvVars({
       PLT_SERVER_HOSTNAME: '0.0.0.0',
       PORT: this.config.port || 3042,
-      PLT_SERVER_LOGGER_LEVEL: this.config.logLevel || 'info'
+      PLT_SERVER_LOGGER_LEVEL: this.config.logLevel || 'info',
+      PLT_MANAGEMENT_API: true
     }, { overwrite: false })
   }
 
@@ -165,7 +167,8 @@ class RuntimeGenerator extends BaseGenerator {
         logger: {
           level: '{PLT_SERVER_LOGGER_LEVEL}'
         }
-      }
+      },
+      managementApi: '{PLT_MANAGEMENT_API}'
     }
 
     return config
@@ -337,13 +340,11 @@ class RuntimeGenerator extends BaseGenerator {
 
   async update (newConfig) {
     let allServicesDependencies = {}
-    function getDifference (a, b) {
-      return a.filter(element => {
-        return !b.includes(element)
-      })
-    }
-    this.config.isUpdating = true
+    const runtimeAddedEnvKeys = []
 
+    this.config.isUpdating = true
+    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)
@@ -354,7 +355,7 @@ class RuntimeGenerator extends BaseGenerator {
 
     await envTool.load()
 
-    const removedServices = getDifference(allCurrentServicesNames, allNewServicesNames)
+    const removedServices = getArrayDifference(allCurrentServicesNames, allNewServicesNames)
     if (removedServices.length > 0) {
       throw new CannotRemoveServiceOnUpdateError(removedServices.join(', '))
     }
@@ -373,12 +374,22 @@ class RuntimeGenerator extends BaseGenerator {
         // update existing services env values
         // otherwise, is a new service
         baseConfig.isUpdating = true
+
+        // 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 pluginsToRemove = getArrayDifference(oldServicePackages, newServicePackages)
+        pluginsToRemove.forEach((p) => delete currentRuntimeDependencies[p])
       }
       serviceInstance.setConfig(baseConfig)
+
+      const serviceEnvPrefix = `PLT_${serviceInstance.config.envPrefix}`
       for (const plug of newService.plugins) {
         await serviceInstance.addPackage(plug)
         for (const opt of plug.options) {
-          const key = `PLT_${serviceInstance.config.envPrefix}_${opt.name}`
+          const key = `${serviceEnvPrefix}_${opt.name}`
+          runtimeAddedEnvKeys.push(key)
           const value = opt.value
           if (envTool.hasKey(key)) {
             envTool.updateKey(key, value)
@@ -390,11 +401,16 @@ class RuntimeGenerator extends BaseGenerator {
       allServicesDependencies = { ...allServicesDependencies, ...serviceInstance.config.dependencies }
       await serviceInstance.prepare()
       await serviceInstance.writeFiles()
+      // cleanup runtime env removing keys not present anymore in service plugins
+      const allKeys = envTool.getKeys()
+      allKeys.forEach((k) => {
+        if (k.startsWith('PLT_') && !runtimeAddedEnvKeys.includes(k)) {
+          envTool.deleteKey(k)
+        }
+      })
     }
 
     // update runtime package.json dependencies
-    // read current package.json file
-    const currrentPackageJson = JSON.parse(await readFile(join(this.targetDirectory, 'package.json'), 'utf-8'))
     currrentPackageJson.dependencies = {
       ...currrentPackageJson.dependencies,
       ...allServicesDependencies
@@ -402,7 +418,7 @@ class RuntimeGenerator extends BaseGenerator {
     this.addFile({
       path: '',
       file: 'package.json',
-      contents: JSON.stringify(currrentPackageJson)
+      contents: JSON.stringify(currrentPackageJson, null, 2)
     })
 
     await this.writeFiles()

package/lib/logs.js

@@ -21,7 +21,9 @@ async function getLogFiles () {
   return runtimeLogFiles
 }
 
-async function pipeLiveLogs (writableStream, logger, startLogIndex) {
+async function pipeLogsStream (writableStream, logger, startLogIndex, endLogIndex) {
+  endLogIndex = endLogIndex || Infinity
+
   const runtimeLogFiles = await getLogFiles()
   if (runtimeLogFiles.length === 0) {
     writableStream.end()
@@ -47,6 +49,11 @@ async function pipeLiveLogs (writableStream, logger, startLogIndex) {
   }).unref()
 
   const streamLogFile = () => {
+    if (fileIndex > endLogIndex) {
+      writableStream.end()
+      return
+    }
+
     const fileName = 'logs.' + fileIndex
     const filePath = join(runtimeTmpDir, fileName)
 
@@ -61,7 +68,7 @@ async function pipeLiveLogs (writableStream, logger, startLogIndex) {
     }
 
     fileStream.on('error', (err) => {
-      logger.log.error(err, 'Error streaming log file')
+      logger.error(err, 'Error streaming log file')
       fileStream.destroy()
       watcher.close()
       writableStream.end()
@@ -72,6 +79,10 @@ async function pipeLiveLogs (writableStream, logger, startLogIndex) {
     })
 
     fileStream.on('eof', () => {
+      if (fileIndex >= endLogIndex) {
+        writableStream.end()
+        return
+      }
       if (latestFileIndex > fileIndex) {
         streamLogFile(++fileIndex)
       } else {
@@ -106,7 +117,7 @@ async function getLogFileStream (logFileIndex) {
 }
 
 module.exports = {
-  pipeLiveLogs,
+  pipeLogsStream,
   getLogFileStream,
   getLogIndexes
 }

package/lib/management-api.js

@@ -6,7 +6,7 @@ const { readFile, mkdir, unlink } = require('node:fs/promises')
 const fastify = require('fastify')
 const ws = require('ws')
 const errors = require('./errors')
-const { pipeLiveLogs, getLogFileStream, getLogIndexes } = require('./logs')
+const { pipeLogsStream, getLogFileStream, getLogIndexes } = require('./logs')
 const platformaticVersion = require('../package.json').version
 
 const PLATFORMATIC_TMP_DIR = join(tmpdir(), 'platformatic', 'runtimes')
@@ -118,14 +118,16 @@ async function createManagementApi (configManager, runtimeApiClient) {
 
     app.get('/metrics/live', { websocket: true }, async (socket) => {
       const cachedMetrics = runtimeApiClient.getCachedMetrics()
-      const serializedMetrics = cachedMetrics
-        .map((metric) => JSON.stringify(metric))
-        .join('\n')
-      socket.send(serializedMetrics)
+      if (cachedMetrics.length > 0) {
+        const serializedMetrics = cachedMetrics
+          .map((metric) => JSON.stringify(metric))
+          .join('\n')
+        socket.send(serializedMetrics + '\n')
+      }
 
       const eventHandler = (metrics) => {
         const serializedMetrics = JSON.stringify(metrics)
-        socket.send(serializedMetrics)
+        socket.send(serializedMetrics + '\n')
       }
 
       runtimeApiClient.on('metrics', eventHandler)
@@ -150,8 +152,7 @@ async function createManagementApi (configManager, runtimeApiClient) {
       }
 
       const stream = ws.createWebSocketStream(socket)
-
-      pipeLiveLogs(stream, req.log, startLogIndex)
+      pipeLogsStream(stream, req.log, startLogIndex)
     })
 
     app.get('/logs/indexes', async () => {
@@ -159,6 +160,15 @@ async function createManagementApi (configManager, runtimeApiClient) {
       return { indexes: logIndexes }
     })
 
+    app.get('/logs/all', async (req, reply) => {
+      const logIndexes = await getLogIndexes()
+      const startLogIndex = logIndexes.at(0)
+      const endLogIndex = logIndexes.at(-1)
+
+      reply.hijack()
+      pipeLogsStream(reply.raw, req.log, startLogIndex, endLogIndex)
+    })
+
     app.get('/logs/:id', async (req) => {
       const { id } = req.params
 

package/lib/schema.js

@@ -150,6 +150,7 @@ const platformaticRuntimeSchema = {
     managementApi: {
       anyOf: [
         { type: 'boolean' },
+        { type: 'string' },
         {
           type: 'object',
           properties: {
@@ -163,7 +164,8 @@ const platformaticRuntimeSchema = {
           },
           additionalProperties: false
         }
-      ]
+      ],
+      default: true
     },
     metrics: {
       anyOf: [

package/lib/utils.js

@@ -0,0 +1,10 @@
+'use strict'
+function getArrayDifference (a, b) {
+  return a.filter(element => {
+    return !b.includes(element)
+  })
+}
+
+module.exports = {
+  getArrayDifference
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "1.29.0",
+  "version": "1.30.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -33,8 +33,8 @@
     "typescript": "^5.4.2",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/sql-graphql": "1.29.0",
-    "@platformatic/sql-mapper": "1.29.0"
+    "@platformatic/sql-mapper": "1.30.0",
+    "@platformatic/sql-graphql": "1.30.0"
   },
   "dependencies": {
     "ws": "^8.16.0",
@@ -47,7 +47,7 @@
     "commist": "^3.2.0",
     "debounce": "^2.0.0",
     "desm": "^1.3.1",
-    "dotenv-tool": "^0.0.2",
+    "dotenv-tool": "^0.1.1",
     "es-main": "^1.3.0",
     "fastest-levenshtein": "^1.0.16",
     "fastify": "^4.26.2",
@@ -62,13 +62,13 @@
     "tail-file-stream": "^0.1.0",
     "undici": "^6.9.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "1.29.0",
-    "@platformatic/config": "1.29.0",
-    "@platformatic/db": "1.29.0",
-    "@platformatic/generators": "1.29.0",
-    "@platformatic/telemetry": "1.29.0",
-    "@platformatic/service": "1.29.0",
-    "@platformatic/utils": "1.29.0"
+    "@platformatic/composer": "1.30.0",
+    "@platformatic/db": "1.30.0",
+    "@platformatic/config": "1.30.0",
+    "@platformatic/generators": "1.30.0",
+    "@platformatic/service": "1.30.0",
+    "@platformatic/telemetry": "1.30.0",
+    "@platformatic/utils": "1.30.0"
   },
   "standard": {
     "ignore": [