@platformatic/runtime 3.27.0 → 3.28.0

package/config.d.ts

@@ -48,6 +48,7 @@ export type PlatformaticRuntimeConfig = {
         };
         envfile?: string;
         sourceMaps?: boolean;
+        nodeModulesSourceMaps?: string[];
         packageManager?: "npm" | "pnpm" | "yarn";
         preload?: string | string[];
         nodeOptions?: string;
@@ -473,6 +474,7 @@ export type PlatformaticRuntimeConfig = {
     [k: string]: string;
   };
   sourceMaps?: boolean;
+  nodeModulesSourceMaps?: string[];
   scheduler?: {
     enabled?: boolean | string;
     name: string;

package/lib/management-api.js

@@ -288,6 +288,44 @@ export async function managementApiPlugin (app, opts) {
   app.get('/logs/live', { websocket: true }, async socket => {
     runtime.addLoggerDestination(createWebSocketStream(socket))
   })
+
+  app.get('/applications/:id/repl', { websocket: true }, async (socket, request) => {
+    const { id } = request.params
+
+    try {
+      // Start REPL and get the communication port
+      const port = await runtime.startApplicationRepl(id)
+
+      // Forward messages between WebSocket and MessagePort
+      port.on('message', (message) => {
+        if (message.type === 'output') {
+          socket.send(message.data)
+        } else if (message.type === 'exit') {
+          socket.close()
+        }
+      })
+
+      socket.on('message', (data) => {
+        port.postMessage({ type: 'input', data: data.toString() })
+      })
+
+      socket.on('close', () => {
+        port.postMessage({ type: 'close' })
+        port.close()
+      })
+
+      socket.on('error', () => {
+        port.postMessage({ type: 'close' })
+        port.close()
+      })
+    } catch (error) {
+      socket.send(JSON.stringify({
+        error: error.message,
+        code: error.code
+      }))
+      socket.close()
+    }
+  })
 }
 
 export async function startManagementApi (runtime) {

package/lib/runtime.js

@@ -679,6 +679,19 @@ export class Runtime extends EventEmitter {
     return sendViaITC(service, 'stopProfiling', options)
   }
 
+  async startApplicationRepl (id, ensureStarted = true) {
+    const service = await this.#getApplicationById(id, ensureStarted)
+
+    // Create a MessageChannel for REPL communication
+    const { port1, port2 } = new MessageChannel()
+
+    // Send port1 to the worker to start the REPL
+    await sendViaITC(service, 'startRepl', port1, [port1])
+
+    // Return port2 for the caller to use
+    return port2
+  }
+
   async updateUndiciInterceptors (undiciConfig) {
     this.#config.undici = undiciConfig
 
@@ -885,6 +898,10 @@ export class Runtime extends EventEmitter {
     this.#concurrency = concurrency
   }
 
+  getRoot () {
+    return this.#root
+  }
+
   getUrl () {
     return this.#url
   }
@@ -2081,6 +2098,14 @@ export class Runtime extends EventEmitter {
     const label = this.#workerExtendedLabel(applicationId, index, workersCount)
     let newWorker
 
+    const stopBeforeStart =
+      applicationConfig.entrypoint &&
+      (config.reuseTcpPorts === false || applicationConfig.reuseTcpPorts === false || !features.node.reusePort)
+
+    if (stopBeforeStart) {
+      await this.#removeWorker(workersCount, applicationId, index, worker, silent, label)
+    }
+
     try {
       if (!silent) {
         this.logger.debug(`Preparing to start a replacement for ${label}  ...`)
@@ -2104,17 +2129,25 @@ export class Runtime extends EventEmitter {
 
       this.#workers.set(workerId, newWorker)
       this.#meshInterceptor.route(applicationId, newWorker)
-
-      // Remove the old worker and then kill it
-      await sendViaITC(worker, 'removeFromMesh')
     } catch (e) {
       newWorker?.terminate?.()
       throw e
     }
 
+    if (!stopBeforeStart) {
+      await this.#removeWorker(workersCount, applicationId, index, worker, silent, label)
+    }
+  }
+
+  async #removeWorker (workersCount, applicationId, index, worker, silent, label) {
     if (!silent) {
       this.logger.debug(`Preparing to stop the old version of ${label} ...`)
     }
+
+    // Remove the old worker and then kill it
+    await sendViaITC(worker, 'removeFromMesh')
+
+    // Stop the old worker to free the port
     await this.#stopWorker(workersCount, applicationId, index, false, worker, [])
   }
 

package/lib/worker/itc.js

@@ -2,6 +2,8 @@ import { ensureLoggableError, executeInParallel, executeWithTimeout, kTimeout }
 import { ITC } from '@platformatic/itc'
 import { Unpromise } from '@watchable/unpromise'
 import { once } from 'node:events'
+import repl from 'node:repl'
+import { Duplex } from 'node:stream'
 import { parentPort, workerData } from 'node:worker_threads'
 import {
   ApplicationExitedError,
@@ -261,6 +263,55 @@ export function setupITC (controller, application, dispatcher, sharedContext) {
 
       saveMessagingChannel (channel) {
         messaging.addSource(channel)
+      },
+
+      startRepl (port) {
+        // Create a duplex stream that wraps the MessagePort
+        const replStream = new Duplex({
+          read () {},
+          write (chunk, encoding, callback) {
+            port.postMessage({ type: 'output', data: chunk.toString() })
+            callback()
+          }
+        })
+
+        port.on('message', (message) => {
+          if (message.type === 'input') {
+            replStream.push(message.data)
+          } else if (message.type === 'close') {
+            replStream.push(null)
+          }
+        })
+
+        port.on('close', () => {
+          replStream.push(null)
+        })
+
+        // Start the REPL with the stream
+        const replServer = repl.start({
+          prompt: `${controller.applicationConfig.id}> `,
+          input: replStream,
+          output: replStream,
+          terminal: false,
+          useColors: true,
+          ignoreUndefined: true,
+          preview: false
+        })
+
+        // Expose useful context
+        // For service-based capabilities, expose the Fastify app
+        replServer.context.app = controller.capability?.getApplication?.()
+        replServer.context.capability = controller.capability
+        replServer.context.platformatic = globalThis.platformatic
+        replServer.context.config = controller.applicationConfig
+        replServer.context.logger = globalThis.platformatic?.logger
+
+        replServer.on('exit', () => {
+          port.postMessage({ type: 'exit' })
+          port.close()
+        })
+
+        return { started: true }
       }
     }
   })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "3.27.0",
+  "version": "3.28.0",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -35,14 +35,14 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "3.27.0",
-    "@platformatic/gateway": "3.27.0",
-    "@platformatic/db": "3.27.0",
-    "@platformatic/service": "3.27.0",
-    "@platformatic/node": "3.27.0",
-    "@platformatic/sql-graphql": "3.27.0",
-    "@platformatic/sql-mapper": "3.27.0",
-    "@platformatic/wattpm-pprof-capture": "3.27.0"
+    "@platformatic/composer": "3.28.0",
+    "@platformatic/db": "3.28.0",
+    "@platformatic/gateway": "3.28.0",
+    "@platformatic/node": "3.28.0",
+    "@platformatic/sql-graphql": "3.28.0",
+    "@platformatic/service": "3.28.0",
+    "@platformatic/sql-mapper": "3.28.0",
+    "@platformatic/wattpm-pprof-capture": "3.28.0"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -71,12 +71,12 @@
     "undici": "^7.0.0",
     "undici-thread-interceptor": "^0.15.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "3.27.0",
-    "@platformatic/foundation": "3.27.0",
-    "@platformatic/generators": "3.27.0",
-    "@platformatic/metrics": "3.27.0",
-    "@platformatic/itc": "3.27.0",
-    "@platformatic/telemetry": "3.27.0"
+    "@platformatic/basic": "3.28.0",
+    "@platformatic/generators": "3.28.0",
+    "@platformatic/foundation": "3.28.0",
+    "@platformatic/itc": "3.28.0",
+    "@platformatic/metrics": "3.28.0",
+    "@platformatic/telemetry": "3.28.0"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.27.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.28.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Runtime Config",
   "type": "object",
@@ -227,6 +227,12 @@
               "sourceMaps": {
                 "type": "boolean"
               },
+              "nodeModulesSourceMaps": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
               "packageManager": {
                 "type": "string",
                 "enum": [
@@ -525,6 +531,12 @@
           "sourceMaps": {
             "type": "boolean"
           },
+          "nodeModulesSourceMaps": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "packageManager": {
             "type": "string",
             "enum": [
@@ -821,6 +833,12 @@
           "sourceMaps": {
             "type": "boolean"
           },
+          "nodeModulesSourceMaps": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "packageManager": {
             "type": "string",
             "enum": [
@@ -1117,6 +1135,12 @@
           "sourceMaps": {
             "type": "boolean"
           },
+          "nodeModulesSourceMaps": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "packageManager": {
             "type": "string",
             "enum": [
@@ -2388,6 +2412,13 @@
       "type": "boolean",
       "default": false
     },
+    "nodeModulesSourceMaps": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "default": []
+    },
     "scheduler": {
       "type": "array",
       "items": {