@itentialopensource/adapter-kafkav2 0.3.12

package/error.json

@@ -0,0 +1,178 @@
+{
+  "errors": [
+    {
+      "key": "Unable To Save To Database",
+      "icode": "AD.100",
+      "displayString": "Error on saving to Database $VARIABLE$",
+      "recommendation": "Verify the database connectivity and credentials"
+    },
+    {
+      "key": "Database Error",
+      "icode": "AD.101",
+      "displayString": "Database Error: $VARIABLE$",
+      "recommendation": "Verify the database connectivity, schema and permissions"
+    },
+    {
+      "key": "Database Credentials",
+      "icode": "AD.102",
+      "displayString": "Database Error: Invalid Credentials",
+      "recommendation": "Verify the database credentials"
+    },
+    {
+      "key": "No Queue Item",
+      "icode": "AD.110",
+      "displayString": "Queue Item $VARIABLE$ not found in queue",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Unable To Create Queue",
+      "icode": "AD.111",
+      "displayString": "Unable to create queue: $VARIABLE$",
+      "recommendation": "Verify access to the database, redis or system memory"
+    },
+    {
+      "key": "Queue Full",
+      "icode": "AD.112",
+      "displayString": "Request $VARIABLE$ Transaction $VARIABLE$ rejected - queue full at $VARIABLE$",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Unable To Clear Queue",
+      "icode": "AD.113",
+      "displayString": "Unable to clear queue: $VARIABLE$",
+      "recommendation": "Make sure the queue exists"
+    },
+    {
+      "key": "Unable To Claim Turn",
+      "icode": "AD.114",
+      "displayString": "Request $VARIABLE$ Transaction $VARIABLE$ unable to claim license: $VARIABLE$",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Unable To Free Turn",
+      "icode": "AD.115",
+      "displayString": "Request $VARIABLE$ Transaction $VARIABLE$ unable to free license: $VARIABLE$",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Item In Wrong State",
+      "icode": "AD.116",
+      "displayString": "Queue item is in the wrong state: $VARIABLE$ ",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Missing Data",
+      "icode": "AD.300",
+      "displayString": "$VARIABLE$ is required",
+      "recommendation": "Please provide the required data"
+    },
+    {
+      "key": "Missing File",
+      "icode": "AD.301",
+      "displayString": "Can not open file $VARIABLE$",
+      "recommendation": "Verify the file exists and has proper permissions"
+    },
+    {
+      "key": "Invalid Action File",
+      "icode": "AD.302",
+      "displayString": "Invalid action file: $VARIABLE$ in $VARIABLE$",
+      "recommendation": "Verify the action file"
+    },
+    {
+      "key": "Unsupported Protocol",
+      "icode": "AD.303",
+      "displayString": "Protocol $VARIABLE$ not currently supported",
+      "recommendation": "Verify the protocol on the action"
+    },
+    {
+      "key": "Invalid Schema File",
+      "icode": "AD.304",
+      "displayString": "Invalid schema file: $VARIABLE$ in $VARIABLE$",
+      "recommendation": "Verify the action file"
+    },
+    {
+      "key": "Invalid Properties",
+      "icode": "AD.305",
+      "displayString": "Invalid properties: $VARIABLE$",
+      "recommendation": "Verify the properties for the adapter"
+    },
+    {
+      "key": "Query Not Translated",
+      "icode": "AD.310",
+      "displayString": "Query Not Translated",
+      "recommendation": "Verify the information passed in the query object"
+    },
+    {
+      "key": "Payload Not Translated",
+      "icode": "AD.311",
+      "displayString": "Payload Not Translated",
+      "recommendation": "Verify the information passed in the payload object"
+    },
+    {
+      "key": "Schema Validation Failure",
+      "icode": "AD.312",
+      "displayString": "Schema validation failed on $VARIABLE$",
+      "recommendation": "Verify the information provided is in the correct format with everything required"
+    },
+    {
+      "key": "Entity Cache Not Loading",
+      "icode": "AD.320",
+      "displayString": "Could not load entity: $VARIABLE$, into cache",
+      "recommendation": "Verify the cache is working properly"
+    },
+    {
+      "key": "Error Verifying Entity Cache",
+      "icode": "AD.321",
+      "displayString": "Could not verify entity in cache",
+      "recommendation": "Verify the cache is working properly"
+    },
+    {
+      "key": "Unable To Authenticate",
+      "icode": "AD.400",
+      "displayString": "Unable to authenticate with $VARIABLE$, response $VARIABLE$",
+      "recommendation": "Verify the user credentials and check the response for more information"
+    },
+    {
+      "key": "Unable To Encode",
+      "icode": "AD.401",
+      "displayString": "Can not perform base64 encoding on $VARIABLE$",
+      "recommendation": "Check the authentication format"
+    },
+    {
+      "key": "Unable To Get Token",
+      "icode": "AD.402",
+      "displayString": "Unable to get token for user: $VARIABLE$",
+      "recommendation": "Verify the user credentials and the system information"
+    },
+    {
+      "key": "Error On Request",
+      "icode": "AD.500",
+      "displayString": "Error $VARIABLE$ received on request",
+      "recommendation": "Verify the request is accurate via debug logs and postman"
+    },
+    {
+      "key": "Request Timeout",
+      "icode": "AD.501",
+      "displayString": "The Adapter has run out of time for the request",
+      "recommendation": "Increase your adapter request.attempt_timeout property"
+    },
+    {
+      "key": "Invalid Response",
+      "icode": "AD.502",
+      "displayString": "Invalid response received for $VARIABLE$",
+      "recommendation": "Verify the request is accurate via debug logs and postman"
+    },
+    {
+      "key": "Failure Response",
+      "icode": "AD.503",
+      "displayString": "Failure response received for $VARIABLE$",
+      "recommendation": "Check the reason for failure in the stack trace"
+    },
+    {
+      "key": "Caught Exception",
+      "icode": "AD.900",
+      "displayString": "Caught Exception $VARIABLE$",
+      "recommendation": "Evaluate why the exception took place"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@itentialopensource/adapter-kafkav2",
+  "version": "0.3.12",
+  "description": "Itential adapter to connect to kafka",
+  "main": "adapter.js",
+  "wizardVersion": "2.35.0",
+  "engineVersion": "1.40.2",
+  "scripts": {
+    "artifactize": "npm i && node utils/packModificationScript.js",
+    "preinstall": "node utils/setup.js && npm install --package-lock-only --ignore-scripts && npx npm-force-resolutions",
+    "lint": "eslint . --ext .json --ext .js",
+    "lint:errors": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js --quiet",
+    "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
+    "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
+    "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
+    "test": "npm run test:unit && npm run test:integration",
+    "deploy": "npm publish --registry=https://registry.npmjs.org --access=public",
+    "build": "npm run deploy",
+    "postinstall": "patch-package"
+  },
+  "keywords": [
+    "Itential",
+    "IAP",
+    "Automation",
+    "Integration",
+    "App-Artifacts",
+    "Adapter",
+    "Notification",
+    "Messaging",
+    "Kafka",
+    "Pre-Release"
+  ],
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">= 0.12.7"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@gitlab.com:itentialopensource/adapters/notification-messaging/adapter-kafka.git"
+  },
+  "author": "Itential",
+  "homepage": "https://gitlab.com/itentialopensource/adapters/notification-messaging/adapter-kafka",
+  "dependencies": {
+    "ajv": "^6.12.0",
+    "avro-schema-registry": "^2.1.0",
+    "avsc": "^5.4.21",
+    "fs-extra": "^8.1.0",
+    "json-query": "^2.2.2",
+    "kafkajs": "2.2.3",
+    "package-json-validator": "^0.6.3",
+    "patch-package": "^6.4.7",
+    "readline-sync": "^1.4.10",
+    "request": "^2.88.2",
+    "uuid": "^3.0.1"
+  },
+  "devDependencies": {
+    "chai": "^4.2.0",
+    "eslint": "^7.2.0",
+    "eslint-config-airbnb-base": "^14.2.0",
+    "eslint-plugin-import": "^2.21.2",
+    "eslint-plugin-json": "^2.1.1",
+    "mocha": "^9.0.1",
+    "nyc": "^15.1.0",
+    "testdouble": "^3.16.1",
+    "winston": "^3.3.3"
+  },
+  "resolutions": {
+    "minimist": "^1.2.5"
+  },
+  "private": false
+}

package/pronghorn.json

@@ -0,0 +1,44 @@
+{
+  "id": "@itentialopensource/adapter-kafkav2",
+  "type": "Adapter",
+  "export": "Kafkav2",
+  "displayName": "Kafkav2",
+  "title": "Kafkav2",
+  "src": "adapter.js",
+  "roles": [
+    "admin"
+  ],
+  "topics": {
+    "kafka": {},
+    "first_kafka_topic": {},
+    "test-topic": {}
+  },
+  "methods": [
+    {
+      "name": "sendMessage",
+      "summary": "send message",
+      "description": "send message",
+      "input": [
+        {
+          "name": "payloads",
+          "type": "array",
+          "info": "array of ProduceRequest",
+          "required": false
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result"
+      },
+      "route": {
+        "verb": "POST",
+        "path": "/sendMessage"
+      },
+      "roles": [
+        "admin"
+      ],
+      "task": true
+    }
+  ]
+}

package/propertiesSchema.json

@@ -0,0 +1,198 @@
+{
+  "$id": "adapter-kafkav2",
+  "type": "object",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "host": {
+          "type": "string",
+          "description": "hostname of the server",
+          "default": "localhost",
+          "examples": [
+            "systemx.customer.com"
+          ]
+        },
+        "port": {
+          "type": "integer",
+          "description": "port on which to connect to the server",
+          "default": 9092,
+          "minimum": 1,
+          "maximum": 65535
+        }
+      },
+      "required": [
+        "host",
+        "port"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "hostList": {
+          "type": "string",
+          "description": "A string of kafka broker/host combination delimited by comma",
+          "default": "localhost:9092",
+          "examples": [
+            "kafka-1.us-east-1.myapp.com:9093,kafka-2.us-east-1.myapp.com:9093,kafka-3.us-east-1.myapp.com:9093",
+            "kafka-1.us-east-1.myapp.com:9093"
+          ]
+        }
+      },
+      "required": [
+        "hostList"
+      ]
+    }
+  ],
+  "if": {
+    "not": {
+      "anyOf": [
+        {
+          "required": ["host"]
+        },
+        {
+          "required": ["hostList"]
+        }
+      ]
+    }
+  },
+  "then": {
+    "properties": {
+      "host": {
+        "default": "localhost"
+      },
+      "port": {
+        "default": 9092
+      }
+    }
+  },
+  "properties": {
+    "registry_url": {
+      "type": "string",
+      "description": "registry url of schema",
+      "default": "",
+      "examples": [
+        "systemx.customer.com:8081"
+      ]
+    },
+    "topics": {
+      "type": "array",
+      "description": "An array of specific topics to move from kafka to rabbit",
+      "items": {
+        "type": [
+          "string",
+          "object"
+        ]
+      }
+    },
+    "parseMessage" :{
+      "type": "boolean",
+      "description": "Whether or not to prase the message as JSON when consumed by IAP",
+      "default" : true
+    },
+    "wrapMessage" : {
+      "type": "string",
+      "description": "A key to wrap the parsed JSON message",
+      "examples" : [ "message"],
+      "default" : "payload"
+    },
+    "interval_time": {
+      "type": "integer",
+      "description": "how often to write the topics file",
+      "default": 30000,
+      "minimum": 5000,
+      "maximum": 3600000
+    },
+    "stub": {
+      "type": "boolean",
+      "description": "run in stub mode - turns off topic writing",
+      "default": false
+    },
+    "client": {
+      "type": "object",
+      "properties": {
+        "connectTimeout": {
+          "type": "integer",
+          "default": 10000
+        },
+        "requestTimeout": {
+          "type": "integer",
+          "default": 30000
+        },
+        "autoConnect": {
+          "type": "boolean",
+          "default": true
+        },
+        "connectRetryOptions": {
+          "type": "object"
+        },
+        "idleConnection": {
+          "type": "integer",
+          "default": 300000
+        },
+        "reconnectOnIdle": {
+          "type": "boolean",
+          "default": true
+        },
+        "maxAsyncRequests": {
+          "type": "integer",
+          "default": 10
+        },
+        "sslOptions": {
+          "type": "object"
+        },
+        "sasl": {
+          "type": "object"
+        }
+      }
+    },
+    "producer": {
+      "type": "object",
+      "properties": {
+        "requireAcks": {
+          "type": "integer"
+        },
+        "ackTimeoutMs": {
+          "type": "integer"
+        },
+        "partitionerType": {
+          "type": "integer"
+        }
+      }
+    },
+    "consumer": {
+      "type": "object",
+      "properties": {
+        "groupId": {
+          "type": "string"
+        },
+        "autoCommit": {
+          "type": "boolean"
+        },
+        "autoCommitIntervalMs": {
+          "type": "integer"
+        },
+        "fetchMaxWaitMs": {
+          "type": "integer"
+        },
+        "fetchMinBytes": {
+          "type": "integer"
+        },
+        "fetchMaxBytes": {
+          "type": "integer"
+        },
+        "fromOffset": {
+          "type": "boolean"
+        },
+        "encoding": {
+          "type": "string"
+        },
+        "keyEncoding": {
+          "type": "string"
+        }
+      }
+    }
+  },
+  "definitions": {}
+}

package/sampleProperties.json

@@ -0,0 +1,41 @@
+{
+  "type": "Kafkav2",
+  "id": "kafkav2",
+  "properties": {
+    "host": "localhost",
+    "port": 9092,
+    "registry_url": "",
+    "topics": [],
+    "interval_time": 5000,
+    "stub": false,
+    "client": {
+      "connectTimeout": 10000,
+      "requestTimeout": 30000,
+      "autoConnect": true,
+      "connectRetryOptions": {},
+      "idleConnection": 300000,
+      "reconnectOnIdle": true,
+      "maxAsyncRequests": 10,
+      "sslOptions": {},
+      "sasl": {}
+    },
+    "producer": {
+      "requireAcks": 1,
+      "ackTimeoutMs": 100,
+      "partitionerType": 0
+    },
+    "consumer": {
+      "groupId": "kafka-node-group",
+      "autoCommit": false,
+      "autoCommitIntervalMs": 5000,
+      "fetchMaxWaitMs": 100,
+      "fetchMinBytes": 1,
+      "fetchMaxBytes": 1048576,
+      "fromOffset": true,
+      "encoding": "utf8",
+      "keyEncoding": "utf8"
+    }
+  },
+  "logLevel": "none",
+  "timeout": 60000
+}