sqs-consumer 6.2.1 → 7.0.0

package/.github/workflows/coverage.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [18.x]
 
     steps:
       - uses: actions/checkout@v3

package/.github/workflows/issues-to-projects.yml

@@ -0,0 +1,17 @@
+name: Add bugs to bugs project
+
+on:
+  issues:
+    types:
+      - opened
+      - labeled
+
+jobs:
+  add-to-project:
+    name: Add issue to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v0.4.0
+        with:
+          project-url: https://github.com/orgs/bbc/projects/170
+          github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}

package/.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [16.x, 18.x]
 
     steps:
       - uses: actions/checkout@v3

package/README.md

@@ -22,6 +22,12 @@ npm install --save-dev sqs-consumer
 > npm install sqs-consumer@5.8.0 --save-dev
 > ```
 
+### Node version
+
+From v7 and above, this library will only support Node v16 or above. If you are still using Node 14, please use a previous version of the library.
+
+This decision was made due to the removal of security support from the Node.JS team from April 30th, 2023.
+
 ## Usage
 
 ```js
@@ -49,6 +55,7 @@ app.start();
 - Messages are deleted from the queue once the handler function has completed successfully.
 - Throwing an error (or returning a rejected promise) from the handler function will cause the message to be left on the queue. An [SQS redrive policy](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html) can be used to move messages that cannot be processed to a dead letter queue.
 - By default messages are processed one at a time – a new message won't be received until the first one has been processed. To process messages in parallel, use the `batchSize` option [detailed below](#options).
+- By default, messages that are sent to the `handleMessage` and `handleMessageBatch` functions will be considered as processed if they return without an error. To acknowledge individual messages, please return the message that you want to acknowledge if you are using `handleMessage` or the messages for `handleMessageBatch`. It's also important to await any processing that you are doing to ensure that messages are processed one at a time.
 
 ### Credentials
 
