sqs-consumer 8.2.0 → 9.1.0

package/.github/workflows/publish.yml

@@ -17,8 +17,6 @@ jobs:
           cache: 'npm'
           registry-url: 'https://registry.npmjs.org'
       - run: npm ci
-      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
-        run: npm audit signatures
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/CHANGELOG.md

@@ -1,12 +1,16 @@
-## [8.2.0](https://github.com/bbc/sqs-consumer/compare/v8.1.5...v8.2.0) (2024-02-06)
+## [9.1.0](https://github.com/bbc/sqs-consumer/compare/v9.0.0...v9.1.0) (2024-03-12)
 
 
 ### Features
 
-* Wait for msgs to be processed before emitting stopped ([#454](https://github.com/bbc/sqs-consumer/issues/454)) ([0fa5305](https://github.com/bbc/sqs-consumer/commit/0fa53055a4957dba7381307cdeb65aa99128c315))
+* feat: Add useQueueUrlAsEndpoint to ConsumerOptions ([#472](https://github.com/bbc/sqs-consumer/issues/472)) ([075bd54](https://github.com/bbc/sqs-consumer/commit/075bd54a0aa574f4589d7d8f2c6c82d6adbdf1a1))
+
+
+### Bug Fixes
+
+* handle CredentialsProviderError from AWS SDK JS v3 ([#474](https://github.com/bbc/sqs-consumer/issues/474)) ([9a14d66](https://github.com/bbc/sqs-consumer/commit/9a14d661c36e7bbca0dfc1ce467253991103279f))
 
 
 ### Chores
 
-* removing semantic git ([b834205](https://github.com/bbc/sqs-consumer/commit/b834205bfe9183bc69141c4016831cdbb6e33d7a))
-* updating release config ([6b95edb](https://github.com/bbc/sqs-consumer/commit/6b95edbf894864e25a61a748ab0ac9d6ebf2a2f7))
+* version bump to 9.1.0 ([c031e1e](https://github.com/bbc/sqs-consumer/commit/c031e1e12bfa43f35f2cae8221694b0ac31a8712))

package/README.md

@@ -26,6 +26,10 @@ npm install sqs-consumer
 
 We will only support Node versions that are actively or security supported by the Node team. If you are still using an Node 14, please use a version of this library before the v7 release, if you are using Node 16, please use a version before the v7.3.0 release.
 
+## Documentation
+
+Visit [https://bbc.github.io/sqs-consumer/](https://bbc.github.io/sqs-consumer/) for the full API documentation.
+
 ## Usage
 
 ```js
@@ -125,9 +129,15 @@ By default, the value of `abort` is set to `false` which means pre existing requ
 
 `consumer.stop({ abort: true })`
 
-### `consumer.isRunning`
+### `consumer.status`
+
+Returns the current status of the consumer.
+
+- `isRunning` - `true` if the consumer has been started and not stopped, `false` if was not started or if it was stopped.
+- `isPolling` - `true` if the consumer is actively polling, `false` if it is not.
 
-Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
+> **Note:**
+> This method is not available in versions before v9.0.0 and replaced the method `isRunning` to supply both running and polling states.
 
 ### `consumer.updateOption(option, value)`
 

package/dist/consumer.d.ts

@@ -51,9 +51,13 @@ export declare class Consumer extends TypedEventEmitter {
      */
     private waitForPollingToComplete;
     /**
-     * Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
+     * Returns the current status of the consumer.
+     * This includes whether it is running or currently polling.
      */
-    get isRunning(): boolean;
+    get status(): {
+        isRunning: boolean;
+        isPolling: boolean;
+    };
     /**
      * Validates and then updates the provided option to the provided value.
      * @param option The option to validate and then update

package/dist/consumer.js

@@ -12,10 +12,11 @@ const logger_1 = require("./logger");
  */
 class Consumer extends emitter_1.TypedEventEmitter {
     constructor(options) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g;
         super();
         this.pollingTimeoutId = undefined;
         this.stopped = true;
+        this.isPolling = false;
         (0, validation_1.assertOptions)(options);
         this.queueUrl = options.queueUrl;
         this.handleMessage = options.handleMessage;
@@ -40,6 +41,7 @@ class Consumer extends emitter_1.TypedEventEmitter {
         this.sqs =
             options.sqs ||
                 new client_sqs_1.SQSClient({
+                    useQueueUrlAsEndpoint: (_g = options.useQueueUrlAsEndpoint) !== null && _g !== void 0 ? _g : true,
                     region: options.region || process.env.AWS_REGION || 'eu-west-1'
                 });
         (0, bind_1.autoBind)(this);
@@ -108,18 +110,22 @@ class Consumer extends emitter_1.TypedEventEmitter {
         const exceededTimeout = Date.now() - this.stopRequestedAtTimestamp >
             this.pollingCompleteWaitTimeMs;
         if (exceededTimeout) {
-            logger_1.logger.debug('waiting_for_polling_to_complete_timeout_exceeded');
+            this.emit('waiting_for_polling_to_complete_timeout_exceeded');
             this.emit('stopped');
             return;
         }
-        logger_1.logger.debug('waiting_for_polling_to_complete');
+        this.emit('waiting_for_polling_to_complete');
         setTimeout(this.waitForPollingToComplete, 1000);
     }
     /**
-     * Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
+     * Returns the current status of the consumer.
+     * This includes whether it is running or currently polling.
      */
-    get isRunning() {
-        return !this.stopped;
+    get status() {
+        return {
+            isRunning: !this.stopped,
+            isPolling: this.isPolling
+        };
     }
     /**
      * Validates and then updates the provided option to the provided value.
@@ -221,18 +227,12 @@ class Consumer extends emitter_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) {

package/dist/errors.js

@@ -32,7 +32,8 @@ function isConnectionError(err) {
         return (err.statusCode === 403 ||
             err.code === 'CredentialsError' ||
             err.code === 'UnknownEndpoint' ||
-            err.code === 'AWS.SimpleQueueService.NonExistentQueue');
+            err.code === 'AWS.SimpleQueueService.NonExistentQueue' ||
+            err.code === 'CredentialsProviderError');
     }
     return false;
 }

package/dist/types.d.ts

@@ -75,6 +75,11 @@ export interface ConsumerOptions {
      * @defaultValue process.env.AWS_REGION || `eu-west-1`
      */
     region?: string;
+    /**
+     * If false uses the QueueUrl hostname as the endpoint.
+     * @defaultValue `true`
+     */
+    useQueueUrlAsEndpoint?: boolean;
     /**
      * Time in ms to wait for `handleMessage` to process a message before timing out.
      *
@@ -189,6 +194,14 @@ export interface Events {
      * Fired when an option is updated
      */
     option_updated: [UpdatableOptions, ConsumerOptions[UpdatableOptions]];
+    /**
+     * Fired when the Consumer is waiting for polling to complete before stopping.
+     */
+    waiting_for_polling_to_complete: [];
+    /**
+     * Fired when the Consumer has waited for polling to complete and is stopping due to a timeout.
+     */
+    waiting_for_polling_to_complete_timeout_exceeded: [];
 }
 export type AWSError = {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "8.2.0",
+  "version": "9.1.0",
   "description": "Build SQS-based Node applications without the boilerplate",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,7 +21,7 @@
     "lcov": "c8 mocha && c8 report --reporter=lcov",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --fix",
-    "format": "prettier --loglevel warn --write \"**/*.{js,json,jsx,md,ts,tsx,html}\"",
+    "format": "prettier --log-level warn --write \"**/*.{js,json,jsx,md,ts,tsx,html}\"",
     "format:check": "prettier --check \"**/*.{js,json,jsx,md,ts,tsx,html}\"",
     "posttest": "npm run lint && npm run format:check",
     "generate-docs": "typedoc"
@@ -57,6 +57,10 @@
         {
           "preset": "conventionalcommits",
           "releaseRules": [
+            {
+              "type": "breaking",
+              "release": "major"
+            },
             {
               "type": "feat",
               "release": "minor"
@@ -124,39 +128,39 @@
     ]
   },
   "devDependencies": {
-    "@cucumber/cucumber": "10.0.1",
+    "@cucumber/cucumber": "10.3.1",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^11.1.0",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^9.2.6",
-    "@semantic-release/npm": "^11.0.2",
+    "@semantic-release/npm": "11.0.3",
     "@semantic-release/release-notes-generator": "^12.1.0",
-    "@types/chai": "^4.3.9",
-    "@types/mocha": "^10.0.3",
-    "@types/node": "^20.8.7",
-    "@types/sinon": "^10.0.20",
-    "c8": "^8.0.1",
+    "@types/chai": "^4.3.12",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^20.11.25",
+    "@types/sinon": "^17.0.3",
+    "c8": "^9.1.0",
     "chai": "^4.3.10",
     "conventional-changelog-conventionalcommits": "^7.0.2",
-    "eslint": "^8.52.0",
-    "eslint-config-iplayer": "^9.1.0",
-    "eslint-config-prettier": "^9.0.0",
-    "mocha": "^10.2.0",
+    "eslint": "^8.57.0",
+    "eslint-config-iplayer": "^9.2.0",
+    "eslint-config-prettier": "^9.1.0",
+    "mocha": "^10.3.0",
     "p-event": "^4.2.0",
-    "prettier": "^3.0.3",
-    "semantic-release": "^23.0.0",
-    "sinon": "^17.0.0",
-    "sqs-producer": "^4.0.0",
-    "ts-node": "^10.9.1",
-    "typedoc": "^0.25.2",
-    "typescript": "^5.2.2"
+    "prettier": "^3.2.5",
+    "semantic-release": "^23.0.2",
+    "sinon": "^17.0.1",
+    "sqs-producer": "^5.0.0",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.25.12",
+    "typescript": "^5.4.2"
   },
   "dependencies": {
-    "@aws-sdk/client-sqs": "^3.447.0",
+    "@aws-sdk/client-sqs": "^3.529.1",
     "debug": "^4.3.4"
   },
   "peerDependencies": {
-    "@aws-sdk/client-sqs": "^3.447.0"
+    "@aws-sdk/client-sqs": "^3.529.1"
   },
   "mocha": {
     "spec": "test/tests/**/**/*.test.ts",

package/src/consumer.ts

@@ -56,7 +56,7 @@ export class Consumer extends TypedEventEmitter {
   private pollingWaitTimeMs: number;
   private pollingCompleteWaitTimeMs: number;
   private heartbeatInterval: number;
-  private isPolling: boolean;
+  private isPolling = false;
   private stopRequestedAtTimestamp: number;
   public abortController: AbortController;
 
@@ -86,6 +86,7 @@ export class Consumer extends TypedEventEmitter {
     this.sqs =
       options.sqs ||
       new SQSClient({
+        useQueueUrlAsEndpoint: options.useQueueUrlAsEndpoint ?? true,
         region: options.region || process.env.AWS_REGION || 'eu-west-1'
       });
     autoBind(this);
@@ -164,20 +165,27 @@ export class Consumer extends TypedEventEmitter {
       Date.now() - this.stopRequestedAtTimestamp >
       this.pollingCompleteWaitTimeMs;
     if (exceededTimeout) {
-      logger.debug('waiting_for_polling_to_complete_timeout_exceeded');
+      this.emit('waiting_for_polling_to_complete_timeout_exceeded');
       this.emit('stopped');
       return;
     }
 
-    logger.debug('waiting_for_polling_to_complete');
+    this.emit('waiting_for_polling_to_complete');
     setTimeout(this.waitForPollingToComplete, 1000);
   }
 
   /**
-   * Returns the current polling state of the consumer: `true` if it is actively polling, `false` if it is not.
+   * Returns the current status of the consumer.
+   * This includes whether it is running or currently polling.
    */
-  public get isRunning(): boolean {
-    return !this.stopped;
+  public get status(): {
+    isRunning: boolean;
+    isPolling: boolean;
+  } {
+    return {
+      isRunning: !this.stopped,
+      isPolling: this.isPolling
+    };
   }
 
   /**
@@ -297,20 +305,12 @@ 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');

package/src/errors.ts

@@ -46,7 +46,8 @@ function isConnectionError(err: Error): boolean {
       err.statusCode === 403 ||
       err.code === 'CredentialsError' ||
       err.code === 'UnknownEndpoint' ||
-      err.code === 'AWS.SimpleQueueService.NonExistentQueue'
+      err.code === 'AWS.SimpleQueueService.NonExistentQueue' ||
+      err.code === 'CredentialsProviderError'
     );
   }
   return false;

package/src/types.ts

@@ -76,6 +76,11 @@ export interface ConsumerOptions {
    * @defaultValue process.env.AWS_REGION || `eu-west-1`
    */
   region?: string;
+  /**
+   * If false uses the QueueUrl hostname as the endpoint.
+   * @defaultValue `true`
+   */
+  useQueueUrlAsEndpoint?: boolean;
   /**
    * Time in ms to wait for `handleMessage` to process a message before timing out.
    *
@@ -197,6 +202,14 @@ export interface Events {
    * Fired when an option is updated
    */
   option_updated: [UpdatableOptions, ConsumerOptions[UpdatableOptions]];
+  /**
+   * Fired when the Consumer is waiting for polling to complete before stopping.
+   */
+  waiting_for_polling_to_complete: [];
+  /**
+   * Fired when the Consumer has waited for polling to complete and is stopping due to a timeout.
+   */
+  waiting_for_polling_to_complete_timeout_exceeded: [];
 }
 
 export type AWSError = {