ac-support-connector 0.1.1 → 1.0.1

package/.github/workflows/node.js.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x]
+        node-version: [18.x, 20.x, 22.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
         redis-version: [6]
 

package/.ncurc.js

@@ -0,0 +1,8 @@
+// List packages for minor updates
+const minorUpdatePackages = ['chai']
+
+module.exports = {
+  target: packageName => {
+    return minorUpdatePackages.includes(packageName) ? 'minor' : 'latest'
+  }
+}

package/CHANGELOG.md

@@ -1,3 +1,33 @@
+<a name="1.0.1"></a>
+
+## [1.0.1](https://github.com/admiralcloud/ac-support-connector/compare/v1.0.0..v1.0.1) (2024-08-27 14:05:03)
+
+
+### Bug Fix
+
+* **Connector:** Use ac-sqs | MP | [42dd23f9dde355204eb77a5f546cb2f12a8bb700](https://github.com/admiralcloud/ac-support-connector/commit/42dd23f9dde355204eb77a5f546cb2f12a8bb700)    
+Use our ac-sqs package  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+<a name="1.0.0"></a>
+ 
+# [1.0.0](https://github.com/admiralcloud/ac-support-connector/compare/v0.1.1..v1.0.0) (2024-08-26 07:17:38)
+
+
+### Bug Fix
+
+* **Connector:** Improved usage | MP | [c1962e78072ee709e52d1f2230ebf0655aef568c](https://github.com/admiralcloud/ac-support-connector/commit/c1962e78072ee709e52d1f2230ebf0655aef568c)    
+Improved message processing with more flexibility. See README.  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+* **Connector:** Package updates | MP | [ae989c837d20b4a68245c5683631dc2c4c71b3ce](https://github.com/admiralcloud/ac-support-connector/commit/ae989c837d20b4a68245c5683631dc2c4c71b3ce)    
+Package update  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+### Chores
+
+* **Connector:** Updated packages | MP | [c469b370133e827a2e6994d04e1197f17d81357b](https://github.com/admiralcloud/ac-support-connector/commit/c469b370133e827a2e6994d04e1197f17d81357b)    
+Updated packages  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+## BREAKING CHANGES
+* **Connector:** See README - changes version 1
 <a name="0.1.1"></a>
 
 ## [0.1.1](https://github.com/admiralcloud/ac-support-connector/compare/v0.1.0..v0.1.1) (2023-07-26 19:49:09)

package/README.md

@@ -3,6 +3,14 @@ This module sends unified support payloads to SQS. A dedicated service (not part
 
 [![Node.js CI](https://github.com/AdmiralCloud/ac-geoip/actions/workflows/node.js.yml/badge.svg)](https://github.com/AdmiralCloud/ac-support-connector/actions/workflows/node.js.yml)
 
+# Breaking changes 
+## Version 1
++ platforms array is now required
++ channels are no longer supported, use platforms instead
++ use "text" for simple messages and "message" array for complex messages
++ level, service, project, etc are types in the message array (see example below)
++ messages with payload > 256kB will throw an exception (instead of truncating)
+
 # Prerequisites
 Create a SQS queue (e.g. supportQueue) and use a policy that allows all (or selected) IAM users from the account to send messages to the queue:
 
@@ -34,11 +42,38 @@ await supportConnector.init({
 
 // now send logs like this
 
+// SIMPLE MESSAGE
 await supportConnector.createMessage({ 
+  platforms: ['jsm']
   subject: 'Operation failed',
   text: 'The operation ABC failed due to missing parameter',
-  level: 'warn' // optional, if none is set, the level is info
 })
+
+// COMPLEX MESSAGE
+await supportConnector.createMessage({ 
+  platform: ['jsm', 'teams'],
+  subject: 'Operation failed',
+  reporter: 'jane.doe@admiralcloud.com',
+  message: [{
+    type: 'text',
+    content: 'The operation ABC failed due to missing parameter'
+  }, {
+    type: 'level,
+    content: 'warn'
+  }, {
+    type: 'service',
+    content: 'my-service'
+  }, {
+    type: 'instanceId',
+    content: 'abc123'
+  }, {
+    type: 'project',
+    content: 'playground-channel'
+  }]
+})
+
+NOTE: If instanceId and service are set during init, they will be automatically added to message payload.
+
 ```
 
 # Parameters
@@ -55,13 +90,15 @@ await supportConnector.createMessage({
 |---|---|---|
 |subject|string|Subject of the message
 |text|string|Text of the message
-|level|string|Level of the message, if not set defaults to info. Available: error, warn, debug, verbose, info
+|message|array|Array of objects with properties types and content*
 |block|integer|Seconds before the message is sent again (if the error occurs again). If Redis is not available, memory is used.
 
+There is no limit to types in message array. Some of them have an effect when using ac-lambda-supportEventProcessor. Only type "text" must exist. Every type can be multiple times in the array.
+
+Using message as array can help to "layout" your message, e.g. in Teams as nice message card.
 
 ## Links
 - [Website](https://www.admiralcloud.com/)
-- [Facebook](https://www.facebook.com/MediaAssetManagement/)
 
 ## License
-Copyright AdmiralCloud AG, Mark Poepping
+Copyright 2009 - today, AdmiralCloud AG, Mark Poepping

package/eslint.config.js

@@ -0,0 +1,30 @@
+const globals = require('globals');
+
+module.exports = {
+  ignores: [
+    'config/env/**'
+  ],
+  languageOptions: {
+    ecmaVersion: 2022,
+    sourceType: 'module',
+    globals: {
+      ...globals.commonjs,
+      ...globals.es6,
+      ...globals.node,
+      expect: 'readonly',
+      describe: 'readonly',
+      it: 'readonly'
+    }
+  },
+  rules: {
+    'no-const-assign': 'error', // Ensure this rule is enabled
+    'space-before-function-paren': 'off',
+    'no-extra-semi': 'off',
+    'object-curly-spacing': ['error', 'always'],
+    'brace-style': ['error', 'stroustrup', { allowSingleLine: true }],
+    'no-useless-escape': 'off',
+    'standard/no-callback-literal': 'off',
+    'new-cap': 'off',
+    'no-console': ['warn', { allow: ['warn', 'error'] }]
+  }
+};

package/index.js

@@ -1,53 +1,48 @@
-const { SQSClient, SendMessageCommand } = require('@aws-sdk/client-sqs')
 const { STSClient, GetCallerIdentityCommand } = require('@aws-sdk/client-sts')
-const { fromIni } = require("@aws-sdk/credential-providers")
-
-const getLength = require('utf8-byte-length')
-const truncate = require('truncate-utf8-bytes')
-
 const NodeCache = require('node-cache')
 
+const ACSQS = require('ac-sqs')
+
 const functionName = 'ac-support-connector'.padEnd(20)
 
 module.exports = {
 
   aws: {},
 
-  init: async function({ serviceName, instanceId, sqsQueue, redisInstance, region = 'eu-central-1', profile = process.env['profile'], debug } = {}) {
+  init: async function({ serviceName, instanceId, sqsQueue = 'AC-SupportQueue', bucket, redisInstance, region = 'eu-central-1', profile = process.env['profile'], debug } = {}) {
     
-    if (!debug) {
-      const awsConfig = {
-        region
-      }
-      // credentials are determined from  role.
-      // But you can also use a set profile 
-      if (profile) {
-        console.error('%s | Using AWS profile | %s', functionName, profile)
-        awsConfig.credentials = fromIni({ profile })
-      }
+    this.sqsQueue = sqsQueue
+    this.serviceName = serviceName || 'SupportConnector'
+    this.instanceId = instanceId
+    this.redisInstance = redisInstance
+    this.cache = new NodeCache()
+    this.debugMode = debug
 
-      // determine accountId
+    if (!debug) {
       const client = new STSClient(awsConfig)
       const command = new GetCallerIdentityCommand()
       const response = await client.send(command)
       const accountId = response?.Account
-      
-      this.aws = {
-        sqs: new SQSClient(awsConfig),
-        region,
-        accountId
+      const sqsParams = {
+        account: accountId,
+        availableLists: [{
+          name: sqsQueue,
+          fifo: true
+        }]
       }
+      if (profile) sqsParams.profile = profile // Optional AWS profile, see below
+      if (bucket) {
+        sqsParams.useS3 = { 
+          enabled: true,
+          bucket
+        }
+      }
+      this.acsqs = new ACSQS(sqsParams)
     }
-
-    this.serviceName = serviceName || 'SupportConnector'
-    this.instanceId = instanceId
-    this.sqsQueue = sqsQueue || 'supportQueue'
-    this.redisInstance = redisInstance
-    this.cache = new NodeCache()
   },
 
 
-  createMessage: async function({ subject, text, level, block, channels }) {
+  createMessage: async function({ subject, text, message = [], block, platforms, reporter }) {
     // check block time in Redis, fallback to memory
     if (block) {
       if (block < 1) block = 1 // make sure to use reasonable value!
@@ -69,40 +64,29 @@ module.exports = {
       }
     }
 
+    // message is an array of objects, if it is empty and just text is set, add it to the array
+    if (message.length === 0) message.push({ type: 'text', content: text })
+
+    // service is also part of message array
+    message.push({ type: 'service', content: this.serviceName })
+    if (this.instanceId) message.push({ type: 'instanceId', content: this.instanceId })
+
     const messagePayload = {
+      platforms,
       subject,
-      text,
-      level,
-      serviceName: this.serviceName
+      reporter,
+      message,
     }
-    if (this.instanceId) messagePayload.instanceId = this.instanceId
-    if (channels) messagePayload.channels = channels
 
-    const maxSize = 256 * 1024 // 256kb 
-    const recordLength = getLength(JSON.stringify(messagePayload))
-    if (recordLength > maxSize) {
-      // text must be truncated
-      const textLength = getLength(messagePayload.text)
-      const truncatedSize = textLength - (recordLength - maxSize)
-      messagePayload.text = truncate(messagePayload.text, truncatedSize)
-      console.log('%s | Subject %s | Truncated to %s', functionName, subject, truncatedSize)
-    }  
-  
     if (process.env.NODE_ENV === 'test') {
       return messagePayload
     }
-
-    const awsInput = {
-      QueueUrl: `https://sqs.${this.aws.region}.amazonaws.com/${this.aws.accountId}/${this.sqsQueue}`,
-      MessageBody: JSON.stringify(messagePayload)
-    }
-    const command = new SendMessageCommand(awsInput)
     try {
-      const response = await this.aws.sqs.send(command)
-      console.log(response)
+      await this.acsqs.sendSQSMessage({ name: this.sqsQueue, message: JSON.stringify(messagePayload) })
+      if (this.debugMode) console.warn(response)
     }
     catch(e) {
-      console.log('%s | Subject %s | Failed %j', functionName, subject, e?.message)
+      console.error('%s | Subject %s | Failed %j', functionName, subject, e?.message)
     }
   }
 }

package/package.json

@@ -3,27 +3,23 @@
   "author": "Mark Poepping (https://www.admiralcloud.com)",
   "license": "MIT",
   "repository": "admiralcloud/ac-support-connector",
-  "version": "0.1.1",
+  "version": "1.0.1",
   "dependencies": {
-    "@aws-sdk/client-sqs": "^3.378.0",
-    "@aws-sdk/client-sts": "^3.378.0",
-    "@aws-sdk/credential-providers": "^3.378.0",
-    "node-cache": "^5.1.2",
-    "truncate-utf8-bytes": "^1.0.2",
-    "utf8-byte-length": "^1.0.4"
+    "ac-sqs": "^2.0.4",
+    "node-cache": "^5.1.2"
   },
   "devDependencies": {
     "ac-semantic-release": "^0.4.2",
-    "chai": "^4.3.7",
-    "eslint": "^8.45.0",
-    "expect": "^29.6.1",
-    "ioredis": "^5.3.2",
-    "mocha": "^10.2.0"
+    "chai": "^4.5.0",
+    "eslint": "^9.9.1",
+    "expect": "^29.7.0",
+    "ioredis": "^5.4.1",
+    "mocha": "^10.7.3"
   },
   "scripts": {
     "test": "NODE_ENV=test mocha --reporter spec || :"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   }
 }

package/test/test.js

@@ -1,8 +1,5 @@
 const { expect } = require('chai');
 
-const getLength = require("utf8-byte-length")
-const truncate = require("truncate-utf8-bytes")
-
 const Redis = require("ioredis");
 const redisInstance = new Redis() 
 
@@ -19,29 +16,30 @@ describe('Basic tests', () => {
   it('Test properties', async() => {
     let params = {
       subject: 'Failed',
-      text: 'This failed',
-      level: 'warn'
+      text: 'This failed'
     }
     let response = await supCon.createMessage(params)
-    Object.keys(params).forEach(prop => {
-      const val = params[prop]
-      expect(response).to.have.property(prop, val)
-    })
+    expect(response).to.have.property('subject', params.subject)
+    expect(response).to.have.property('message').that.is.an('array').with.lengthOf.at.least(1);
+    expect(response.message[0]).to.have.property('type', 'text')
+    expect(response.message[0]).to.have.property('content', params.text)
   })
 
-  it('Check truncated payload > 256KB - truncated', async() => {
+  it('Check truncated payload > 256KB - should not throw an error', async() => {
     let params = {
       subject: 'Failed',
-      text: string1001
+      message: [{
+        type: 'text',
+        content: string1001
+      }]
     }
-    const maxSize = 256 * 1024 // 256kb 
-    const recordLength = getLength(JSON.stringify(params))
-    const textLength = getLength(params.text)
-    const truncated = truncate(params.text, textLength - (recordLength - maxSize))
+
     let response = await supCon.createMessage(params)
-    expect(response.text).to.equal(truncated)
+    expect(response).to.have.property('subject', params.subject)
+    expect(response).to.have.property('message').that.is.an('array').with.lengthOf.at.least(1);
+    expect(response.message[0]).to.have.property('type', 'text')
+    expect(response.message[0]).to.have.property('content', string1001)
   })
-
 })
 
 describe('Block with Redis', () => {

package/.eslintrc.js

@@ -1,27 +0,0 @@
-const config = {
-  root: true,
-  'env': {
-    'commonjs': true,
-    'es6': true,
-    'node': true
-  },
-  'extends': 'eslint:recommended',
-  "rules": {
-    "space-before-function-paren": 0,
-    "no-extra-semi": 0,
-    "object-curly-spacing": ["error", "always"],
-    "brace-style": ["error", "stroustrup", { "allowSingleLine": true }],
-    "no-useless-escape": 0,
-    "standard/no-callback-literal": 0,
-    "new-cap": 0
-  },
-  globals: {
-    describe: true,
-    it: true
-  },
-  'parserOptions': {
-    'ecmaVersion': 2021
-},
-}
-
-module.exports = config