sqs-consumer - npm Package Compare versions

Comparing version 3.4.0 to 3.5.0

index.js

@@ -161,5 +161,5 @@ 'use strict';
       if (err.name === SQSError.name) {
-        consumer.emit('error', err);
+        consumer.emit('error', err, message);
       } else {
-        consumer.emit('processing_error', err);
+        consumer.emit('processing_error', err, message);
       }
@@ -166,0 +166,0 @@ } else {

package.json

 {
   "name": "sqs-consumer",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Build SQS-based Node applications without the boilerplate",
@@ -32,3 +32,3 @@ "main": "index.js",
     "mocha": "^3.0.2",
-    "codeclimate-test-reporter": "0.4.0",
+    "codeclimate-test-reporter": "0.4.1",
     "sinon": "^1.10.3"
@@ -35,0 +35,0 @@ },

README.md

@@ -9,5 +9,5 @@ # sqs-consumer
 
+```bash
+npm install sqs-consumer --save
 ```
-npm install sqs-consumer
-```
 
@@ -17,7 +17,7 @@ ## Usage
 ```js
-var Consumer = require('sqs-consumer');
+const Consumer = require('sqs-consumer');
 
-var app = Consumer.create({
+const app = Consumer.create({
   queueUrl: 'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',
-  handleMessage: function (message, done) {
+  handleMessage: (message, done) => {
     // do some work with `message`
@@ -28,3 +28,3 @@ done();
 
-app.on('error', function (err) {
+app.on('error', (err) => {
   console.log(err.message);
@@ -45,3 +45,3 @@ });
 
-```
+```bash
 export AWS_SECRET_ACCESS_KEY=...
@@ -55,4 +55,4 @@ export AWS_ACCESS_KEY_ID=...
 ```js
-var Consumer = require('sqs-consumer');
-var AWS = require('aws-sdk');
+const Consumer = require('sqs-consumer');
+const AWS = require('aws-sdk');
 
@@ -65,5 +65,5 @@ AWS.config.update({
 
-var app = Consumer.create({
+const app = Consumer.create({
   queueUrl: 'https://sqs.eu-west-1.amazonaws.com/account-id/queue-name',
-  handleMessage: function (message, done) {
+  handleMessage: (message, done) => {
     // ...
@@ -75,3 +75,3 @@ done();
 
-app.on('error', function (err) {
+app.on('error', (err) => {
   console.log(err.message);
@@ -81,3 +81,2 @@ });
 app.start();
-
 ```
@@ -118,4 +117,4 @@
 |-----|------|-----------|
-|`error`|`err`|Fired when an error occurs interacting with the queue.|
-|`processing_error`|`err`|Fired when an error occurs processing the message.|
+|`error`|`err`, `[message]`|Fired when an error occurs interacting with the queue. If the error correlates to a message, that error is included in Params|
+|`processing_error`|`err`, `message`|Fired when an error occurs processing the message.|
 |`message_received`|`message`|Fired when a message is received.|
@@ -122,0 +121,0 @@ |`message_processed`|`message`|Fired when a message is successfully processed and removed from the queue.|

test/index.js

@@ -25,2 +25,3 @@ 'use strict';
     sqs.deleteMessage = sinon.stub().yieldsAsync(null);
+    sqs._deleteMessage = sinon.stub().yieldsAsync(null);
     consumer = new Consumer({
@@ -120,3 +121,3 @@ queueUrl: 'some-queue-url',
 
-    it('fires an error event when an error occurs processing a message', function (done) {
+    it('fires a `processing_error` event when a non-`SQSError` error occurs processing a message', function (done) {
       var processingErr = new Error('Processing error');
@@ -126,4 +127,5 @@
 
-      consumer.on('processing_error', function (err) {
+      consumer.on('processing_error', function (err, message) {
         assert.equal(err, processingErr);
+        assert.equal(message.MessageId, '123');
         done();
@@ -135,2 +137,17 @@ });
 
+    it('fires an `error` event when an `SQSError` occurs processing a message', function (done) {
+      var sqsError = new Error('Processing error');
+      sqsError.name = 'SQSError';
+
+      handleMessage.yields(sqsError);
+
+      consumer.on('error', function (err, message) {
+        assert.equal(err, sqsError);
+        assert.equal(message.MessageId, '123');
+        done();
+      });
+
+      consumer.start();
+    });
+
     it('waits before repolling when a credentials error occurs', function (done) {
@@ -137,0 +154,0 @@ var credentialsErr = {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

24212

increased by2.9%

Lines of code

508

increased by2.63%

Worsened metrics

Number of lines in readme file

115

decreased by-0.86%

No dependency changes