sqs-consumer 7.5.0 → 8.1.0

package/.github/workflows/cla.yml

@@ -5,6 +5,11 @@ on:
   pull_request_target:
     types: [opened,closed,synchronize]
 
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+
 jobs:
   CLAAssistant:
     runs-on: ubuntu-latest

package/README.md

@@ -50,10 +50,14 @@ app.start();
 ```
 
 - The queue is polled continuously for messages using [long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html).
-- Messages are deleted from the queue once the handler function has completed successfully.
 - Throwing an error (or returning a rejected promise) from the handler function will cause the message to be left on the queue. An [SQS redrive policy](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html) can be used to move messages that cannot be processed to a dead letter queue.
-- By default messages are processed one at a time – a new message won't be received until the first one has been processed. To process messages in parallel, use the `batchSize` option [detailed below](#options).
-- By default, messages that are sent to the `handleMessage` and `handleMessageBatch` functions will be considered as processed if they return without an error. To acknowledge individual messages, please return the message that you want to acknowledge if you are using `handleMessage` or the messages for `handleMessageBatch`. It's also important to await any processing that you are doing to ensure that messages are processed one at a time.
+- By default messages are processed one at a time – a new message won't be received until the first one has been processed. To process messages in parallel, use the `batchSize` option [detailed here](https://bbc.github.io/sqs-consumer/interfaces/ConsumerOptions.html#batchSize).
+  - It's also important to await any processing that you are doing to ensure that messages are processed one at a time.
+- By default, messages that are sent to the `handleMessage` and `handleMessageBatch` functions will be considered as processed if they return without an error.
+  - To acknowledge individual messages, please return the message that you want to acknowledge if you are using `handleMessage` or the messages for `handleMessageBatch`.
+    - To note, returning an empty object or an empty array will be considered an acknowledgement of no message(s) and will result in no messages being deleted. If you would like to change this behaviour, please use the `alwaysAcknowledge` option [detailed here](https://bbc.github.io/sqs-consumer/interfaces/ConsumerOptions.html).
+    - By default, if an object or an array is not returned, all messages will be acknowledged.
+- Messages are deleted from the queue once the handler function has completed successfully (the above items should also be taken into account).
 
 ### Credentials
 

package/dist/consumer.d.ts

@@ -16,6 +16,7 @@ export declare class Consumer extends TypedEventEmitter {
     private attributeNames;
     private messageAttributeNames;
     private shouldDeleteMessages;
+    private alwaysAcknowledge;
     private batchSize;
     private visibilityTimeout;
     private terminateVisibilityTimeout;

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;
+        var _a, _b, _c, _d, _e;
         super();
         this.pollingTimeoutId = undefined;
         this.stopped = true;
@@ -35,6 +35,7 @@ class Consumer extends emitter_1.TypedEventEmitter {
             (_b = options.authenticationErrorTimeout) !== null && _b !== void 0 ? _b : 10000;
         this.pollingWaitTimeMs = (_c = options.pollingWaitTimeMs) !== null && _c !== void 0 ? _c : 0;
         this.shouldDeleteMessages = (_d = options.shouldDeleteMessages) !== null && _d !== void 0 ? _d : true;
+        this.alwaysAcknowledge = (_e = options.alwaysAcknowledge) !== null && _e !== void 0 ? _e : false;
         this.sqs =
             options.sqs ||
                 new client_sqs_1.SQSClient({
@@ -346,7 +347,9 @@ class Consumer extends emitter_1.TypedEventEmitter {
             else {
                 result = await this.handleMessage(message);
             }
-            return result instanceof Object ? result : message;
+            return !this.alwaysAcknowledge && result instanceof Object
+                ? result
+                : message;
         }
         catch (err) {
             if (err instanceof errors_1.TimeoutError) {
@@ -370,7 +373,9 @@ class Consumer extends emitter_1.TypedEventEmitter {
     async executeBatchHandler(messages) {
         try {
             const result = await this.handleMessageBatch(messages);
-            return result instanceof Object ? result : messages;
+            return !this.alwaysAcknowledge && result instanceof Object
+                ? result
+                : messages;
         }
         catch (err) {
             if (err instanceof Error) {

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { SQSClient, Message } from '@aws-sdk/client-sqs';
+import { SQSClient, Message, QueueAttributeName } from '@aws-sdk/client-sqs';
 export interface ConsumerOptions {
     /**
      * The SQS queue URL.
@@ -9,7 +9,7 @@ export interface ConsumerOptions {
      * `['All', 'ApproximateFirstReceiveTimestamp', 'ApproximateReceiveCount']`).
      * @defaultvalue `[]`
      */
-    attributeNames?: string[];
+    attributeNames?: QueueAttributeName[];
     /**
      * List of message attributes to retrieve (i.e. `['name', 'address']`).
      * @defaultvalue `[]`
@@ -83,6 +83,14 @@ export interface ConsumerOptions {
      * @defaultvalue `true`
      */
     shouldDeleteMessages?: boolean;
+    /**
+     * By default, the consumer will treat an empty object or array from either of the
+     * handlers as a acknowledgement of no messages and will not delete those messages as
+     * a result. Set this to `true` to always acknowledge all messages no matter the returned
+     * value.
+     * @defaultvalue `false`
+     */
+    alwaysAcknowledge?: boolean;
     /**
      * An `async` function (or function that returns a `Promise`) to be called whenever
      * a message is received.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "7.5.0",
+  "version": "8.1.0",
   "description": "Build SQS-based Node applications without the boilerplate",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -55,17 +55,17 @@
     "p-event": "^4.2.0",
     "prettier": "^3.0.3",
     "sinon": "^17.0.0",
-    "sqs-producer": "^3.4.0",
+    "sqs-producer": "^4.0.0",
     "ts-node": "^10.9.1",
     "typedoc": "^0.25.2",
     "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@aws-sdk/client-sqs": "^3.428.0",
+    "@aws-sdk/client-sqs": "^3.447.0",
     "debug": "^4.3.4"
   },
   "peerDependencies": {
-    "@aws-sdk/client-sqs": "^3.428.0"
+    "@aws-sdk/client-sqs": "^3.447.0"
   },
   "mocha": {
     "spec": "test/tests/**/**/*.test.ts",

package/src/consumer.ts

@@ -13,7 +13,8 @@ import {
   DeleteMessageBatchCommandInput,
   ReceiveMessageCommand,
   ReceiveMessageCommandInput,
-  ReceiveMessageCommandOutput
+  ReceiveMessageCommandOutput,
+  QueueAttributeName
 } from '@aws-sdk/client-sqs';
 
 import { ConsumerOptions, StopOptions, UpdatableOptions } from './types';
@@ -43,9 +44,10 @@ export class Consumer extends TypedEventEmitter {
   private postReceiveMessageCallback?: () => Promise<void>;
   private sqs: SQSClient;
   private handleMessageTimeout: number;
-  private attributeNames: string[];
+  private attributeNames: QueueAttributeName[];
   private messageAttributeNames: string[];
   private shouldDeleteMessages: boolean;
+  private alwaysAcknowledge: boolean;
   private batchSize: number;
   private visibilityTimeout: number;
   private terminateVisibilityTimeout: boolean;
@@ -76,6 +78,7 @@ export class Consumer extends TypedEventEmitter {
       options.authenticationErrorTimeout ?? 10000;
     this.pollingWaitTimeMs = options.pollingWaitTimeMs ?? 0;
     this.shouldDeleteMessages = options.shouldDeleteMessages ?? true;
+    this.alwaysAcknowledge = options.alwaysAcknowledge ?? false;
     this.sqs =
       options.sqs ||
       new SQSClient({
@@ -452,7 +455,9 @@ export class Consumer extends TypedEventEmitter {
         result = await this.handleMessage(message);
       }
 
-      return result instanceof Object ? result : message;
+      return !this.alwaysAcknowledge && result instanceof Object
+        ? result
+        : message;
     } catch (err) {
       if (err instanceof TimeoutError) {
         throw toTimeoutError(
@@ -481,7 +486,9 @@ export class Consumer extends TypedEventEmitter {
     try {
       const result = await this.handleMessageBatch(messages);
 
-      return result instanceof Object ? result : messages;
+      return !this.alwaysAcknowledge && result instanceof Object
+        ? result
+        : messages;
     } catch (err) {
       if (err instanceof Error) {
         throw toStandardError(

package/src/types.ts

@@ -1,4 +1,4 @@
-import { SQSClient, Message } from '@aws-sdk/client-sqs';
+import { SQSClient, Message, QueueAttributeName } from '@aws-sdk/client-sqs';
 
 export interface ConsumerOptions {
   /**
@@ -10,7 +10,7 @@ export interface ConsumerOptions {
    * `['All', 'ApproximateFirstReceiveTimestamp', 'ApproximateReceiveCount']`).
    * @defaultvalue `[]`
    */
-  attributeNames?: string[];
+  attributeNames?: QueueAttributeName[];
   /**
    * List of message attributes to retrieve (i.e. `['name', 'address']`).
    * @defaultvalue `[]`
@@ -84,6 +84,14 @@ export interface ConsumerOptions {
    * @defaultvalue `true`
    */
   shouldDeleteMessages?: boolean;
+  /**
+   * By default, the consumer will treat an empty object or array from either of the
+   * handlers as a acknowledgement of no messages and will not delete those messages as
+   * a result. Set this to `true` to always acknowledge all messages no matter the returned
+   * value.
+   * @defaultvalue `false`
+   */
+  alwaysAcknowledge?: boolean;
   /**
    * An `async` function (or function that returns a `Promise`) to be called whenever
    * a message is received.