sqs-consumer 7.0.2 → 7.1.0-canary.1

package/.github/DISCUSSION_TEMPLATE/feature-request.yml

@@ -0,0 +1,17 @@
+body:
+  - type: textarea
+    attributes:
+      label: Background
+      description: Why do you think this feature is needed? Are there current alternatives?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Objectives
+      description: What should this feature request aim to address?
+      value: |
+        1.
+        2.
+        3.
+    validations:
+      required: true

package/.github/DISCUSSION_TEMPLATE/help.yml

@@ -0,0 +1,13 @@
+body:
+  - type: textarea
+    attributes:
+      label: Summary
+      description: What do you need help with?
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Example
+      description: A link to a minimal reproduction is helpful for debugging!
+    validations:
+      required: false

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/README.md

@@ -12,14 +12,14 @@ Build SQS-based applications without the boilerplate. Just define an async funct
 To install this package, simply enter the following command into your terminal (or the variant of whatever package manager you are using):
 
 ```bash
-npm install --save-dev sqs-consumer
+npm install sqs-consumer
 ```
 
 > **Note**
 > This library assumes you are using [AWS SDK v3](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sqs/index.html). If you are using v2, please install v5.8.0:
 >
 > ```bash
-> npm install sqs-consumer@5.8.0 --save-dev
+> npm install sqs-consumer@5.8.0
 > ```
 
 ### Node version
@@ -127,6 +127,12 @@ By default, the value of `abort` is set to `false` which means pre existing requ
 
 Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
 
