sqs-consumer 8.1.5 → 9.0.0

package/.github/workflows/publish.yml

@@ -17,8 +17,6 @@ jobs:
           cache: 'npm'
           registry-url: 'https://registry.npmjs.org'
       - run: npm ci
-      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
-        run: npm audit signatures
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/CHANGELOG.md

@@ -0,0 +1,21 @@
+## [9.0.0](https://github.com/bbc/sqs-consumer/compare/v8.2.0...v9.0.0) (2024-03-11)
+
+
+### ⚠ BREAKING CHANGES
+
+* removing handler_processing debugger in favour of status (#470)
+* replacing the isRunning method with status (#459)
+
+### Features
+
+* removing handler_processing debugger in favour of status ([#470](https://github.com/bbc/sqs-consumer/issues/470)) ([b554da6](https://github.com/bbc/sqs-consumer/commit/b554da6e700bc0e69b77032352f250f19dba081b))
+* replacing the isRunning method with status ([#459](https://github.com/bbc/sqs-consumer/issues/459)) ([9f07383](https://github.com/bbc/sqs-consumer/commit/9f07383b0244fa0ce05238c45f27238cd3459ebf))
+
+
+### Chores
+
+* adding a link to the documentation ([#471](https://github.com/bbc/sqs-consumer/issues/471)) ([bd7fbbb](https://github.com/bbc/sqs-consumer/commit/bd7fbbb78a7e1d10cb7eae1b7d8f595c48b3438e))
+* **deps:** upgrading dependencies - March 24 ([#468](https://github.com/bbc/sqs-consumer/issues/468)) ([2d342cd](https://github.com/bbc/sqs-consumer/commit/2d342cd63365bb42c095e2d4f56a7e2433f43f25))
+* handle breaking changes ([2924ca2](https://github.com/bbc/sqs-consumer/commit/2924ca24e9fda687bf47a5daf45d17618561dae1))
+* **release:** v9.0.0 ([bc5593c](https://github.com/bbc/sqs-consumer/commit/bc5593c4f9940e30c05e6463a1e7339bf14f1e50))
+* upgrading @semantic-release/npm ([bed4dc6](https://github.com/bbc/sqs-consumer/commit/bed4dc63e42344325de0be398952c2b99994e631))

package/README.md

@@ -26,6 +26,10 @@ npm install sqs-consumer
 
 We will only support Node versions that are actively or security supported by the Node team. If you are still using an Node 14, please use a version of this library before the v7 release, if you are using Node 16, please use a version before the v7.3.0 release.
 
+## Documentation
+
+Visit [https://bbc.github.io/sqs-consumer/](https://bbc.github.io/sqs-consumer/) for the full API documentation.
+
 ## Usage
 
 ```js
@@ -125,9 +129,15 @@ By default, the value of `abort` is set to `false` which means pre existing requ
 
 `consumer.stop({ abort: true })`
 
-### `consumer.isRunning`
+### `consumer.status`
+
+Returns the current status of the consumer.
+
+- `isRunning` - `true` if the consumer has been started and not stopped, `false` if was not started or if it was stopped.
+- `isPolling` - `true` if the consumer is actively polling, `false` if it is not.
 
-Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
+> **Note:**
+> This method is not available in versions before v9.0.0 and replaced the method `isRunning` to supply both running and polling states.
 
 ### `consumer.updateOption(option, value)`
 

package/dist/consumer.d.ts

@@ -23,7 +23,10 @@ export declare class Consumer extends TypedEventEmitter {
     private waitTimeSeconds;
     private authenticationErrorTimeout;
     private pollingWaitTimeMs;
+    private pollingCompleteWaitTimeMs;
     private heartbeatInterval;
+    private isPolling;
+    private stopRequestedAtTimestamp;
     abortController: AbortController;
     constructor(options: ConsumerOptions);
     /**
@@ -43,9 +46,18 @@ export declare class Consumer extends TypedEventEmitter {
      */
     stop(options?: StopOptions): void;
     /**
-     * Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
+     * Wait for final poll and in flight messages to complete.
+     * @private
      */
-    get isRunning(): boolean;
+    private waitForPollingToComplete;
+    /**
+     * Returns the current status of the consumer.
+     * This includes whether it is running or currently polling.
+     */
+    get status(): {
+        isRunning: boolean;
+        isPolling: boolean;
+    };
     /**
      * Validates and then updates the provided option to the provided value.
      * @param option The option to validate and then update

package/dist/consumer.js

@@ -12,10 +12,11 @@ const logger_1 = require("./logger");
  */
 class Consumer extends emitter_1.TypedEventEmitter {
     constructor(options) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f;
         super();
         this.pollingTimeoutId = undefined;
         this.stopped = true;
+        this.isPolling = false;
         (0, validation_1.assertOptions)(options);
         this.queueUrl = options.queueUrl;
         this.handleMessage = options.handleMessage;
@@ -34,8 +35,9 @@ class Consumer extends emitter_1.TypedEventEmitter {
         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.alwaysAcknowledge = (_e = options.alwaysAcknowledge) !== null && _e !== void 0 ? _e : false;
+        this.pollingCompleteWaitTimeMs = (_d = options.pollingCompleteWaitTimeMs) !== null && _d !== void 0 ? _d : 0;
+        this.shouldDeleteMessages = (_e = options.shouldDeleteMessages) !== null && _e !== void 0 ? _e : true;
+        this.alwaysAcknowledge = (_f = options.alwaysAcknowledge) !== null && _f !== void 0 ? _f : false;
         this.sqs =
             options.sqs ||
                 new client_sqs_1.SQSClient({
@@ -92,13 +94,37 @@ class Consumer extends emitter_1.TypedEventEmitter {
             this.abortController.abort();
             this.emit('aborted');
         }
-        this.emit('stopped');
+        this.stopRequestedAtTimestamp = Date.now();
+        this.waitForPollingToComplete();
     }
     /**
-     * Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
+     * Wait for final poll and in flight messages to complete.
+     * @private
      */
-    get isRunning() {
-        return !this.stopped;
+    waitForPollingToComplete() {
+        if (!this.isPolling || !(this.pollingCompleteWaitTimeMs > 0)) {
+            this.emit('stopped');
+            return;
+        }
+        const exceededTimeout = Date.now() - this.stopRequestedAtTimestamp >
+            this.pollingCompleteWaitTimeMs;
+        if (exceededTimeout) {
+            this.emit('waiting_for_polling_to_complete_timeout_exceeded');
+            this.emit('stopped');
+            return;
+        }
+        this.emit('waiting_for_polling_to_complete');
+        setTimeout(this.waitForPollingToComplete, 1000);
+    }
+    /**
+     * Returns the current status of the consumer.
+     * This includes whether it is running or currently polling.
+     */
+    get status() {
+        return {
+            isRunning: !this.stopped,
+            isPolling: this.isPolling
+        };
     }
     /**
      * Validates and then updates the provided option to the provided value.
@@ -140,6 +166,7 @@ class Consumer extends emitter_1.TypedEventEmitter {
             return;
         }
         logger_1.logger.debug('polling');
+        this.isPolling = true;
         let currentPollingTimeout = this.pollingWaitTimeMs;
         this.receiveMessage({
             QueueUrl: this.queueUrl,
@@ -168,6 +195,9 @@ class Consumer extends emitter_1.TypedEventEmitter {
         })
             .catch((err) => {
             this.emitError(err);
+        })
+            .finally(() => {
+            this.isPolling = false;
         });
     }
     /**
@@ -196,18 +226,12 @@ class Consumer extends emitter_1.TypedEventEmitter {
      */
     async handleSqsResponse(response) {
         if ((0, validation_1.hasMessages)(response)) {
-            const handlerProcessingDebugger = setInterval(() => {
-                logger_1.logger.debug('handler_processing', {
-                    detail: 'The handler is still processing the message(s)...'
-                });
-            }, 1000);
             if (this.handleMessageBatch) {
                 await this.processMessageBatch(response.Messages);
             }
             else {
                 await Promise.all(response.Messages.map(this.processMessage));
             }
-            clearInterval(handlerProcessingDebugger);
             this.emit('response_processed');
         }
         else if (response) {

package/dist/types.d.ts

@@ -45,6 +45,12 @@ export interface ConsumerOptions {
      * @defaultvalue `0`
      */
     pollingWaitTimeMs?: number;
+    /**
+     * If you want the stop action to wait for the final poll to complete and in-flight messages
+     * to be processed before emitting 'stopped' set this to the max amount of time to wait.
+     * @defaultvalue `0`
+     */
+    pollingCompleteWaitTimeMs?: number;
     /**
      * If true, sets the message visibility timeout to 0 after a `processing_error`.
      * @defaultvalue `false`
@@ -183,6 +189,14 @@ export interface Events {
      * Fired when an option is updated
      */
     option_updated: [UpdatableOptions, ConsumerOptions[UpdatableOptions]];
+    /**
+     * Fired when the Consumer is waiting for polling to complete before stopping.
+     */
+    waiting_for_polling_to_complete: [];
+    /**
+     * Fired when the Consumer has waited for polling to complete and is stopping due to a timeout.
+     */
+    waiting_for_polling_to_complete_timeout_exceeded: [];
 }
 export type AWSError = {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "8.1.5",
+  "version": "9.0.0",
   "description": "Build SQS-based Node applications without the boilerplate",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,7 +21,7 @@
     "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}\"",
+    "format": "prettier --log-level 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",
     "generate-docs": "typedoc"
@@ -57,6 +57,10 @@
         {
           "preset": "conventionalcommits",
           "releaseRules": [
+            {
+              "type": "breaking",
+              "release": "major"
+            },
             {
               "type": "feat",
               "release": "minor"
@@ -118,44 +122,45 @@
           }
         }
       ],
-      "@semantic-release/git",
+      "@semantic-release/changelog",
       "@semantic-release/github",
       "@semantic-release/npm"
     ]
   },
   "devDependencies": {
-    "@cucumber/cucumber": "10.0.1",
+    "@cucumber/cucumber": "10.3.1",
+    "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^11.1.0",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^9.2.6",
-    "@semantic-release/npm": "^11.0.2",
+    "@semantic-release/npm": "11.0.3",
     "@semantic-release/release-notes-generator": "^12.1.0",
-    "@types/chai": "^4.3.9",
-    "@types/mocha": "^10.0.3",
-    "@types/node": "^20.8.7",
-    "@types/sinon": "^10.0.20",
-    "c8": "^8.0.1",
+    "@types/chai": "^4.3.12",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^20.11.25",
+    "@types/sinon": "^17.0.3",
+    "c8": "^9.1.0",
     "chai": "^4.3.10",
     "conventional-changelog-conventionalcommits": "^7.0.2",
-    "eslint": "^8.52.0",
-    "eslint-config-iplayer": "^9.1.0",
-    "eslint-config-prettier": "^9.0.0",
-    "mocha": "^10.2.0",
+    "eslint": "^8.57.0",
+    "eslint-config-iplayer": "^9.2.0",
+    "eslint-config-prettier": "^9.1.0",
+    "mocha": "^10.3.0",
     "p-event": "^4.2.0",
-    "prettier": "^3.0.3",
-    "semantic-release": "^23.0.0",
-    "sinon": "^17.0.0",
-    "sqs-producer": "^4.0.0",
-    "ts-node": "^10.9.1",
-    "typedoc": "^0.25.2",
-    "typescript": "^5.2.2"
+    "prettier": "^3.2.5",
+    "semantic-release": "^23.0.2",
+    "sinon": "^17.0.1",
+    "sqs-producer": "^5.0.0",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.25.12",
+    "typescript": "^5.4.2"
   },
   "dependencies": {
-    "@aws-sdk/client-sqs": "^3.447.0",
+    "@aws-sdk/client-sqs": "^3.529.1",
     "debug": "^4.3.4"
   },
   "peerDependencies": {
-    "@aws-sdk/client-sqs": "^3.447.0"
+    "@aws-sdk/client-sqs": "^3.529.1"
   },
   "mocha": {
     "spec": "test/tests/**/**/*.test.ts",

package/src/consumer.ts

@@ -54,7 +54,10 @@ export class Consumer extends TypedEventEmitter {
   private waitTimeSeconds: number;
   private authenticationErrorTimeout: number;
   private pollingWaitTimeMs: number;
+  private pollingCompleteWaitTimeMs: number;
   private heartbeatInterval: number;
+  private isPolling = false;
+  private stopRequestedAtTimestamp: number;
   public abortController: AbortController;
 
   constructor(options: ConsumerOptions) {
@@ -77,6 +80,7 @@ export class Consumer extends TypedEventEmitter {
     this.authenticationErrorTimeout =
       options.authenticationErrorTimeout ?? 10000;
     this.pollingWaitTimeMs = options.pollingWaitTimeMs ?? 0;
+    this.pollingCompleteWaitTimeMs = options.pollingCompleteWaitTimeMs ?? 0;
     this.shouldDeleteMessages = options.shouldDeleteMessages ?? true;
     this.alwaysAcknowledge = options.alwaysAcknowledge ?? false;
     this.sqs =
@@ -142,14 +146,45 @@ export class Consumer extends TypedEventEmitter {
       this.emit('aborted');
     }
 
-    this.emit('stopped');
+    this.stopRequestedAtTimestamp = Date.now();
+    this.waitForPollingToComplete();
   }
 
   /**
-   * Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
+   * Wait for final poll and in flight messages to complete.
+   * @private
    */
-  public get isRunning(): boolean {
-    return !this.stopped;
+  private waitForPollingToComplete(): void {
+    if (!this.isPolling || !(this.pollingCompleteWaitTimeMs > 0)) {
+      this.emit('stopped');
+      return;
+    }
+
+    const exceededTimeout =
+      Date.now() - this.stopRequestedAtTimestamp >
+      this.pollingCompleteWaitTimeMs;
+    if (exceededTimeout) {
+      this.emit('waiting_for_polling_to_complete_timeout_exceeded');
+      this.emit('stopped');
+      return;
+    }
+
+    this.emit('waiting_for_polling_to_complete');
+    setTimeout(this.waitForPollingToComplete, 1000);
+  }
+
+  /**
+   * Returns the current status of the consumer.
+   * This includes whether it is running or currently polling.
+   */
+  public get status(): {
+    isRunning: boolean;
+    isPolling: boolean;
+  } {
+    return {
+      isRunning: !this.stopped,
+      isPolling: this.isPolling
+    };
   }
 
   /**
@@ -198,6 +233,8 @@ export class Consumer extends TypedEventEmitter {
 
     logger.debug('polling');
 
+    this.isPolling = true;
+
     let currentPollingTimeout = this.pollingWaitTimeMs;
     this.receiveMessage({
       QueueUrl: this.queueUrl,
@@ -227,6 +264,9 @@ export class Consumer extends TypedEventEmitter {
       })
       .catch((err) => {
         this.emitError(err);
+      })
+      .finally(() => {
+        this.isPolling = false;
       });
   }
 
@@ -264,20 +304,12 @@ export class Consumer extends TypedEventEmitter {
     response: ReceiveMessageCommandOutput
   ): Promise<void> {
     if (hasMessages(response)) {
-      const handlerProcessingDebugger = setInterval(() => {
-        logger.debug('handler_processing', {
-          detail: 'The handler is still processing the message(s)...'
-        });
-      }, 1000);
-
       if (this.handleMessageBatch) {
         await this.processMessageBatch(response.Messages);
       } else {
         await Promise.all(response.Messages.map(this.processMessage));
       }
 
-      clearInterval(handlerProcessingDebugger);
-
       this.emit('response_processed');
     } else if (response) {
       this.emit('empty');

package/src/types.ts

@@ -46,6 +46,12 @@ export interface ConsumerOptions {
    * @defaultvalue `0`
    */
   pollingWaitTimeMs?: number;
+  /**
+   * If you want the stop action to wait for the final poll to complete and in-flight messages
+   * to be processed before emitting 'stopped' set this to the max amount of time to wait.
+   * @defaultvalue `0`
+   */
+  pollingCompleteWaitTimeMs?: number;
   /**
    * If true, sets the message visibility timeout to 0 after a `processing_error`.
    * @defaultvalue `false`
@@ -191,6 +197,14 @@ export interface Events {
    * Fired when an option is updated
    */
   option_updated: [UpdatableOptions, ConsumerOptions[UpdatableOptions]];
+  /**
+   * Fired when the Consumer is waiting for polling to complete before stopping.
+   */
+  waiting_for_polling_to_complete: [];
+  /**
+   * Fired when the Consumer has waited for polling to complete and is stopping due to a timeout.
+   */
+  waiting_for_polling_to_complete_timeout_exceeded: [];
 }
 
 export type AWSError = {