sqs-consumer 5.8.0 → 6.0.0-alpha.1

package/README.md

@@ -13,10 +13,17 @@ Build SQS-based applications without the boilerplate. Just define an async funct
 npm install sqs-consumer --save-dev
 ```
 
+> **Note**
+> This library assumes you are using [AWS SDK v3](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sqs/index.html). If you are using v2, please install v5.8.0:
+>
+> ```bash
+> npm install sqs-consumer@5.8.0 --save-dev
+> ```
+
 ## Usage
 
 ```js
-const { Consumer } = require('sqs-consumer');
+import { Consumer } from 'sqs-consumer';
 
 const app = Consumer.create({
   queueUrl: 'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',
@@ -40,37 +47,6 @@ app.start();
 - 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](http://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, the default Node.js HTTP/HTTPS SQS agent creates a new TCP connection for every new request ([AWS SQS documentation](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html)). To avoid the cost of establishing a new connection, you can reuse an existing connection by passing a new SQS instance with `keepAlive: true`.
-
-```js
-const { Consumer } = require('sqs-consumer');
-const AWS = require('aws-sdk');
-const https = require('https');
-
-const app = Consumer.create({
-  queueUrl: 'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',
-  handleMessage: async (message) => {
-    // do some work with `message`
-  },
-  sqs: new AWS.SQS({
-    httpOptions: {
-      agent: new https.Agent({
-        keepAlive: true
-      })
-    }
-  })
-});
-
-app.on('error', (err) => {
-  console.error(err.message);
-});
-
-app.on('processing_error', (err) => {
-  console.error(err.message);
-});
-
-app.start();
-```
 
 ### Credentials
 
@@ -81,24 +57,24 @@ export AWS_SECRET_ACCESS_KEY=...
 export AWS_ACCESS_KEY_ID=...
 ```
 
-If you need to specify your credentials manually, you can use a pre-configured instance of the [AWS SQS](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SQS.html) client:
+If you need to specify your credentials manually, you can use a pre-configured instance of the [SQS Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sqs/classes/sqsclient.html) client.
 
 ```js
-const { Consumer } = require('sqs-consumer');
-const AWS = require('aws-sdk');
-
-AWS.config.update({
-  region: 'eu-west-1',
-  accessKeyId: '...',
-  secretAccessKey: '...'
-});
+import { Consumer } from 'sqs-consumer';
+import { SQSClient } from '@aws-sdk/client-sqs';
 
 const app = Consumer.create({
   queueUrl: 'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',
   handleMessage: async (message) => {
     // ...
   },
-  sqs: new AWS.SQS()
+  sqs: new SQSClient({
+    region: 'my-region',
+    credentials: {
+      accessKeyId: process.env.AWS_ACCESS_KEY_ID,
+      secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
+    }
+  })
 });
 
 app.on('error', (err) => {
@@ -138,7 +114,7 @@ Creates a new SQS consumer.
 - `waitTimeSeconds` - _Number_ - The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning (defaults to `20`).
 - `authenticationErrorTimeout` - _Number_ - The duration (in milliseconds) to wait before retrying after an authentication error (defaults to `10000`).
 - `pollingWaitTimeMs` - _Number_ - The duration (in milliseconds) to wait before repolling the queue (defaults to `0`).
-- `sqs` - _Object_ - An optional [AWS SQS](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SQS.html) object to use if you need to configure the client manually
+- `sqs` - _Object_ - An optional [SQS Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sqs/classes/sqsclient.html) object to use if you need to configure the client manually
 - `shouldDeleteMessages` - _Boolean_ - Default to `true`, if you don't want the package to delete messages from sqs set this to `false`
 
 ### `consumer.start()`

package/dist/consumer.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" />
-import { SQS } from 'aws-sdk';
+import { SQSClient, Message } from '@aws-sdk/client-sqs';
 import { EventEmitter } from 'events';
-export type SQSMessage = SQS.Types.Message;
 export interface ConsumerOptions {
     queueUrl?: string;
     attributeNames?: string[];
@@ -14,21 +13,21 @@ export interface ConsumerOptions {
     pollingWaitTimeMs?: number;
     terminateVisibilityTimeout?: boolean;
     heartbeatInterval?: number;
-    sqs?: SQS;
+    sqs?: SQSClient;
     region?: string;
     handleMessageTimeout?: number;
     shouldDeleteMessages?: boolean;
-    handleMessage?(message: SQSMessage): Promise<void>;
-    handleMessageBatch?(messages: SQSMessage[]): Promise<void>;
+    handleMessage?(message: Message): Promise<void>;
+    handleMessageBatch?(messages: Message[]): Promise<void>;
 }
 interface Events {
     response_processed: [];
     empty: [];
-    message_received: [SQSMessage];
-    message_processed: [SQSMessage];
-    error: [Error, void | SQSMessage | SQSMessage[]];
-    timeout_error: [Error, SQSMessage];
-    processing_error: [Error, SQSMessage];
+    message_received: [Message];
+    message_processed: [Message];
+    error: [Error, void | Message | Message[]];
+    timeout_error: [Error, Message];
+    processing_error: [Error, Message];
     stopped: [];
 }
 export declare class Consumer extends EventEmitter {
@@ -67,7 +66,7 @@ export declare class Consumer extends EventEmitter {
     private processMessageBatch;
     private deleteMessageBatch;
     private executeBatchHandler;
-    private changeVisabilityTimeoutBatch;
+    private changeVisibilityTimeoutBatch;
     private startHeartbeat;
 }
 export {};

package/dist/consumer.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Consumer = void 0;
-const aws_sdk_1 = require("aws-sdk");
+const client_sqs_1 = require("@aws-sdk/client-sqs");
 const debug_1 = require("debug");
 const events_1 = require("events");
 const bind_1 = require("./bind");
@@ -45,13 +45,14 @@ function isConnectionError(err) {
     return false;
 }
 function toSQSError(err, message) {
+    var _a, _b;
     const sqsError = new errors_1.SQSError(message);
-    sqsError.code = err.code;
-    sqsError.statusCode = err.statusCode;
-    sqsError.region = err.region;
-    sqsError.retryable = err.retryable;
-    sqsError.hostname = err.hostname;
-    sqsError.time = err.time;
+    sqsError.code = err.name;
+    sqsError.statusCode = (_a = err.$metadata) === null || _a === void 0 ? void 0 : _a.httpStatusCode;
+    sqsError.retryable = (_b = err.$retryable) === null || _b === void 0 ? void 0 : _b.throttling;
+    sqsError.service = err.$service;
+    sqsError.fault = err.$fault;
+    sqsError.time = new Date();
     return sqsError;
 }
 function hasMessages(response) {
@@ -81,7 +82,7 @@ class Consumer extends events_1.EventEmitter {
         this.shouldDeleteMessages = (_d = options.shouldDeleteMessages) !== null && _d !== void 0 ? _d : true;
         this.sqs =
             options.sqs ||
-                new aws_sdk_1.SQS({
+                new client_sqs_1.SQSClient({
                     region: options.region || process.env.AWS_REGION || 'eu-west-1'
                 });
         (0, bind_1.autoBind)(this);
@@ -156,7 +157,7 @@ class Consumer extends events_1.EventEmitter {
     }
     async receiveMessage(params) {
         try {
-            return await this.sqs.receiveMessage(params).promise();
+            return await this.sqs.send(new client_sqs_1.ReceiveMessageCommand(params));
         }
         catch (err) {
             throw toSQSError(err, `SQS receive message failed: ${err.message}`);
@@ -173,7 +174,7 @@ class Consumer extends events_1.EventEmitter {
             ReceiptHandle: message.ReceiptHandle
         };
         try {
-            await this.sqs.deleteMessage(deleteParams).promise();
+            await this.sqs.send(new client_sqs_1.DeleteMessageCommand(deleteParams));
         }
         catch (err) {
             throw toSQSError(err, `SQS delete message failed: ${err.message}`);
@@ -206,13 +207,12 @@ class Consumer extends events_1.EventEmitter {
     }
     async changeVisibilityTimeout(message, timeout) {
         try {
-            return await this.sqs
-                .changeMessageVisibility({
+            const input = {
                 QueueUrl: this.queueUrl,
                 ReceiptHandle: message.ReceiptHandle,
                 VisibilityTimeout: timeout
-            })
-                .promise();
+            };
+            return await this.sqs.send(new client_sqs_1.ChangeMessageVisibilityCommand(input));
         }
         catch (err) {
             this.emit('error', toSQSError(err, `Error changing visibility timeout: ${err.message}`), message);
@@ -269,7 +269,7 @@ class Consumer extends events_1.EventEmitter {
         try {
             if (this.heartbeatInterval) {
                 heartbeat = this.startHeartbeat(async () => {
-                    return this.changeVisabilityTimeoutBatch(messages, this.visibilityTimeout);
+                    return this.changeVisibilityTimeoutBatch(messages, this.visibilityTimeout);
                 });
             }
             await this.executeBatchHandler(messages);
@@ -281,7 +281,7 @@ class Consumer extends events_1.EventEmitter {
         catch (err) {
             this.emit('error', err, messages);
             if (this.terminateVisibilityTimeout) {
-                await this.changeVisabilityTimeoutBatch(messages, 0);
+                await this.changeVisibilityTimeoutBatch(messages, 0);
             }
         }
         finally {
@@ -302,7 +302,7 @@ class Consumer extends events_1.EventEmitter {
             }))
         };
         try {
-            await this.sqs.deleteMessageBatch(deleteParams).promise();
+            await this.sqs.send(new client_sqs_1.DeleteMessageBatchCommand(deleteParams));
         }
         catch (err) {
             throw toSQSError(err, `SQS delete message failed: ${err.message}`);
@@ -317,7 +317,7 @@ class Consumer extends events_1.EventEmitter {
             throw err;
         }
     }
-    async changeVisabilityTimeoutBatch(messages, timeout) {
+    async changeVisibilityTimeoutBatch(messages, timeout) {
         const params = {
             QueueUrl: this.queueUrl,
             Entries: messages.map((message) => ({
@@ -327,7 +327,7 @@ class Consumer extends events_1.EventEmitter {
             }))
         };
         try {
-            return await this.sqs.changeMessageVisibilityBatch(params).promise();
+            return await this.sqs.send(new client_sqs_1.ChangeMessageVisibilityBatchCommand(params));
         }
         catch (err) {
             this.emit('error', toSQSError(err, `Error changing visibility timeout: ${err.message}`), messages);

package/dist/errors.d.ts

@@ -1,10 +1,10 @@
 declare class SQSError extends Error {
     code: string;
     statusCode: number;
-    region: string;
-    hostname: string;
+    service: string;
     time: Date;
     retryable: boolean;
+    fault: 'client' | 'server';
     constructor(message: string);
 }
 declare class TimeoutError extends Error {

package/dist/index.d.ts

@@ -1 +1 @@
-export { SQSMessage, Consumer, ConsumerOptions } from './consumer';
+export { Consumer, ConsumerOptions } from './consumer';

package/dist/types.d.ts

@@ -0,0 +1,59 @@
+export type AWSError = {
+    /**
+     * Name, eg. ConditionalCheckFailedException
+     */
+    name: string;
+    /**
+     * Human-readable error response message
+     */
+    message: string;
+    /**
+     * Non-standard stacktrace
+     */
+    stack?: string;
+    /**
+     * Whether the client or server are at fault.
+     */
+    readonly $fault?: 'client' | 'server';
+    /**
+     * The service that encountered the exception.
+     */
+    readonly $service?: string;
+    /**
+     * Indicates that an error MAY be retried by the client.
+     */
+    readonly $retryable?: {
+        /**
+         * Indicates that the error is a retryable throttling error.
+         */
+        readonly throttling?: boolean;
+    };
+    $metadata?: {
+        /**
+         * The status code of the last HTTP response received for this operation.
+         */
+        httpStatusCode?: number;
+        /**
+         * A unique identifier for the last request sent for this operation. Often
+         * requested by AWS service teams to aid in debugging.
+         */
+        requestId?: string;
+        /**
+         * A secondary identifier for the last request sent. Used for debugging.
+         */
+        extendedRequestId?: string;
+        /**
+         * A tertiary identifier for the last request sent. Used for debugging.
+         */
+        cfId?: string;
+        /**
+         * The number of times this operation was attempted.
+         */
+        attempts?: number;
+        /**
+         * The total amount of time (in milliseconds) that was spent waiting between
+         * retry attempts.
+         */
+        totalRetryDelay?: number;
+    };
+};

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/examples/express-simple/dist/app.d.ts

@@ -0,0 +1,4 @@
+declare const express: any;
+declare const consumer: any;
+declare const producer: any;
+declare const expressApp: any;

package/examples/express-simple/dist/app.js

@@ -0,0 +1,97 @@
+const express = require('express');
+const { consumer } = require('./utils/consumer');
+const { producer } = require('./utils/producer');
+const expressApp = express();
+expressApp.get('/', (_, res) => {
+    res.send('Hello! Send me a request to one of my other endpoints to test SQS Consumer!');
+});
+expressApp.get('/queue-size', async (_, res) => {
+    // get the current size of the queue
+    const size = await producer.queueSize();
+    res.send({
+        message: 'Queue size retrieved!',
+        data: size
+    });
+});
+expressApp.post('/sample', async (_, res) => {
+    // send messages to the queue
+    const messages = await producer.send(['msg1', 'msg2']);
+    res.send({
+        message: 'Sample messages sent successfully!',
+        data: messages
+    });
+});
+expressApp.post('/sample-with-id', async (_, res) => {
+    // send a message to the queue with a specific ID (by default the body is used as the ID)
+    const messages = await producer.send([
+        {
+            id: 'id1',
+            body: 'Hello world'
+        }
+    ]);
+    res.send({
+        message: 'Sample messages sent successfully!',
+        data: messages
+    });
+});
+expressApp.post('/sample-with-attributes', async (_, res) => {
+    // send a message to the queue with
+    // - messageAttributes
+    const messages = await producer.send([
+        {
+            id: 'id1',
+            body: 'Hello world with two string attributes: attr1 and attr2',
+            messageAttributes: {
+                attr1: { DataType: 'String', StringValue: 'stringValue' },
+                attr2: { DataType: 'String', StringValue: 'stringValue2' },
+            }
+        }
+    ]);
+    res.send({
+        message: 'Sample messages sent successfully!',
+        data: messages
+    });
+});
+expressApp.post('/sample-with-delay', async (_, res) => {
+    // send a message to the queue with
+    // - delaySeconds (must be an number contained within 0 and 900)
+    const messages = await producer.send([
+        {
+            id: 'id1',
+            body: 'Hello world delayed by 5 seconds',
+            delaySeconds: 5
+        }
+    ]);
+    res.send({
+        message: 'Sample messages sent successfully!',
+        data: messages
+    });
+});
+expressApp.post('/sample-with-fido', async (_, res) => {
+    // send a message to a FIFO queue
+    //
+    // note that AWS FIFO queues require two additional params:
+    // - groupId (string)
+    // - deduplicationId (string)
+    //
+    // deduplicationId can be excluded if content-based deduplication is enabled
+    //
+    // http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html
+    const messages = await producer.send({
+        id: 'testId',
+        body: 'Hello world from our FIFO queue!',
+        groupId: 'group1234',
+        deduplicationId: 'abcdef123456' // typically a hash of the message body
+    });
+    res.send({
+        message: 'Sample messages sent successfully!',
+        data: messages
+    });
+});
+expressApp.listen(3026, () => {
+    // eslint-disable-next-line no-console
+    console.log('STARTING SQS CONSUMER');
+    consumer.start();
+    // eslint-disable-next-line no-console
+    console.log('EXPRESS APP LISTENING ON: http://localhost:3026');
+});

package/examples/express-simple/dist/utils/consumer.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/express-simple/dist/utils/consumer.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const { Consumer } = require('../../../dist/index');
+const { QUEUE_URL, sqs } = require('./sqs');
+const consumer = Consumer.create({
+    queueUrl: QUEUE_URL,
+    sqs,
+    handleMessage: async (message) => {
+        // eslint-disable-next-line no-console
+        console.log('RECEIVED SQS MESSAGE:');
+        // eslint-disable-next-line no-console
+        console.log(message);
+    }
+});
+consumer.on('error', (err) => {
+    // eslint-disable-next-line no-console
+    console.log('RECEIVED SQS ERROR:');
+    // eslint-disable-next-line no-console
+    console.error(err.message);
+});
+consumer.on('processing_error', (err) => {
+    // eslint-disable-next-line no-console
+    console.log('RECEIVED SQS PROCESSING ERROR:');
+    // eslint-disable-next-line no-console
+    console.error(err.message);
+});
+consumer.on('timeout_error', (err) => {
+    // eslint-disable-next-line no-console
+    console.log('RECEIVED SQS TIMEOUT ERROR:');
+    // eslint-disable-next-line no-console
+    console.error(err.message);
+});
+consumer.on('timeout_error', (err) => {
+    // eslint-disable-next-line no-console
+    console.log('RECEIVED SQS TIMEOUT ERROR:');
+    // eslint-disable-next-line no-console
+    console.error(err.message);
+});
+consumer.on('message_received', (message) => {
+    // eslint-disable-next-line no-console
+    console.log('RECEIVED SQS MESSAGE:');
+    // eslint-disable-next-line no-console
+    console.error(message);
+});
+consumer.on('message_processed', (message) => {
+    // eslint-disable-next-line no-console
+    console.log('RECEIVED SQS MESSAGE PROCESSED:');
+    // eslint-disable-next-line no-console
+    console.error(message);
+});
+consumer.on('response_processed', () => {
+    // eslint-disable-next-line no-console
+    console.log('RECEIVED SQS RESPONSE PROCESSED:');
+});
+consumer.on('stopped', () => {
+    // eslint-disable-next-line no-console
+    console.log('RECEIVED SQS STOPPED:');
+});
+consumer.on('empty', () => {
+    // eslint-disable-next-line no-console
+    console.log('RECEIVED SQS EMPTY:');
+});
+exports.consumer = consumer;

package/examples/express-simple/dist/utils/producer.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/express-simple/dist/utils/producer.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const { Producer } = require('sqs-producer');
+const { QUEUE_URL, sqsConfig, sqs } = require('./sqs');
+const producer = Producer.create({
+    queueUrl: QUEUE_URL,
+    region: sqsConfig.region,
+    sqs
+});
+exports.producer = producer;

package/examples/express-simple/dist/utils/sqs.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/express-simple/dist/utils/sqs.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const { Endpoint, SQS } = require('aws-sdk');
+const sqsConfig = {
+    region: 'eu-west-1',
+};
+if (process.env.SQS_ENDPOINT) {
+    sqsConfig.endpoint = new Endpoint(process.env.SQS_ENDPOINT);
+}
+else if (process.env.NODE_ENV === 'development') {
+    sqsConfig.endpoint = new Endpoint('http://localhost:4566');
+}
+if (process.env.SQS_ACCESS_KEY_ID) {
+    sqsConfig.accessKeyId = process.env.SQS_ACCESS_KEY_ID;
+}
+else if (process.env.NODE_ENV === 'development') {
+    sqsConfig.accessKeyId = 'na';
+}
+if (process.env.SQS_SECRET_ACCESS_KEY) {
+    sqsConfig.secretAccessKey = process.env.SQS_SECRET_ACCESS_KEY;
+}
+else if (process.env.NODE_ENV === 'development') {
+    sqsConfig.secretAccessKey = 'na';
+}
+exports.sqs =
+    !sqsConfig.endpoint && process.env.NODE_ENV === 'development'
+        ? null
+        : new SQS(sqsConfig);
+exports.QUEUE_NAME = process.env.SQS_QUEUE_NAME || 'sqs-consumer-data';
+exports.QUEUE_URL =
+    process.env.SQS_QUEUE_URL ||
+        'http://localhost:4566/000000000000/sqs-consumer-data';
+exports.sqsConfig = sqsConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "5.8.0",
+  "version": "6.0.0-alpha.1",
   "description": "Build SQS-based Node applications without the boilerplate",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -52,11 +52,11 @@
     "typescript": "^4.9.4"
   },
   "dependencies": {
-    "aws-sdk": "^2.1271.0",
+    "@aws-sdk/client-sqs": "^3.226.0",
     "debug": "^4.3.4"
   },
   "peerDependencies": {
-    "aws-sdk": "^2.1271.0"
+    "@aws-sdk/client-sqs": "^3.226.0"
   },
   "mocha": {
     "spec": "test/**/**/*.test.ts",