@itentialopensource/adapter-kafkav2 0.23.3 → 0.23.5

package/README.md

@@ -157,6 +157,14 @@ Sample SSL and SASL properties that go under client props. In the below example
         }
 ```
 
+Sample socket properties
+```json
+"socketOptions": {
+          "keepAlive": true,
+          "keepAliveInterval": 45000,
+          "socketTimeout": 20000
+        }
+```
 
 ### Topic Properties
 
@@ -311,6 +319,7 @@ The following properties are used to define the Kafka Client. These properties a
 | retry -> retries | Max number of retries per call. default: 5 |
 | ssl | Object, options to be passed to the tls broker sockets, ex. { rejectUnauthorized: false }.|
 | sasl | Object, SASL authentication configuration (Currently, supports PLAIN, SCRAM-SHA-256, SCRAM-SHA-512), ex. { mechanism: 'plain', username: 'foo', password: 'bar' }.|
+| socketOptions | Object, Socket Options: Configuration for socket behavior, including keep-alive, interval, and timeout settings.|
 
 For all client config options see [Client Config](https://kafka.js.org/docs/configuration)
 

package/adapter.js

@@ -17,11 +17,16 @@
 const fs = require('fs-extra');
 const path = require('path');
 const util = require('util');
+const net = require('net');
+const tls = require('tls');
 /* Fetch in the other needed components for the this Adaptor */
 // const EventEmitterCl = require('events').EventEmitter;
 const AdapterBaseCl = require(path.join(__dirname, 'adapterBase.js'));
 const DBUtil = require(path.join(__dirname, 'utils', 'dbUtil.js'));
 
+const DEFAULT_KEEP_ALIVE_INTERVAL = 60000; // 60s
+const DEFAULT_SOCKET_TIMEOUT = 30000; // 30s
+
 const axios = require('axios');
 
 let needRestart = false;
@@ -216,6 +221,51 @@ function formatErrorObject(origin, type, variables, sysCode, sysRes, stack) {
   return errorObject;
 }
 
+/**
+ * @summary Creates a socket factory for KafkaJS to handle custom socket connections.
+ *
+ * @function createSocketFactory
+ * @param {Object} socketOptions - Configuration options for the socket connection.
+ * @param {Boolean} useSSL - Determines whether SSL should be used for the connection.
+ *
+ * @return {Function} - A socket factory function that establishes a connection to Kafka brokers.
+ */
+function createSocketFactory(socketOptions, useSSL) {
+  return (options) => {
+    console.log('KafkaJS Socket Options:', options); // See what KafkaJS is actually passing
+
+    // Destructure properties from the options object
+    const { host, port, ssl } = options;
+    const brokerAddress = `${host}:${port}`;
+    console.log(
+      `Connecting to Kafka broker: ${brokerAddress} (${host}:${port}) ${useSSL ? 'with SSL' : 'without SSL'
+      }`
+    );
+
+    const socket = useSSL
+      ? tls.connect({ host, port, rejectUnauthorized: false }) // Use TLS for SSL
+      : net.createConnection({ host, port }); // Use Net for Non-SSL
+
+    const keepAliveEnabled = socketOptions && socketOptions.keepAlive !== undefined
+      ? socketOptions.keepAlive
+      : true;
+    const keepAliveInterval = socketOptions && socketOptions.keepAliveInterval !== undefined
+      ? socketOptions.keepAliveInterval
+      : DEFAULT_KEEP_ALIVE_INTERVAL; // 60s default
+    const socketTimeout = socketOptions && socketOptions.socketTimeout !== undefined
+      ? socketOptions.socketTimeout
+      : DEFAULT_SOCKET_TIMEOUT; // 30s default
+
+    socket.setKeepAlive(keepAliveEnabled, keepAliveInterval);
+    socket.setTimeout(socketTimeout);
+
+    socket.on('error', (err) => console.error(`Socket error with ${brokerAddress}:`, err));
+    socket.on('timeout', () => console.warn(`Socket timeout with ${brokerAddress}`));
+
+    return socket;
+  };
+}
+
 /**
  * This is the adapter/interface into Kafka
  */
@@ -645,6 +695,14 @@ class Kafkav2 extends AdapterBaseCl {
       log.info('EMITTED ONLINE ON STUB MODE');
       return;
     }
+    const combinedProps = this.props.client || {};
+    // Extract socket options with default values
+    const socketOptions = this.props.client.socketOptions || null;
+    const useSSL = this.props.client.ssl || false; // Determine SSL usage
+
+    if (socketOptions) {
+      combinedProps.socketFactory = createSocketFactory(socketOptions, useSSL);
+    }
 
     if (!needRestart) {
       try {
@@ -653,7 +711,7 @@ class Kafkav2 extends AdapterBaseCl {
           this.props.client.logLevel = logLevelEnum;
         }
         // Create a kafka client
-        const combinedProps = this.props.client || {};
+
         if (this.props.client.ssl && this.props.client.ssl.ca) {
           combinedProps.ssl.ca = [fs.readFileSync(this.props.client.ssl.ca, 'utf-8')];
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-kafkav2",
-  "version": "0.23.3",
+  "version": "0.23.5",
   "description": "Itential adapter to connect to kafka",
   "main": "adapter.js",
   "wizardVersion": "2.35.0",
@@ -46,7 +46,7 @@
     "ajv": "^8.17.1",
     "avro-schema-registry": "^2.1.0",
     "avsc": "^5.4.21",
-    "axios": "^1.7.9",
+    "axios": "^1.8.2",
     "fs-extra": "^11.2.0",
     "json-query": "^2.2.2",
     "kafkajs": "2.2.3",

package/propertiesSchema.json

@@ -21,16 +21,18 @@
         ]
       }
     },
-    "parseMessage" :{
+    "parseMessage": {
       "type": "boolean",
       "description": "Whether or not to prase the message as JSON when consumed by IAP",
-      "default" : true
+      "default": true
     },
-    "wrapMessage" : {
+    "wrapMessage": {
       "type": "string",
       "description": "A key to wrap the parsed JSON message",
-      "examples" : [ "message"],
-      "default" : "payload"
+      "examples": [
+        "message"
+      ],
+      "default": "payload"
     },
     "interval_time": {
       "type": "integer",
@@ -79,6 +81,26 @@
         },
         "sasl": {
           "type": "object"
+        },
+        "socketOptions": {
+          "type": "object",
+          "properties": {
+            "keepAlive": {
+              "type": "boolean",
+              "description": "Whether to enable keep-alive on the socket."
+            },
+            "keepAliveInterval": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Interval (in milliseconds) for keep-alive packets."
+            },
+            "socketTimeout": {
+              "type": "integer",
+              "minimum": 0,
+              "description": "Timeout (in milliseconds) for socket inactivity before closing."
+            }
+          },
+          "additionalProperties": false
         }
       }
     },

package/sampleProperties.json

@@ -37,6 +37,11 @@
         "username": "my-user",
         "password": "my-password",
         "mechanism": "scram-sha-512"
+      },
+      "socketOptions": {
+        "keepAlive": true,
+        "keepAliveInterval": 45000,
+        "socketTimeout": 20000
       }
     },
     "producer": {