@remit/sqs-client 0.0.13 → 0.0.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/sqs-client",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",
@@ -9,6 +9,10 @@
       "types": "./src/index.ts",
       "default": "./src/index.ts"
     },
+    "./attempt-budget": {
+      "types": "./src/attempt-budget.ts",
+      "default": "./src/attempt-budget.ts"
+    },
     "./heartbeat": {
       "types": "./src/heartbeat.ts",
       "default": "./src/heartbeat.ts"

package/src/attempt-budget.test.ts

@@ -0,0 +1,58 @@
+import assert from "node:assert/strict";
+import { afterEach, describe, it } from "node:test";
+import { attemptBudget } from "./attempt-budget.js";
+
+describe("attemptBudget", () => {
+	afterEach(() => {
+		delete process.env.EXAMPLE_MAX_ATTEMPTS;
+	});
+
+	it("parses the named env var as a base-10 integer", () => {
+		assert.equal(
+			attemptBudget("EXAMPLE_MAX_ATTEMPTS", 3, {
+				EXAMPLE_MAX_ATTEMPTS: "5",
+			}),
+			5,
+		);
+		assert.equal(
+			attemptBudget("EXAMPLE_MAX_ATTEMPTS", 3, {
+				EXAMPLE_MAX_ATTEMPTS: "10",
+			}),
+			10,
+		);
+	});
+
+	it("reads only the named var, so budgets stay independent", () => {
+		assert.equal(
+			attemptBudget("EXAMPLE_MAX_ATTEMPTS", 3, {
+				OTHER_MAX_ATTEMPTS: "9",
+			}),
+			3,
+		);
+	});
+
+	it("falls back when the var is absent or empty", () => {
+		assert.equal(attemptBudget("EXAMPLE_MAX_ATTEMPTS", 3, {}), 3);
+		assert.equal(
+			attemptBudget("EXAMPLE_MAX_ATTEMPTS", 7, { EXAMPLE_MAX_ATTEMPTS: "" }),
+			7,
+		);
+	});
+
+	it("falls back on a value that is not a positive integer", () => {
+		for (const raw of ["nope", "0", "-1", "NaN", " "]) {
+			assert.equal(
+				attemptBudget("EXAMPLE_MAX_ATTEMPTS", 3, {
+					EXAMPLE_MAX_ATTEMPTS: raw,
+				}),
+				3,
+				`expected ${JSON.stringify(raw)} to fall back`,
+			);
+		}
+	});
+
+	it("reads process.env when no environment is supplied", () => {
+		process.env.EXAMPLE_MAX_ATTEMPTS = "4";
+		assert.equal(attemptBudget("EXAMPLE_MAX_ATTEMPTS", 3), 4);
+	});
+});

package/src/attempt-budget.ts

@@ -0,0 +1,24 @@
+/**
+ * Reads a handler's redelivery budget from the environment. CDK derives every
+ * `*_MAX_ATTEMPTS` var from the corresponding queue's own `MAX_RECEIVE_COUNT`
+ * (`infra/stacks/dev/stacks/remit-queue-stack.ts`, `deploy/vps/queues.json`)
+ * so a worker's idea of "last attempt" cannot drift from the redrive policy
+ * that actually dead-letters the record (issue #1270). SQS's
+ * `ApproximateReceiveCount` is the source of truth for how many times a record
+ * has been delivered; once it reaches this budget the current invocation is
+ * the last attempt, and the handler resolves exhaustion itself instead of
+ * letting the record dead-letter undiagnosed. The fallback keeps an
+ * environment that never injects the var — local dev, unit tests — behaving
+ * like production.
+ */
+export const attemptBudget = (
+	envName: string,
+	fallback: number,
+	processEnv: NodeJS.ProcessEnv = process.env,
+): number => {
+	const raw = processEnv[envName];
+	if (!raw) return fallback;
+	const parsed = Number.parseInt(raw, 10);
+	if (!Number.isFinite(parsed) || parsed <= 0) return fallback;
+	return parsed;
+};

package/src/poller.ts

@@ -61,7 +61,13 @@ export interface RunQueuePollerOptions {
 // the extra receive per message is a millisecond against the local queue
 // sidecar — the same total work either way.
 const DEFAULT_MAX_MESSAGES = 1;
-const DEFAULT_VISIBILITY_TIMEOUT_SECONDS = 300;
+/**
+ * What a handler has before the queue redelivers the record underneath it.
+ * Exported because a handler that budgets its own wait has to agree with it;
+ * `deploy/vps/queues.json` sets the same number on the queue itself, and this
+ * is the one that applies wherever a target passes no override.
+ */
+export const DEFAULT_VISIBILITY_TIMEOUT_SECONDS = 300;
 
 const pollTarget = async (
 	target: QueuePollerTarget,