sqs-consumer 5.6.0 → 5.7.0

package/README.md

@@ -44,6 +44,7 @@ app.start();
 ```js
 const { Consumer } = require('sqs-consumer');
 const AWS = require('aws-sdk');
+const https = require('https');
 
 const app = Consumer.create({
   queueUrl: 'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',
@@ -138,7 +139,7 @@ Creates a new SQS consumer.
 * `authenticationErrorTimeout` - _Number_ - The duration (in milliseconds) to wait before retrying after an authentication error (defaults to `10000`).
 * `pollingWaitTimeMs` - _Number_ - The duration (in milliseconds) to wait before repolling the queue (defaults to `0`).
 * `sqs` - _Object_ - An optional [AWS SQS](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SQS.html) object to use if you need to configure the client manually
-
+* `shouldDeleteMessages` - _Boolean_ - Default to `true`, if you don't want the package to delete messages from sqs set this to `false`
 ### `consumer.start()`
 
 Start polling the queue for messages.
@@ -157,7 +158,7 @@ Each consumer is an [`EventEmitter`](http://nodejs.org/api/events.html) and emit
 
 |Event|Params|Description|
 |-----|------|-----------|
-|`error`|`err`, `[message]`|Fired when an error occurs interacting with the queue. If the error correlates to a message, that error is included in Params|
+|`error`|`err`, `[message]`|Fired when an error occurs interacting with the queue. If the error correlates to a message, that message is included in Params|
 |`processing_error`|`err`, `message`|Fired when an error occurs processing the message.|
 |`timeout_error`|`err`, `message`|Fired when `handleMessageTimeout` is supplied as an option and if `handleMessage` times out.|
 |`message_received`|`message`|Fired when a message is received.|
@@ -168,8 +169,7 @@ Each consumer is an [`EventEmitter`](http://nodejs.org/api/events.html) and emit
 
 ### AWS IAM Permissions
 
-Consumer will receive and delete messages from the SQS queue. Ensure `sqs:ReceiveMessage` and `sqs:DeleteMessage` access is granted on the queue being consumed.
-
+Consumer will receive and delete messages from the SQS queue. Ensure `sqs:ReceiveMessage`, `sqs:DeleteMessage`, `sqs:DeleteMessageBatch`, `sqs:ChangeMessageVisibility` and `sqs:ChangeMessageVisibilityBatch` access is granted on the queue being consumed.
 
 ### Contributing 
 See contributing [guidelines](https://github.com/bbc/sqs-consumer/blob/master/.github/CONTRIBUTING.md).

package/dist/consumer.d.ts

@@ -17,6 +17,7 @@ export interface ConsumerOptions {
     sqs?: SQS;
     region?: string;
     handleMessageTimeout?: number;
+    shouldDeleteMessages?: boolean;
     handleMessage?(message: SQSMessage): Promise<void>;
     handleMessageBatch?(messages: SQSMessage[]): Promise<void>;
 }
@@ -46,6 +47,7 @@ export declare class Consumer extends EventEmitter {
     private terminateVisibilityTimeout;
     private heartbeatInterval;
     private sqs;
+    private shouldDeleteMessages;
     constructor(options: ConsumerOptions);
     emit<T extends keyof Events>(event: T, ...args: Events[T]): boolean;
     on<T extends keyof Events>(event: T, listener: (...args: Events[T]) => void): this;
@@ -59,7 +61,7 @@ export declare class Consumer extends EventEmitter {
     private receiveMessage;
     private deleteMessage;
     private executeHandler;
-    private changeVisabilityTimeout;
+    private changeVisibilityTimeout;
     private emitError;
     private poll;
     private processMessageBatch;

package/dist/consumer.js

@@ -56,6 +56,7 @@ function hasMessages(response) {
 }
 class Consumer extends events_1.EventEmitter {
     constructor(options) {
+        var _a, _b, _c, _d;
         super();
         assertOptions(options);
         this.queueUrl = options.queueUrl;
@@ -69,9 +70,10 @@ class Consumer extends events_1.EventEmitter {
         this.visibilityTimeout = options.visibilityTimeout;
         this.terminateVisibilityTimeout = options.terminateVisibilityTimeout || false;
         this.heartbeatInterval = options.heartbeatInterval;
-        this.waitTimeSeconds = options.waitTimeSeconds || 20;
-        this.authenticationErrorTimeout = options.authenticationErrorTimeout || 10000;
-        this.pollingWaitTimeMs = options.pollingWaitTimeMs || 0;
+        this.waitTimeSeconds = (_a = options.waitTimeSeconds) !== null && _a !== void 0 ? _a : 20;
+        this.authenticationErrorTimeout = (_b = options.authenticationErrorTimeout) !== null && _b !== void 0 ? _b : 10000;
+        this.pollingWaitTimeMs = (_c = options.pollingWaitTimeMs) !== null && _c !== void 0 ? _c : 0;
+        this.shouldDeleteMessages = (_d = options.shouldDeleteMessages) !== null && _d !== void 0 ? _d : true;
         this.sqs = options.sqs || new SQS({
             region: options.region || process.env.AWS_REGION || 'eu-west-1'
         });
@@ -128,7 +130,7 @@ class Consumer extends events_1.EventEmitter {
         try {
             if (this.heartbeatInterval) {
                 heartbeat = this.startHeartbeat(async () => {
-                    return this.changeVisabilityTimeout(message, this.visibilityTimeout);
+                    return this.changeVisibilityTimeout(message, this.visibilityTimeout);
                 });
             }
             await this.executeHandler(message);
@@ -138,7 +140,7 @@ class Consumer extends events_1.EventEmitter {
         catch (err) {
             this.emitError(err, message);
             if (this.terminateVisibilityTimeout) {
-                await this.changeVisabilityTimeout(message, 0);
+                await this.changeVisibilityTimeout(message, 0);
             }
         }
         finally {
@@ -156,6 +158,10 @@ class Consumer extends events_1.EventEmitter {
         }
     }
     async deleteMessage(message) {
+        if (!this.shouldDeleteMessages) {
+            debug('Skipping message delete since shouldDeleteMessages is set to false');
+            return;
+        }
         debug('Deleting message %s', message.MessageId);
         const deleteParams = {
             QueueUrl: this.queueUrl,
@@ -198,9 +204,9 @@ class Consumer extends events_1.EventEmitter {
             clearTimeout(timeout);
         }
     }
-    async changeVisabilityTimeout(message, timeout) {
+    async changeVisibilityTimeout(message, timeout) {
         try {
-            return this.sqs
+            return await this.sqs
                 .changeMessageVisibility({
                 QueueUrl: this.queueUrl,
                 ReceiptHandle: message.ReceiptHandle,
@@ -209,7 +215,7 @@ class Consumer extends events_1.EventEmitter {
                 .promise();
         }
         catch (err) {
-            this.emit('error', err, message);
+            this.emit('error', toSQSError(err, `Error changing visibility timeout: ${err.message}`), message);
         }
     }
     emitError(err, message) {
@@ -281,6 +287,10 @@ class Consumer extends events_1.EventEmitter {
         }
     }
     async deleteMessageBatch(messages) {
+        if (!this.shouldDeleteMessages) {
+            debug('Skipping message delete since shouldDeleteMessages is set to false');
+            return;
+        }
         debug('Deleting messages %s', messages.map((msg) => msg.MessageId).join(' ,'));
         const deleteParams = {
             QueueUrl: this.queueUrl,
@@ -317,12 +327,12 @@ class Consumer extends events_1.EventEmitter {
             }))
         };
         try {
-            return this.sqs
+            return await this.sqs
                 .changeMessageVisibilityBatch(params)
                 .promise();
         }
         catch (err) {
-            this.emit('error', err, messages);
+            this.emit('error', toSQSError(err, `Error changing visibility timeout: ${err.message}`), messages);
         }
     }
     startHeartbeat(heartbeatFn) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "5.6.0",
+  "version": "5.7.0",
   "description": "Build SQS-based Node applications without the boilerplate",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -50,13 +50,13 @@
     "tslint-config-airbnb": "^5.11.2",
     "tslint-microsoft-contrib": "^6.2.0",
     "typescript": "^3.9.5",
-    "aws-sdk": "^2.699.0"
+    "aws-sdk": "^2.1114.0"
   },
   "dependencies": {
-    "debug": "^4.1.1"
+    "debug": "^4.3.1"
   },
   "peerDependencies": {
-    "aws-sdk": "^2.699.0"
+    "aws-sdk": "^2.1114.0"
   },
   "nyc": {
     "include": [

package/src/consumer.ts

@@ -88,6 +88,7 @@ export interface ConsumerOptions {
   sqs?: SQS;
   region?: string;
   handleMessageTimeout?: number;
+  shouldDeleteMessages?: boolean;
   handleMessage?(message: SQSMessage): Promise<void>;
   handleMessageBatch?(messages: SQSMessage[]): Promise<void>;
 }
@@ -119,6 +120,7 @@ export class Consumer extends EventEmitter {
   private terminateVisibilityTimeout: boolean;
   private heartbeatInterval: number;
   private sqs: SQS;
+  private shouldDeleteMessages: boolean;
 
   constructor(options: ConsumerOptions) {
     super();
@@ -134,9 +136,10 @@ export class Consumer extends EventEmitter {
     this.visibilityTimeout = options.visibilityTimeout;
     this.terminateVisibilityTimeout = options.terminateVisibilityTimeout || false;
     this.heartbeatInterval = options.heartbeatInterval;
-    this.waitTimeSeconds = options.waitTimeSeconds || 20;
-    this.authenticationErrorTimeout = options.authenticationErrorTimeout || 10000;
-    this.pollingWaitTimeMs = options.pollingWaitTimeMs || 0;
+    this.waitTimeSeconds = options.waitTimeSeconds ?? 20;
+    this.authenticationErrorTimeout = options.authenticationErrorTimeout ?? 10000;
+    this.pollingWaitTimeMs = options.pollingWaitTimeMs ?? 0;
+    this.shouldDeleteMessages = options.shouldDeleteMessages ?? true;
 
     this.sqs = options.sqs || new SQS({
       region: options.region || process.env.AWS_REGION || 'eu-west-1'
@@ -204,7 +207,7 @@ export class Consumer extends EventEmitter {
     try {
       if (this.heartbeatInterval) {
         heartbeat = this.startHeartbeat(async () => {
-          return this.changeVisabilityTimeout(message, this.visibilityTimeout);
+          return this.changeVisibilityTimeout(message, this.visibilityTimeout);
         });
       }
       await this.executeHandler(message);
@@ -214,7 +217,7 @@ export class Consumer extends EventEmitter {
       this.emitError(err, message);
 
       if (this.terminateVisibilityTimeout) {
-        await this.changeVisabilityTimeout(message, 0);
+        await this.changeVisibilityTimeout(message, 0);
       }
     } finally {
       clearInterval(heartbeat);
@@ -232,6 +235,10 @@ export class Consumer extends EventEmitter {
   }
 
   private async deleteMessage(message: SQSMessage): Promise<void> {
+    if (!this.shouldDeleteMessages) {
+      debug('Skipping message delete since shouldDeleteMessages is set to false');
+      return;
+    }
     debug('Deleting message %s', message.MessageId);
 
     const deleteParams = {
@@ -273,9 +280,9 @@ export class Consumer extends EventEmitter {
     }
   }
 
-  private async changeVisabilityTimeout(message: SQSMessage, timeout: number): Promise<PromiseResult<any, AWSError>> {
+  private async changeVisibilityTimeout(message: SQSMessage, timeout: number): Promise<PromiseResult<any, AWSError>> {
     try {
-      return this.sqs
+      return await this.sqs
         .changeMessageVisibility({
           QueueUrl: this.queueUrl,
           ReceiptHandle: message.ReceiptHandle,
@@ -283,7 +290,7 @@ export class Consumer extends EventEmitter {
         })
         .promise();
     } catch (err) {
-      this.emit('error', err, message);
+      this.emit('error', toSQSError(err, `Error changing visibility timeout: ${err.message}`), message);
     }
   }
 
@@ -359,6 +366,10 @@ export class Consumer extends EventEmitter {
   }
 
   private async deleteMessageBatch(messages: SQSMessage[]): Promise<void> {
+    if (!this.shouldDeleteMessages) {
+      debug('Skipping message delete since shouldDeleteMessages is set to false');
+      return;
+    }
     debug('Deleting messages %s', messages.map((msg) => msg.MessageId).join(' ,'));
 
     const deleteParams = {
@@ -397,11 +408,11 @@ export class Consumer extends EventEmitter {
       }))
     };
     try {
-      return this.sqs
+      return await this.sqs
         .changeMessageVisibilityBatch(params)
         .promise();
     } catch (err) {
-      this.emit('error', err, messages);
+      this.emit('error', toSQSError(err, `Error changing visibility timeout: ${err.message}`), messages);
     }
   }
 

package/test/consumer.ts

@@ -692,6 +692,60 @@ describe('Consumer', () => {
       });
       sandbox.assert.calledOnce(clearIntervalSpy);
     });
+
+    it('emit error when changing visibility timeout fails', async () => {
+      sqs.receiveMessage = stubResolve({
+        Messages: [
+          { MessageId: '1', ReceiptHandle: 'receipt-handle-1', Body: 'body-1' }
+        ]
+      });
+      consumer = new Consumer({
+        queueUrl: 'some-queue-url',
+        region: 'some-region',
+        handleMessage: () => new Promise((resolve) => setTimeout(resolve, 75000)),
+        sqs,
+        visibilityTimeout: 40,
+        heartbeatInterval: 30
+      });
+
+      const receiveErr = new MockSQSError('failed');
+      sqs.changeMessageVisibility = stubReject(receiveErr);
+
+      consumer.start();
+      const [err]: any[] = await Promise.all([pEvent(consumer, 'error'), clock.tickAsync(75000)]);
+      consumer.stop();
+
+      assert.ok(err);
+      assert.equal(err.message, 'Error changing visibility timeout: failed');
+    });
+
+    it('emit error when changing visibility timeout fails for batch handler functions', async () => {
+      sqs.receiveMessage = stubResolve({
+        Messages: [
+          { MessageId: '1', ReceiptHandle: 'receipt-handle-1', Body: 'body-1' },
+          { MessageId: '2', ReceiptHandle: 'receipt-handle-2', Body: 'body-2' }
+        ]
+      });
+      consumer = new Consumer({
+        queueUrl: 'some-queue-url',
+        region: 'some-region',
+        handleMessageBatch: () => new Promise((resolve) => setTimeout(resolve, 75000)),
+        sqs,
+        batchSize: 2,
+        visibilityTimeout: 40,
+        heartbeatInterval: 30
+      });
+
+      const receiveErr = new MockSQSError('failed');
+      sqs.changeMessageVisibilityBatch = stubReject(receiveErr);
+
+      consumer.start();
+      const [err]: any[] = await Promise.all([pEvent(consumer, 'error'), clock.tickAsync(75000)]);
+      consumer.stop();
+
+      assert.ok(err);
+      assert.equal(err.message, 'Error changing visibility timeout: failed');
+    });
   });
 
   describe('.stop', () => {
@@ -752,4 +806,27 @@ describe('Consumer', () => {
       assert.isFalse(consumer.isRunning);
     });
   });
+
+  describe('delete messages property', () => {
+    beforeEach(() => {
+      consumer = new Consumer({
+        queueUrl: 'some-queue-url',
+        region: 'some-region',
+        handleMessage,
+        sqs,
+        authenticationErrorTimeout: 20,
+        shouldDeleteMessages: false
+      });
+    });
+
+    it('dont deletes the message when the handleMessage function is called', async () => {
+      handleMessage.resolves();
+
+      consumer.start();
+      await pEvent(consumer, 'message_processed');
+      consumer.stop();
+
+      sandbox.assert.notCalled(sqs.deleteMessage);
+    });
+  });
 });