@itentialopensource/adapter-utils 6.0.2 → 6.1.7

package/lib/connectorRest.js

@@ -110,6 +110,7 @@ let numRetries = 3;
 let numRedirects = 0;
 let limitRetryError = [0];
 let attemptTimeout = 5000;
+let keepAliveInterval = 0;
 let healthcheckOnTimeout = true;
 let globalRequest = null;
 let archiving = false;
@@ -878,6 +879,20 @@ function makeRequest(request, entitySchema, callProperties, startTrip, attempt,
       });
     });
 
+    // Enable TCP keep-alive on the socket if configured
+    // Minimum value enforced: 30000ms (30 seconds)
+    if (keepAliveInterval > 0 && keepAliveInterval < 30000) {
+      // Auto-correct to minimum value
+      log.warn(`${id}-connectorRest-makeRequest: keep_alive_interval (${keepAliveInterval}ms) is below minimum (30000ms). Using 30000ms.`);
+      httpRequest.on('socket', (socket) => {
+        socket.setKeepAlive(true, 30000);
+      });
+    } else if (keepAliveInterval >= 30000) {
+      httpRequest.on('socket', (socket) => {
+        socket.setKeepAlive(true, keepAliveInterval);
+      });
+    }
+
     // handle post error
     httpRequest.on('error', (cerror) => {
       const tripDiff = process.hrtime(roundTTime);
@@ -4444,6 +4459,19 @@ class ConnectorRest {
       if (typeof props.request.return_request === 'boolean') {
         returnRequest = props.request.return_request;
       }
+
+      // set the TCP keep-alive interval (optional - default is 0/disabled)
+      // Minimum value of 30000ms (30 seconds) enforced at point of use
+      if (typeof props.request.keep_alive_interval === 'number'
+        || typeof props.request.keep_alive_interval === 'string') {
+        keepAliveInterval = Number(props.request.keep_alive_interval);
+
+        // Validate the parsed value
+        if (Number.isNaN(keepAliveInterval)) {
+          log.error(`${id}-connectorRest: Invalid keep_alive_interval value "${props.request.keep_alive_interval}". Using default 0 (disabled).`);
+          keepAliveInterval = 0;
+        }
+      }
     }
 
     if (props.proxy) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-utils",
-  "version": "6.0.2",
+  "version": "6.1.7",
   "description": "Itential Adapter Utility Libraries",
   "scripts": {
     "postinstall": "node utils/setup.js",
@@ -35,7 +35,7 @@
     "https-proxy-agent": "^7.0.0",
     "json-query": "^2.2.2",
     "jsontoxml": "^1.0.1",
-    "jsonwebtoken": "^9.0.1",
+    "jsonwebtoken": "^9.0.3",
     "mongodb": "^3.7.4",
     "readline-sync": "^1.4.10",
     "socks-proxy-agent": "^8.0.1",

package/schemas/propertiesSchema.json

@@ -790,6 +790,13 @@
           "type": "boolean",
           "description": "This property turns on returning the response information - need to be carefull in case credentials are in the path",
           "default": false
+        },
+        "keep_alive_interval": {
+          "type": "integer",
+          "description": "TCP keep-alive interval in milliseconds to prevent connection timeout during long-running requests. 0 = disabled (default). Minimum value when enabled is 30000ms (30 seconds). Values below 30000ms will be auto-corrected to 30000ms with a warning.",
+          "default": 0,
+          "minimum": 0,
+          "maximum": 3600000
         }
       },
       "required": [