sqs-consumer 6.2.0 → 6.2.1

package/.github/CONTRIBUTING.md

@@ -6,7 +6,7 @@ Thank you for your interest in contributing to the sqs-consumer.
 - We aim for 100% test coverage. Please write tests for any new functionality or changes.
 - Any API changes should be fully documented.
 - Make sure your code meets our linting standards. Run `npm run lint` to check your code.
-- Maintain the existing coding style. There are some settings in `.jsbeautifyrc` to help.
+- Maintain the existing coding style.
 - Be mindful of others when making suggestions and/or code reviewing.
 
 ## Reporting Issues

package/.github/workflows/coverage.yml

@@ -23,6 +23,10 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: NPM Audit
+        run: npx audit-ci
 
       - name: Install Node Modules
         run: npm ci

package/.github/workflows/docs.yml

@@ -34,7 +34,11 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version: 18.x
+          cache: 'npm'
+
+      - name: NPM Audit
+        run: npx audit-ci
 
       - name: Install Node Modules
         run: npm ci

package/.github/workflows/test.yml

@@ -23,12 +23,18 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-
-      - name: Install Node Modules
-        run: npm ci
+          cache: 'npm'
 
       - name: NPM Audit
         run: npx audit-ci
 
+      - name: Install Node Modules
+        run: npm ci
+
       - name: Run Tests and Linting
         run: npm run test
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: test-reports-${{ matrix.node-version }}
+          path: test/reports/

package/.prettierignore

@@ -2,4 +2,5 @@ node_modules
 coverage
 bake-scripts
 dist
-public
+public
+test/reports

package/README.md

@@ -50,8 +50,6 @@ app.start();
 - 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).
 
-You can also find some examples of sqs-consumer implemented in various ways within the [examples directory](./examples/).
-
 ### Credentials
 
 By default the consumer will look for AWS credentials in the places [specified by the AWS SDK](https://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html#Setting_AWS_Credentials). The simplest option is to export your credentials as environment variables:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "6.2.0",
+  "version": "6.2.1",
   "description": "Build SQS-based Node applications without the boilerplate",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,8 +9,11 @@
     "watch": "tsc --watch",
     "clean": "rm -fr dist/*",
     "prepublishOnly": "npm run build",
-    "pretest": "npm run build",
-    "test": "mocha --recursive --full-trace --exit",
+    "test:unit": "mocha --recursive --full-trace --exit",
+    "pretest:integration:init": "npm run build",
+    "test:integration:init": "sh ./test/scripts/initIntTests.sh",
+    "test:integration": "npm run test:integration:init && cucumber-js --config ./test/config/cucumber.js",
+    "test": "npm run test:unit && npm run test:integration",
     "coverage": "nyc mocha && nyc report --reporter=html && nyc report --reporter=json-summary",
     "lcov": "nyc mocha && nyc report --reporter=lcov",
     "lint": "eslint . --ext .ts",
@@ -22,10 +25,10 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/BBC/sqs-consumer.git"
+    "url": "https://github.com/bbc/sqs-consumer.git"
   },
   "bugs": {
-    "url": "https://github.com/BBC/sqs-consumer/issues"
+    "url": "https://github.com/bbc/sqs-consumer/issues"
   },
   "homepage": "https://bbc.github.io/sqs-consumer/",
   "keywords": [
@@ -35,33 +38,35 @@
   ],
   "license": "Apache-2.0",
   "devDependencies": {
+    "@cucumber/cucumber": "^8.10.0",
     "@types/chai": "^4.3.4",
     "@types/debug": "^4.1.7",
     "@types/mocha": "^10.0.1",
     "@types/node": "^18.11.18",
     "@types/sinon": "^10.0.13",
     "chai": "^4.3.7",
-    "eslint": "^8.31.0",
+    "eslint": "^8.32.0",
     "eslint-config-iplayer-ts": "^4.1.0",
-    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-prettier": "^8.6.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
     "p-event": "^4.2.0",
-    "prettier": "^2.8.1",
+    "prettier": "^2.8.3",
     "sinon": "^15.0.1",
+    "sqs-producer": "^3.1.1",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.23.23",
+    "typedoc": "^0.23.24",
     "typescript": "^4.9.4"
   },
   "dependencies": {
-    "@aws-sdk/client-sqs": "^3.241.0",
+    "@aws-sdk/client-sqs": "^3.258.0",
     "debug": "^4.3.4"
   },
   "peerDependencies": {
-    "@aws-sdk/client-sqs": "^3.241.0"
+    "@aws-sdk/client-sqs": "^3.258.0"
   },
   "mocha": {
-    "spec": "test/**/**/*.test.ts",
+    "spec": "test/tests/**/**/*.test.ts",
     "require": "ts-node/register"
   },
   "nyc": {