sqs-consumer 8.1.5 → 8.2.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+## [8.2.0](https://github.com/bbc/sqs-consumer/compare/v8.1.5...v8.2.0) (2024-02-06)
+
+
+### Features
+
+* Wait for msgs to be processed before emitting stopped ([#454](https://github.com/bbc/sqs-consumer/issues/454)) ([0fa5305](https://github.com/bbc/sqs-consumer/commit/0fa53055a4957dba7381307cdeb65aa99128c315))
+
+
+### Chores
+
+* removing semantic git ([b834205](https://github.com/bbc/sqs-consumer/commit/b834205bfe9183bc69141c4016831cdbb6e33d7a))
+* updating release config ([6b95edb](https://github.com/bbc/sqs-consumer/commit/6b95edbf894864e25a61a748ab0ac9d6ebf2a2f7))

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);
     /**
@@ -42,6 +45,11 @@ export declare class Consumer extends TypedEventEmitter {
      * Stop polling the queue for messages (pre existing requests will still be made until concluded).
      */
     stop(options?: StopOptions): void;
+    /**
+     * Wait for final poll and in flight messages to complete.
+     * @private
+     */
+    private waitForPollingToComplete;
     /**
      * Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
      */

package/dist/consumer.js

@@ -12,7 +12,7 @@ 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;
@@ -34,8 +34,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,7 +93,27 @@ class Consumer extends emitter_1.TypedEventEmitter {
             this.abortController.abort();
             this.emit('aborted');
         }
-        this.emit('stopped');
+        this.stopRequestedAtTimestamp = Date.now();
+        this.waitForPollingToComplete();
+    }
+    /**
+     * Wait for final poll and in flight messages to complete.
+     * @private
+     */
+    waitForPollingToComplete() {
+        if (!this.isPolling || !(this.pollingCompleteWaitTimeMs > 0)) {
+            this.emit('stopped');
+            return;
+        }
+        const exceededTimeout = Date.now() - this.stopRequestedAtTimestamp >
+            this.pollingCompleteWaitTimeMs;
+        if (exceededTimeout) {
+            logger_1.logger.debug('waiting_for_polling_to_complete_timeout_exceeded');
+            this.emit('stopped');
+            return;
+        }
+        logger_1.logger.debug('waiting_for_polling_to_complete');
+        setTimeout(this.waitForPollingToComplete, 1000);
     }
     /**
      * Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
@@ -140,6 +161,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 +190,9 @@ class Consumer extends emitter_1.TypedEventEmitter {
         })
             .catch((err) => {
             this.emitError(err);
+        })
+            .finally(() => {
+            this.isPolling = false;
         });
     }
     /**

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`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "8.1.5",
+  "version": "8.2.0",
   "description": "Build SQS-based Node applications without the boilerplate",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -118,13 +118,14 @@
           }
         }
       ],
-      "@semantic-release/git",
+      "@semantic-release/changelog",
       "@semantic-release/github",
       "@semantic-release/npm"
     ]
   },
   "devDependencies": {
     "@cucumber/cucumber": "10.0.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",

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: boolean;
+  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,7 +146,31 @@ export class Consumer extends TypedEventEmitter {
       this.emit('aborted');
     }
 
-    this.emit('stopped');
+    this.stopRequestedAtTimestamp = Date.now();
+    this.waitForPollingToComplete();
+  }
+
+  /**
+   * Wait for final poll and in flight messages to complete.
+   * @private
+   */
+  private waitForPollingToComplete(): void {
+    if (!this.isPolling || !(this.pollingCompleteWaitTimeMs > 0)) {
+      this.emit('stopped');
+      return;
+    }
+
+    const exceededTimeout =
+      Date.now() - this.stopRequestedAtTimestamp >
+      this.pollingCompleteWaitTimeMs;
+    if (exceededTimeout) {
+      logger.debug('waiting_for_polling_to_complete_timeout_exceeded');
+      this.emit('stopped');
+      return;
+    }
+
+    logger.debug('waiting_for_polling_to_complete');
+    setTimeout(this.waitForPollingToComplete, 1000);
   }
 
   /**
@@ -198,6 +226,8 @@ export class Consumer extends TypedEventEmitter {
 
     logger.debug('polling');
 
+    this.isPolling = true;
+
     let currentPollingTimeout = this.pollingWaitTimeMs;
     this.receiveMessage({
       QueueUrl: this.queueUrl,
@@ -227,6 +257,9 @@ export class Consumer extends TypedEventEmitter {
       })
       .catch((err) => {
         this.emitError(err);
+      })
+      .finally(() => {
+        this.isPolling = false;
       });
   }
 

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`