sqs-consumer 7.1.0-canary.2 → 7.1.0

package/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -32,7 +32,7 @@ body:
         Please add a link to a minimal reproduction.
         Note:
         - Please keep your example as simple and reproduceable as possible, try leaving out dependencies that are not required for reproduction.
-        - To create a shareable code example for web, you can use CodeSandbox (https://codesandbox.io/s/new) or Stackblitz (https://stackblitz.com/).
+        - To create a shareable code example for web, you can use Stackblitz (https://stackblitz.com/edit/sqs-consumer-starter).
         - Please make sure the example is complete and runnable - e.g. avoid localhost URLs.
       placeholder: |
         e.g. Code Sandbox, Stackblitz, Expo Snack or TypeScript playground

package/dist/consumer.d.ts

@@ -38,14 +38,9 @@ export declare class Consumer extends TypedEventEmitter {
      */
     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
+     * Validates and then updates the provided option to the provided value.
+     * @param option The option to validate and then update
+     * @param value The value to set the provided option to
      */
     updateOption(option: UpdatableOptions, value: ConsumerOptions[UpdatableOptions]): void;
     /**

package/dist/consumer.js

@@ -93,34 +93,15 @@ class Consumer extends types_1.TypedEventEmitter {
         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
+     * Validates and then updates the provided option to the provided value.
+     * @param option The option to validate and then update
+     * @param value The value to set the provided option to
      */
     updateOption(option, value) {
-        switch (option) {
-            case 'visibilityTimeout':
-                this.updateVisibilityTimeout(value);
-                break;
-            default:
-                throw new Error(`The update ${option} cannot be updated`);
-        }
+        (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);
     }
     /**
      * Emit one of the consumer's error events depending on the error received.

package/dist/types.d.ts

@@ -105,7 +105,7 @@ export interface ConsumerOptions {
      */
     handleMessageBatch?(messages: Message[]): Promise<Message[] | void>;
 }
-export type UpdatableOptions = 'visibilityTimeout';
+export type UpdatableOptions = 'visibilityTimeout' | 'batchSize' | 'waitTimeSeconds';
 export interface StopOptions {
     /**
      * Default to `false`, if you want the stop action to also abort requests to SQS

package/dist/validation.d.ts

@@ -1,5 +1,8 @@
 import { ReceiveMessageCommandOutput } from '@aws-sdk/client-sqs';
 import { ConsumerOptions } from './types';
+declare function validateOption(option: string, value: any, allOptions: {
+    [key: string]: any;
+}, strict?: boolean): void;
 /**
  * Ensure that the required options have been set.
  * @param options The options that have been set by the application.
@@ -10,4 +13,4 @@ declare function assertOptions(options: ConsumerOptions): void;
  * @param response The response from SQS.
  */
 declare function hasMessages(response: ReceiveMessageCommandOutput): boolean;
-export { hasMessages, assertOptions };
+export { hasMessages, assertOptions, validateOption };

package/dist/validation.js

@@ -1,11 +1,43 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertOptions = exports.hasMessages = void 0;
+exports.validateOption = exports.assertOptions = exports.hasMessages = void 0;
 const requiredOptions = [
     'queueUrl',
     // only one of handleMessage / handleMessagesBatch is required
     'handleMessage|handleMessageBatch'
 ];
+function validateOption(option, value, allOptions, strict) {
+    switch (option) {
+        case 'batchSize':
+            if (value > 10 || value < 1) {
+                throw new Error('batchSize must be between 1 and 10.');
+            }
+            break;
+        case 'heartbeatInterval':
+            if (!allOptions.visibilityTimeout ||
+                value >= allOptions.visibilityTimeout) {
+                throw new Error('heartbeatInterval must be less than visibilityTimeout.');
+            }
+            break;
+        case 'visibilityTimeout':
+            if (allOptions.heartbeatInterval &&
+                value <= allOptions.heartbeatInterval) {
+                throw new Error('heartbeatInterval must be less than visibilityTimeout.');
+            }
+            break;
+        case 'waitTimeSeconds':
+            if (value < 1 || value > 20) {
+                throw new Error('waitTimeSeconds must be between 0 and 20.');
+            }
+            break;
+        default:
+            if (strict) {
+                throw new Error(`The update ${option} cannot be updated`);
+            }
+            break;
+    }
+}
+exports.validateOption = validateOption;
 /**
  * Ensure that the required options have been set.
  * @param options The options that have been set by the application.
@@ -17,12 +49,11 @@ function assertOptions(options) {
             throw new Error(`Missing SQS consumer option [ ${possibilities.join(' or ')} ].`);
         }
     });
-    if (options.batchSize > 10 || options.batchSize < 1) {
-        throw new Error('SQS batchSize option must be between 1 and 10.');
+    if (options.batchSize) {
+        validateOption('batchSize', options.batchSize, options);
     }
-    if (options.heartbeatInterval &&
-        !(options.heartbeatInterval < options.visibilityTimeout)) {
-        throw new Error('heartbeatInterval must be less than visibilityTimeout.');
+    if (options.heartbeatInterval) {
+        validateOption('heartbeatInterval', options.heartbeatInterval, options);
     }
 }
 exports.assertOptions = assertOptions;

package/package.json

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

package/src/consumer.ts

@@ -30,7 +30,7 @@ import {
   toSQSError,
   isConnectionError
 } from './errors';
-import { assertOptions, hasMessages } from './validation';
+import { validateOption, assertOptions, hasMessages } from './validation';
 import { abortController } from './controllers';
 
 const debug = Debug('sqs-consumer');
@@ -139,44 +139,21 @@ export class Consumer extends TypedEventEmitter {
   }
 
   /**
-   * 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
+   * Validates and then updates the provided option to the provided value.
+   * @param option The option to validate and then update
+   * @param value The value to set the provided 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`);
-    }
+    validateOption(option, value, this, true);
+
+    debug(`Updating the ${option} option to the value ${value}`);
+
+    this[option] = value;
+
+    this.emit('option_updated', option, value);
   }
 
   /**

package/src/types.ts

@@ -106,7 +106,10 @@ export interface ConsumerOptions {
   handleMessageBatch?(messages: Message[]): Promise<Message[] | void>;
 }
 
-export type UpdatableOptions = 'visibilityTimeout';
+export type UpdatableOptions =
+  | 'visibilityTimeout'
+  | 'batchSize'
+  | 'waitTimeSeconds';
 
 export interface StopOptions {
   /**

package/src/validation.ts

@@ -8,6 +8,51 @@ const requiredOptions = [
   'handleMessage|handleMessageBatch'
 ];
 
+function validateOption(
+  option: string,
+  value: any,
+  allOptions: { [key: string]: any },
+  strict?: boolean
+): void {
+  switch (option) {
+    case 'batchSize':
+      if (value > 10 || value < 1) {
+        throw new Error('batchSize must be between 1 and 10.');
+      }
+      break;
+    case 'heartbeatInterval':
+      if (
+        !allOptions.visibilityTimeout ||
+        value >= allOptions.visibilityTimeout
+      ) {
+        throw new Error(
+          'heartbeatInterval must be less than visibilityTimeout.'
+        );
+      }
+      break;
+    case 'visibilityTimeout':
+      if (
+        allOptions.heartbeatInterval &&
+        value <= allOptions.heartbeatInterval
+      ) {
+        throw new Error(
+          'heartbeatInterval must be less than visibilityTimeout.'
+        );
+      }
+      break;
+    case 'waitTimeSeconds':
+      if (value < 1 || value > 20) {
+        throw new Error('waitTimeSeconds must be between 0 and 20.');
+      }
+      break;
+    default:
+      if (strict) {
+        throw new Error(`The update ${option} cannot be updated`);
+      }
+      break;
+  }
+}
+
 /**
  * Ensure that the required options have been set.
  * @param options The options that have been set by the application.
@@ -22,15 +67,11 @@ function assertOptions(options: ConsumerOptions): void {
     }
   });
 
-  if (options.batchSize > 10 || options.batchSize < 1) {
-    throw new Error('SQS batchSize option must be between 1 and 10.');
+  if (options.batchSize) {
+    validateOption('batchSize', options.batchSize, options);
   }
-
-  if (
-    options.heartbeatInterval &&
-    !(options.heartbeatInterval < options.visibilityTimeout)
-  ) {
-    throw new Error('heartbeatInterval must be less than visibilityTimeout.');
+  if (options.heartbeatInterval) {
+    validateOption('heartbeatInterval', options.heartbeatInterval, options);
   }
 }
 
@@ -42,4 +83,4 @@ function hasMessages(response: ReceiveMessageCommandOutput): boolean {
   return response.Messages && response.Messages.length > 0;
 }
 
-export { hasMessages, assertOptions };
+export { hasMessages, assertOptions, validateOption };