@remit/sqs-client 0.0.14 → 0.0.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/sqs-client",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "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

@@ -231,7 +231,8 @@ const pollTarget = async (
 };
 
 /**
- * received (default: SIGINT, SIGTERM). The signal aborts each loop's in-flight
+ * Runs every target's poll loop until one of `signals` is received (default:
+ * SIGINT, SIGTERM). The signal aborts each loop's in-flight
  * long-poll receive so an idle worker returns at once instead of waiting out
  * the current 20s poll; a loop mid-handler finishes that handler first. Rejects
  * (crashes the process) if any loop throws — a stuck poller should exit loudly,

package/src/producer.test.ts

@@ -1,6 +1,8 @@
 import assert from "node:assert/strict";
+import { createServer } from "node:http";
+import type { AddressInfo } from "node:net";
 import { describe, it } from "node:test";
-import type { SQSClient } from "@aws-sdk/client-sqs";
+import { ReceiveMessageCommand, type SQSClient } from "@aws-sdk/client-sqs";
 import { AwsQueryProtocol } from "@aws-sdk/core/protocols";
 import { createQueueProducer, isLocalEndpoint } from "./producer.js";
 
@@ -148,3 +150,30 @@ describe("createQueueProducer", () => {
 		assert.equal((await remote.config.credentials()).accessKeyId, "real");
 	});
 });
+
+describe("createQueueProducer request timeout", () => {
+	it("fails a receive the queue server never answers", async () => {
+		const server = createServer(() => {});
+		await new Promise<void>((resolve) => {
+			server.listen(0, "127.0.0.1", resolve);
+		});
+		const { port } = server.address() as AddressInfo;
+		const queueUrl = `http://127.0.0.1:${port}/000000000000/hung`;
+		const client = createQueueProducer({
+			queueUrl,
+			requestTimeoutMs: 100,
+			localCredentials: { accessKeyId: "test", secretAccessKey: "test" },
+		});
+
+		try {
+			await assert.rejects(
+				() => client.send(new ReceiveMessageCommand({ QueueUrl: queueUrl })),
+				{ name: "TimeoutError" },
+			);
+		} finally {
+			client.destroy();
+			server.closeAllConnections();
+			await new Promise<void>((resolve) => server.close(() => resolve()));
+		}
+	});
+});

package/src/producer.ts

@@ -12,8 +12,11 @@ export interface CreateQueueProducerOptions {
 	 * sign with and a self-hosted stack has no credential chain to fall back on.
 	 */
 	readonly localCredentials?: SqsStaticCredentials;
+	readonly requestTimeoutMs?: number;
 }
 
+const DEFAULT_REQUEST_TIMEOUT_MS = 45_000;
+
 const LOOPBACK_HOSTNAMES = new Set(["localhost", "127.0.0.1", "[::1]"]);
 
 /**
@@ -59,8 +62,10 @@ export const createQueueProducer = (
 	options: CreateQueueProducerOptions,
 ): SQSClient => {
 	const { queueUrl, endpoint, env, localCredentials } = options;
+	const requestTimeout = options.requestTimeoutMs ?? DEFAULT_REQUEST_TIMEOUT_MS;
 	const local = isLocalEndpoint(queueUrl);
 	return new SQSClient({
+		requestHandler: { requestTimeout, throwOnRequestTimeout: true },
 		endpoint: endpoint ?? (local ? new URL(queueUrl).origin : undefined),
 		...(local && { protocol: AwsQueryProtocol }),
 		credentials: