@platformatic/node 3.13.1 → 3.15.0

package/config.d.ts

@@ -117,7 +117,20 @@ export interface PlatformaticNodeJsConfig {
     services?: {
       [k: string]: unknown;
     }[];
-    workers?: number | string;
+    workers?:
+      | number
+      | string
+      | {
+          static?: number;
+          dynamic?: boolean;
+          minimum?: number;
+          maximum?: number;
+          total?: number;
+          maxMemory?: number;
+          cooldown?: number;
+          gracePeriod?: number;
+          [k: string]: unknown;
+        };
     workersRestartDelay?: number | string;
     logger?: {
       level: (
@@ -201,6 +214,7 @@ export interface PlatformaticNodeJsConfig {
         rejectUnauthorized?: boolean;
       };
     };
+    reuseTcpPorts?: boolean;
     startTimeout?: number;
     restartOnError?: boolean | number;
     exitOnUnhandledErrors?: boolean;
@@ -325,6 +339,37 @@ export interface PlatformaticNodeJsConfig {
               };
           plugins?: string[];
           timeout?: number | string;
+          /**
+           * Configuration for exporting metrics to an OTLP endpoint
+           */
+          otlpExporter?: {
+            /**
+             * Enable or disable OTLP metrics export
+             */
+            enabled?: boolean | string;
+            /**
+             * OTLP endpoint URL (e.g., http://collector:4318/v1/metrics)
+             */
+            endpoint: string;
+            /**
+             * Interval in milliseconds between metric pushes
+             */
+            interval?: number | string;
+            /**
+             * Additional HTTP headers for authentication
+             */
+            headers?: {
+              [k: string]: string;
+            };
+            /**
+             * Service name for OTLP resource attributes
+             */
+            serviceName?: string;
+            /**
+             * Service version for OTLP resource attributes
+             */
+            serviceVersion?: string;
+          };
         };
     telemetry?: {
       enabled?: boolean | string;
@@ -408,13 +453,28 @@ export interface PlatformaticNodeJsConfig {
       maxTotalMemory?: number;
       minWorkers?: number;
       maxWorkers?: number;
+      cooldownSec?: number;
+      gracePeriod?: number;
+      /**
+       * @deprecated
+       */
       scaleUpELU?: number;
+      /**
+       * @deprecated
+       */
       scaleDownELU?: number;
+      /**
+       * @deprecated
+       */
       timeWindowSec?: number;
+      /**
+       * @deprecated
+       */
       scaleDownTimeWindowSec?: number;
-      cooldownSec?: number;
+      /**
+       * @deprecated
+       */
       scaleIntervalSec?: number;
-      gracePeriod?: number;
     };
     inspectorOptions?: {
       host?: string;

package/lib/capability.js

@@ -7,7 +7,6 @@ import {
   importFile,
   injectViaRequest
 } from '@platformatic/basic'
-import { features } from '@platformatic/foundation'
 import { Unpromise } from '@watchable/unpromise'
 import inject from 'light-my-request'
 import { once } from 'node:events'
@@ -100,6 +99,7 @@ export class NodeCapability extends BaseCapability {
   #isKoa
   #appClose
   #useHttpForDispatch
+  #factory
 
   constructor (root, config, context) {
     super('nodejs', version, root, config, context)
@@ -111,6 +111,8 @@ export class NodeCapability extends BaseCapability {
       return this.url
     }
 
+    await super._start({ listen })
+
     // Listen if entrypoint
     if (this.#app && listen) {
       await this._listen()
@@ -156,15 +158,15 @@ export class NodeCapability extends BaseCapability {
     this.#module = this.#module.default || this.#module
 
     // Deal with application
-    const factory = ['build', 'create'].find(f => typeof this.#module[f] === 'function')
+    this.#factory = ['build', 'create'].find(f => typeof this.#module[f] === 'function')
     this.#appClose = this.#module['close']
 
     if (this.#hasServer()) {
-      if (factory) {
+      if (this.#factory) {
         // We have build function, this Capability will not use HTTP unless it is the entrypoint
         serverPromise.cancel()
 
-        this.#app = await this.#module[factory]()
+        this.#app = await this.#module[this.#factory]()
         this.#isFastify = isFastify(this.#app)
         this.#isKoa = isKoa(this.#app)
 
@@ -194,12 +196,21 @@ export class NodeCapability extends BaseCapability {
   }
 
   #hasServer () {
-    return this.config.node?.hasServer !== false && this.#module.hasServer !== false
+    return this.config.node?.hasServer !== false && this.#module?.hasServer !== false
   }
 
   async stop () {
     await super.stop()
 
+    // Emit the close event so that an application can handle it
+    const closeHandled = globalThis.platformatic.events.emit('close')
+
+    if (!this.#isFastify && !this.#appClose && !closeHandled) {
+      this.logger.warn(
+        `Please export a "close" function or register a "close" event handler in globalThis.platformatic.events for application "${this.applicationId}" to make sure resources have been closed properly and avoid exit timeouts.`
+      )
+    }
+
     if (this.status === 'starting') {
       await Unpromise.race([once(this, 'started'), once(this, 'start:error')])
     }
@@ -208,9 +219,14 @@ export class NodeCapability extends BaseCapability {
       return this.stopCommand()
     }
 
-    // for no-server apps, we support custom close method
-    if (this.#appClose && !this.#hasServer()) {
-      return this.#appClose()
+    // If we have a close function, always invoke it
+    if (this.#appClose) {
+      await this.#appClose()
+    }
+
+    // for no-server apps, nothing else to do
+    if (!this.#hasServer()) {
+      return
     }
 
     // This is needed if the capability was subclassed
@@ -326,10 +342,6 @@ export class NodeCapability extends BaseCapability {
     const serverOptions = this.serverConfig
     const listenOptions = { host: serverOptions?.hostname || '127.0.0.1', port: serverOptions?.port || 0 }
 
-    if (this.isProduction && features.node.reusePort) {
-      listenOptions.reusePort = true
-    }
-
     if (this.#isFastify) {
       await this.#app.listen(listenOptions)
       this.url = getServerUrl(this.#app.server)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/node",
-  "version": "3.13.1",
+  "version": "3.15.0",
   "description": "Platformatic Node.js Capability",
   "main": "index.js",
   "type": "module",
@@ -18,9 +18,9 @@
     "@watchable/unpromise": "^1.0.2",
     "json5": "^2.2.3",
     "light-my-request": "^6.0.0",
-    "@platformatic/basic": "3.13.1",
-    "@platformatic/generators": "3.13.1",
-    "@platformatic/foundation": "3.13.1"
+    "@platformatic/foundation": "3.15.0",
+    "@platformatic/basic": "3.15.0",
+    "@platformatic/generators": "3.15.0"
   },
   "devDependencies": {
     "cleaner-spec-reporter": "^0.5.0",
@@ -32,8 +32,8 @@
     "neostandard": "^0.12.0",
     "tsx": "^4.19.0",
     "typescript": "^5.5.4",
-    "@platformatic/service": "3.13.1",
-    "@platformatic/gateway": "3.13.1"
+    "@platformatic/gateway": "3.15.0",
+    "@platformatic/service": "3.15.0"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/node/3.13.1.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/node/3.15.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Node.js Config",
   "type": "object",
@@ -426,14 +426,34 @@
               "useHttp": {
                 "type": "boolean"
               },
+              "reuseTcpPorts": {
+                "type": "boolean",
+                "default": true
+              },
               "workers": {
                 "anyOf": [
                   {
-                    "type": "number",
-                    "minimum": 1
+                    "type": "number"
                   },
                   {
                     "type": "string"
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "static": {
+                        "type": "number",
+                        "minimum": 1
+                      },
+                      "minimum": {
+                        "type": "number",
+                        "minimum": 1
+                      },
+                      "maximum": {
+                        "type": "number",
+                        "minimum": 0
+                      }
+                    }
                   }
                 ]
               },
@@ -654,6 +674,43 @@
             },
             {
               "type": "string"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "static": {
+                  "type": "number",
+                  "minimum": 1
+                },
+                "dynamic": {
+                  "type": "boolean",
+                  "default": false
+                },
+                "minimum": {
+                  "type": "number",
+                  "minimum": 1
+                },
+                "maximum": {
+                  "type": "number",
+                  "minimum": 0
+                },
+                "total": {
+                  "type": "number",
+                  "minimum": 1
+                },
+                "maxMemory": {
+                  "type": "number",
+                  "minimum": 0
+                },
+                "cooldown": {
+                  "type": "number",
+                  "minimum": 0
+                },
+                "gracePeriod": {
+                  "type": "number",
+                  "minimum": 0
+                }
+              }
             }
           ]
         },
@@ -939,6 +996,10 @@
           },
           "additionalProperties": false
         },
+        "reuseTcpPorts": {
+          "type": "boolean",
+          "default": true
+        },
         "startTimeout": {
           "default": 30000,
           "type": "number",
@@ -1430,6 +1491,58 @@
                     }
                   ],
                   "default": 10000
+                },
+                "otlpExporter": {
+                  "type": "object",
+                  "description": "Configuration for exporting metrics to an OTLP endpoint",
+                  "properties": {
+                    "enabled": {
+                      "anyOf": [
+                        {
+                          "type": "boolean"
+                        },
+                        {
+                          "type": "string"
+                        }
+                      ],
+                      "description": "Enable or disable OTLP metrics export"
+                    },
+                    "endpoint": {
+                      "type": "string",
+                      "description": "OTLP endpoint URL (e.g., http://collector:4318/v1/metrics)"
+                    },
+                    "interval": {
+                      "anyOf": [
+                        {
+                          "type": "integer"
+                        },
+                        {
+                          "type": "string"
+                        }
+                      ],
+                      "default": 60000,
+                      "description": "Interval in milliseconds between metric pushes"
+                    },
+                    "headers": {
+                      "type": "object",
+                      "additionalProperties": {
+                        "type": "string"
+                      },
+                      "description": "Additional HTTP headers for authentication"
+                    },
+                    "serviceName": {
+                      "type": "string",
+                      "description": "Service name for OTLP resource attributes"
+                    },
+                    "serviceVersion": {
+                      "type": "string",
+                      "description": "Service version for OTLP resource attributes"
+                    }
+                  },
+                  "required": [
+                    "endpoint"
+                  ],
+                  "additionalProperties": false
                 }
               },
               "additionalProperties": false
@@ -1589,35 +1702,40 @@
               "type": "number",
               "minimum": 1
             },
+            "cooldownSec": {
+              "type": "number",
+              "minimum": 0
+            },
+            "gracePeriod": {
+              "type": "number",
+              "minimum": 0
+            },
             "scaleUpELU": {
               "type": "number",
               "minimum": 0,
-              "maximum": 1
+              "maximum": 1,
+              "deprecated": true
             },
             "scaleDownELU": {
               "type": "number",
               "minimum": 0,
-              "maximum": 1
+              "maximum": 1,
+              "deprecated": true
             },
             "timeWindowSec": {
               "type": "number",
-              "minimum": 0
+              "minimum": 0,
+              "deprecated": true
             },
             "scaleDownTimeWindowSec": {
               "type": "number",
-              "minimum": 0
-            },
-            "cooldownSec": {
-              "type": "number",
-              "minimum": 0
+              "minimum": 0,
+              "deprecated": true
             },
             "scaleIntervalSec": {
               "type": "number",
-              "minimum": 0
-            },
-            "gracePeriod": {
-              "type": "number",
-              "minimum": 0
+              "minimum": 0,
+              "deprecated": true
             }
           },
           "additionalProperties": false