ac-sqs 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+ 
+# [3.1.0](https://github.com/admiralcloud/ac-sqs/compare/v3.0.0..v3.1.0) (2025-04-12 08:11:38)
+
+
+### Feature
+
+* **App:** Add visibilityTimeout management | MP | [ccdd4d0230fc98a5e1aa8531a9939ef2457b614a](https://github.com/admiralcloud/ac-sqs/commit/ccdd4d0230fc98a5e1aa8531a9939ef2457b614a)    
+It is now possible to automatically extend visibility for messages. Just set visibilityTimeout in list config  
+Related issues: [admiralcloud/ac-sqs#1](https://github.com/admiralcloud/ac-sqs/issues/1) [admiralcloud/ac-api-server#340](https://github.com/admiralcloud/ac-api-server/issues/340)
+### Documentation
+
+* **App:** Added visibilityTimeout management  | MP | [4c6e916b0056c894dcac5cb58fa48166de769de4](https://github.com/admiralcloud/ac-sqs/commit/4c6e916b0056c894dcac5cb58fa48166de769de4)    
+Added visibilityTimeout management  
+Related issues: [admiralcloud/ac-sqs#1](https://github.com/admiralcloud/ac-sqs/issues/1) [admiralcloud/ac-api-server#340](https://github.com/admiralcloud/ac-api-server/issues/340)
+### Chores
+
+* **App:** Updated packages | MP | [c2f533d3bd7bb0d9917d9815e46ef6e8ab5c79d2](https://github.com/admiralcloud/ac-sqs/commit/c2f533d3bd7bb0d9917d9815e46ef6e8ab5c79d2)    
+Updated packages  
+Related issues: [admiralcloud/ac-sqs#1](https://github.com/admiralcloud/ac-sqs/issues/1) [admiralcloud/ac-api-server#340](https://github.com/admiralcloud/ac-api-server/issues/340)
 <a name="3.0.0"></a>
  
 # [3.0.0](https://github.com/admiralcloud/ac-sqs/compare/v2.0.8..v3.0.0) (2024-10-17 15:51:06)

package/README.md

@@ -33,7 +33,7 @@ The ***account*** id of your AWS account. This is required
 Array of AWS SQS lists that will be used by this function. Every item in the list must be an object with the following properties:
 + name -> the name of the list in AWS SQS. See below for more info.
 + batchSize -> number of messages to fetch per call. Max 10, defaults to 1
-+ visibilityTimeout -> see AWS SQS for details, defaults to 30
++ visibilityTimeout -> see AWS SQS for details, defaults to 30. If set, visibilityTimeout management is activated
 + waitTime -> see AWS SQS for details, defaults to 20
 + fifo -> set to true, if this is a fifo list
 + localPrefix -> set your local prefix. See below for more info
@@ -55,6 +55,9 @@ useS3: {
 }
 ```
 
+**Visibility Timeout Management**
+If you set list config parameter visibilityTimeout, the automatic visibilityTimeout management will be activated. It will make sure that visibilityTimeout for messages is automatically extended.
+
 Make sure your function can read, write and delete messages in the bucket.
 
 ## sendSQSMessage

package/index.js

@@ -1,7 +1,7 @@
 const _ = require('lodash')
 const { v4: uuidV4 } = require('uuid')
 
-const { SQSClient, SendMessageCommand, ReceiveMessageCommand, DeleteMessageBatchCommand, GetQueueAttributesCommand } = require('@aws-sdk/client-sqs')
+const { SQSClient, SendMessageCommand, ReceiveMessageCommand, DeleteMessageBatchCommand, GetQueueAttributesCommand, ChangeMessageVisibilityCommand } = require('@aws-sdk/client-sqs')
 const { S3Client, GetObjectCommand, PutObjectCommand, DeleteObjectsCommand } = require("@aws-sdk/client-s3")
 
 
@@ -12,6 +12,7 @@ class ACSQS {
     this.availableLists = availableLists
     this.logger = logger
     this.throwError = throwError
+    this.visibilityTimer = {}
 
     const awsConfig = {
       region,
@@ -109,13 +110,71 @@ class ACSQS {
     }
   }
 
+  async extendVisibility({ name, message }) {
+    const config = _.find(this.availableLists, { name })
+    if (!config) {
+      this.logger.error('AWS | extendVisibility | configurationMissing | %s', name)
+      throw new Error('configurationForListMissing')
+    }
+
+    const visibilityTimeout = _.get(config, 'visibilityTimeout', 15)
+    const maxVisibilityExtensions = _.get(config, 'maxVisibilityExtensions', 12) // max number of times the extension can me made (12 x 15s = 3min)
+    
+    const { MessageId: messageId, ReceiptHandle: receiptHandle } = message
+
+     // Check if we've reached maximum extensions
+    if (this.visibilityTimer[messageId] && this.visibilityTimer[messageId].visibilityExtensionCount >= maxVisibilityExtensions) {
+      this.logger.warn('ACSQS | extendVisibility | %s | M %s | Max extensions reached | %s | %j', name, messageId, maxVisibilityExtensions, message)
+      this.deleteVisibilityTimer({ messageId })
+      return
+    }
+    
+    // Track extension count
+    if (this.visibilityTimer[messageId]) {
+      this.visibilityTimer[messageId].visibilityExtensionCount++
+    }
+    
+    const sqsParams = {
+      QueueUrl: await this.getQueueUrl(config),
+      ReceiptHandle: receiptHandle,
+      VisibilityTimeout: visibilityTimeout
+    }
+    const command = new ChangeMessageVisibilityCommand(sqsParams)
+    try {
+      const response = await this.sqs.send(command)
+      if (config.debug) {
+        const visibilityExtensionCount = this.visibilityTimer[messageId] ? this.visibilityTimer[messageId].visibilityExtensionCount : 0
+        this.logger.debug('ACSQS | extendVisibility | %s |  M %s | %ss | %s | %j', name, messageId, visibilityTimeout, visibilityExtensionCount, message)
+      }
+
+      return response
+    }
+    catch(e) {
+      this.logger.error('ACSQS | extendVisibility | %s | %s', name, e?.message)
+      this.deleteVisibilityTimer({ messageId })
+      if (this.throwError || throwError) throw e
+    }
+  }
+
+  deleteVisibilityTimer({ messageId }) {
+    if (this.visibilityTimer[messageId]) {
+      clearTimeout(this.visibilityTimer[messageId].timer)
+      const self = this
+      setTimeout(() => {
+        delete self.visibilityTimer[messageId]
+      }, 1000)
+    }
+  }
+
   async receiveSQSMessages({ name, throwError }) {
     const config = _.find(this.availableLists, { name })
     if (!config) {
-      this.logger.error('AWS | receiveSQSMessage | configurationMissing | %s', name)
+      this.logger.error('ACSQS | receiveSQSMessage | configurationMissing | %s', name)
       throw new Error('configurationForListMissing')
     }
-    let sqsParams = {
+    const visibilityTimeout = _.get(config, 'visibilityTimeout') // if set, will activate visibilityTimeout management
+  
+    const sqsParams = {
       QueueUrl: await this.getQueueUrl(config),
       MaxNumberOfMessages: _.get(config, 'batchSize', 10),
       VisibilityTimeout: _.get(config, 'visibilityTimeout', 30),
@@ -126,7 +185,9 @@ class ACSQS {
     try {
       const result = await this.sqs.send(command)
       if (!_.size(result.Messages)) return
-      const messages = await Promise.all(result.Messages.map(async message => {
+      
+      // Benutze Arrow-Funktion, um `this` beizubehalten
+      const messages = await Promise.all(result.Messages.map(async (message) => {
         if (message.Body.startsWith('s3:')) {
           const key = message.Body.replace('s3:', '')
           try {
@@ -135,9 +196,29 @@ class ACSQS {
             message.s3key = key
           }
           catch(e) {
-            this.logger.error('AWS | receiveSQSMessages | s3KeyInvalid | %s', name, key)         
+            this.logger.error('ACSQS | receiveSQSMessages | s3KeyInvalid | %s', name, key)         
           }
         }
+  
+        if (visibilityTimeout > 0) {
+          // start visibility timer that automatically extends visibility of the message if required
+          const { MessageId: messageId } = message
+          const timeoutMs = Math.floor(visibilityTimeout * 0.8 * 1000)
+          const self = this // `this` als lokale Variable speichern
+          
+          this.visibilityTimer[messageId] = {
+            // Arrow-Funktion für setInterval damit `this` erhalten bleibt,
+            // oder verwende die lokale Variable `self`
+            timer: setInterval(() => {
+              this.extendVisibility({ name, message })
+                .catch(e => {
+                  this.logger.error('ACSQS | AutoExtendVisibility | Failed %s', e.message)
+                })
+            }, timeoutMs),
+            visibilityExtensionCount: 0
+          }
+        }
+  
         return message
       }))
       return messages
@@ -156,6 +237,11 @@ class ACSQS {
       throw new Error('configurationForListMissing')
     }
 
+    if (!_.size(items)) {
+      this.logger.error('AWS | deleteSQSMessage | %s | noItemsToDelete', name)
+      return
+    }
+
     const entries = []
     const s3keys = []
     for (const item of items) {
@@ -163,8 +249,13 @@ class ACSQS {
       if (item.s3key) {
         s3keys.push({ Key: item.s3key })
       }
+      const messageId = item.Id
+      if (this.visibilityTimer[messageId]) {
+        this.deleteVisibilityTimer({ messageId })
+      }
     }
 
+
     let sqsParams = {
       QueueUrl: await this.getQueueUrl(config),
       Entries: entries

package/package.json

@@ -3,18 +3,18 @@
   "author": "Mark Poepping (https://www.admiralcloud.com)",
   "license": "MIT",
   "repository": "admiralcloud/ac-sqs",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.673.0",
-    "@aws-sdk/client-sqs": "^3.670.0",
+    "@aws-sdk/client-s3": "^3.787.0",
+    "@aws-sdk/client-sqs": "^3.787.0",
     "lodash": "^4.17.21",
-    "uuid": "^10.0.0"
+    "uuid": "^11.1.0"
   },
   "devDependencies": {
-    "ac-semantic-release": "^0.4.3",
+    "ac-semantic-release": "^0.4.5",
     "chai": "^4.5.0",
-    "eslint": "^9.12.0",
-    "mocha": "^10.7.3"
+    "eslint": "^9.24.0",
+    "mocha": "^11.1.0"
   },
   "scripts": {
     "test": "mocha --reporter spec"