sqs-consumer 7.1.0 → 7.2.0-canary.2

package/.github/DISCUSSION_TEMPLATE/help.yml

@@ -8,6 +8,6 @@ body:
   - type: input
     attributes:
       label: Example
-      description: A link to a minimal reproduction is helpful for debugging!
+      description: A link to a minimal reproduction is helpful for debugging! You can fork [this stackblitz setup](https://stackblitz.com/edit/sqs-consumer-starter) to get a reproduction setup quickly.
     validations:
-      required: false
+      required: false

package/dist/consumer.d.ts

@@ -1,4 +1,5 @@
-import { ConsumerOptions, TypedEventEmitter, StopOptions, UpdatableOptions } from './types';
+import { ConsumerOptions, StopOptions, UpdatableOptions } from './types';
+import { TypedEventEmitter } from './emitter';
 /**
  * [Usage](https://bbc.github.io/sqs-consumer/index.html#usage)
  */

package/dist/consumer.js

@@ -2,17 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Consumer = void 0;
 const client_sqs_1 = require("@aws-sdk/client-sqs");
-const debug_1 = require("debug");
-const types_1 = require("./types");
+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 debug = (0, debug_1.default)('sqs-consumer');
+const logger_1 = require("./logger");
 /**
  * [Usage](https://bbc.github.io/sqs-consumer/index.html#usage)
  */
-class Consumer extends types_1.TypedEventEmitter {
+class Consumer extends emitter_1.TypedEventEmitter {
     constructor(options) {
         var _a, _b, _c, _d;
         super();
@@ -59,7 +58,7 @@ class Consumer extends types_1.TypedEventEmitter {
      */
     start() {
         if (this.stopped) {
-            debug('Starting consumer');
+            logger_1.logger.debug('starting');
             this.stopped = false;
             this.emit('started');
             this.poll();
@@ -70,17 +69,17 @@ class Consumer extends types_1.TypedEventEmitter {
      */
     stop(options) {
         if (this.stopped) {
-            debug('Consumer was already stopped');
+            logger_1.logger.debug('already_stopped');
             return;
         }
-        debug('Stopping consumer');
+        logger_1.logger.debug('stopping');
         this.stopped = true;
         if (this.pollingTimeoutId) {
             clearTimeout(this.pollingTimeoutId);
             this.pollingTimeoutId = undefined;
         }
         if (options === null || options === void 0 ? void 0 : options.abort) {
-            debug('Aborting SQS requests');
+            logger_1.logger.debug('aborting');
             controllers_1.abortController.abort();
             this.emit('aborted');
         }
@@ -99,7 +98,6 @@ class Consumer extends types_1.TypedEventEmitter {
      */
     updateOption(option, value) {
         (0, validation_1.validateOption)(option, value, this, true);
-        debug(`Updating the ${option} option to the value ${value}`);
         this[option] = value;
         this.emit('option_updated', option, value);
     }
@@ -127,10 +125,12 @@ class Consumer extends types_1.TypedEventEmitter {
      */
     poll() {
         if (this.stopped) {
-            debug('Poll was called while consumer was stopped, cancelling poll...');
+            logger_1.logger.debug('cancelling_poll', {
+                detail: 'Poll was called while consumer was stopped, cancelling poll...'
+            });
             return;
         }
-        debug('Polling for messages');
+        logger_1.logger.debug('polling');
         let currentPollingTimeout = this.pollingWaitTimeMs;
         this.receiveMessage({
             QueueUrl: this.queueUrl,
@@ -144,7 +144,9 @@ class Consumer extends types_1.TypedEventEmitter {
             .catch((err) => {
             this.emitError(err);
             if ((0, errors_1.isConnectionError)(err)) {
-                debug('There was an authentication error. Pausing before retrying.');
+                logger_1.logger.debug('authentication_error', {
+                    detail: 'There was an authentication error. Pausing before retrying.'
+                });
                 currentPollingTimeout = this.authenticationErrorTimeout;
             }
             return;
@@ -178,12 +180,18 @@ class Consumer extends types_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) {
@@ -215,7 +223,9 @@ class Consumer extends types_1.TypedEventEmitter {
             }
         }
         finally {
-            clearInterval(heartbeatTimeoutId);
+            if (this.heartbeatInterval) {
+                clearInterval(heartbeatTimeoutId);
+            }
         }
     }
     /**
@@ -356,10 +366,12 @@ class Consumer extends types_1.TypedEventEmitter {
      */
     async deleteMessage(message) {
         if (!this.shouldDeleteMessages) {
-            debug('Skipping message delete since shouldDeleteMessages is set to false');
+            logger_1.logger.debug('skipping_delete', {
+                detail: 'Skipping message delete since shouldDeleteMessages is set to false'
+            });
             return;
         }
-        debug('Deleting message %s', message.MessageId);
+        logger_1.logger.debug('deleting_message', { messageId: message.MessageId });
         const deleteParams = {
             QueueUrl: this.queueUrl,
             ReceiptHandle: message.ReceiptHandle
@@ -377,10 +389,14 @@ class Consumer extends types_1.TypedEventEmitter {
      */
     async deleteMessageBatch(messages) {
         if (!this.shouldDeleteMessages) {
-            debug('Skipping message delete since shouldDeleteMessages is set to false');
+            logger_1.logger.debug('skipping_delete', {
+                detail: 'Skipping message delete since shouldDeleteMessages is set to false'
+            });
             return;
         }
-        debug('Deleting messages %s', messages.map((msg) => msg.MessageId).join(' ,'));
+        logger_1.logger.debug('deleting_messages', {
+            messageIds: messages.map((msg) => msg.MessageId)
+        });
         const deleteParams = {
             QueueUrl: this.queueUrl,
             Entries: messages.map((message) => ({

package/dist/emitter.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { Events } from './types';
+export declare class TypedEventEmitter extends EventEmitter {
+    /**
+     * Trigger a listener on all emitted events
+     * @param event The name of the event to listen to
+     * @param listener A function to trigger when the event is emitted
+     */
+    on<E extends keyof Events>(event: E, listener: (...args: Events[E]) => void): this;
+    /**
+     * Trigger a listener only once for an emitted event
+     * @param event The name of the event to listen to
+     * @param listener A function to trigger when the event is emitted
+     */
+    once<E extends keyof Events>(event: E, listener: (...args: Events[E]) => void): this;
+    /**
+     * Emits an event with the provided arguments
+     * @param event The name of the event to emit
+     */
+    emit<E extends keyof Events>(event: E, ...args: Events[E]): boolean;
+}

package/dist/emitter.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypedEventEmitter = void 0;
+const events_1 = require("events");
+const logger_1 = require("./logger");
+class TypedEventEmitter extends events_1.EventEmitter {
+    /**
+     * Trigger a listener on all emitted events
+     * @param event The name of the event to listen to
+     * @param listener A function to trigger when the event is emitted
+     */
+    on(event, listener) {
+        return super.on(event, listener);
+    }
+    /**
+     * Trigger a listener only once for an emitted event
+     * @param event The name of the event to listen to
+     * @param listener A function to trigger when the event is emitted
+     */
+    once(event, listener) {
+        return super.once(event, listener);
+    }
+    /**
+     * Emits an event with the provided arguments
+     * @param event The name of the event to emit
+     */
+    emit(event, ...args) {
+        logger_1.logger.debug(event, ...args);
+        return super.emit(event, ...args);
+    }
+}
+exports.TypedEventEmitter = TypedEventEmitter;

package/dist/logger.d.ts

@@ -0,0 +1,3 @@
+export declare const logger: {
+    debug: any;
+};

package/dist/logger.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const debug = require('debug')('sqs-consumer');
+exports.logger = {
+    debug
+};

package/dist/types.d.ts

@@ -1,6 +1,4 @@
-/// <reference types="node" />
 import { SQSClient, Message } from '@aws-sdk/client-sqs';
-import { EventEmitter } from 'events';
 export interface ConsumerOptions {
     /**
      * The SQS queue URL.
@@ -163,25 +161,6 @@ export interface Events {
      */
     option_updated: [UpdatableOptions, ConsumerOptions[UpdatableOptions]];
 }
-export declare class TypedEventEmitter extends EventEmitter {
-    /**
-     * Trigger a listener on all emitted events
-     * @param event The name of the event to listen to
-     * @param listener A function to trigger when the event is emitted
-     */
-    on<E extends keyof Events>(event: E, listener: (...args: Events[E]) => void): this;
-    /**
-     * Trigger a listener only once for an emitted event
-     * @param event The name of the event to listen to
-     * @param listener A function to trigger when the event is emitted
-     */
-    once<E extends keyof Events>(event: E, listener: (...args: Events[E]) => void): this;
-    /**
-     * Emits an event with the provided arguments
-     * @param event The name of the event to emit
-     */
-    emit<E extends keyof Events>(event: E, ...args: Events[E]): boolean;
-}
 export type AWSError = {
     /**
      * Name, eg. ConditionalCheckFailedException

package/dist/types.js

@@ -1,30 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypedEventEmitter = void 0;
-const events_1 = require("events");
-class TypedEventEmitter extends events_1.EventEmitter {
-    /**
-     * Trigger a listener on all emitted events
-     * @param event The name of the event to listen to
-     * @param listener A function to trigger when the event is emitted
-     */
-    on(event, listener) {
-        return super.on(event, listener);
-    }
-    /**
-     * Trigger a listener only once for an emitted event
-     * @param event The name of the event to listen to
-     * @param listener A function to trigger when the event is emitted
-     */
-    once(event, listener) {
-        return super.once(event, listener);
-    }
-    /**
-     * Emits an event with the provided arguments
-     * @param event The name of the event to emit
-     */
-    emit(event, ...args) {
-        return super.emit(event, ...args);
-    }
-}
-exports.TypedEventEmitter = TypedEventEmitter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "7.1.0",
+  "version": "7.2.0-canary.2",
   "description": "Build SQS-based Node applications without the boilerplate",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -41,32 +41,31 @@
   ],
   "license": "Apache-2.0",
   "devDependencies": {
-    "@cucumber/cucumber": "^8.10.0",
-    "@types/chai": "^4.3.4",
-    "@types/debug": "^4.1.7",
+    "@cucumber/cucumber": "^9.1.2",
+    "@types/chai": "^4.3.5",
     "@types/mocha": "^10.0.1",
     "@types/node": "^18.11.18",
-    "@types/sinon": "^10.0.13",
+    "@types/sinon": "^10.0.15",
     "chai": "^4.3.7",
-    "eslint": "^8.32.0",
-    "eslint-config-iplayer-ts": "^4.1.0",
-    "eslint-config-prettier": "^8.6.0",
+    "eslint": "^8.42.0",
+    "eslint-config-iplayer-ts": "^4.1.1",
+    "eslint-config-prettier": "^8.8.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
     "p-event": "^4.2.0",
-    "prettier": "^2.8.3",
-    "sinon": "^15.0.1",
-    "sqs-producer": "^3.1.1",
+    "prettier": "^2.8.8",
+    "sinon": "^15.1.0",
+    "sqs-producer": "^3.1.2",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.23.24",
+    "typedoc": "^0.24.8",
     "typescript": "^4.9.4"
   },
   "dependencies": {
-    "@aws-sdk/client-sqs": "^3.258.0",
+    "@aws-sdk/client-sqs": "^3.348.0",
     "debug": "^4.3.4"
   },
   "peerDependencies": {
-    "@aws-sdk/client-sqs": "^3.258.0"
+    "@aws-sdk/client-sqs": "^3.348.0"
   },
   "mocha": {
     "spec": "test/tests/**/**/*.test.ts",

package/src/consumer.ts

@@ -15,14 +15,9 @@ import {
   ReceiveMessageCommandInput,
   ReceiveMessageCommandOutput
 } from '@aws-sdk/client-sqs';
-import Debug from 'debug';
 
-import {
-  ConsumerOptions,
-  TypedEventEmitter,
-  StopOptions,
-  UpdatableOptions
-} from './types';
+import { ConsumerOptions, StopOptions, UpdatableOptions } from './types';
+import { TypedEventEmitter } from './emitter';
 import { autoBind } from './bind';
 import {
   SQSError,
@@ -32,8 +27,7 @@ import {
 } from './errors';
 import { validateOption, assertOptions, hasMessages } from './validation';
 import { abortController } from './controllers';
-
-const debug = Debug('sqs-consumer');
+import { logger } from './logger';
 
 /**
  * [Usage](https://bbc.github.io/sqs-consumer/index.html#usage)
@@ -96,7 +90,7 @@ export class Consumer extends TypedEventEmitter {
    */
   public start(): void {
     if (this.stopped) {
-      debug('Starting consumer');
+      logger.debug('starting');
       this.stopped = false;
       this.emit('started');
       this.poll();
@@ -108,11 +102,11 @@ export class Consumer extends TypedEventEmitter {
    */
   public stop(options?: StopOptions): void {
     if (this.stopped) {
-      debug('Consumer was already stopped');
+      logger.debug('already_stopped');
       return;
     }
 
-    debug('Stopping consumer');
+    logger.debug('stopping');
     this.stopped = true;
 
     if (this.pollingTimeoutId) {
@@ -121,10 +115,8 @@ export class Consumer extends TypedEventEmitter {
     }
 
     if (options?.abort) {
-      debug('Aborting SQS requests');
-
+      logger.debug('aborting');
       abortController.abort();
-
       this.emit('aborted');
     }
 
@@ -149,8 +141,6 @@ export class Consumer extends TypedEventEmitter {
   ) {
     validateOption(option, value, this, true);
 
-    debug(`Updating the ${option} option to the value ${value}`);
-
     this[option] = value;
 
     this.emit('option_updated', option, value);
@@ -185,11 +175,13 @@ export class Consumer extends TypedEventEmitter {
    */
   private poll(): void {
     if (this.stopped) {
-      debug('Poll was called while consumer was stopped, cancelling poll...');
+      logger.debug('cancelling_poll', {
+        detail: 'Poll was called while consumer was stopped, cancelling poll...'
+      });
       return;
     }
 
-    debug('Polling for messages');
+    logger.debug('polling');
 
     let currentPollingTimeout = this.pollingWaitTimeMs;
     this.receiveMessage({
@@ -204,7 +196,10 @@ export class Consumer extends TypedEventEmitter {
       .catch((err) => {
         this.emitError(err);
         if (isConnectionError(err)) {
-          debug('There was an authentication error. Pausing before retrying.');
+          logger.debug('authentication_error', {
+            detail:
+              'There was an authentication error. Pausing before retrying.'
+          });
           currentPollingTimeout = this.authenticationErrorTimeout;
         }
         return;
@@ -246,12 +241,20 @@ 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');
@@ -287,7 +290,9 @@ export class Consumer extends TypedEventEmitter {
         await this.changeVisibilityTimeout(message, 0);
       }
     } finally {
-      clearInterval(heartbeatTimeoutId);
+      if (this.heartbeatInterval) {
+        clearInterval(heartbeatTimeoutId);
+      }
     }
   }
 
@@ -462,12 +467,13 @@ export class Consumer extends TypedEventEmitter {
    */
   private async deleteMessage(message: Message): Promise<void> {
     if (!this.shouldDeleteMessages) {
-      debug(
-        'Skipping message delete since shouldDeleteMessages is set to false'
-      );
+      logger.debug('skipping_delete', {
+        detail:
+          'Skipping message delete since shouldDeleteMessages is set to false'
+      });
       return;
     }
-    debug('Deleting message %s', message.MessageId);
+    logger.debug('deleting_message', { messageId: message.MessageId });
 
     const deleteParams: DeleteMessageCommandInput = {
       QueueUrl: this.queueUrl,
@@ -490,15 +496,15 @@ export class Consumer extends TypedEventEmitter {
    */
   private async deleteMessageBatch(messages: Message[]): Promise<void> {
     if (!this.shouldDeleteMessages) {
-      debug(
-        'Skipping message delete since shouldDeleteMessages is set to false'
-      );
+      logger.debug('skipping_delete', {
+        detail:
+          'Skipping message delete since shouldDeleteMessages is set to false'
+      });
       return;
     }
-    debug(
-      'Deleting messages %s',
-      messages.map((msg) => msg.MessageId).join(' ,')
-    );
+    logger.debug('deleting_messages', {
+      messageIds: messages.map((msg) => msg.MessageId)
+    });
 
     const deleteParams: DeleteMessageBatchCommandInput = {
       QueueUrl: this.queueUrl,

package/src/emitter.ts

@@ -0,0 +1,37 @@
+import { EventEmitter } from 'events';
+
+import { logger } from './logger';
+import { Events } from './types';
+
+export class TypedEventEmitter extends EventEmitter {
+  /**
+   * Trigger a listener on all emitted events
+   * @param event The name of the event to listen to
+   * @param listener A function to trigger when the event is emitted
+   */
+  on<E extends keyof Events>(
+    event: E,
+    listener: (...args: Events[E]) => void
+  ): this {
+    return super.on(event, listener);
+  }
+  /**
+   * Trigger a listener only once for an emitted event
+   * @param event The name of the event to listen to
+   * @param listener A function to trigger when the event is emitted
+   */
+  once<E extends keyof Events>(
+    event: E,
+    listener: (...args: Events[E]) => void
+  ): this {
+    return super.once(event, listener);
+  }
+  /**
+   * Emits an event with the provided arguments
+   * @param event The name of the event to emit
+   */
+  emit<E extends keyof Events>(event: E, ...args: Events[E]): boolean {
+    logger.debug(event, ...args);
+    return super.emit(event, ...args);
+  }
+}

package/src/logger.ts

@@ -0,0 +1,5 @@
+const debug = require('debug')('sqs-consumer');
+
+export const logger = {
+  debug
+};

package/src/types.ts

@@ -1,5 +1,4 @@
 import { SQSClient, Message } from '@aws-sdk/client-sqs';
-import { EventEmitter } from 'events';
 
 export interface ConsumerOptions {
   /**
@@ -170,38 +169,6 @@ export interface Events {
   option_updated: [UpdatableOptions, ConsumerOptions[UpdatableOptions]];
 }
 
-export class TypedEventEmitter extends EventEmitter {
-  /**
-   * Trigger a listener on all emitted events
-   * @param event The name of the event to listen to
-   * @param listener A function to trigger when the event is emitted
-   */
-  on<E extends keyof Events>(
-    event: E,
-    listener: (...args: Events[E]) => void
-  ): this {
-    return super.on(event, listener);
-  }
-  /**
-   * Trigger a listener only once for an emitted event
-   * @param event The name of the event to listen to
-   * @param listener A function to trigger when the event is emitted
-   */
-  once<E extends keyof Events>(
-    event: E,
-    listener: (...args: Events[E]) => void
-  ): this {
-    return super.once(event, listener);
-  }
-  /**
-   * Emits an event with the provided arguments
-   * @param event The name of the event to emit
-   */
-  emit<E extends keyof Events>(event: E, ...args: Events[E]): boolean {
-    return super.emit(event, ...args);
-  }
-}
-
 export type AWSError = {
   /**
    * Name, eg. ConditionalCheckFailedException