sqs-consumer 7.0.1 → 7.0.3

package/.github/workflows/lock-threads.yml

@@ -0,0 +1,29 @@
+name: "Lock Threads"
+
+on:
+  schedule:
+    - cron: "0 * * * *" # Once a day, at midnight UTC
+  workflow_dispatch:
+
+permissions:
+  issues: write
+  pull-requests: write
+
+concurrency:
+  group: lock
+
+jobs:
+  action:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/lock-threads@v4
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          issue-inactive-days: "30" # Lock issues after 30 days of being closed
+          pr-inactive-days: "5" # Lock closed PRs after 5 days. This ensures that issues that stem from a PR are opened as issues, rather than comments on the recently merged PR.
+          add-issue-labels: "outdated"
+          exclude-issue-created-before: "2023-01-01"
+          issue-comment: >
+            This issue has been closed for more than 30 days. If this issue is still occuring, please open a new issue with more recent context.
+          pr-comment: >
+            This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

package/dist/consumer.d.ts

@@ -4,8 +4,6 @@ import { ConsumerOptions, TypedEventEmitter, StopOptions } from './types';
  */
 export declare class Consumer extends TypedEventEmitter {
     private pollingTimeoutId;
-    private heartbeatTimeoutId;
-    private handleMessageTimeoutId;
     private stopped;
     private queueUrl;
     private handleMessage;
@@ -34,7 +32,7 @@ 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;
+    stop(options?: StopOptions): void;
     /**
      * Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
      */

package/dist/consumer.js

@@ -17,8 +17,6 @@ class Consumer extends types_1.TypedEventEmitter {
         var _a, _b, _c, _d;
         super();
         this.pollingTimeoutId = undefined;
-        this.heartbeatTimeoutId = undefined;
-        this.handleMessageTimeoutId = undefined;
         this.stopped = true;
         /**
          * A reusable options object for sqs.send that's used to avoid duplication.
@@ -186,10 +184,11 @@ class Consumer extends types_1.TypedEventEmitter {
      * @param message The message that was delivered from SQS
      */
     async processMessage(message) {
+        let heartbeatTimeoutId = undefined;
         try {
             this.emit('message_received', message);
             if (this.heartbeatInterval) {
-                this.heartbeatTimeoutId = this.startHeartbeat(message);
+                heartbeatTimeoutId = this.startHeartbeat(message);
             }
             const ackedMessage = await this.executeHandler(message);
             if ((ackedMessage === null || ackedMessage === void 0 ? void 0 : ackedMessage.MessageId) === message.MessageId) {
@@ -204,8 +203,7 @@ class Consumer extends types_1.TypedEventEmitter {
             }
         }
         finally {
-            clearInterval(this.heartbeatTimeoutId);
-            this.heartbeatTimeoutId = undefined;
+            clearInterval(heartbeatTimeoutId);
         }
     }
     /**
@@ -213,12 +211,13 @@ class Consumer extends types_1.TypedEventEmitter {
      * @param messages The messages that were delivered from SQS
      */
     async processMessageBatch(messages) {
+        let heartbeatTimeoutId = undefined;
         try {
             messages.forEach((message) => {
                 this.emit('message_received', message);
             });
             if (this.heartbeatInterval) {
-                this.heartbeatTimeoutId = this.startHeartbeat(null, messages);
+                heartbeatTimeoutId = this.startHeartbeat(null, messages);
             }
             const ackedMessages = await this.executeBatchHandler(messages);
             if ((ackedMessages === null || ackedMessages === void 0 ? void 0 : ackedMessages.length) > 0) {
@@ -235,8 +234,7 @@ class Consumer extends types_1.TypedEventEmitter {
             }
         }
         finally {
-            clearInterval(this.heartbeatTimeoutId);
-            this.heartbeatTimeoutId = undefined;
+            clearInterval(heartbeatTimeoutId);
         }
     }
     /**
@@ -297,11 +295,12 @@ class Consumer extends types_1.TypedEventEmitter {
      * @param message The message that was received from SQS
      */
     async executeHandler(message) {
+        let handleMessageTimeoutId = undefined;
         try {
             let result;
             if (this.handleMessageTimeout) {
                 const pending = new Promise((_, reject) => {
-                    this.handleMessageTimeoutId = setTimeout(() => {
+                    handleMessageTimeoutId = setTimeout(() => {
                         reject(new errors_1.TimeoutError());
                     }, this.handleMessageTimeout);
                 });
@@ -320,8 +319,8 @@ class Consumer extends types_1.TypedEventEmitter {
             throw err;
         }
         finally {
-            if (this.handleMessageTimeoutId) {
-                clearTimeout(this.handleMessageTimeoutId);
+            if (handleMessageTimeoutId) {
+                clearTimeout(handleMessageTimeoutId);
             }
         }
     }

package/dist/types.d.ts

@@ -69,7 +69,7 @@ export interface ConsumerOptions {
     sqs?: SQSClient;
     /**
      * The AWS region.
-     * @defaultValue `eu-west-1`
+     * @defaultValue process.env.AWS_REGION || `eu-west-1`
      */
     region?: string;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "7.0.1",
+  "version": "7.0.3",
   "description": "Build SQS-based Node applications without the boilerplate",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/consumer.ts

@@ -35,8 +35,6 @@ const debug = Debug('sqs-consumer');
  */
 export class Consumer extends TypedEventEmitter {
   private pollingTimeoutId: NodeJS.Timeout | undefined = undefined;
-  private heartbeatTimeoutId: NodeJS.Timeout | undefined = undefined;
-  private handleMessageTimeoutId: NodeJS.Timeout | undefined = undefined;
   private stopped = true;
   private queueUrl: string;
   private handleMessage: (message: Message) => Promise<Message | void>;
@@ -102,7 +100,7 @@ export class Consumer extends TypedEventEmitter {
   /**
    * Stop polling the queue for messages (pre existing requests will still be made until concluded).
    */
-  public stop(options: StopOptions): void {
+  public stop(options?: StopOptions): void {
     if (this.stopped) {
       debug('Consumer was already stopped');
       return;
@@ -242,11 +240,13 @@ export class Consumer extends TypedEventEmitter {
    * @param message The message that was delivered from SQS
    */
   private async processMessage(message: Message): Promise<void> {
+    let heartbeatTimeoutId: NodeJS.Timeout | undefined = undefined;
+
     try {
       this.emit('message_received', message);
 
       if (this.heartbeatInterval) {
-        this.heartbeatTimeoutId = this.startHeartbeat(message);
+        heartbeatTimeoutId = this.startHeartbeat(message);
       }
 
       const ackedMessage = await this.executeHandler(message);
@@ -263,8 +263,7 @@ export class Consumer extends TypedEventEmitter {
         await this.changeVisibilityTimeout(message, 0);
       }
     } finally {
-      clearInterval(this.heartbeatTimeoutId);
-      this.heartbeatTimeoutId = undefined;
+      clearInterval(heartbeatTimeoutId);
     }
   }
 
@@ -273,13 +272,15 @@ export class Consumer extends TypedEventEmitter {
    * @param messages The messages that were delivered from SQS
    */
   private async processMessageBatch(messages: Message[]): Promise<void> {
+    let heartbeatTimeoutId: NodeJS.Timeout | undefined = undefined;
+
     try {
       messages.forEach((message) => {
         this.emit('message_received', message);
       });
 
       if (this.heartbeatInterval) {
-        this.heartbeatTimeoutId = this.startHeartbeat(null, messages);
+        heartbeatTimeoutId = this.startHeartbeat(null, messages);
       }
 
       const ackedMessages = await this.executeBatchHandler(messages);
@@ -298,8 +299,7 @@ export class Consumer extends TypedEventEmitter {
         await this.changeVisibilityTimeoutBatch(messages, 0);
       }
     } finally {
-      clearInterval(this.heartbeatTimeoutId);
-      this.heartbeatTimeoutId = undefined;
+      clearInterval(heartbeatTimeoutId);
     }
   }
 
@@ -387,12 +387,14 @@ export class Consumer extends TypedEventEmitter {
    * @param message The message that was received from SQS
    */
   private async executeHandler(message: Message): Promise<Message> {
+    let handleMessageTimeoutId: NodeJS.Timeout | undefined = undefined;
+
     try {
       let result;
 
       if (this.handleMessageTimeout) {
         const pending = new Promise((_, reject) => {
-          this.handleMessageTimeoutId = setTimeout((): void => {
+          handleMessageTimeoutId = setTimeout((): void => {
             reject(new TimeoutError());
           }, this.handleMessageTimeout);
         });
@@ -409,8 +411,8 @@ export class Consumer extends TypedEventEmitter {
           : `Unexpected message handler failure: ${err.message}`;
       throw err;
     } finally {
-      if (this.handleMessageTimeoutId) {
-        clearTimeout(this.handleMessageTimeoutId);
+      if (handleMessageTimeoutId) {
+        clearTimeout(handleMessageTimeoutId);
       }
     }
   }

package/src/types.ts

@@ -69,7 +69,7 @@ export interface ConsumerOptions {
   sqs?: SQSClient;
   /**
    * The AWS region.
-   * @defaultValue `eu-west-1`
+   * @defaultValue process.env.AWS_REGION || `eu-west-1`
    */
   region?: string;
   /**