sqs-consumer 5.6.0 → 5.8.0

package/dist/consumer.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Consumer = void 0;
-const SQS = require("aws-sdk/clients/sqs");
-const Debug = require("debug");
+const aws_sdk_1 = require("aws-sdk");
+const debug_1 = require("debug");
 const events_1 = require("events");
 const bind_1 = require("./bind");
 const errors_1 = require("./errors");
-const debug = Debug('sqs-consumer');
+const debug = (0, debug_1.default)('sqs-consumer');
 const requiredOptions = [
     'queueUrl',
     // only one of handleMessage / handleMessagesBatch is required
@@ -31,13 +31,16 @@ function assertOptions(options) {
     if (options.batchSize > 10 || options.batchSize < 1) {
         throw new Error('SQS batchSize option must be between 1 and 10.');
     }
-    if (options.heartbeatInterval && !(options.heartbeatInterval < options.visibilityTimeout)) {
+    if (options.heartbeatInterval &&
+        !(options.heartbeatInterval < options.visibilityTimeout)) {
         throw new Error('heartbeatInterval must be less than visibilityTimeout.');
     }
 }
 function isConnectionError(err) {
     if (err instanceof errors_1.SQSError) {
-        return (err.statusCode === 403 || err.code === 'CredentialsError' || err.code === 'UnknownEndpoint');
+        return (err.statusCode === 403 ||
+            err.code === 'CredentialsError' ||
+            err.code === 'UnknownEndpoint');
     }
     return false;
 }
@@ -56,6 +59,7 @@ function hasMessages(response) {
 }
 class Consumer extends events_1.EventEmitter {
     constructor(options) {
+        var _a, _b, _c, _d;
         super();
         assertOptions(options);
         this.queueUrl = options.queueUrl;
@@ -67,15 +71,20 @@ class Consumer extends events_1.EventEmitter {
         this.stopped = true;
         this.batchSize = options.batchSize || 1;
         this.visibilityTimeout = options.visibilityTimeout;
-        this.terminateVisibilityTimeout = options.terminateVisibilityTimeout || false;
+        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.sqs = options.sqs || new SQS({
-            region: options.region || process.env.AWS_REGION || 'eu-west-1'
-        });
-        bind_1.autoBind(this);
+        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 aws_sdk_1.SQS({
+                    region: options.region || process.env.AWS_REGION || 'eu-west-1'
+                });
+        (0, bind_1.autoBind)(this);
     }
     emit(event, ...args) {
         return super.emit(event, ...args);
@@ -128,7 +137,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 +147,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 {
@@ -147,24 +156,24 @@ class Consumer extends events_1.EventEmitter {
     }
     async receiveMessage(params) {
         try {
-            return await this.sqs
-                .receiveMessage(params)
-                .promise();
+            return await this.sqs.receiveMessage(params).promise();
         }
         catch (err) {
             throw toSQSError(err, `SQS receive message failed: ${err.message}`);
         }
     }
     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,
             ReceiptHandle: message.ReceiptHandle
         };
         try {
-            await this.sqs
-                .deleteMessage(deleteParams)
-                .promise();
+            await this.sqs.deleteMessage(deleteParams).promise();
         }
         catch (err) {
             throw toSQSError(err, `SQS delete message failed: ${err.message}`);
@@ -176,10 +185,7 @@ class Consumer extends events_1.EventEmitter {
         try {
             if (this.handleMessageTimeout) {
                 [timeout, pending] = createTimeout(this.handleMessageTimeout);
-                await Promise.race([
-                    this.handleMessage(message),
-                    pending
-                ]);
+                await Promise.race([this.handleMessage(message), pending]);
             }
             else {
                 await this.handleMessage(message);
@@ -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) {
@@ -247,9 +253,11 @@ class Consumer extends events_1.EventEmitter {
                 currentPollingTimeout = this.authenticationErrorTimeout;
             }
             return;
-        }).then(() => {
+        })
+            .then(() => {
             setTimeout(this.poll, currentPollingTimeout);
-        }).catch((err) => {
+        })
+            .catch((err) => {
             this.emit('error', err);
         });
     }
@@ -281,6 +289,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,
@@ -290,9 +302,7 @@ class Consumer extends events_1.EventEmitter {
             }))
         };
         try {
-            await this.sqs
-                .deleteMessageBatch(deleteParams)
-                .promise();
+            await this.sqs.deleteMessageBatch(deleteParams).promise();
         }
         catch (err) {
             throw toSQSError(err, `SQS delete message failed: ${err.message}`);
@@ -317,12 +327,10 @@ class Consumer extends events_1.EventEmitter {
             }))
         };
         try {
-            return this.sqs
-                .changeMessageVisibilityBatch(params)
-                .promise();
+            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/dist/index.js

@@ -1,4 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Consumer = void 0;
 var consumer_1 = require("./consumer");
 Object.defineProperty(exports, "Consumer", { enumerable: true, get: function () { return consumer_1.Consumer; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "5.6.0",
+  "version": "5.8.0",
   "description": "Build SQS-based Node applications without the boilerplate",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,11 +11,13 @@
     "prepublish": "npm run build",
     "pretest": "npm run build",
     "test": "mocha --recursive --full-trace --exit",
-    "lint": "eslint . --ext .ts",
-    "lint:fix": "eslint . --fix",
     "coverage": "nyc mocha && nyc report --reporter=html && nyc report --reporter=json-summary",
     "lcov": "nyc mocha && nyc report --reporter=lcov",
-    "posttest": "npm run lint"
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --loglevel warn --write \"**/*.{js,json,jsx,md,ts,tsx,html}\"",
+    "format:check": "prettier --check \"**/*.{js,json,jsx,md,ts,tsx,html}\"",
+    "posttest": "npm run lint && npm run format:check"
   },
   "repository": {
     "type": "git",
@@ -32,31 +34,33 @@
   ],
   "license": "Apache-2.0",
   "devDependencies": {
-    "@types/chai": "^4.2.11",
-    "@types/debug": "^4.1.5",
-    "@types/mocha": "^7.0.2",
-    "@types/node": "^14.0.13",
-    "@types/sinon": "^9.0.4",
-    "@types/typescript": "^2.0.0",
-    "chai": "^4.2.0",
-    "codeclimate-test-reporter": "^0.5.1",
-    "eslint": "^7.2.0",
-    "eslint-config-iplayer-ts": "^2.0.0",
-    "mocha": "^8.0.1",
+    "@types/chai": "^4.3.4",
+    "@types/debug": "^4.1.7",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^16.18.7",
+    "@types/sinon": "^10.0.13",
+    "chai": "^4.3.7",
+    "eslint": "^8.29.0",
+    "eslint-config-iplayer-ts": "^4.1.0",
+    "eslint-config-prettier": "^4.3.0",
+    "mocha": "^10.1.0",
     "nyc": "^15.1.0",
     "p-event": "^4.2.0",
-    "sinon": "^9.0.2",
-    "ts-node": "^8.10.2",
-    "tslint-config-airbnb": "^5.11.2",
-    "tslint-microsoft-contrib": "^6.2.0",
-    "typescript": "^3.9.5",
-    "aws-sdk": "^2.699.0"
+    "prettier": "^2.8.1",
+    "sinon": "^15.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.4"
   },
   "dependencies": {
-    "debug": "^4.1.1"
+    "aws-sdk": "^2.1271.0",
+    "debug": "^4.3.4"
   },
   "peerDependencies": {
-    "aws-sdk": "^2.699.0"
+    "aws-sdk": "^2.1271.0"
+  },
+  "mocha": {
+    "spec": "test/**/**/*.test.ts",
+    "require": "ts-node/register"
   },
   "nyc": {
     "include": [
@@ -72,14 +76,28 @@
     "instrument": true
   },
   "eslintConfig": {
-    "extends": "iplayer-ts",
+    "extends": [
+      "iplayer-ts",
+      "prettier",
+      "prettier/react",
+      "prettier/@typescript-eslint"
+    ],
     "parserOptions": {
-      "ecmaVersion": 2017,
       "sourceType": "module"
+    },
+    "rules": {
+      "@typescript-eslint/naming-convention": [
+        "error",
+        {
+          "selector": "variable",
+          "format": [
+            "camelCase",
+            "UPPER_CASE",
+            "PascalCase"
+          ],
+          "leadingUnderscore": "allow"
+        }
+      ]
     }
-  },
-  "mocha": {
-    "spec": "test/**/**/*.ts",
-    "require": "ts-node/register"
   }
 }

package/src/consumer.ts

@@ -1,14 +1,16 @@
-import { AWSError } from 'aws-sdk';
-import * as SQS from 'aws-sdk/clients/sqs';
+import { AWSError, SQS } from 'aws-sdk';
 import { PromiseResult } from 'aws-sdk/lib/request';
-import * as Debug from 'debug';
+import Debug from 'debug';
 import { EventEmitter } from 'events';
 import { autoBind } from './bind';
 import { SQSError, TimeoutError } from './errors';
 
 const debug = Debug('sqs-consumer');
 
-type ReceieveMessageResponse = PromiseResult<SQS.Types.ReceiveMessageResult, AWSError>;
+type ReceieveMessageResponse = PromiseResult<
+  SQS.Types.ReceiveMessageResult,
+  AWSError
+>;
 type ReceiveMessageRequest = SQS.Types.ReceiveMessageRequest;
 export type SQSMessage = SQS.Types.Message;
 
@@ -37,7 +39,9 @@ function assertOptions(options: ConsumerOptions): void {
   requiredOptions.forEach((option) => {
     const possibilities = option.split('|');
     if (!possibilities.find((p) => options[p])) {
-      throw new Error(`Missing SQS consumer option [ ${possibilities.join(' or ')} ].`);
+      throw new Error(
+        `Missing SQS consumer option [ ${possibilities.join(' or ')} ].`
+      );
     }
   });
 
@@ -45,14 +49,21 @@ function assertOptions(options: ConsumerOptions): void {
     throw new Error('SQS batchSize option must be between 1 and 10.');
   }
 
-  if (options.heartbeatInterval && !(options.heartbeatInterval < options.visibilityTimeout)) {
+  if (
+    options.heartbeatInterval &&
+    !(options.heartbeatInterval < options.visibilityTimeout)
+  ) {
     throw new Error('heartbeatInterval must be less than visibilityTimeout.');
   }
 }
 
 function isConnectionError(err: Error): boolean {
   if (err instanceof SQSError) {
-    return (err.statusCode === 403 || err.code === 'CredentialsError' || err.code === 'UnknownEndpoint');
+    return (
+      err.statusCode === 403 ||
+      err.code === 'CredentialsError' ||
+      err.code === 'UnknownEndpoint'
+    );
   }
   return false;
 }
@@ -88,19 +99,20 @@ export interface ConsumerOptions {
   sqs?: SQS;
   region?: string;
   handleMessageTimeout?: number;
+  shouldDeleteMessages?: boolean;
   handleMessage?(message: SQSMessage): Promise<void>;
   handleMessageBatch?(messages: SQSMessage[]): Promise<void>;
 }
 
 interface Events {
-  'response_processed': [];
-  'empty': [];
-  'message_received': [SQSMessage];
-  'message_processed': [SQSMessage];
-  'error': [Error, void | SQSMessage | SQSMessage[]];
-  'timeout_error': [Error, SQSMessage];
-  'processing_error': [Error, SQSMessage];
-  'stopped': [];
+  response_processed: [];
+  empty: [];
+  message_received: [SQSMessage];
+  message_processed: [SQSMessage];
+  error: [Error, void | SQSMessage | SQSMessage[]];
+  timeout_error: [Error, SQSMessage];
+  processing_error: [Error, SQSMessage];
+  stopped: [];
 }
 
 export class Consumer extends EventEmitter {
@@ -119,6 +131,7 @@ export class Consumer extends EventEmitter {
   private terminateVisibilityTimeout: boolean;
   private heartbeatInterval: number;
   private sqs: SQS;
+  private shouldDeleteMessages: boolean;
 
   constructor(options: ConsumerOptions) {
     super();
@@ -132,15 +145,20 @@ export class Consumer extends EventEmitter {
     this.stopped = true;
     this.batchSize = options.batchSize || 1;
     this.visibilityTimeout = options.visibilityTimeout;
-    this.terminateVisibilityTimeout = options.terminateVisibilityTimeout || false;
+    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.sqs = options.sqs || new SQS({
-      region: options.region || process.env.AWS_REGION || 'eu-west-1'
-    });
+    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'
+      });
 
     autoBind(this);
   }
@@ -149,11 +167,17 @@ export class Consumer extends EventEmitter {
     return super.emit(event, ...args);
   }
 
-  on<T extends keyof Events>(event: T, listener: (...args: Events[T]) => void): this {
+  on<T extends keyof Events>(
+    event: T,
+    listener: (...args: Events[T]) => void
+  ): this {
     return super.on(event, listener);
   }
 
-  once<T extends keyof Events>(event: T, listener: (...args: Events[T]) => void): this {
+  once<T extends keyof Events>(
+    event: T,
+    listener: (...args: Events[T]) => void
+  ): this {
     return super.once(event, listener);
   }
 
@@ -178,7 +202,9 @@ export class Consumer extends EventEmitter {
     this.stopped = true;
   }
 
-  private async handleSqsResponse(response: ReceieveMessageResponse): Promise<void> {
+  private async handleSqsResponse(
+    response: ReceieveMessageResponse
+  ): Promise<void> {
     debug('Received SQS response');
     debug(response);
 
@@ -204,7 +230,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,24 +240,30 @@ 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);
     }
   }
 
-  private async receiveMessage(params: ReceiveMessageRequest): Promise<ReceieveMessageResponse> {
+  private async receiveMessage(
+    params: ReceiveMessageRequest
+  ): Promise<ReceieveMessageResponse> {
     try {
-      return await this.sqs
-        .receiveMessage(params)
-        .promise();
+      return await this.sqs.receiveMessage(params).promise();
     } catch (err) {
       throw toSQSError(err, `SQS receive message failed: ${err.message}`);
     }
   }
 
   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 = {
@@ -240,9 +272,7 @@ export class Consumer extends EventEmitter {
     };
 
     try {
-      await this.sqs
-        .deleteMessage(deleteParams)
-        .promise();
+      await this.sqs.deleteMessage(deleteParams).promise();
     } catch (err) {
       throw toSQSError(err, `SQS delete message failed: ${err.message}`);
     }
@@ -254,10 +284,7 @@ export class Consumer extends EventEmitter {
     try {
       if (this.handleMessageTimeout) {
         [timeout, pending] = createTimeout(this.handleMessageTimeout);
-        await Promise.race([
-          this.handleMessage(message),
-          pending
-        ]);
+        await Promise.race([this.handleMessage(message), pending]);
       } else {
         await this.handleMessage(message);
       }
@@ -273,9 +300,12 @@ 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 +313,11 @@ 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
+      );
     }
   }
 
@@ -323,9 +357,11 @@ export class Consumer extends EventEmitter {
           currentPollingTimeout = this.authenticationErrorTimeout;
         }
         return;
-      }).then(() => {
+      })
+      .then(() => {
         setTimeout(this.poll, currentPollingTimeout);
-      }).catch((err) => {
+      })
+      .catch((err) => {
         this.emit('error', err);
       });
   }
@@ -339,7 +375,10 @@ export class Consumer extends EventEmitter {
     try {
       if (this.heartbeatInterval) {
         heartbeat = this.startHeartbeat(async () => {
-          return this.changeVisabilityTimeoutBatch(messages, this.visibilityTimeout);
+          return this.changeVisabilityTimeoutBatch(
+            messages,
+            this.visibilityTimeout
+          );
         });
       }
       await this.executeBatchHandler(messages);
@@ -359,7 +398,16 @@ export class Consumer extends EventEmitter {
   }
 
   private async deleteMessageBatch(messages: SQSMessage[]): Promise<void> {
-    debug('Deleting messages %s', messages.map((msg) => msg.MessageId).join(' ,'));
+    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,
@@ -370,9 +418,7 @@ export class Consumer extends EventEmitter {
     };
 
     try {
-      await this.sqs
-        .deleteMessageBatch(deleteParams)
-        .promise();
+      await this.sqs.deleteMessageBatch(deleteParams).promise();
     } catch (err) {
       throw toSQSError(err, `SQS delete message failed: ${err.message}`);
     }
@@ -387,7 +433,10 @@ export class Consumer extends EventEmitter {
     }
   }
 
-  private async changeVisabilityTimeoutBatch(messages: SQSMessage[], timeout: number): Promise<PromiseResult<any, AWSError>> {
+  private async changeVisabilityTimeoutBatch(
+    messages: SQSMessage[],
+    timeout: number
+  ): Promise<PromiseResult<any, AWSError>> {
     const params = {
       QueueUrl: this.queueUrl,
       Entries: messages.map((message) => ({
@@ -397,11 +446,13 @@ export class Consumer extends EventEmitter {
       }))
     };
     try {
-      return this.sqs
-        .changeMessageVisibilityBatch(params)
-        .promise();
+      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/src/errors.ts

@@ -20,7 +20,4 @@ class TimeoutError extends Error {
   }
 }
 
-export {
-  SQSError,
-  TimeoutError
-};
+export { SQSError, TimeoutError };