@platformatic/runtime 1.22.0 → 1.23.0

package/fixtures/configs/monorepo-with-management-api.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v1.21.0/runtime",
+  "entrypoint": "serviceApp",
+  "allowCycles": true,
+  "hotReload": false,
+  "autoload": {
+    "path": "../monorepo",
+    "exclude": ["docs", "composerApp"],
+    "mappings": {
+      "serviceAppWithLogger": {
+        "id": "with-logger",
+        "config": "platformatic.service.json"
+      },
+      "serviceAppWithMultiplePlugins": {
+        "id": "multi-plugin-service",
+        "config": "platformatic.service.json"
+      }
+    }
+  },
+  "managementApi": {}
+}

package/fixtures/monorepo/serviceAppWithLogger/platformatic.service.json

@@ -16,5 +16,8 @@
       "plugin.js"
     ]
   },
-  "watch": true
+  "watch": true,
+  "metrics": {
+    "server": "parent"
+  }
 }

package/lib/api-client.js

@@ -27,8 +27,14 @@ class RuntimeApiClient extends EventEmitter {
     return this.#sendCommand('plt:start-services')
   }
 
+  async stop () {
+    await this.#sendCommand('plt:stop-services')
+  }
+
   async close () {
     await this.#sendCommand('plt:stop-services')
+
+    this.worker.postMessage({ command: 'plt:close' })
     await this.#exitPromise
   }
 

package/lib/api.js

@@ -47,12 +47,13 @@ class RuntimeApi {
     parentPort.on('message', async (message) => {
       const command = message?.command
       if (command) {
-        const res = await this.#executeCommand(message)
-        parentPort.postMessage(res)
-
-        if (command === 'plt:stop-services') {
+        if (command === 'plt:close') {
+          await this.#dispatcher.close()
           process.exit() // Exit the worker thread.
         }
+
+        const res = await this.#executeCommand(message)
+        parentPort.postMessage(res)
         return
       }
       await this.#handleProcessLevelEvent(message)
@@ -134,7 +135,7 @@ class RuntimeApi {
   }
 
   async stopServices () {
-    const stopServiceReqs = [this.#dispatcher.close()]
+    const stopServiceReqs = []
     for (const service of this.#services.values()) {
       const serviceStatus = service.getStatus()
       if (serviceStatus === 'started') {
@@ -269,8 +270,7 @@ class RuntimeApi {
       statusCode: res.statusCode,
       statusMessage: res.statusMessage,
       headers: res.headers,
-      body: res.body,
-      payload: res.payload
+      body: res.body
     }
   }
 }

package/lib/app.js

@@ -103,6 +103,16 @@ class PlatformaticApp {
       })
     }
 
+    if (!this.appConfig.entrypoint) {
+      configManager.update({
+        ...configManager.current,
+        server: {
+          ...(configManager.current.server || {}),
+          trustProxy: true
+        }
+      })
+    }
+
     const config = configManager.current
 
     this.#setuplogger(configManager)

package/lib/errors.js

@@ -21,5 +21,6 @@ module.exports = {
   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.')
+  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"')
 }

package/lib/generator/runtime-generator.js

@@ -84,7 +84,7 @@ class RuntimeGenerator extends BaseGenerator {
       PLT_SERVER_HOSTNAME: '0.0.0.0',
       PORT: this.config.port || 3042,
       PLT_SERVER_LOGGER_LEVEL: this.config.logLevel || 'info'
-    })
+    }, { overwrite: false })
   }
 
   addServicesDependencies () {

package/lib/management-api.js

@@ -0,0 +1,113 @@
+'use strict'
+
+const fastify = require('fastify')
+const { isatty } = require('tty')
+const platformaticVersion = require('../package.json').version
+
+async function createManagementApi (config, runtimeApiClient) {
+  addManagementApiLogger(config)
+  const app = fastify(config)
+  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.'
+  )
+
+  app.register(async (app) => {
+    app.get('/metadata', async () => {
+      return {
+        pid: process.pid,
+        cwd: process.cwd(),
+        execPath: process.execPath,
+        nodeVersion: process.version,
+        platformaticVersion
+      }
+    })
+
+    app.get('/services', async () => {
+      return runtimeApiClient.getServices()
+    })
+
+    app.post('/services/start', async () => {
+      app.log.debug('start services')
+      await runtimeApiClient.start()
+    })
+
+    app.post('/services/stop', async () => {
+      app.log.debug('stop services')
+      await runtimeApiClient.stop()
+    })
+
+    app.post('/services/restart', async () => {
+      app.log.debug('restart services')
+      await runtimeApiClient.restart()
+    })
+
+    app.get('/services/:id', async (request) => {
+      const { id } = request.params
+      app.log.debug('get service details', { id })
+      return runtimeApiClient.getServiceDetails(id)
+    })
+
+    app.get('/services/:id/config', async (request) => {
+      const { id } = request.params
+      app.log.debug('get service config', { id })
+      return runtimeApiClient.getServiceConfig(id)
+    })
+
+    app.post('/services/:id/start', async (request) => {
+      const { id } = request.params
+      app.log.debug('start service', { id })
+      await runtimeApiClient.startService(id)
+    })
+
+    app.post('/services/:id/stop', async (request) => {
+      const { id } = request.params
+      app.log.debug('stop service', { id })
+      await runtimeApiClient.stopService(id)
+    })
+
+    app.all('/services/:id/proxy/*', async (request, reply) => {
+      const { id, '*': requestUrl } = request.params
+      app.log.debug('proxy request', { id, requestUrl })
+
+      const injectParams = {
+        method: request.method,
+        url: requestUrl || '/',
+        headers: request.headers,
+        query: request.query,
+        body: request.body
+      }
+
+      const res = await runtimeApiClient.inject(id, injectParams)
+
+      reply
+        .code(res.statusCode)
+        .headers(res.headers)
+        .send(res.body)
+    })
+  }, { prefix: '/api' })
+
+  return app
+}
+
+function addManagementApiLogger (config) {
+  let logger = config.logger
+  if (!logger) {
+    config.logger = {
+      level: 'info',
+      name: 'management-api'
+    }
+    logger = config.logger
+  }
+
+  /* c8 ignore next 5 */
+  if (isatty(1) && !logger.transport) {
+    logger.transport = {
+      target: 'pino-pretty'
+    }
+  }
+}
+
+module.exports = { createManagementApi }

