sqs-consumer 14.2.0 → 14.2.1-canary.2

package/CHANGELOG.md

@@ -1,35 +1,9 @@
-## [14.2.0](https://github.com/bbc/sqs-consumer/compare/v14.1.0...v14.2.0) (2025-12-12)
-
-### Features
-
-* Preserve AWSError as cause when rethrowing as SQSError ([#662](https://github.com/bbc/sqs-consumer/issues/662)) ([be74bda](https://github.com/bbc/sqs-consumer/commit/be74bda07b04397643adb8bfe519fcb81b049e34))
+## [14.2.1-canary.2](https://github.com/bbc/sqs-consumer/compare/v14.2.1-canary.1...v14.2.1-canary.2) (2025-12-15)
 
 ### Chores
 
-* add issues write permission ([7aeb319](https://github.com/bbc/sqs-consumer/commit/7aeb3194588a525489a94a1284304b4911d24a0b))
-* audit signatures before release ([131e3ad](https://github.com/bbc/sqs-consumer/commit/131e3add701ef4adc775da6c4b5e6202dc1b0724))
-* **deps-dev:** bump @types/node from 24.6.2 to 24.8.0 ([#634](https://github.com/bbc/sqs-consumer/issues/634)) ([e8d8202](https://github.com/bbc/sqs-consumer/commit/e8d8202f0fcc3943e0da32ea8efce8b815d40864))
-* **deps-dev:** bump @types/node from 24.8.0 to 24.9.1 ([#641](https://github.com/bbc/sqs-consumer/issues/641)) ([c97f3a3](https://github.com/bbc/sqs-consumer/commit/c97f3a30edc6e601946e627fb3aec149a0649a57))
-* **deps-dev:** bump @typescript-eslint/eslint-plugin ([#637](https://github.com/bbc/sqs-consumer/issues/637)) ([8cd58c5](https://github.com/bbc/sqs-consumer/commit/8cd58c51d064cb6905d552f87109a6cfb48dc3cf))
-* **deps-dev:** bump @typescript-eslint/eslint-plugin ([#645](https://github.com/bbc/sqs-consumer/issues/645)) ([d0b8784](https://github.com/bbc/sqs-consumer/commit/d0b87840920f2be837015eb6d8dc13874e804bf8))
-* **deps-dev:** bump eslint from 9.36.0 to 9.37.0 ([#631](https://github.com/bbc/sqs-consumer/issues/631)) ([ad1bf72](https://github.com/bbc/sqs-consumer/commit/ad1bf72bad55838c0ca264d2797cfd9bb3830c72))
-* **deps-dev:** bump eslint from 9.37.0 to 9.38.0 ([#642](https://github.com/bbc/sqs-consumer/issues/642)) ([f686c45](https://github.com/bbc/sqs-consumer/commit/f686c45132a003551dc949ca2196d88b1bd5bf79))
-* **deps-dev:** bump js-yaml ([#660](https://github.com/bbc/sqs-consumer/issues/660)) ([dbded25](https://github.com/bbc/sqs-consumer/commit/dbded25e5b38b2a1702c197d978eb9130aafc775))
-* **deps-dev:** bump typedoc from 0.28.13 to 0.28.14 ([#643](https://github.com/bbc/sqs-consumer/issues/643)) ([ff04703](https://github.com/bbc/sqs-consumer/commit/ff0470391dc221e03e6af0eb1925c73e0f367580))
-* **deps:** bump @aws-sdk/client-sqs from 3.901.0 to 3.911.0 ([#636](https://github.com/bbc/sqs-consumer/issues/636)) ([fe33548](https://github.com/bbc/sqs-consumer/commit/fe3354839219b24acb21adad857c212c1ca1409b))
-* **deps:** bump actions/checkout from 5.0.0 to 6.0.1 ([#658](https://github.com/bbc/sqs-consumer/issues/658)) ([7437eb6](https://github.com/bbc/sqs-consumer/commit/7437eb69bcd849a16b7af16baa6ee834428f35f6))
-* **deps:** bump actions/dependency-review-action from 4.8.1 to 4.8.2 ([#646](https://github.com/bbc/sqs-consumer/issues/646)) ([a68e32e](https://github.com/bbc/sqs-consumer/commit/a68e32e14dd7f03f8919fc8c8dd48a027e149513))
-* **deps:** bump actions/setup-node from 5.0.0 to 6.0.0 ([#627](https://github.com/bbc/sqs-consumer/issues/627)) ([f000859](https://github.com/bbc/sqs-consumer/commit/f0008594886d2e0adfe5277691f2077307ae18a9))
-* **deps:** bump actions/setup-node from 6.0.0 to 6.1.0 ([#661](https://github.com/bbc/sqs-consumer/issues/661)) ([3d1cd30](https://github.com/bbc/sqs-consumer/commit/3d1cd3082da74386945e9f128c01202c3ccaeab8))
-* **deps:** bump actions/stale from 10.1.0 to 10.1.1 ([#659](https://github.com/bbc/sqs-consumer/issues/659)) ([437d1eb](https://github.com/bbc/sqs-consumer/commit/437d1eb2fbb748e3850bf795d45e065d607019de))
-* **deps:** bump actions/upload-artifact from 4.6.2 to 5.0.0 ([#638](https://github.com/bbc/sqs-consumer/issues/638)) ([618911c](https://github.com/bbc/sqs-consumer/commit/618911cc71db194c6c6040da66851022dcae1489))
-* **deps:** bump dorny/test-reporter from 2.1.1 to 2.3.0 ([#656](https://github.com/bbc/sqs-consumer/issues/656)) ([c981884](https://github.com/bbc/sqs-consumer/commit/c9818847f25d9a6739c0dcf93714357ecfb8549c))
-* **deps:** bump github/codeql-action from 4.30.8 to 4.31.2 ([#640](https://github.com/bbc/sqs-consumer/issues/640)) ([6eb9c12](https://github.com/bbc/sqs-consumer/commit/6eb9c12ccf0081bcf32412e48a07fd6afc520d9e))
-* **deps:** bump github/codeql-action from 4.31.2 to 4.31.6 ([#657](https://github.com/bbc/sqs-consumer/issues/657)) ([e671dfd](https://github.com/bbc/sqs-consumer/commit/e671dfd41a1bdc16c995b0d6ce3fd15c82c1e750))
-* **deps:** bump the npm_and_yarn group across 1 directory with 1 update ([#651](https://github.com/bbc/sqs-consumer/issues/651)) ([dbd969f](https://github.com/bbc/sqs-consumer/commit/dbd969fec2b9d0d43909383e072739e6bfc01f5c))
-* trying a different permissions placement ([c951306](https://github.com/bbc/sqs-consumer/commit/c951306636c23759e7f3168d3b888f32bbb31f5d))
-* undoing change ([7ff35d2](https://github.com/bbc/sqs-consumer/commit/7ff35d2d2ce43dfe000b772388fcf096ec73a5ac))
-* update brace-expansion ([6b4d508](https://github.com/bbc/sqs-consumer/commit/6b4d508ef83fdfbe49498f38e67d81a1602cd469))
-* update npx commands ([f4c195c](https://github.com/bbc/sqs-consumer/commit/f4c195c43bf43dc03cff9bb5514d5c0e63e7ef86))
-* update package version ([62a5d6c](https://github.com/bbc/sqs-consumer/commit/62a5d6c109ad49f736952a681e7de514d426d7df))
-* whoops we don't use pnpm yet ([aeed6e6](https://github.com/bbc/sqs-consumer/commit/aeed6e6d3e8bfae457cd4fa3c4854b569cb7f78d))
+* **deps-dev:** bump p-event from 7.0.0 to 7.0.1 ([#668](https://github.com/bbc/sqs-consumer/issues/668)) ([9a95442](https://github.com/bbc/sqs-consumer/commit/9a9544206ac0c2a1fc5f6512d7f84b2031b8f580))
+* **deps:** bump actions/upload-artifact from 5.0.0 to 6.0.0 ([#671](https://github.com/bbc/sqs-consumer/issues/671)) ([cd8a729](https://github.com/bbc/sqs-consumer/commit/cd8a72903073ffdeabdcb620e93d9e3c2fce1a14))
+* **deps:** bump dessant/lock-threads from 5.0.1 to 6.0.0 ([#670](https://github.com/bbc/sqs-consumer/issues/670)) ([42f4f81](https://github.com/bbc/sqs-consumer/commit/42f4f81798ef53b1beb0c744d66781228e9b3c07))
+* **deps:** bump github/codeql-action from 4.31.7 to 4.31.8 ([#669](https://github.com/bbc/sqs-consumer/issues/669)) ([afdbb9f](https://github.com/bbc/sqs-consumer/commit/afdbb9fc35f15a8d80c54702e2219631f0b5fda0))
+* **deps:** bump zgosalvez/github-actions-report-lcov ([#672](https://github.com/bbc/sqs-consumer/issues/672)) ([54d336a](https://github.com/bbc/sqs-consumer/commit/54d336ab360974e8d720164c6c994e6ed044473a))

package/README.md

@@ -136,6 +136,50 @@ By default, the value of `abort` is set to `false` which means pre existing requ
 
 `consumer.stop({ abort: true })`
 
+#### Graceful shutdowns
+
+Calling `consumer.stop()` on its own only prevents new polls from being scheduled. The consumer will emit `stopped` immediately, even if the current long poll or message handler is still running. To wait for the final poll plus any in-flight message processing to finish, set `pollingCompleteWaitTimeMs` to the maximum amount of time you are willing to wait.
+
+- While waiting, the consumer emits `waiting_for_polling_to_complete` every second.
+- If the timeout elapses first, `waiting_for_polling_to_complete_timeout_exceeded` fires right before `stopped`.
+- For graceful shutdowns keep `abort: false` (the default). Passing `abort: true` cancels the shared `AbortController`, which halts heartbeat extensions and prevents acknowledgements/deletions from finishing.
+
+Here's an example of a graceful shutdown implementation:
+
+```js
+const consumer = Consumer.create({
+  queueUrl: "https://sqs.eu-west-1.amazonaws.com/account-id/queue-name",
+  handleMessage: async (message) => {
+    await doWork(message);
+    return message;
+  },
+  pollingCompleteWaitTimeMs: 10_000, // This will allow up to 10s for the last poll + handler
+});
+
+const shutdown = (signal) => {
+  console.log(`Received ${signal}, waiting for in-flight work...`);
+  consumer.stop();
+
+  consumer.once("waiting_for_polling_to_complete", () => {
+    console.log("Still processing in-flight messages...");
+  });
+
+  consumer.once("waiting_for_polling_to_complete_timeout_exceeded", () => {
+    console.warn("Graceful shutdown timed out, continuing shutdown anyway.");
+  });
+
+  consumer.once("stopped", () => {
+    console.log("Consumer stopped cleanly");
+    process.exit(0);
+  });
+};
+
+process.once("SIGINT", shutdown);
+process.once("SIGTERM", shutdown);
+
+consumer.start();
+```
+
 ### `consumer.status`
 
 Returns the current status of the consumer.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "14.2.0",
+  "version": "14.2.1-canary.2",
   "description": "Build SQS-based Node applications without the boilerplate",
   "type": "module",
   "main": "dist/cjs/index.js",
@@ -171,7 +171,7 @@
     "eslint-config-eslint": "^13.0.0",
     "jsr": "^0.13.5",
     "mocha": "^11.7.4",
-    "p-event": "^7.0.0",
+    "p-event": "^7.0.1",
     "prettier": "^3.6.2",
     "semantic-release": "^25.0.2",
     "sinon": "^21.0.0",