@platformatic/basic 2.22.0 → 2.24.0

package/index.js

@@ -1,6 +1,6 @@
+import { createRequire } from '@platformatic/utils'
 import { existsSync } from 'node:fs'
 import { readFile } from 'node:fs/promises'
-import { createRequire } from 'node:module'
 import { relative, resolve } from 'node:path'
 import { workerData } from 'node:worker_threads'
 import pino from 'pino'
@@ -37,7 +37,7 @@ function isImportFailedError (error, pkg) {
   return match?.[1] === pkg || error.requireStack?.[0].endsWith(importStackablePackageMarker)
 }
 
-async function importStackablePackage (opts, pkg, autodetectDescription) {
+async function importStackablePackage (opts, pkg) {
   try {
     try {
       // Try regular import
@@ -105,7 +105,7 @@ async function buildStackable (opts) {
     toImport = '@platformatic/astro'
   }
 
-  const imported = await importStackablePackage(opts, toImport, autodetectDescription)
+  const imported = await importStackablePackage(opts, toImport)
 
   const serviceRoot = relative(process.cwd(), opts.context.directory)
   if (

package/lib/base.js

@@ -1,4 +1,4 @@
-import { collectMetrics } from '@platformatic/metrics'
+import { client, collectMetrics } from '@platformatic/metrics'
 import { deepmerge, executeWithTimeout } from '@platformatic/utils'
 import { parseCommandString } from 'execa'
 import { spawn } from 'node:child_process'
@@ -19,6 +19,7 @@ export class BaseStackable {
   childManager
   subprocess
   #subprocessStarted
+  #metricsCollected
 
   constructor (type, version, options, root, configManager) {
     options.context.worker ??= { count: 1, index: 0 }
@@ -38,7 +39,8 @@ export class BaseStackable {
     this.basePath = null
     this.isEntrypoint = options.context.isEntrypoint
     this.isProduction = options.context.isProduction
-    this.metricsRegistry = null
+    this.metricsRegistry = new client.Registry()
+    this.#metricsCollected = false
     this.startHttpTimer = null
     this.endHttpTimer = null
     this.clientWs = null
@@ -71,7 +73,8 @@ export class BaseStackable {
       setConnectionString: this.setConnectionString.bind(this),
       setBasePath: this.setBasePath.bind(this),
       runtimeBasePath: this.runtimeConfig?.basePath ?? null,
-      invalidateHttpCache: this.#invalidateHttpCache.bind(this)
+      invalidateHttpCache: this.#invalidateHttpCache.bind(this),
+      prometheus: { client, registry: this.metricsRegistry }
     })
   }
 
@@ -263,7 +266,7 @@ export class BaseStackable {
 
       this.#subprocessStarted = true
     } catch (e) {
-      this.childManager.close('SIGKILL')
+      this.childManager.close()
       throw new Error(`Cannot execute command "${command}": executable not found`)
     } finally {
       await this.childManager.eject()
@@ -272,7 +275,7 @@ export class BaseStackable {
     // If the process exits prematurely, terminate the thread with the same code
     this.subprocess.on('exit', code => {
       if (this.#subprocessStarted && typeof code === 'number' && code !== 0) {
-        this.childManager.close('SIGKILL')
+        this.childManager.close()
         process.exit(code)
       }
     })
@@ -280,10 +283,12 @@ export class BaseStackable {
     const [url, clientWs] = await once(this.childManager, 'url')
     this.url = url
     this.clientWs = clientWs
+
+    await this._collectMetrics()
   }
 
   async stopCommand () {
-    const exitTimeout = this.runtimeConfig.gracefulShutdown.runtime
+    const exitTimeout = this.runtimeConfig.gracefulShutdown.service
 
     this.#subprocessStarted = false
     const exitPromise = once(this.subprocess, 'exit')
@@ -307,7 +312,7 @@ export class BaseStackable {
     await exitPromise
 
     // Close the manager
-    this.childManager.close()
+    await this.childManager.close()
   }
 
   getChildManager () {
@@ -323,7 +328,16 @@ export class BaseStackable {
       : spawn(executable, args, { cwd: this.root })
   }
 
-  async collectMetrics () {
+  async _collectMetrics () {
+    if (this.#metricsCollected) {
+      return
+    }
+
+    this.#metricsCollected = true
+    await this.#collectMetrics()
+  }
+
+  async #collectMetrics () {
     let metricsConfig = this.options.context.metricsConfig
     if (metricsConfig !== false) {
       metricsConfig = {
@@ -341,13 +355,13 @@ export class BaseStackable {
         return
       }
 
-      const { registry, startHttpTimer, endHttpTimer } = await collectMetrics(
+      const { startHttpTimer, endHttpTimer } = await collectMetrics(
         this.serviceId,
         this.workerId,
-        metricsConfig
+        metricsConfig,
+        this.metricsRegistry
       )
 
-      this.metricsRegistry = registry
       this.startHttpTimer = startHttpTimer
       this.endHttpTimer = endHttpTimer
     }
@@ -358,8 +372,6 @@ export class BaseStackable {
       return this.childManager.send(this.clientWs, 'getMetrics', { format })
     }
 
-    if (!this.metricsRegistry) return null
-
     return format === 'json' ? await this.metricsRegistry.getMetricsAsJSON() : await this.metricsRegistry.metrics()
   }
 

package/lib/utils.js

@@ -1,4 +1,4 @@
-import { createRequire } from 'node:module'
+import { createRequire } from '@platformatic/utils'
 import { pathToFileURL } from 'node:url'
 import { request } from 'undici'
 

package/lib/worker/child-manager.js

@@ -1,9 +1,9 @@
 import { ITC } from '@platformatic/itc'
-import { createDirectory, ensureLoggableError } from '@platformatic/utils'
+import { createDirectory, createRequire, ensureLoggableError } from '@platformatic/utils'
 import { once } from 'node:events'
 import { rm, writeFile } from 'node:fs/promises'
 import { createServer } from 'node:http'
-import { createRequire, register } from 'node:module'
+import { register } from 'node:module'
 import { platform, tmpdir } from 'node:os'
 import { dirname, join, resolve } from 'node:path'
 import { pathToFileURL } from 'node:url'
@@ -43,6 +43,7 @@ export class ChildManager extends ITC {
   #scripts
   #logger
   #server
+  #websocketServer
   #socketPath
   #clients
   #requests
@@ -93,9 +94,9 @@ export class ChildManager extends ITC {
       await createDirectory(dirname(this.#socketPath))
     }
 
-    const wssServer = new WebSocketServer({ server: this.#server })
+    this.#websocketServer = new WebSocketServer({ server: this.#server })
 
-    wssServer.on('connection', ws => {
+    this.#websocketServer.on('connection', ws => {
       this.#clients.add(ws)
 
       ws.on('message', raw => {
@@ -135,8 +136,14 @@ export class ChildManager extends ITC {
       await rm(this.#dataPath, { force: true })
     }
 
-    this.#server?.close()
-    super.close()
+    for (const client of this.#clients) {
+      client.close()
+      await once(client, 'close')
+    }
+
+    await this.#closeServer(this.#websocketServer)
+    await this.#closeServer(this.#server)
+    await super.close()
   }
 
   async inject () {
@@ -252,4 +259,22 @@ export class ChildManager extends ITC {
     this.#logger.error({ err: ensureLoggableError(error) }, message)
     process.exit(exitCode)
   }
+
+  #closeServer (server) {
+    return new Promise((resolve, reject) => {
+      if (!server || server.listening === false) {
+        resolve()
+        return
+      }
+
+      server.close(err => {
+        if (err) {
+          reject(err)
+          return
+        }
+
+        resolve()
+      })
+    })
+  }
 }

package/lib/worker/child-process.js

@@ -1,6 +1,6 @@
 import { ITC } from '@platformatic/itc'
-import { collectMetrics } from '@platformatic/metrics'
-import { createPinoWritable, ensureLoggableError } from '@platformatic/utils'
+import { client, collectMetrics } from '@platformatic/metrics'
+import { createPinoWritable, ensureLoggableError, features } from '@platformatic/utils'
 import diagnosticChannel, { tracingChannel } from 'node:diagnostics_channel'
 import { EventEmitter, once } from 'node:events'
 import { readFile } from 'node:fs/promises'
@@ -105,6 +105,7 @@ export class ChildProcess extends ITC {
     const protocol = platform() === 'win32' ? 'ws+unix:' : 'ws+unix://'
     this.#socket = new WebSocket(`${protocol}${getSocketPath(process.env.PLT_MANAGER_ID)}`)
     this.#pendingMessages = []
+    this.#metricsRegistry = new client.Registry()
 
     this.listen()
     this.#setupLogger()
@@ -124,6 +125,7 @@ export class ChildProcess extends ITC {
       setGraphqlSchema: this.setGraphqlSchema.bind(this),
       setConnectionString: this.setConnectionString.bind(this),
       setBasePath: this.setBasePath.bind(this),
+      prometheus: { client, registry: this.#metricsRegistry }
     })
   }
 
@@ -177,13 +179,10 @@ export class ChildProcess extends ITC {
   }
 
   async #collectMetrics ({ serviceId, workerId, metricsConfig }) {
-    const { registry } = await collectMetrics(serviceId, workerId, metricsConfig)
-    this.#metricsRegistry = registry
+    await collectMetrics(serviceId, workerId, metricsConfig, this.#metricsRegistry)
   }
 
   async #getMetrics ({ format } = {}) {
-    if (!this.#metricsRegistry) return null
-
     const res =
       format === 'json' ? await this.#metricsRegistry.getMetricsAsJSON() : await this.#metricsRegistry.metrics()
 
@@ -232,8 +231,14 @@ export class ChildProcess extends ITC {
         const host = globalThis.platformatic.host
 
         if (port !== false) {
-          options.port = typeof port === 'number' ? port : 0
+          const hasFixedPort = typeof port === 'number'
+          options.port = hasFixedPort ? port : 0
+
+          if (hasFixedPort && features.node.reusePort) {
+            options.reusePort = true
+          }
         }
+
         if (typeof host === 'string') {
           options.host = host
         }

package/lib/worker/listeners.js

@@ -1,5 +1,12 @@
-import { withResolvers } from '@platformatic/utils'
+import { features, withResolvers } from '@platformatic/utils'
 import { subscribe, tracingChannel, unsubscribe } from 'node:diagnostics_channel'
+import { AsyncLocalStorage } from 'node:async_hooks'
+
+const snapshots = new WeakMap()
+
+export function getAsyncLocalStorageSnapshot (server) {
+  return snapshots.get(server)
+}
 
 export function createServerListener (overridePort = true, overrideHost) {
   const { promise, resolve, reject } = withResolvers()
@@ -12,14 +19,21 @@ export function createServerListener (overridePort = true, overrideHost) {
       }
 
       if (overridePort !== false) {
-        options.port = typeof overridePort === 'number' ? overridePort : 0
+        const hasFixedPort = typeof overridePort === 'number'
+        options.port = hasFixedPort ? overridePort : 0
+
+        if (hasFixedPort && features.node.reusePort) {
+          options.reusePort = true
+        }
       }
+
       if (typeof overrideHost === 'string') {
         options.host = overrideHost
       }
     },
     asyncEnd ({ server }) {
       cancel()
+      snapshots.set(server, AsyncLocalStorage.snapshot())
       resolve(server)
     },
     error ({ error }) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/basic",
-  "version": "2.22.0",
+  "version": "2.24.0",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -23,19 +23,20 @@
     "split2": "^4.2.0",
     "undici": "^7.0.0",
     "ws": "^8.18.0",
-    "@platformatic/config": "2.22.0",
-    "@platformatic/itc": "2.22.0",
-    "@platformatic/metrics": "2.22.0",
-    "@platformatic/utils": "2.22.0",
-    "@platformatic/telemetry": "2.22.0"
+    "@platformatic/config": "2.24.0",
+    "@platformatic/itc": "2.24.0",
+    "@platformatic/telemetry": "2.24.0",
+    "@platformatic/metrics": "2.24.0",
+    "@platformatic/utils": "2.24.0"
   },
   "devDependencies": {
     "borp": "^0.19.0",
     "eslint": "9",
     "express": "^4.19.2",
     "fastify": "^5.0.0",
+    "get-port": "^7.1.0",
     "json-schema-to-typescript": "^15.0.0",
-    "neostandard": "^0.11.1",
+    "neostandard": "^0.12.0",
     "next": "^15.0.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/basic/2.22.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/basic/2.24.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Stackable",
   "type": "object",