@platformatic/basic 3.14.0 → 3.15.0

package/config.d.ts

@@ -110,6 +110,7 @@ export interface PlatformaticBasicConfig {
         rejectUnauthorized?: boolean;
       };
     };
+    reuseTcpPorts?: boolean;
     startTimeout?: number;
     restartOnError?: boolean | number;
     exitOnUnhandledErrors?: boolean;

package/lib/capability.js

@@ -2,6 +2,7 @@ import {
   buildPinoOptions,
   deepmerge,
   executeWithTimeout,
+  features,
   kHandledError,
   kMetadata,
   kTimeout
@@ -9,6 +10,7 @@ import {
 import { client, collectMetrics, ensureMetricsGroup, setupOtlpExporter } from '@platformatic/metrics'
 import { parseCommandString } from 'execa'
 import { spawn } from 'node:child_process'
+import { tracingChannel } from 'node:diagnostics_channel'
 import EventEmitter, { once } from 'node:events'
 import { existsSync } from 'node:fs'
 import { platform } from 'node:os'
@@ -34,6 +36,7 @@ export class BaseCapability extends EventEmitter {
   workerId
   telemetryConfig
   serverConfig
+  reuseTcpPorts
   openapiSchema
   graphqlSchema
   connectionString
@@ -56,6 +59,7 @@ export class BaseCapability extends EventEmitter {
   #subprocessStarted
   #metricsCollected
   #pendingDependenciesWaits
+  #reuseTcpPortsSubscribers
 
   constructor (type, version, root, config, context, standardStreams = {}) {
     super()
@@ -89,6 +93,7 @@ export class BaseCapability extends EventEmitter {
     this.subprocessForceClose = false
     this.subprocessTerminationSignal = 'SIGINT'
     this.logger = this._initializeLogger()
+    this.reuseTcpPorts = this.config.reuseTcpPorts ?? this.runtimeConfig.reuseTcpPorts
     // True by default, can be overridden in subclasses. If false, it takes precedence over the runtime configuration
     this.exitOnUnhandledErrors = true
 
@@ -129,6 +134,8 @@ export class BaseCapability extends EventEmitter {
       return
     }
 
+    // TODO@PI: Handle reusePort
+
     // Wait for explicit dependencies to start
     await this.waitForDependenciesStart(this.dependencies)
 
@@ -159,6 +166,11 @@ export class BaseCapability extends EventEmitter {
       await Promise.allSettled(this.#pendingDependenciesWaits)
     }
 
+    if (this.#reuseTcpPortsSubscribers) {
+      tracingChannel('net.server.listen').unsubscribe(this.#reuseTcpPortsSubscribers)
+      this.#reuseTcpPortsSubscribers = null
+    }
+
     // Stop OTLP bridge if running
     if (this.otlpBridge) {
       this.otlpBridge.stop()
@@ -562,6 +574,7 @@ export class BaseCapability extends EventEmitter {
       basePath,
       logLevel: this.logger.level,
       isEntrypoint: this.isEntrypoint,
+      reuseTcpPorts: this.reuseTcpPorts,
       runtimeBasePath: this.runtimeConfig?.basePath ?? null,
       wantsAbsoluteUrls: meta.gateway?.wantsAbsoluteUrls ?? false,
       exitOnUnhandledErrors: this.runtimeConfig.exitOnUnhandledErrors ?? true,
@@ -615,6 +628,23 @@ export class BaseCapability extends EventEmitter {
     return pino(pinoOptions, this.standardStreams?.stdout)
   }
 
+  _start () {
+    if (this.reuseTcpPorts) {
+      if (!features.node.reusePort) {
+        this.reuseTcpPorts = false
+        this.logger.warn('Cannot enable reusePort as it is not available in your OS.')
+      } else {
+        this.#reuseTcpPortsSubscribers = {
+          asyncStart ({ options }) {
+            options.reusePort = true
+          }
+        }
+
+        tracingChannel('net.server.listen').subscribe(this.#reuseTcpPortsSubscribers)
+      }
+    }
+  }
+
   async _collectMetrics () {
     if (this.#metricsCollected) {
       return
@@ -757,18 +787,17 @@ export class BaseCapability extends EventEmitter {
     }
 
     // Setup and start OTLP exporter bridge
-    this.otlpBridge = await setupOtlpExporter(
-      this.metricsRegistry,
-      metricsConfig.otlpExporter,
-      this.applicationId
-    )
+    this.otlpBridge = await setupOtlpExporter(this.metricsRegistry, metricsConfig.otlpExporter, this.applicationId)
 
     if (this.otlpBridge) {
       this.otlpBridge.start()
-      this.logger.info({
-        endpoint: metricsConfig.otlpExporter.endpoint,
-        interval: metricsConfig.otlpExporter.interval || 60000
-      }, 'OTLP metrics exporter started')
+      this.logger.info(
+        {
+          endpoint: metricsConfig.otlpExporter.endpoint,
+          interval: metricsConfig.otlpExporter.interval || 60000
+        },
+        'OTLP metrics exporter started'
+      )
     }
   }
 

package/lib/worker/child-process.js

@@ -2,8 +2,7 @@ import {
   buildPinoFormatters,
   buildPinoTimestamp,
   disablePinoDirectWrite,
-  ensureLoggableError,
-  features
+  ensureLoggableError
 } from '@platformatic/foundation'
 import { ITC } from '@platformatic/itc/lib/index.js'
 import { client, collectMetrics } from '@platformatic/metrics'
@@ -131,6 +130,10 @@ export class ChildProcess extends ITC {
     this.#setupServer()
     this.#setupInterceptors()
 
+    if (globalThis.platformatic.reuseTcpPorts) {
+      this.#setupTcpPortsHandling()
+    }
+
     this.registerGlobals({
       logger: this.#logger,
       setOpenapiSchema: this.setOpenapiSchema.bind(this),
@@ -359,10 +362,6 @@ export class ChildProcess extends ITC {
         if (port !== false) {
           const hasFixedPort = typeof port === 'number'
           options.port = hasFixedPort ? port : 0
-
-          if (hasFixedPort && features.node.reusePort) {
-            options.reusePort = true
-          }
         }
 
         if (typeof host === 'string') {
@@ -399,6 +398,14 @@ export class ChildProcess extends ITC {
     }
   }
 
+  #setupTcpPortsHandling () {
+    tracingChannel('net.server.listen').subscribe({
+      asyncStart ({ options }) {
+        options.reusePort = true
+      }
+    })
+  }
+
   #setupInterceptors () {
     const globalDispatcher = new Agent().compose(createInterceptor(this))
     setGlobalDispatcher(globalDispatcher)

package/lib/worker/listeners.js

@@ -1,4 +1,3 @@
-import { features } from '@platformatic/foundation'
 import { subscribe, tracingChannel, unsubscribe } from 'node:diagnostics_channel'
 
 export function createServerListener (overridePort = true, overrideHost) {
@@ -14,10 +13,6 @@ export function createServerListener (overridePort = true, overrideHost) {
       if (overridePort !== false) {
         const hasFixedPort = typeof overridePort === 'number'
         options.port = hasFixedPort ? overridePort : 0
-
-        if (hasFixedPort && features.node.reusePort) {
-          options.reusePort = true
-        }
       }
 
       if (typeof overrideHost === 'string') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/basic",
-  "version": "3.14.0",
+  "version": "3.15.0",
   "description": "",
   "main": "index.js",
   "types": "index.d.ts",
@@ -25,10 +25,10 @@
     "split2": "^4.2.0",
     "undici": "^7.0.0",
     "ws": "^8.18.0",
-    "@platformatic/itc": "3.14.0",
-    "@platformatic/foundation": "3.14.0",
-    "@platformatic/metrics": "3.14.0",
-    "@platformatic/telemetry": "3.14.0"
+    "@platformatic/foundation": "3.15.0",
+    "@platformatic/itc": "3.15.0",
+    "@platformatic/metrics": "3.15.0",
+    "@platformatic/telemetry": "3.15.0"
   },
   "devDependencies": {
     "cleaner-spec-reporter": "^0.5.0",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/basic/3.14.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/basic/3.15.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Basic Config",
   "type": "object",
@@ -68,6 +68,10 @@
               "useHttp": {
                 "type": "boolean"
               },
+              "reuseTcpPorts": {
+                "type": "boolean",
+                "default": true
+              },
               "workers": {
                 "anyOf": [
                   {
@@ -634,6 +638,10 @@
           },
           "additionalProperties": false
         },
+        "reuseTcpPorts": {
+          "type": "boolean",
+          "default": true
+        },
         "startTimeout": {
           "default": 30000,
           "type": "number",