@itentialopensource/adapter-kafkav2 0.23.4 → 0.24.0

package/.eslintrc.js

@@ -9,6 +9,7 @@ module.exports = {
     'json'
   ],
   parserOptions: {
+    ecmaVersion: 2020,
     sourceType: 'module'
   },
   rules: {

package/.topics-Kafkav2.json

@@ -0,0 +1 @@
+[]

package/AUTH.md

@@ -1,13 +1,13 @@
 ## Authenticating Kafka v2 Adapter 
 
-This document will go through the steps for authenticating the Kafka v2 adapter with. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>. 
+This document will go through the steps for authenticating the Kafka v2 adapter with. Properly configuring the properties for an adapter in Itential Platform is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>. 
 
 ### Library Authentication
 The Kafka v2 adapter supports SASL Authentication for Kafka v2 server. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
 
 STEPS  
 1. Ensure you have access to a Kafka v2 server and that it is running
-2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
+2. Follow the steps in the README.md to import the adapter into Itential Platform if you have not already done so
 3. Use the properties below for the ```properties.client.sasl``` field
 4. Kafka v2 adapter supports both PLAIN and SCRAM-SHA authentication mechanism
 
@@ -33,6 +33,6 @@ For more details on sasl authentication follow the README.md
 
 ### Troubleshooting
 - Make sure you copied over the correct username and password.
-- Turn on debug level logs for the adapter in IAP Admin Essentials.
+- Turn on debug level logs for the adapter in Itential Platform Admin Essentials.
 - Investigate the logs
 - Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.

package/ENHANCE.md

@@ -2,7 +2,7 @@
 
 ### Adding a Second Instance of an Adapter
 
-You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.
+You can add a second instance of this adapter without adding new code on the file system. To do this go into the Itential Platform Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.
 
 ### Adding Adapter Calls
 
@@ -18,7 +18,7 @@ npm run adapter:update
 
 If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.
 
-If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.
+If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in Itential Platform, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.
 
 ```text
 Files to update
@@ -32,7 +32,7 @@ Files to update
 
 ### Adding Adapter Properties
 
-While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
+While changing adapter properties is done in the service instance configuration section of Itential Platform, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
 
 ```text
 Files to update

package/README.md

@@ -1,16 +1,16 @@
 # Kafkav2 Adapter
 
-This adapter is used to integrate the Itential Automation Platform (IAP) with the Kafka System. The documenation for kafkajs is available at [https://kafka.js.org/docs/getting-started]. The adapter utilizes the kafkjs library to provide the integrations that are deemed pertinent to IAP. This Readme file is intended to provide information on this adapter.
+This adapter is used to integrate the Itential Platform with the Kafka System. The documenation for kafkajs is available at [https://kafka.js.org/docs/getting-started]. The adapter utilizes the kafkjs library to provide the integrations that are deemed pertinent to Itential Platform. This Readme file is intended to provide information on this adapter.
 
 >**Note**: It is possible that some integrations will be supported through the Kafka adapter while other integrations will not.
 
 Itential provides information on all of its product adapters in the Customer Knowledge Base. Information in the [Customer Knowledge Base](https://itential.atlassian.net/servicedesk/customer/portals) is consistently maintained and goes through documentation reviews. As a result, it should be the first place to go for information.
 
-For custom built adapters, it is a starting point to understand what you have built, provide the information for you to be able to update the adapter, and assist you with deploying the adapter into IAP.
+For custom built adapters, it is a starting point to understand what you have built, provide the information for you to be able to update the adapter, and assist you with deploying the adapter into Itential Platform.
 
 ## Versioning
 
-Itential Product adapters utilize SemVer for versioning. The current version of the adapter can be found in the `package.json` file or viewed in the IAP GUI on the System page. For Open Source Adapters, the versions available can be found in the [Itential OpenSource Repository](https://www.npmjs.com/search?q=itentialopensource%2Fadapter).
+Itential Product adapters utilize SemVer for versioning. The current version of the adapter can be found in the `package.json` file or viewed in the Itential Platform GUI on the System page. For Open Source Adapters, the versions available can be found in the [Itential OpenSource Repository](https://www.npmjs.com/search?q=itentialopensource%2Fadapter).
 
 ## Release History
 
@@ -77,7 +77,7 @@ npm install
 
 ## Installing an Itential Product Adapter
 
-1. Set up the name space location in your IAP node_modules.
+1. Set up the name space location in your Itential Platform node_modules.
 
 ```json
 cd /opt/pronghorn/current/node_modules
@@ -85,7 +85,7 @@ if the @itentialopensource directory does not exist, create it:
    mkdir @itentialopensource
 ```
 
-1. Clone the adapter into your IAP environment.
+1. Clone the adapter into your Itential Platform environment.
 
 ```json
 cd \@itentialopensource
@@ -102,7 +102,7 @@ npm install
 1. Add the adapter properties for Kafka (created from Adapter Builder) to the `properties.json` file for your Itential build. You will need to change the credentials and possibly the host information below.
 [Kafka sample properties](sampleProperties.json)
 
-1. Restart IAP
+1. Restart Itential Platform
 
 ```json
 systemctl restart pronghorn
@@ -110,7 +110,7 @@ systemctl restart pronghorn
 
 ## Adapter Properties and Descriptions
 
-This section defines **all** the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or IAP are provided in the **Installation** section.
+This section defines **all** the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or Itential Platform are provided in the **Installation** section.
 
 ```json
   {
@@ -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)
 
@@ -337,13 +346,13 @@ Refer to kafkajs docs for all consumer options [Consumer](https://kafka.js.org/d
 
 ## Parsing Properties
 
-The `parseMessage` property allows the user to define how they want the Kafka message to be published to IAP's event system. If `parseMessage` is set to true or omitted, the value of the Kafka message will be parsed as either an object or string and wrapped in an outer object. The wrapper object's key can be defined with the property `wrapMessage`, or the default value `payload` can be used if omitted. If `parseMessage` is set to false, the entire kafka payload, including metadata, would be returned and the message itself would need to be transformed at a later point.
+The `parseMessage` property allows the user to define how they want the Kafka message to be published to Itential Platform's event system. If `parseMessage` is set to true or omitted, the value of the Kafka message will be parsed as either an object or string and wrapped in an outer object. The wrapper object's key can be defined with the property `wrapMessage`, or the default value `payload` can be used if omitted. If `parseMessage` is set to false, the entire kafka payload, including metadata, would be returned and the message itself would need to be transformed at a later point.
 
 ## Turning off stream if WorkflowEngine or OperationsManager is down
 
-`check_iap_apps` (boolean) and `iap_apps_check_interval` (integer) are used when the user wants to turn off stream if WorkflowEngine or OperationsManager is down. If `check_iap_apps` is set to true, by default, the adapter will check the status of both WorkflowEngine and OperationsManager at a defined interval. If any IAP apps are down, the consumer will be paused until the apps are active again. If the user does not want to healthcheck OperationsManager, set `check_ops_manager_status` to false. Similarly, if the user does not want to check WorkflowEngine status, set `check_wfe_status` to false.
+`check_iap_apps` (boolean) and `iap_apps_check_interval` (integer) are used when the user wants to turn off stream if WorkflowEngine or OperationsManager is down. If `check_iap_apps` is set to true, by default, the adapter will check the status of both WorkflowEngine and OperationsManager at a defined interval. If any Itential Platform apps are down, the consumer will be paused until the apps are active again. If the user does not want to healthcheck OperationsManager, set `check_ops_manager_status` to false. Similarly, if the user does not want to check WorkflowEngine status, set `check_wfe_status` to false.
 
-`iap_apps_check_interval` (default 30000ms - 30s) allows the user to set the frequency in which to run IAP app healtcheck.
+`iap_apps_check_interval` (default 30000ms - 30s) allows the user to set the frequency in which to run Itential Platform app healtcheck.
 
 ## Send message sample payload
 
@@ -360,9 +369,9 @@ Note that this is an array, so it can have multiple topics.
 ```
 For all options of messages array please follow [kafkajs documentation](https://kafka.js.org/docs/producing#producing-messages)
 
-## Triggering jobs in IAP from a kafka message
+## Triggering jobs in Itential Platform from a kafka message
 
-Once you have the adapter configured and online in an IAP instance, you can create triggers in Operations Manager to kick off jobs when a kafka message is consumed. The adapter listens for messages on the subscribed topics and publishes to an event. This event is picked up by the Operations Manager. If you have created triggers for this specific topic, a job will get triggered. For a step-by-step example follow the next sub-section.
+Once you have the adapter configured and online in an Itential Platform instance, you can create triggers in Operations Manager to kick off jobs when a kafka message is consumed. The adapter listens for messages on the subscribed topics and publishes to an event. This event is picked up by the Operations Manager. If you have created triggers for this specific topic, a job will get triggered. For a step-by-step example follow the next sub-section.
 
 ### Listen to a topic called test-topic and trigger a workflow called test
 

package/SUMMARY.md

@@ -1,8 +1,8 @@
 ## Overview
-This adapter is used to integrate the Itential Automation Platform (IAP) with the Kafka System. The adapter utilizes the KafkaJS client to integrate with Apache Kafka. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
+This adapter is used to integrate the Itential Platform with the Kafka System. The adapter utilizes the KafkaJS client to integrate with Apache Kafka. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
 
 >**Note**: It is possible that some integrations will be supported through the KafkaV2 adapter while other integrations will not.
 
 Itential provides information on all of its product adapters in the Customer Knowledge Base. Information in the <a href="https://itential.atlassian.net/servicedesk/customer/portals" target="_blank">Customer Knowledge Base</a> is consistently maintained and goes through documentation reviews. As a result, it should be the first place to go for information.
 
-For opensourced and custom built adapters, the ReadMe is a starting point to understand what you have built, provide the information for you to be able to update the adapter, and assist you with deploying the adapter into IAP.
+For opensourced and custom built adapters, the ReadMe is a starting point to understand what you have built, provide the information for you to be able to update the adapter, and assist you with deploying the adapter into Itential Platform.

package/SYSTEMINFO.md

@@ -16,7 +16,7 @@ Apache Kafka is an open-source distributed event streaming platform used by thou
 "Store streams of data safely in a distributed, durable, fault-tolerant cluster."
 
 ## Why Integrate
-The Kafka v2 adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Kafka. With this adapter you have the ability to perform operations with Kafka on items such as:
+The Kafka v2 adapter from Itential is used to integrate the Itential Platform with Kafka. With this adapter you have the ability to perform operations with Kafka on items such as:
 
 - Produce/Publish messages onto message topics for others to consume
 - Listen, receive and process messages placed on topics by other systems

package/TAB1.md

@@ -1,9 +1,9 @@
 # Overview 
-This adapter is used to integrate the Itential Automation Platform (IAP) with the Kafka System. The adapter utilizes the KafkaJS client to integrate with Apache Kafka. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
+This adapter is used to integrate the Itential Platform with the Kafka System. The adapter utilizes the KafkaJS client to integrate with Apache Kafka. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
 
 
 ## Details 
-The Kafka v2 adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Kafka. With this adapter you have the ability to perform operations with Kafka on items such as:
+The Kafka v2 adapter from Itential is used to integrate the Itential Platform with Kafka. With this adapter you have the ability to perform operations with Kafka on items such as:
 
 - Produce/Publish messages onto message topics for others to consume
 - Listen, receive and process messages placed on topics by other systems

package/TAB2.md

@@ -11,14 +11,14 @@
 ## Specific Adapter Information
 ### Authentication
 
-This document will go through the steps for authenticating the Kafka v2 adapter with. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>. 
+This document will go through the steps for authenticating the Kafka v2 adapter with. Properly configuring the properties for an adapter in Itential Platform is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>. 
 
 #### Library Authentication
 The Kafka v2 adapter supports SASL Authentication for Kafka v2 server. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
 
 STEPS  
 1. Ensure you have access to a Kafka v2 server and that it is running
-2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
+2. Follow the steps in the README.md to import the adapter into Itential Platform if you have not already done so
 3. Use the properties below for the ```properties.client.sasl``` field
 4. Kafka v2 adapter supports both PLAIN and SCRAM-SHA authentication mechanism
 
@@ -44,12 +44,12 @@ For more details on sasl authentication follow the README.md
 
 #### Troubleshooting
 - Make sure you copied over the correct username and password.
-- Turn on debug level logs for the adapter in IAP Admin Essentials.
+- Turn on debug level logs for the adapter in Itential Platform Admin Essentials.
 - Investigate the logs
 - Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
 ### Sample Properties
 
-Sample Properties can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
+Sample Properties can be used to help you configure the adapter in the Itential Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
 
 ```json
   "properties": {
@@ -69,6 +69,16 @@ Sample Properties can be used to help you configure the adapter in the Itential
       ],
       "clientId": "my-app",
       "logLevel": "INFO",
+      "connectionTimeout": 1000,
+      "requestTimeout": 30000,
+      "enforceRequestTimeout": true,
+      "retry": {
+        "maxRetryTime": 30000,
+        "initialRetryTime": 300,
+        "factor": 0.2,
+        "multiplier": 2,
+        "retries": 5
+      },
       "ssl": {
         "enableTrace": true,
         "ca": "/path/to/crt.pem",
@@ -78,6 +88,11 @@ Sample Properties can be used to help you configure the adapter in the Itential
         "username": "my-user",
         "password": "my-password",
         "mechanism": "scram-sha-512"
+      },
+      "socketOptions": {
+        "keepAlive": true,
+        "keepAliveInterval": 45000,
+        "socketTimeout": 20000
       }
     },
     "producer": {

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,12 +1,11 @@
 {
   "name": "@itentialopensource/adapter-kafkav2",
-  "version": "0.23.4",
+  "version": "0.24.0",
   "description": "Itential adapter to connect to kafka",
   "main": "adapter.js",
-  "wizardVersion": "2.35.0",
-  "engineVersion": "1.40.2",
+  "wizardVersion": "2.44.7",
+  "engineVersion": "1.69.14",
   "scripts": {
-    "artifactize": "npm i && node utils/packModificationScript.js",
     "preinstall": "node utils/setup.js",
     "deinstall": "node utils/removeHooks.js",
     "lint": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js",
@@ -20,10 +19,9 @@
   },
   "keywords": [
     "Itential",
-    "IAP",
+    "Itential Platform",
     "Automation",
     "Integration",
-    "App-Artifacts",
     "Adapter",
     "Notification",
     "Messaging",
@@ -43,26 +41,26 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-kafkav2",
   "dependencies": {
-    "ajv": "^8.17.1",
-    "avro-schema-registry": "^2.1.0",
-    "avsc": "^5.4.21",
-    "axios": "^1.8.2",
-    "fs-extra": "^11.2.0",
-    "json-query": "^2.2.2",
+    "ajv": "8.17.1",
+    "avro-schema-registry": "2.1.0",
+    "avsc": "5.4.21",
+    "axios": "1.9.0",
+    "fs-extra": "11.3.0",
+    "json-query": "2.2.2",
     "kafkajs": "2.2.3",
-    "mongodb": "^6.2.0",
-    "readline-sync": "^1.4.10",
-    "uuid": "^3.0.1"
+    "mongodb": "4.17.2",
+    "readline-sync": "1.4.10",
+    "uuid": "3.0.1",
+    "mocha": "10.8.2",
+    "winston": "3.17.0"
   },
   "devDependencies": {
-    "chai": "^4.3.7",
-    "eslint": "^8.44.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-json": "^3.1.0",
-    "mocha": "^10.7.0",
-    "testdouble": "^3.18.0",
-    "winston": "^3.13.1"
+    "chai": "4.5.0",
+    "eslint": "8.57.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-plugin-import": "2.31.0",
+    "eslint-plugin-json": "3.1.0",
+    "testdouble": "3.18.0"
   },
   "private": false
 }

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": {

package/test/integration/adapterTestIntegration.js

@@ -14,11 +14,11 @@ const winston = require('winston');
 const { expect } = require('chai');
 const { use } = require('chai');
 const td = require('testdouble');
+const log = require('../../utils/logger');
 
 const anything = td.matchers.anything();
 
 // stub and attemptTimeout are used throughout the code so set them here
-let logLevel = 'none';
 const stub = true;
 const isRapidFail = false;
 const isSaveMockData = false;
@@ -58,43 +58,6 @@ global.pronghornProps = {
 
 global.$HOME = `${__dirname}/../..`;
 
-// set the log levels that Pronghorn uses, spam and trace are not defaulted in so without
-// this you may error on log.trace calls.
-const myCustomLevels = {
-  levels: {
-    spam: 6,
-    trace: 5,
-    debug: 4,
-    info: 3,
-    warn: 2,
-    error: 1,
-    none: 0
-  }
-};
-
-// need to see if there is a log level passed in
-process.argv.forEach((val) => {
-  // is there a log level defined to be passed in?
-  if (val.indexOf('--LOG') === 0) {
-    // get the desired log level
-    const inputVal = val.split('=')[1];
-
-    // validate the log level is supported, if so set it
-    if (Object.hasOwnProperty.call(myCustomLevels.levels, inputVal)) {
-      logLevel = inputVal;
-    }
-  }
-});
-
-// need to set global logging
-global.log = winston.createLogger({
-  level: logLevel,
-  levels: myCustomLevels.levels,
-  transports: [
-    new winston.transports.Console()
-  ]
-});
-
 /**
  * Runs the common asserts for test
  */

package/test/unit/adapterBaseTestUnit.js

@@ -14,11 +14,11 @@ const execute = require('child_process').execSync;
 const { expect } = require('chai');
 const { use } = require('chai');
 const td = require('testdouble');
+const log = require('../../utils/logger');
 
 const anything = td.matchers.anything();
 
 // stub and attemptTimeout are used throughout the code so set them here
-let logLevel = 'none';
 const stub = true;
 const isRapidFail = false;
 const attemptTimeout = 120000;
@@ -53,43 +53,6 @@ global.pronghornProps = {
 
 global.$HOME = `${__dirname}/../..`;
 
-// set the log levels that Pronghorn uses, spam and trace are not defaulted in so without
-// this you may error on log.trace calls.
-const myCustomLevels = {
-  levels: {
-    spam: 6,
-    trace: 5,
-    debug: 4,
-    info: 3,
-    warn: 2,
-    error: 1,
-    none: 0
-  }
-};
-
-// need to see if there is a log level passed in
-process.argv.forEach((val) => {
-  // is there a log level defined to be passed in?
-  if (val.indexOf('--LOG') === 0) {
-    // get the desired log level
-    const inputVal = val.split('=')[1];
-
-    // validate the log level is supported, if so set it
-    if (Object.hasOwnProperty.call(myCustomLevels.levels, inputVal)) {
-      logLevel = inputVal;
-    }
-  }
-});
-
-// need to set global logging
-global.log = winston.createLogger({
-  level: logLevel,
-  levels: myCustomLevels.levels,
-  transports: [
-    new winston.transports.Console()
-  ]
-});
-
 /**
  * Runs the error asserts for the test
  */

package/test/unit/adapterTestUnit.js

@@ -17,13 +17,13 @@ const { expect } = require('chai');
 const { use } = require('chai');
 const td = require('testdouble');
 const Ajv = require('ajv');
+const log = require('../../utils/logger');
 
 const ajv = new Ajv({ allErrors: true, unknownFormats: 'ignore' });
 
 const anything = td.matchers.anything();
 
 // stub and attemptTimeout are used throughout the code so set them here
-let logLevel = 'none';
 const stub = true;
 const isRapidFail = false;
 const attemptTimeout = 120000;
@@ -58,43 +58,6 @@ global.pronghornProps = {
 
 global.$HOME = `${__dirname}/../..`;
 
-// set the log levels that Pronghorn uses, spam and trace are not defaulted in so without
-// this you may error on log.trace calls.
-const myCustomLevels = {
-  levels: {
-    spam: 6,
-    trace: 5,
-    debug: 4,
-    info: 3,
-    warn: 2,
-    error: 1,
-    none: 0
-  }
-};
-
-// need to see if there is a log level passed in
-process.argv.forEach((val) => {
-  // is there a log level defined to be passed in?
-  if (val.indexOf('--LOG') === 0) {
-    // get the desired log level
-    const inputVal = val.split('=')[1];
-
-    // validate the log level is supported, if so set it
-    if (Object.hasOwnProperty.call(myCustomLevels.levels, inputVal)) {
-      logLevel = inputVal;
-    }
-  }
-});
-
-// need to set global logging
-global.log = winston.createLogger({
-  level: logLevel,
-  levels: myCustomLevels.levels,
-  transports: [
-    new winston.transports.Console()
-  ]
-});
-
 /**
  * Runs the error asserts for the test
  */

package/utils/argParser.js

@@ -0,0 +1,44 @@
+const customLevels = {
+  spam: 6,
+  trace: 5,
+  debug: 4,
+  info: 3,
+  warn: 2,
+  error: 1,
+  none: 0
+};
+
+function parseArgs(argv = process.argv) {
+  let properties = null;
+  let logLevel = 'none';
+  let maxCalls = 5;
+  let host = null;
+
+  argv.forEach((val) => {
+    if (val.startsWith('--PROPS=')) {
+      // get the properties
+      const inputVal = val.split('=')[1];
+      properties = JSON.parse(inputVal);
+    } else if (val.startsWith('--LOG=')) {
+      // get the desired log level
+      const level = val.split('=')[1];
+      // validate the log level is supported, if so set it
+      if (Object.hasOwnProperty.call(customLevels, level)) {
+        logLevel = level;
+      }
+    } else if (val.startsWith('--MAXCALLS=')) {
+      const override = parseInt(val.split('=')[1], 10);
+      if (!Number.isNaN(override) && override > 0) {
+        maxCalls = override;
+      }
+    } else if (val.startsWith('--HOST=')) {
+      [, host] = val.split('=');
+    }
+  });
+
+  return {
+    properties, logLevel, maxCalls, host
+  };
+}
+
+module.exports = { parseArgs };

package/utils/logger.js

@@ -0,0 +1,26 @@
+// utils/logger.js
+const winston = require('winston');
+const { parseArgs } = require('./argParser');
+
+const customLevels = {
+  spam: 6,
+  trace: 5,
+  debug: 4,
+  info: 3,
+  warn: 2,
+  error: 1,
+  none: 0
+};
+
+// Only set global logger if it doesn't already exist (i.e., not provided by app)
+if (!global.log) {
+  const { logLevel = 'info' } = parseArgs();
+
+  global.log = winston.createLogger({
+    level: logLevel,
+    levels: customLevels,
+    transports: [new winston.transports.Console()]
+  });
+}
+
+module.exports = global.log;