package/lib/schema.js

@@ -129,6 +129,15 @@ const platformaticRuntimeSchema = {
     },
     $schema: {
       type: 'string'
+    },
+    managementApi: {
+      anyOf: [
+        { type: 'boolean' },
+        {
+          type: 'object',
+          properties: {}
+        }
+      ]
     }
   },
   anyOf: [

package/lib/start.js

@@ -1,16 +1,19 @@
 'use strict'
+
+const { tmpdir, platform } = require('node:os')
 const { once } = require('node:events')
 const inspector = require('node:inspector')
 const { join, resolve, dirname } = require('node:path')
-const fs = require('node:fs/promises')
+const { writeFile, unlink, mkdir } = require('node:fs/promises')
 const { pathToFileURL } = require('node:url')
 const { Worker } = require('node:worker_threads')
-const closeWithGrace = require('close-with-grace')
 const { start: serviceStart } = require('@platformatic/service')
+const { printConfigValidationErrors } = require('@platformatic/config')
+const closeWithGrace = require('close-with-grace')
 const { loadConfig } = require('./load-config')
+const { createManagementApi } = require('./management-api')
 const { parseInspectorOptions, wrapConfigInRuntimeConfig } = require('./config')
 const RuntimeApiClient = require('./api-client.js')
-const { printConfigValidationErrors } = require('@platformatic/config')
 const errors = require('./errors')
 const pkg = require('../package.json')
 
@@ -22,6 +25,8 @@ const kWorkerExecArgv = [
   kLoaderFile
 ]
 
+const PLATFORMATIC_TMP_DIR = join(tmpdir(), 'platformatic', 'pids')
+
 async function startWithConfig (configManager, env = process.env) {
   const config = configManager.current
 
@@ -50,6 +55,8 @@ async function startWithConfig (configManager, env = process.env) {
     env
   })
 
+  let managementApi = null
+
   let exited = null
   let isWorkerAlive = true
   worker.on('exit', (code) => {
@@ -57,6 +64,7 @@ async function startWithConfig (configManager, env = process.env) {
     process.exitCode = code
     isWorkerAlive = false
     configManager.fileWatcher?.stopWatching()
+    managementApi?.close()
     if (typeof exited === 'function') {
       exited()
     }
@@ -96,6 +104,12 @@ async function startWithConfig (configManager, env = process.env) {
   await once(worker, 'message') // plt:init
 
   const runtimeApiClient = new RuntimeApiClient(worker)
+
+  if (config.managementApi) {
+    managementApi = await startManagementApi(config.managementApi, runtimeApiClient)
+    runtimeApiClient.managementApi = managementApi
+  }
+
   return runtimeApiClient
 }
 
@@ -112,6 +126,38 @@ async function start (args) {
   return serviceStart(config.app, args)
 }
 
+async function startManagementApi (managementApiConfig, runtimeApiClient) {
+  const runtimePID = process.pid
+
+  let socketPath = null
+  if (platform() === 'win32') {
+    socketPath = '\\\\.\\pipe\\' + join(PLATFORMATIC_TMP_DIR, `${runtimePID}.sock`)
+  } else {
+    await mkdir(PLATFORMATIC_TMP_DIR, { recursive: true })
+    socketPath = join(PLATFORMATIC_TMP_DIR, `${runtimePID}.sock`)
+  }
+
+  try {
+    await mkdir(PLATFORMATIC_TMP_DIR, { recursive: true })
+    await unlink(socketPath).catch((err) => {
+      if (err.code !== 'ENOENT') {
+        throw new errors.FailedToUnlinkManagementApiSocket(err.message)
+      }
+    })
+
+    const managementApi = await createManagementApi(
+      managementApiConfig,
+      runtimeApiClient
+    )
+    await managementApi.listen({ path: socketPath })
+    return managementApi
+  /* c8 ignore next 4 */
+  } catch (err) {
+    console.error(err)
+    process.exit(1)
+  }
+}
+
 async function startCommand (args) {
   try {
     const config = await loadConfig({}, args)
@@ -148,7 +194,7 @@ async function startCommand (args) {
       }
       const toWrite = join(dirname(resolve(args[0])), 'platformatic.service.json')
       console.log(`No config file found, creating ${join(dirname(args[0]), 'platformatic.service.json')}`)
-      await fs.writeFile(toWrite, JSON.stringify(config, null, 2))
+      await writeFile(toWrite, JSON.stringify(config, null, 2))
       return startCommand(['--config', toWrite])
     }
     logErrorAndExit(err)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "1.22.0",
+  "version": "1.23.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -30,8 +30,8 @@
     "tsd": "^0.30.4",
     "typescript": "^5.3.3",
     "undici-oauth-interceptor": "^0.4.2",
-    "@platformatic/sql-graphql": "1.22.0",
-    "@platformatic/sql-mapper": "1.22.0"
+    "@platformatic/sql-graphql": "1.23.0",
+    "@platformatic/sql-mapper": "1.23.0"
   },
   "dependencies": {
     "@fastify/error": "^3.4.1",
@@ -52,13 +52,13 @@
     "pino-pretty": "^10.3.1",
     "undici": "^6.6.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "1.22.0",
-    "@platformatic/db": "1.22.0",
-    "@platformatic/config": "1.22.0",
-    "@platformatic/generators": "1.22.0",
-    "@platformatic/service": "1.22.0",
-    "@platformatic/telemetry": "1.22.0",
-    "@platformatic/utils": "1.22.0"
+    "@platformatic/composer": "1.23.0",
+    "@platformatic/config": "1.23.0",
+    "@platformatic/db": "1.23.0",
+    "@platformatic/service": "1.23.0",
+    "@platformatic/generators": "1.23.0",
+    "@platformatic/telemetry": "1.23.0",
+    "@platformatic/utils": "1.23.0"
   },
   "standard": {
     "ignore": [