sqs-consumer 7.4.0 → 7.5.0

package/.github/workflows/cla.yml

@@ -11,7 +11,7 @@ jobs:
     steps:
       - name: "CLA Check"
         if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
-        uses: contributor-assistant/github-action@v2.2.0
+        uses: contributor-assistant/github-action@v2.3.1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}

package/.github/workflows/coverage.yml

@@ -17,10 +17,10 @@ jobs:
         node-version: [18.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
@@ -32,7 +32,7 @@ jobs:
         run: npm ci
 
       - name: Report Coverage
-        uses: paambaati/codeclimate-action@v3.2.0
+        uses: paambaati/codeclimate-action@v5.0.0
         env:
           CC_TEST_REPORTER_ID: 760097cb88b4c685dce427cf94a8e12a5f082774d06b4f4f5daef839ffc07821
         with:

package/.github/workflows/dependency-review.yml

@@ -9,6 +9,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: 'Dependency Review'
         uses: actions/dependency-review-action@v3

package/.github/workflows/docs.yml

@@ -29,10 +29,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 18.x
           cache: 'npm'
@@ -47,13 +47,13 @@ jobs:
         run: npm run generate-docs
 
       - name: Setup Pages
-        uses: actions/configure-pages@v2
+        uses: actions/configure-pages@v3
 
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v2
         with:
           path: './public'
 
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v2

package/.github/workflows/issues-to-projects.yml

@@ -11,7 +11,7 @@ jobs:
     name: Add issue to project
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/add-to-project@v0.4.0
+      - uses: actions/add-to-project@v0.5.0
         with:
           project-url: https://github.com/orgs/bbc/projects/170
           github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}

package/.github/workflows/stale.yml

@@ -7,7 +7,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v6
+      - uses: actions/stale@v8
         with:
           stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
           stale-pr-message: 'This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.'

package/.github/workflows/test.yml

