sqs-consumer 7.3.0 → 7.4.0

package/.github/workflows/stale.yml

@@ -18,3 +18,7 @@ jobs:
           days-before-issue-close: 5
           days-before-pr-close: 10
           operations-per-run: 90
+          exempt-issue-labels: keep
+          exempt-pr-labels: keep
+          exempt-all-assignees: true
+          exempt-all-milestones: true

package/dist/consumer.d.ts

@@ -9,6 +9,8 @@ export declare class Consumer extends TypedEventEmitter {
     private queueUrl;
     private handleMessage;
     private handleMessageBatch;
+    private preReceiveMessageCallback?;
+    private postReceiveMessageCallback?;
     private sqs;
     private handleMessageTimeout;
     private attributeNames;
@@ -21,6 +23,7 @@ export declare class Consumer extends TypedEventEmitter {
     private authenticationErrorTimeout;
     private pollingWaitTimeMs;
     private heartbeatInterval;
+    abortController: AbortController;
     constructor(options: ConsumerOptions);
     /**
      * Creates a new SQS consumer.
@@ -30,6 +33,10 @@ export declare class Consumer extends TypedEventEmitter {
      * Start polling the queue for messages.
      */
     start(): void;
+    /**
+     * A reusable options object for sqs.send that's used to avoid duplication.
+     */
+    private get sqsSendOptions();
     /**
      * Stop polling the queue for messages (pre existing requests will still be made until concluded).
      */
@@ -50,10 +57,6 @@ 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

@@ -6,7 +6,6 @@ const emitter_1 = require("./emitter");
 const bind_1 = require("./bind");
 const errors_1 = require("./errors");
 const validation_1 = require("./validation");
-const controllers_1 = require("./controllers");
 const logger_1 = require("./logger");
 /**
  * [Usage](https://bbc.github.io/sqs-consumer/index.html#usage)
@@ -17,16 +16,12 @@ class Consumer extends emitter_1.TypedEventEmitter {
         super();
         this.pollingTimeoutId = 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;
         this.handleMessageBatch = options.handleMessageBatch;
+        this.preReceiveMessageCallback = options.preReceiveMessageCallback;
+        this.postReceiveMessageCallback = options.postReceiveMessageCallback;
         this.handleMessageTimeout = options.handleMessageTimeout;
         this.attributeNames = options.attributeNames || [];
         this.messageAttributeNames = options.messageAttributeNames || [];
@@ -58,12 +53,25 @@ class Consumer extends emitter_1.TypedEventEmitter {
      */
     start() {
         if (this.stopped) {
+            // Create a new abort controller each time the consumer is started
+            this.abortController = new AbortController();
             logger_1.logger.debug('starting');
             this.stopped = false;
             this.emit('started');
             this.poll();
         }
     }
+    /**
+     * A reusable options object for sqs.send that's used to avoid duplication.
+     */
+    get sqsSendOptions() {
+        var _a;
+        return {
+            // return the current abortController signal or a fresh signal that has not been aborted.
+            // This effectively defaults the signal sent to the AWS SDK to not aborted
+            abortSignal: ((_a = this.abortController) === null || _a === void 0 ? void 0 : _a.signal) || new AbortController().signal
+        };
+    }
     /**
      * Stop polling the queue for messages (pre existing requests will still be made until concluded).
      */
@@ -80,7 +88,7 @@ class Consumer extends emitter_1.TypedEventEmitter {
         }
         if (options === null || options === void 0 ? void 0 : options.abort) {
             logger_1.logger.debug('aborting');
-            controllers_1.abortController.abort();
+            this.abortController.abort();
             this.emit('aborted');
         }
         this.emit('stopped');
@@ -167,7 +175,14 @@ class Consumer extends emitter_1.TypedEventEmitter {
      */
     async receiveMessage(params) {
         try {
-            return await this.sqs.send(new client_sqs_1.ReceiveMessageCommand(params), this.sqsSendOptions);
+            if (this.preReceiveMessageCallback) {
+                await this.preReceiveMessageCallback();
+            }
+            const result = await this.sqs.send(new client_sqs_1.ReceiveMessageCommand(params), this.sqsSendOptions);
+            if (this.postReceiveMessageCallback) {
+                await this.postReceiveMessageCallback();
+            }
+            return result;
         }
         catch (err) {
             throw (0, errors_1.toSQSError)(err, `SQS receive message failed: ${err.message}`);

package/dist/types.d.ts

@@ -102,6 +102,22 @@ export interface ConsumerOptions {
      * the successful messages only.
      */
     handleMessageBatch?(messages: Message[]): Promise<Message[] | void>;
+    /**
+     * An `async` function (or function that returns a `Promise`) to be called right
+     * before the SQS Client sends a receive message command.
+     *
+     * This function is usefull if SQS Client module exports have been modified, for
+     * example to add middlewares.
+     */
+    preReceiveMessageCallback?(): Promise<void>;
+    /**
+     * An `async` function (or function that returns a `Promise`) to be called right
+     * after the SQS Client sends a receive message command.
+     *
+     * This function is usefull if SQS Client module exports have been modified, for
+     * example to add middlewares.
+     */
+    postReceiveMessageCallback?(): Promise<void>;
 }
 export type UpdatableOptions = 'visibilityTimeout' | 'batchSize' | 'waitTimeSeconds';
 export interface StopOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "7.3.0",
+  "version": "7.4.0",
   "description": "Build SQS-based Node applications without the boilerplate",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,8 +17,8 @@
     "test:integration:init": "sh ./test/scripts/initIntTests.sh",
     "test:integration": "npm run test:integration:init && cucumber-js --config ./test/config/cucumber.js",
     "test": "npm run test:unit && npm run test:integration",
-    "coverage": "nyc mocha && nyc report --reporter=html && nyc report --reporter=json-summary",
-    "lcov": "nyc mocha && nyc report --reporter=lcov",
+    "coverage": "c8 mocha && c8 report --reporter=html && c8 report --reporter=json-summary",
+    "lcov": "c8 mocha && c8 report --reporter=lcov",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --fix",
     "format": "prettier --loglevel warn --write \"**/*.{js,json,jsx,md,ts,tsx,html}\"",
@@ -41,37 +41,37 @@
   ],
   "license": "Apache-2.0",
   "devDependencies": {
-    "@cucumber/cucumber": "^9.2.0",
-    "@types/chai": "^4.3.5",
-    "@types/mocha": "^10.0.1",
-    "@types/node": "^20.4.1",
-    "@types/sinon": "^10.0.15",
-    "chai": "^4.3.7",
-    "eslint": "^8.44.0",
-    "eslint-config-iplayer-ts": "^4.1.1",
-    "eslint-config-prettier": "^8.8.0",
+    "@cucumber/cucumber": "10.0.1",
+    "@types/chai": "^4.3.9",
+    "@types/mocha": "^10.0.3",
+    "@types/node": "^20.8.7",
+    "@types/sinon": "^10.0.20",
+    "chai": "^4.3.10",
+    "eslint": "^8.52.0",
+    "eslint-config-iplayer": "^9.1.0",
+    "eslint-config-prettier": "^9.0.0",
     "mocha": "^10.2.0",
-    "nyc": "^15.1.0",
+    "c8": "^8.0.1",
     "p-event": "^4.2.0",
-    "prettier": "^3.0.0",
-    "sinon": "^15.2.0",
-    "sqs-producer": "^3.2.1",
+    "prettier": "^3.0.3",
+    "sinon": "^17.0.0",
+    "sqs-producer": "^3.4.0",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.24.8",
-    "typescript": "^4.9.4"
+    "typedoc": "^0.25.2",
+    "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@aws-sdk/client-sqs": "^3.363.0",
+    "@aws-sdk/client-sqs": "^3.428.0",
     "debug": "^4.3.4"
   },
   "peerDependencies": {
-    "@aws-sdk/client-sqs": "^3.363.0"
+    "@aws-sdk/client-sqs": "^3.428.0"
   },
   "mocha": {
     "spec": "test/tests/**/**/*.test.ts",
     "require": "ts-node/register"
   },
-  "nyc": {
+  "c8": {
     "include": [
       "src/**/*.ts"
     ],
@@ -86,7 +86,8 @@
   },
   "eslintConfig": {
     "extends": [
-      "iplayer-ts",
+      "iplayer/base",
+      "iplayer/ts",
       "prettier"
     ],
     "parserOptions": {

package/src/consumer.ts

@@ -26,7 +26,6 @@ import {
   isConnectionError
 } from './errors';
 import { validateOption, assertOptions, hasMessages } from './validation';
-import { abortController } from './controllers';
 import { logger } from './logger';
 
 /**
@@ -38,6 +37,8 @@ export class Consumer extends TypedEventEmitter {
   private queueUrl: string;
   private handleMessage: (message: Message) => Promise<Message | void>;
   private handleMessageBatch: (message: Message[]) => Promise<Message[] | void>;
+  private preReceiveMessageCallback?: () => Promise<void>;
+  private postReceiveMessageCallback?: () => Promise<void>;
   private sqs: SQSClient;
   private handleMessageTimeout: number;
   private attributeNames: string[];
@@ -50,6 +51,7 @@ export class Consumer extends TypedEventEmitter {
   private authenticationErrorTimeout: number;
   private pollingWaitTimeMs: number;
   private heartbeatInterval: number;
+  public abortController: AbortController;
 
   constructor(options: ConsumerOptions) {
     super();
@@ -57,6 +59,8 @@ export class Consumer extends TypedEventEmitter {
     this.queueUrl = options.queueUrl;
     this.handleMessage = options.handleMessage;
     this.handleMessageBatch = options.handleMessageBatch;
+    this.preReceiveMessageCallback = options.preReceiveMessageCallback;
+    this.postReceiveMessageCallback = options.postReceiveMessageCallback;
     this.handleMessageTimeout = options.handleMessageTimeout;
     this.attributeNames = options.attributeNames || [];
     this.messageAttributeNames = options.messageAttributeNames || [];
@@ -90,6 +94,8 @@ export class Consumer extends TypedEventEmitter {
    */
   public start(): void {
     if (this.stopped) {
+      // Create a new abort controller each time the consumer is started
+      this.abortController = new AbortController();
       logger.debug('starting');
       this.stopped = false;
       this.emit('started');
@@ -97,6 +103,17 @@ export class Consumer extends TypedEventEmitter {
     }
   }
 
+  /**
+   * A reusable options object for sqs.send that's used to avoid duplication.
+   */
+  private get sqsSendOptions(): { abortSignal: AbortSignal } {
+    return {
+      // return the current abortController signal or a fresh signal that has not been aborted.
+      // This effectively defaults the signal sent to the AWS SDK to not aborted
+      abortSignal: this.abortController?.signal || new AbortController().signal
+    };
+  }
+
   /**
    * Stop polling the queue for messages (pre existing requests will still be made until concluded).
    */
@@ -116,7 +133,7 @@ export class Consumer extends TypedEventEmitter {
 
     if (options?.abort) {
       logger.debug('aborting');
-      abortController.abort();
+      this.abortController.abort();
       this.emit('aborted');
     }
 
@@ -163,13 +180,6 @@ 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
    */
@@ -223,10 +233,18 @@ export class Consumer extends TypedEventEmitter {
     params: ReceiveMessageCommandInput
   ): Promise<ReceiveMessageCommandOutput> {
     try {
-      return await this.sqs.send(
+      if (this.preReceiveMessageCallback) {
+        await this.preReceiveMessageCallback();
+      }
+      const result = await this.sqs.send(
         new ReceiveMessageCommand(params),
         this.sqsSendOptions
       );
+      if (this.postReceiveMessageCallback) {
+        await this.postReceiveMessageCallback();
+      }
+
+      return result;
     } catch (err) {
       throw toSQSError(err, `SQS receive message failed: ${err.message}`);
     }

package/src/types.ts

@@ -103,6 +103,22 @@ export interface ConsumerOptions {
    * the successful messages only.
    */
   handleMessageBatch?(messages: Message[]): Promise<Message[] | void>;
+  /**
+   * An `async` function (or function that returns a `Promise`) to be called right
+   * before the SQS Client sends a receive message command.
+   *
+   * This function is usefull if SQS Client module exports have been modified, for
+   * example to add middlewares.
+   */
+  preReceiveMessageCallback?(): Promise<void>;
+  /**
+   * An `async` function (or function that returns a `Promise`) to be called right
+   * after the SQS Client sends a receive message command.
+   *
+   * This function is usefull if SQS Client module exports have been modified, for
+   * example to add middlewares.
+   */
+  postReceiveMessageCallback?(): Promise<void>;
 }
 
 export type UpdatableOptions =

package/dist/controllers.d.ts

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

package/dist/controllers.js

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

package/src/controllers.ts

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