@@ -108,9 +115,13 @@ Creates a new SQS consumer using the [defined options](https://bbc.github.io/sqs
 
 Start polling the queue for messages.
 
-### `consumer.stop()`
+### `consumer.stop(options)`
+
+Stop polling the queue for messages. [You can find the options definition here](https://bbc.github.io/sqs-consumer/interfaces/StopOptions.html).
+
+By default, the value of `abort` is set to `false` which means pre existing requests to AWS SQS will still be made until they have concluded. If you would like to abort these requests instead, pass the abort value as `true`, like so:
 
-Stop polling the queue for messages (pre existing requests will still be made until concluded).
+`consumer.stop({ abort: true })`
 
 ### `consumer.isRunning`
 

package/dist/consumer.d.ts

@@ -1,4 +1,4 @@
-import { ConsumerOptions, TypedEventEmitter } from './types';
+import { ConsumerOptions, TypedEventEmitter, StopOptions } from './types';
 /**
  * [Usage](https://bbc.github.io/sqs-consumer/index.html#usage)
  */
@@ -34,7 +34,7 @@ export declare class Consumer extends TypedEventEmitter {
     /**
      * Stop polling the queue for messages (pre existing requests will still be made until concluded).
      */
-    stop(): void;
+    stop(options: StopOptions): void;
     /**
      * Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
      */
@@ -45,6 +45,10 @@ export declare class Consumer extends TypedEventEmitter {
      * @param message The message that the error occurred on
      */
     private emitError;
+    /**
+     * A reusable options object for sqs.send that's used to avoid duplication.
+     */
+    private sqsSendOptions;
     /**
      * Poll for new messages from SQS
      */

package/dist/consumer.js

@@ -7,6 +7,7 @@ const types_1 = require("./types");
 const bind_1 = require("./bind");
 const errors_1 = require("./errors");
 const validation_1 = require("./validation");
+const controllers_1 = require("./controllers");
 const debug = (0, debug_1.default)('sqs-consumer');
 /**
  * [Usage](https://bbc.github.io/sqs-consumer/index.html#usage)
@@ -19,6 +20,12 @@ class Consumer extends types_1.TypedEventEmitter {
         this.heartbeatTimeoutId = undefined;
         this.handleMessageTimeoutId = undefined;
         this.stopped = true;
+        /**
+         * A reusable options object for sqs.send that's used to avoid duplication.
+         */
+        this.sqsSendOptions = {
+            abortSignal: controllers_1.abortController.signal
+        };
         (0, validation_1.assertOptions)(options);
         this.queueUrl = options.queueUrl;
         this.handleMessage = options.handleMessage;
@@ -62,7 +69,7 @@ class Consumer extends types_1.TypedEventEmitter {
     /**
      * Stop polling the queue for messages (pre existing requests will still be made until concluded).
      */
-    stop() {
+    stop(options) {
         if (this.stopped) {
             debug('Consumer was already stopped');
             return;
@@ -73,6 +80,11 @@ class Consumer extends types_1.TypedEventEmitter {
             clearTimeout(this.pollingTimeoutId);
             this.pollingTimeoutId = undefined;
         }
+        if (options === null || options === void 0 ? void 0 : options.abort) {
+            debug('Aborting SQS requests');
+            controllers_1.abortController.abort();
+            this.emit('aborted');
+        }
         this.emit('stopped');
     }
     /**
@@ -143,7 +155,7 @@ class Consumer extends types_1.TypedEventEmitter {
      */
     async receiveMessage(params) {
         try {
-            return await this.sqs.send(new client_sqs_1.ReceiveMessageCommand(params));
+            return await this.sqs.send(new client_sqs_1.ReceiveMessageCommand(params), this.sqsSendOptions);
         }
         catch (err) {
             throw (0, errors_1.toSQSError)(err, `SQS receive message failed: ${err.message}`);
@@ -253,7 +265,7 @@ class Consumer extends types_1.TypedEventEmitter {
                 ReceiptHandle: message.ReceiptHandle,
                 VisibilityTimeout: timeout
             };
-            return await this.sqs.send(new client_sqs_1.ChangeMessageVisibilityCommand(input));
+            return await this.sqs.send(new client_sqs_1.ChangeMessageVisibilityCommand(input), this.sqsSendOptions);
         }
         catch (err) {
             this.emit('error', (0, errors_1.toSQSError)(err, `Error changing visibility timeout: ${err.message}`), message);
@@ -274,7 +286,7 @@ class Consumer extends types_1.TypedEventEmitter {
             }))
         };
         try {
-            return await this.sqs.send(new client_sqs_1.ChangeMessageVisibilityBatchCommand(params));
+            return await this.sqs.send(new client_sqs_1.ChangeMessageVisibilityBatchCommand(params), this.sqsSendOptions);
         }
         catch (err) {
             this.emit('error', (0, errors_1.toSQSError)(err, `Error changing visibility timeout: ${err.message}`), messages);
@@ -342,7 +354,7 @@ class Consumer extends types_1.TypedEventEmitter {
             ReceiptHandle: message.ReceiptHandle
         };
         try {
-            await this.sqs.send(new client_sqs_1.DeleteMessageCommand(deleteParams));
+            await this.sqs.send(new client_sqs_1.DeleteMessageCommand(deleteParams), this.sqsSendOptions);
         }
         catch (err) {
             throw (0, errors_1.toSQSError)(err, `SQS delete message failed: ${err.message}`);
@@ -366,7 +378,7 @@ class Consumer extends types_1.TypedEventEmitter {
             }))
         };
         try {
-            await this.sqs.send(new client_sqs_1.DeleteMessageBatchCommand(deleteParams));
+            await this.sqs.send(new client_sqs_1.DeleteMessageBatchCommand(deleteParams), this.sqsSendOptions);
         }
         catch (err) {
             throw (0, errors_1.toSQSError)(err, `SQS delete message failed: ${err.message}`);

package/dist/controllers.d.ts

@@ -0,0 +1 @@
+export declare const abortController: AbortController;

package/dist/controllers.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.abortController = void 0;
+exports.abortController = new AbortController();

package/dist/types.d.ts

@@ -105,6 +105,14 @@ export interface ConsumerOptions {
      */
     handleMessageBatch?(messages: Message[]): Promise<Message[] | void>;
 }
+export interface StopOptions {
+    /**
+     * Default to `false`, if you want the stop action to also abort requests to SQS
+     * set this to `true`.
+     * @defaultvalue `false`
+     */
+    abort?: boolean;
+}
 export interface Events {
     /**
      * Fired after one batch of items (up to `batchSize`) has been successfully processed.
@@ -137,6 +145,10 @@ export interface Events {
      * Fired when an error occurs processing the message.
      */
     processing_error: [Error, Message];
+    /**
+     * Fired when requests to SQS were aborted.
+     */
+    aborted: [];
     /**
      * Fired when the consumer finally stops its work.
      */

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "sqs-consumer",
-  "version": "6.2.1",
+  "version": "7.0.0",
   "description": "Build SQS-based Node applications without the boilerplate",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "engines": {
+    "node": ">=16.19.0"
+  },
   "scripts": {
     "build": "npm run clean && tsc",
     "watch": "tsc --watch",

package/src/consumer.ts

@@ -17,7 +17,7 @@ import {
 } from '@aws-sdk/client-sqs';
 import Debug from 'debug';
 
-import { ConsumerOptions, TypedEventEmitter } from './types';
+import { ConsumerOptions, TypedEventEmitter, StopOptions } from './types';
 import { autoBind } from './bind';
 import {
   SQSError,
@@ -26,6 +26,7 @@ import {
   isConnectionError
 } from './errors';
 import { assertOptions, hasMessages } from './validation';
+import { abortController } from './controllers';
 
 const debug = Debug('sqs-consumer');
 
@@ -101,7 +102,7 @@ export class Consumer extends TypedEventEmitter {
   /**
    * Stop polling the queue for messages (pre existing requests will still be made until concluded).
    */
-  public stop(): void {
+  public stop(options: StopOptions): void {
     if (this.stopped) {
       debug('Consumer was already stopped');
       return;
@@ -115,6 +116,14 @@ export class Consumer extends TypedEventEmitter {
       this.pollingTimeoutId = undefined;
     }
 
+    if (options?.abort) {
+      debug('Aborting SQS requests');
+
+      abortController.abort();
+
+      this.emit('aborted');
+    }
+
     this.emit('stopped');
   }
 
@@ -142,6 +151,13 @@ export class Consumer extends TypedEventEmitter {
     }
   }
 
+  /**
+   * A reusable options object for sqs.send that's used to avoid duplication.
+   */
+  private sqsSendOptions = {
+    abortSignal: abortController.signal
+  };
+
   /**
    * Poll for new messages from SQS
    */
@@ -190,7 +206,10 @@ export class Consumer extends TypedEventEmitter {
     params: ReceiveMessageCommandInput
   ): Promise<ReceiveMessageCommandOutput> {
     try {
-      return await this.sqs.send(new ReceiveMessageCommand(params));
+      return await this.sqs.send(
+        new ReceiveMessageCommand(params),
+        this.sqsSendOptions
+      );
     } catch (err) {
       throw toSQSError(err, `SQS receive message failed: ${err.message}`);
     }
@@ -319,7 +338,10 @@ export class Consumer extends TypedEventEmitter {
         ReceiptHandle: message.ReceiptHandle,
         VisibilityTimeout: timeout
       };
-      return await this.sqs.send(new ChangeMessageVisibilityCommand(input));
+      return await this.sqs.send(
+        new ChangeMessageVisibilityCommand(input),
+        this.sqsSendOptions
+      );
     } catch (err) {
       this.emit(
         'error',
@@ -348,7 +370,8 @@ export class Consumer extends TypedEventEmitter {
     };
     try {
       return await this.sqs.send(
-        new ChangeMessageVisibilityBatchCommand(params)
+        new ChangeMessageVisibilityBatchCommand(params),
+        this.sqsSendOptions
       );
     } catch (err) {
       this.emit(
@@ -426,7 +449,10 @@ export class Consumer extends TypedEventEmitter {
     };
 
     try {
-      await this.sqs.send(new DeleteMessageCommand(deleteParams));
+      await this.sqs.send(
+        new DeleteMessageCommand(deleteParams),
+        this.sqsSendOptions
+      );
     } catch (err) {
       throw toSQSError(err, `SQS delete message failed: ${err.message}`);
     }
@@ -457,7 +483,10 @@ export class Consumer extends TypedEventEmitter {
     };
 
     try {
-      await this.sqs.send(new DeleteMessageBatchCommand(deleteParams));
+      await this.sqs.send(
+        new DeleteMessageBatchCommand(deleteParams),
+        this.sqsSendOptions
+      );
     } catch (err) {
       throw toSQSError(err, `SQS delete message failed: ${err.message}`);
     }

package/src/controllers.ts

@@ -0,0 +1 @@
+export const abortController = new AbortController();

package/src/types.ts

@@ -106,6 +106,15 @@ export interface ConsumerOptions {
   handleMessageBatch?(messages: Message[]): Promise<Message[] | void>;
 }
 
+export interface StopOptions {
+  /**
+   * Default to `false`, if you want the stop action to also abort requests to SQS
+   * set this to `true`.
+   * @defaultvalue `false`
+   */
+  abort?: boolean;
+}
+
 export interface Events {
   /**
    * Fired after one batch of items (up to `batchSize`) has been successfully processed.
@@ -138,6 +147,10 @@ export interface Events {
    * Fired when an error occurs processing the message.
    */
   processing_error: [Error, Message];
+  /**
+   * Fired when requests to SQS were aborted.
+   */
+  aborted: [];
   /**
    * Fired when the consumer finally stops its work.
    */