@@ -17,10 +17,10 @@ jobs:
         node-version: [18.x, 20.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'

package/README.md

@@ -129,6 +129,8 @@ Returns the current polling state of the consumer: `true` if it is actively poll
 
 Updates the provided option with the provided value.
 
+Please note that any update of the option `pollingWaitTimeMs` will take effect only on next polling cycle.
+
 You can [find out more about this here](https://bbc.github.io/sqs-consumer/classes/Consumer.html#updateOption).
 
 ### Events

package/dist/consumer.js

@@ -350,10 +350,10 @@ class Consumer extends emitter_1.TypedEventEmitter {
         }
         catch (err) {
             if (err instanceof errors_1.TimeoutError) {
-                err.message = `Message handler timed out after ${this.handleMessageTimeout}ms: Operation timed out.`;
+                throw (0, errors_1.toTimeoutError)(err, `Message handler timed out after ${this.handleMessageTimeout}ms: Operation timed out.`);
             }
             else if (err instanceof Error) {
-                err.message = `Unexpected message handler failure: ${err.message}`;
+                throw (0, errors_1.toStandardError)(err, `Unexpected message handler failure: ${err.message}`);
             }
             throw err;
         }
@@ -374,7 +374,7 @@ class Consumer extends emitter_1.TypedEventEmitter {
         }
         catch (err) {
             if (err instanceof Error) {
-                err.message = `Unexpected message handler failure: ${err.message}`;
+                throw (0, errors_1.toStandardError)(err, `Unexpected message handler failure: ${err.message}`);
             }
             throw err;
         }

package/dist/errors.d.ts

@@ -9,6 +9,13 @@ declare class SQSError extends Error {
     constructor(message: string);
 }
 declare class TimeoutError extends Error {
+    cause: Error;
+    time: Date;
+    constructor(message?: string);
+}
+declare class StandardError extends Error {
+    cause: Error;
+    time: Date;
     constructor(message?: string);
 }
 /**
@@ -19,7 +26,19 @@ declare function isConnectionError(err: Error): boolean;
 /**
  * Formats an AWSError the the SQSError type.
  * @param err The error object that was received.
- * @param message The message that the error occurred on.
+ * @param message The message to send with the error.
  */
 declare function toSQSError(err: AWSError, message: string): SQSError;
-export { SQSError, TimeoutError, isConnectionError, toSQSError };
+/**
+ * Formats an Error to the StandardError type.
+ * @param err The error object that was received.
+ * @param message The message to send with the error.
+ */
+declare function toStandardError(err: Error, message: string): StandardError;
+/**
+ * Formats an Error to the TimeoutError type.
+ * @param err The error object that was received.
+ * @param message The message to send with the error.
+ */
+declare function toTimeoutError(err: TimeoutError, message: string): TimeoutError;
+export { SQSError, TimeoutError, isConnectionError, toSQSError, toStandardError, toTimeoutError };

package/dist/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toSQSError = exports.isConnectionError = exports.TimeoutError = exports.SQSError = void 0;
+exports.toTimeoutError = exports.toStandardError = exports.toSQSError = exports.isConnectionError = exports.TimeoutError = exports.SQSError = void 0;
 class SQSError extends Error {
     constructor(message) {
         super(message);
@@ -16,6 +16,13 @@ class TimeoutError extends Error {
     }
 }
 exports.TimeoutError = TimeoutError;
+class StandardError extends Error {
+    constructor(message = 'An unexpected error occurred:') {
+        super(message);
+        this.message = message;
+        this.name = 'StandardError';
+    }
+}
 /**
  * Checks if the error provided should be treated as a connection error.
  * @param err The error that was received.
@@ -33,7 +40,7 @@ exports.isConnectionError = isConnectionError;
 /**
  * Formats an AWSError the the SQSError type.
  * @param err The error object that was received.
- * @param message The message that the error occurred on.
+ * @param message The message to send with the error.
  */
 function toSQSError(err, message) {
     var _a, _b;
@@ -47,3 +54,27 @@ function toSQSError(err, message) {
     return sqsError;
 }
 exports.toSQSError = toSQSError;
+/**
+ * Formats an Error to the StandardError type.
+ * @param err The error object that was received.
+ * @param message The message to send with the error.
+ */
+function toStandardError(err, message) {
+    const error = new StandardError(message);
+    error.cause = err;
+    error.time = new Date();
+    return error;
+}
+exports.toStandardError = toStandardError;
+/**
+ * Formats an Error to the TimeoutError type.
+ * @param err The error object that was received.
+ * @param message The message to send with the error.
+ */
+function toTimeoutError(err, message) {
+    const error = new TimeoutError(message);
+    error.cause = err;
+    error.time = new Date();
+    return error;
+}
+exports.toTimeoutError = toTimeoutError;

package/dist/types.d.ts

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

package/dist/validation.js

@@ -30,6 +30,11 @@ function validateOption(option, value, allOptions, strict) {
                 throw new Error('waitTimeSeconds must be between 0 and 20.');
             }
             break;
+        case 'pollingWaitTimeMs':
+            if (value < 0) {
+                throw new Error('pollingWaitTimeMs must be greater than 0.');
+            }
+            break;
         default:
             if (strict) {
                 throw new Error(`The update ${option} cannot be updated`);

package/package.json

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

package/src/consumer.ts

@@ -22,6 +22,8 @@ import { autoBind } from './bind';
 import {
   SQSError,
   TimeoutError,
+  toStandardError,
+  toTimeoutError,
   toSQSError,
   isConnectionError
 } from './errors';
@@ -453,9 +455,15 @@ export class Consumer extends TypedEventEmitter {
       return result instanceof Object ? result : message;
     } catch (err) {
       if (err instanceof TimeoutError) {
-        err.message = `Message handler timed out after ${this.handleMessageTimeout}ms: Operation timed out.`;
+        throw toTimeoutError(
+          err,
+          `Message handler timed out after ${this.handleMessageTimeout}ms: Operation timed out.`
+        );
       } else if (err instanceof Error) {
-        err.message = `Unexpected message handler failure: ${err.message}`;
+        throw toStandardError(
+          err,
+          `Unexpected message handler failure: ${err.message}`
+        );
       }
       throw err;
     } finally {
@@ -476,7 +484,10 @@ export class Consumer extends TypedEventEmitter {
       return result instanceof Object ? result : messages;
     } catch (err) {
       if (err instanceof Error) {
-        err.message = `Unexpected message handler failure: ${err.message}`;
+        throw toStandardError(
+          err,
+          `Unexpected message handler failure: ${err.message}`
+        );
       }
       throw err;
     }

package/src/errors.ts

@@ -15,6 +15,9 @@ class SQSError extends Error {
 }
 
 class TimeoutError extends Error {
+  cause: Error;
+  time: Date;
+
   constructor(message = 'Operation timed out.') {
     super(message);
     this.message = message;
@@ -22,6 +25,17 @@ class TimeoutError extends Error {
   }
 }
 
+class StandardError extends Error {
+  cause: Error;
+  time: Date;
+
+  constructor(message = 'An unexpected error occurred:') {
+    super(message);
+    this.message = message;
+    this.name = 'StandardError';
+  }
+}
+
 /**
  * Checks if the error provided should be treated as a connection error.
  * @param err The error that was received.
@@ -41,7 +55,7 @@ function isConnectionError(err: Error): boolean {
 /**
  * Formats an AWSError the the SQSError type.
  * @param err The error object that was received.
- * @param message The message that the error occurred on.
+ * @param message The message to send with the error.
  */
 function toSQSError(err: AWSError, message: string): SQSError {
   const sqsError = new SQSError(message);
@@ -55,4 +69,37 @@ function toSQSError(err: AWSError, message: string): SQSError {
   return sqsError;
 }
 
-export { SQSError, TimeoutError, isConnectionError, toSQSError };
+/**
+ * Formats an Error to the StandardError type.
+ * @param err The error object that was received.
+ * @param message The message to send with the error.
+ */
+function toStandardError(err: Error, message: string): StandardError {
+  const error = new StandardError(message);
+  error.cause = err;
+  error.time = new Date();
+
+  return error;
+}
+
+/**
+ * Formats an Error to the TimeoutError type.
+ * @param err The error object that was received.
+ * @param message The message to send with the error.
+ */
+function toTimeoutError(err: TimeoutError, message: string): TimeoutError {
+  const error = new TimeoutError(message);
+  error.cause = err;
+  error.time = new Date();
+
+  return error;
+}
+
+export {
+  SQSError,
+  TimeoutError,
+  isConnectionError,
+  toSQSError,
+  toStandardError,
+  toTimeoutError
+};

package/src/types.ts

@@ -124,7 +124,8 @@ export interface ConsumerOptions {
 export type UpdatableOptions =
   | 'visibilityTimeout'
   | 'batchSize'
-  | 'waitTimeSeconds';
+  | 'waitTimeSeconds'
+  | 'pollingWaitTimeMs';
 
 export interface StopOptions {
   /**

package/src/validation.ts

@@ -45,6 +45,11 @@ function validateOption(
         throw new Error('waitTimeSeconds must be between 0 and 20.');
       }
       break;
+    case 'pollingWaitTimeMs':
+      if (value < 0) {
+        throw new Error('pollingWaitTimeMs must be greater than 0.');
+      }
+      break;
     default:
       if (strict) {
         throw new Error(`The update ${option} cannot be updated`);