sqs-consumer 9.0.0 → 9.1.0

package/CHANGELOG.md

@@ -1,21 +1,16 @@
-## [9.0.0](https://github.com/bbc/sqs-consumer/compare/v8.2.0...v9.0.0) (2024-03-11)
+## [9.1.0](https://github.com/bbc/sqs-consumer/compare/v9.0.0...v9.1.0) (2024-03-12)
 
 
-### ⚠ BREAKING CHANGES
+### Features
 
-* removing handler_processing debugger in favour of status (#470)
-* replacing the isRunning method with status (#459)
+* feat: Add useQueueUrlAsEndpoint to ConsumerOptions ([#472](https://github.com/bbc/sqs-consumer/issues/472)) ([075bd54](https://github.com/bbc/sqs-consumer/commit/075bd54a0aa574f4589d7d8f2c6c82d6adbdf1a1))
 
-### Features
 
-* removing handler_processing debugger in favour of status ([#470](https://github.com/bbc/sqs-consumer/issues/470)) ([b554da6](https://github.com/bbc/sqs-consumer/commit/b554da6e700bc0e69b77032352f250f19dba081b))
-* replacing the isRunning method with status ([#459](https://github.com/bbc/sqs-consumer/issues/459)) ([9f07383](https://github.com/bbc/sqs-consumer/commit/9f07383b0244fa0ce05238c45f27238cd3459ebf))
+### 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
 
-* adding a link to the documentation ([#471](https://github.com/bbc/sqs-consumer/issues/471)) ([bd7fbbb](https://github.com/bbc/sqs-consumer/commit/bd7fbbb78a7e1d10cb7eae1b7d8f595c48b3438e))
-* **deps:** upgrading dependencies - March 24 ([#468](https://github.com/bbc/sqs-consumer/issues/468)) ([2d342cd](https://github.com/bbc/sqs-consumer/commit/2d342cd63365bb42c095e2d4f56a7e2433f43f25))
-* handle breaking changes ([2924ca2](https://github.com/bbc/sqs-consumer/commit/2924ca24e9fda687bf47a5daf45d17618561dae1))
-* **release:** v9.0.0 ([bc5593c](https://github.com/bbc/sqs-consumer/commit/bc5593c4f9940e30c05e6463a1e7339bf14f1e50))
-* upgrading @semantic-release/npm ([bed4dc6](https://github.com/bbc/sqs-consumer/commit/bed4dc63e42344325de0be398952c2b99994e631))
+* version bump to 9.1.0 ([c031e1e](https://github.com/bbc/sqs-consumer/commit/c031e1e12bfa43f35f2cae8221694b0ac31a8712))

package/dist/consumer.js

@@ -12,7 +12,7 @@ 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;
@@ -41,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);

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.
      *

package/package.json

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

package/src/consumer.ts

@@ -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);

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.
    *