+### `consumer.updateOption(option, value)`
+
+Updates the provided option with the provided value.
+
+You can [find out more about this here](https://bbc.github.io/sqs-consumer/public/classes/Consumer.html#updateOption).
+
 ### Events
 
 Each consumer is an [`EventEmitter`](https://nodejs.org/api/events.html) and [emits these events](https://bbc.github.io/sqs-consumer/interfaces/Events.html).

package/dist/consumer.d.ts

@@ -1,11 +1,9 @@
-import { ConsumerOptions, TypedEventEmitter, StopOptions } from './types';
+import { ConsumerOptions, TypedEventEmitter, StopOptions, UpdatableOptions } from './types';
 /**
  * [Usage](https://bbc.github.io/sqs-consumer/index.html#usage)
  */
 export declare class Consumer extends TypedEventEmitter {
     private pollingTimeoutId;
-    private heartbeatTimeoutId;
-    private handleMessageTimeoutId;
     private stopped;
     private queueUrl;
     private handleMessage;
@@ -39,6 +37,17 @@ export declare class Consumer extends TypedEventEmitter {
      * Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
      */
     get isRunning(): boolean;
+    /**
+     * Updates visibilityTimeout to the provided value.
+     * @param value The value to set visibilityTimeout to
+     */
+    private updateVisibilityTimeout;
+    /**
+     * Updates the provided option to the provided value.
+     * @param option The option that you want to update
+     * @param value The value to set the option to
+     */
+    updateOption(option: UpdatableOptions, value: ConsumerOptions[UpdatableOptions]): void;
     /**
      * Emit one of the consumer's error events depending on the error received.
      * @param err The error object to forward on

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.
@@ -93,6 +91,36 @@ class Consumer extends types_1.TypedEventEmitter {
     get isRunning() {
         return !this.stopped;
     }
+    /**
+     * Updates visibilityTimeout to the provided value.
+     * @param value The value to set visibilityTimeout to
+     */
+    updateVisibilityTimeout(value) {
+        if (typeof value !== 'number') {
+            throw new Error('visibilityTimeout must be a number');
+        }
+        if (typeof value !== 'number' ||
+            (this.heartbeatInterval && value <= this.heartbeatInterval)) {
+            throw new Error('heartbeatInterval must be less than visibilityTimeout.');
+        }
+        debug(`Updating the visibilityTimeout option to the value ${value}`);
+        this.visibilityTimeout = value;
+        this.emit('option_updated', 'visibilityTimeout', value);
+    }
+    /**
+     * Updates the provided option to the provided value.
+     * @param option The option that you want to update
+     * @param value The value to set the option to
+     */
+    updateOption(option, value) {
+        switch (option) {
+            case 'visibilityTimeout':
+                this.updateVisibilityTimeout(value);
+                break;
+            default:
+                throw new Error(`The update ${option} cannot be updated`);
+        }
+    }
     /**
      * Emit one of the consumer's error events depending on the error received.
      * @param err The error object to forward on
@@ -186,10 +214,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 +233,7 @@ class Consumer extends types_1.TypedEventEmitter {
             }
         }
         finally {
-            clearInterval(this.heartbeatTimeoutId);
-            this.heartbeatTimeoutId = undefined;
+            clearInterval(heartbeatTimeoutId);
         }
     }
     /**
@@ -213,12 +241,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 +264,7 @@ class Consumer extends types_1.TypedEventEmitter {
             }
         }
         finally {
-            clearInterval(this.heartbeatTimeoutId);
-            this.heartbeatTimeoutId = undefined;
+            clearInterval(heartbeatTimeoutId);
         }
     }
     /**
@@ -297,11 +325,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 +349,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;
     /**
@@ -105,6 +105,7 @@ export interface ConsumerOptions {
      */
     handleMessageBatch?(messages: Message[]): Promise<Message[] | void>;
 }
+export type UpdatableOptions = 'visibilityTimeout';
 export interface StopOptions {
     /**
      * Default to `false`, if you want the stop action to also abort requests to SQS
@@ -153,6 +154,10 @@ export interface Events {
      * Fired when the consumer finally stops its work.
      */
     stopped: [];
+    /**
+     * Fired when an option is updated
+     */
+    option_updated: [UpdatableOptions, ConsumerOptions[UpdatableOptions]];
 }
 export declare class TypedEventEmitter extends EventEmitter {
     /**

package/package.json

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

package/src/consumer.ts

@@ -17,7 +17,12 @@ import {
 } from '@aws-sdk/client-sqs';
 import Debug from 'debug';
 
-import { ConsumerOptions, TypedEventEmitter, StopOptions } from './types';
+import {
+  ConsumerOptions,
+  TypedEventEmitter,
+  StopOptions,
+  UpdatableOptions
+} from './types';
 import { autoBind } from './bind';
 import {
   SQSError,
@@ -35,8 +40,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>;
@@ -134,6 +137,47 @@ export class Consumer extends TypedEventEmitter {
     return !this.stopped;
   }
 
+  /**
+   * Updates visibilityTimeout to the provided value.
+   * @param value The value to set visibilityTimeout to
+   */
+  private updateVisibilityTimeout(value: ConsumerOptions['visibilityTimeout']) {
+    if (typeof value !== 'number') {
+      throw new Error('visibilityTimeout must be a number');
+    }
+
+    if (
+      typeof value !== 'number' ||
+      (this.heartbeatInterval && value <= this.heartbeatInterval)
+    ) {
+      throw new Error('heartbeatInterval must be less than visibilityTimeout.');
+    }
+
+    debug(`Updating the visibilityTimeout option to the value ${value}`);
+
+    this.visibilityTimeout = value;
+
+    this.emit('option_updated', 'visibilityTimeout', value);
+  }
+
+  /**
+   * Updates the provided option to the provided value.
+   * @param option The option that you want to update
+   * @param value The value to set the option to
+   */
+  public updateOption(
+    option: UpdatableOptions,
+    value: ConsumerOptions[UpdatableOptions]
+  ) {
+    switch (option) {
+      case 'visibilityTimeout':
+        this.updateVisibilityTimeout(value);
+        break;
+      default:
+        throw new Error(`The update ${option} cannot be updated`);
+    }
+  }
+
   /**
    * Emit one of the consumer's error events depending on the error received.
    * @param err The error object to forward on
@@ -242,11 +286,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 +309,7 @@ export class Consumer extends TypedEventEmitter {
         await this.changeVisibilityTimeout(message, 0);
       }
     } finally {
-      clearInterval(this.heartbeatTimeoutId);
-      this.heartbeatTimeoutId = undefined;
+      clearInterval(heartbeatTimeoutId);
     }
   }
 
@@ -273,13 +318,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 +345,7 @@ export class Consumer extends TypedEventEmitter {
         await this.changeVisibilityTimeoutBatch(messages, 0);
       }
     } finally {
-      clearInterval(this.heartbeatTimeoutId);
-      this.heartbeatTimeoutId = undefined;
+      clearInterval(heartbeatTimeoutId);
     }
   }
 
@@ -387,12 +433,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 +457,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;
   /**
@@ -106,6 +106,8 @@ export interface ConsumerOptions {
   handleMessageBatch?(messages: Message[]): Promise<Message[] | void>;
 }
 
+export type UpdatableOptions = 'visibilityTimeout';
+
 export interface StopOptions {
   /**
    * Default to `false`, if you want the stop action to also abort requests to SQS
@@ -155,6 +157,10 @@ export interface Events {
    * Fired when the consumer finally stops its work.
    */
   stopped: [];
+  /**
+   * Fired when an option is updated
+   */
+  option_updated: [UpdatableOptions, ConsumerOptions[UpdatableOptions]];
 }
 
 export class TypedEventEmitter extends EventEmitter {