@amqp-contract/worker 0.24.0 → 0.25.0

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { extractConsumer, extractQueue, isQueueWithTtlBackoffInfrastructure } from "@amqp-contract/contract";
-import { AmqpClient, MessageValidationError, TechnicalError, defaultTelemetryProvider, endSpanError, endSpanSuccess, recordConsumeMetric, startConsumeSpan } from "@amqp-contract/core";
-import { Result, ResultAsync, err, errAsync, ok, okAsync } from "neverthrow";
+import { AmqpClient, MessageValidationError, TechnicalError, defaultTelemetryProvider, endSpanError, endSpanSuccess, recordConsumeMetric, safeJsonParse, startConsumeSpan } from "@amqp-contract/core";
+import { ResultAsync, err, errAsync, ok, okAsync } from "neverthrow";
 import { gunzip, inflate } from "node:zlib";
 import { promisify } from "node:util";
 //#region src/decompression.ts
@@ -37,36 +37,39 @@ function decompressBuffer(buffer, contentEncoding) {
 //#endregion
 //#region src/errors.ts
 /**
-* Retryable errors - transient failures that may succeed on retry
-* Examples: network timeouts, rate limiting, temporary service unavailability
+* Abstract base class for all handler-signalled errors.
 *
-* Use this error type when the operation might succeed if retried.
-* The worker will apply exponential backoff and retry the message.
+* Concrete subclasses (`RetryableError`, `NonRetryableError`) discriminate on
+* the `name` property so exhaustive narrowing in user code keeps working.
+* `error instanceof HandlerError` is true for any handler error.
 */
-var RetryableError = class extends Error {
+var HandlerError = class extends Error {
 	constructor(message, cause) {
 		super(message);
 		this.cause = cause;
-		this.name = "RetryableError";
 		const ErrorConstructor = Error;
 		if (typeof ErrorConstructor.captureStackTrace === "function") ErrorConstructor.captureStackTrace(this, this.constructor);
 	}
 };
 /**
+* Retryable errors - transient failures that may succeed on retry
+* Examples: network timeouts, rate limiting, temporary service unavailability
+*
+* Use this error type when the operation might succeed if retried.
+* The worker will apply exponential backoff and retry the message.
+*/
+var RetryableError = class extends HandlerError {
+	name = "RetryableError";
+};
+/**
 * Non-retryable errors - permanent failures that should not be retried
 * Examples: invalid data, business rule violations, permanent external failures
 *
 * Use this error type when retrying would not help - the message will be
 * immediately sent to the dead letter queue (DLQ) if configured.
 */
-var NonRetryableError = class extends Error {
-	constructor(message, cause) {
-		super(message);
-		this.cause = cause;
-		this.name = "NonRetryableError";
-		const ErrorConstructor = Error;
-		if (typeof ErrorConstructor.captureStackTrace === "function") ErrorConstructor.captureStackTrace(this, this.constructor);
-	}
+var NonRetryableError = class extends HandlerError {
+	name = "NonRetryableError";
 };
 /**
 * Type guard to check if an error is a RetryableError.
@@ -137,7 +140,7 @@ function isNonRetryableError(error) {
 * ```
 */
 function isHandlerError(error) {
-	return isRetryableError(error) || isNonRetryableError(error);
+	return error instanceof HandlerError;
 }
 /**
 * Create a RetryableError with less verbosity.
@@ -218,20 +221,15 @@ function nonRetryable(message, cause) {
 */
 function handleError(ctx, error, msg, consumerName, consumer) {
 	if (error instanceof NonRetryableError) {
-		ctx.logger?.error("Non-retryable error, sending to DLQ immediately", {
-			consumerName,
-			errorType: error.name,
-			error: error.message
-		});
 		sendToDLQ(ctx, msg, consumer);
 		return okAsync(void 0);
 	}
 	const config = extractQueue(consumer.queue).retry;
 	if (config.mode === "immediate-requeue") return handleErrorImmediateRequeue(ctx, error, msg, consumerName, consumer, config);
 	if (config.mode === "ttl-backoff") return handleErrorTtlBackoff(ctx, error, msg, consumerName, consumer, config);
-	ctx.logger?.warn("Retry disabled (none mode), sending to DLQ", {
+	ctx.logger?.info("Retry disabled (none mode), sending to DLQ", {
 		consumerName,
-		error: error.message
+		queueName: extractQueue(consumer.queue).name
 	});
 	sendToDLQ(ctx, msg, consumer);
 	return okAsync(void 0);
@@ -250,22 +248,20 @@ function handleErrorImmediateRequeue(ctx, error, msg, consumerName, consumer, co
 	const queueName = queue.name;
 	const retryCount = queue.type === "quorum" ? msg.properties.headers?.["x-delivery-count"] ?? 0 : msg.properties.headers?.["x-retry-count"] ?? 0;
 	if (retryCount >= config.maxRetries) {
-		ctx.logger?.error("Max retries exceeded, sending to DLQ (immediate-requeue mode)", {
+		ctx.logger?.info("Max retries exceeded, sending to DLQ (immediate-requeue mode)", {
 			consumerName,
 			queueName,
 			retryCount,
-			maxRetries: config.maxRetries,
-			error: error.message
+			maxRetries: config.maxRetries
 		});
 		sendToDLQ(ctx, msg, consumer);
 		return okAsync(void 0);
 	}
-	ctx.logger?.warn("Retrying message (immediate-requeue mode)", {
+	ctx.logger?.info("Retrying message (immediate-requeue mode)", {
 		consumerName,
 		queueName,
 		retryCount,
-		maxRetries: config.maxRetries,
-		error: error.message
+		maxRetries: config.maxRetries
 	});
 	if (queue.type === "quorum") {
 		ctx.amqpClient.nack(msg, false, true);
@@ -316,24 +312,22 @@ function handleErrorTtlBackoff(ctx, error, msg, consumerName, consumer, config)
 	const queueName = extractQueue(queueEntry).name;
 	const retryCount = msg.properties.headers?.["x-retry-count"] ?? 0;
 	if (retryCount >= config.maxRetries) {
-		ctx.logger?.error("Max retries exceeded, sending to DLQ (ttl-backoff mode)", {
+		ctx.logger?.info("Max retries exceeded, sending to DLQ (ttl-backoff mode)", {
 			consumerName,
 			queueName,
 			retryCount,
-			maxRetries: config.maxRetries,
-			error: error.message
+			maxRetries: config.maxRetries
 		});
 		sendToDLQ(ctx, msg, consumer);
 		return okAsync(void 0);
 	}
 	const delayMs = calculateRetryDelay(retryCount, config);
-	ctx.logger?.warn("Retrying message (ttl-backoff mode)", {
+	ctx.logger?.info("Retrying message (ttl-backoff mode)", {
 		consumerName,
 		queueName,
 		retryCount: retryCount + 1,
 		maxRetries: config.maxRetries,
-		delayMs,
-		error: error.message
+		delayMs
 	});
 	return publishForRetry(ctx, {
 		msg,
@@ -350,9 +344,9 @@ function handleErrorTtlBackoff(ctx, error, msg, consumerName, consumer, config)
 */
 function calculateRetryDelay(retryCount, config) {
 	const { initialDelayMs, maxDelayMs, backoffMultiplier, jitter } = config;
-	let delay = Math.min(initialDelayMs * Math.pow(backoffMultiplier, retryCount), maxDelayMs);
-	if (jitter) delay = delay * (.5 + Math.random() * .5);
-	return Math.floor(delay);
+	let delay = initialDelayMs * Math.pow(backoffMultiplier, retryCount);
+	if (jitter) delay = delay * (.5 + Math.random());
+	return Math.floor(Math.min(delay, maxDelayMs));
 }
 /**
 * Parse message content for republishing.
@@ -384,7 +378,6 @@ function parseMessageContentForRetry(ctx, msg, queueName) {
 */
 function publishForRetry(ctx, { msg, exchange, routingKey, queueName, waitQueueName, delayMs, error }) {
 	const newRetryCount = (msg.properties.headers?.["x-retry-count"] ?? 0) + 1;
-	ctx.amqpClient.ack(msg);
 	const content = parseMessageContentForRetry(ctx, msg, queueName);
 	return ctx.amqpClient.publish(exchange, routingKey, content, {
 		...msg.properties,
@@ -408,12 +401,21 @@ function publishForRetry(ctx, { msg, exchange, routingKey, queueName, waitQueueN
 			});
 			return err(new TechnicalError("Failed to publish message for retry (write buffer full)"));
 		}
+		ctx.amqpClient.ack(msg);
 		ctx.logger?.info("Message published for retry", {
 			queueName,
 			retryCount: newRetryCount,
 			...delayMs !== void 0 ? { delayMs } : {}
 		});
 		return ok(void 0);
+	}).orElse((publishError) => {
+		ctx.logger?.error("Publish for retry failed; leaving original un-ack'd for redelivery", {
+			queueName,
+			retryCount: newRetryCount,
+			...delayMs !== void 0 ? { delayMs } : {},
+			error: publishError
+		});
+		return err(publishError);
 	});
 }
 /**
@@ -652,7 +654,7 @@ var TypedAmqpWorker = class TypedAmqpWorker {
 	*/
 	parseAndValidateMessage(msg, consumer, consumerName) {
 		const context = { consumerName: String(consumerName) };
-		const parsePayload = decompressBuffer(msg.content, msg.properties.contentEncoding).andThen((buffer) => Result.fromThrowable(() => JSON.parse(buffer.toString()), (error) => new TechnicalError("Failed to parse JSON", error))()).andThen((parsed) => this.validateSchema(consumer.message.payload, parsed, {
+		const parsePayload = decompressBuffer(msg.content, msg.properties.contentEncoding).andThen((buffer) => safeJsonParse(buffer, (error) => new TechnicalError("Failed to parse JSON", error))).andThen((parsed) => this.validateSchema(consumer.message.payload, parsed, {
 			...context,
 			field: "payload"
 		}));
@@ -718,66 +720,110 @@ var TypedAmqpWorker = class TypedAmqpWorker {
 		}).mapErr((error) => new NonRetryableError("Failed to publish RPC response", error)).andThen((published) => published ? ok(void 0) : err(new NonRetryableError("Failed to publish RPC response: channel buffer full"))));
 	}
 	/**
+	* Parse and validate the message; on failure, nack(requeue=false) so the
+	* queue's DLX (if configured) receives the poison message and bypass the
+	* retry pipeline — a malformed payload is deterministic and retrying it
+	* would burn the queue's retry budget on a guaranteed failure.
+	*/
+	parseAndValidateOrNack(msg, consumer, name) {
+		return this.parseAndValidateMessage(msg, consumer, name).orElse((parseError) => {
+			this.amqpClient.nack(msg, false, false);
+			return errAsync(parseError);
+		});
+	}
+	/**
+	* Invoke the handler and ack the message on success. Returns the handler's
+	* response (RPC) or `undefined` (regular consumer). Errors propagate as
+	* `HandlerError` for downstream RPC reply publishing or routing via
+	* {@link handleError}.
+	*/
+	runHandler(handler, validatedMessage, msg) {
+		return handler(validatedMessage, msg);
+	}
+	/**
+	* For RPC handlers, validate and publish the reply on the caller's
+	* `replyTo` / `correlationId`. For non-RPC consumers, this is a no-op that
+	* resolves to `okAsync(undefined)`.
+	*/
+	publishReplyIfRpc(msg, view, name, handlerResponse) {
+		if (!view.isRpc || !view.responseSchema) return okAsync(void 0);
+		const queueName = extractQueue(view.consumer.queue).name;
+		return this.publishRpcResponse(msg, queueName, name, view.responseSchema, handlerResponse);
+	}
+	/**
 	* Process a single consumed message: validate, invoke handler, optionally
-	* publish the RPC response, record telemetry, and handle errors.
+	* publish the RPC response, record telemetry, and route errors.
+	*
+	* The caller-supplied `state` is mutated as the message is ack'd/nack'd so
+	* the consume callback's catch-all guard can tell whether a defensive nack
+	* is still needed (see {@link consumeSingle}).
+	*
+	* Success-vs-failure telemetry is data-driven: the chain resolves to
+	* `ok(undefined)` only on handler success (and reply-publish success for
+	* RPC). Handler failures — even when {@link handleError} routes them
+	* successfully to retry/DLQ — are classified as failures for metrics by
+	* re-failing the chain with a `TechnicalError` whose `cause` is the
+	* original `HandlerError`. The terminal `orTee` unwraps the cause before
+	* recording the span exception so traces keep the original
+	* `RetryableError` / `NonRetryableError` class as the exception type.
 	*/
-	processMessage(msg, view, name, handler) {
-		const { consumer, isRpc, responseSchema } = view;
+	processMessage(msg, view, name, handler, state) {
+		const { consumer } = view;
 		const queueName = extractQueue(consumer.queue).name;
 		const startTime = Date.now();
 		const span = startConsumeSpan(this.telemetry, queueName, String(name), { "messaging.rabbitmq.message.delivery_tag": msg.fields.deliveryTag });
-		let messageHandled = false;
-		let firstError;
-		const inner = this.parseAndValidateMessage(msg, consumer, name).orElse((parseError) => {
-			firstError = parseError;
+		return this.parseAndValidateOrNack(msg, consumer, name).orTee((parseError) => {
 			this.logger?.error("Failed to parse/validate message; sending to DLQ", {
 				consumerName: String(name),
 				queueName,
 				error: parseError
 			});
-			this.amqpClient.nack(msg, false, false);
-			return errAsync(parseError);
-		}).andThen((validatedMessage) => handler(validatedMessage, msg).andThen((handlerResponse) => {
-			if (isRpc && responseSchema) return this.publishRpcResponse(msg, queueName, name, responseSchema, handlerResponse).map(() => {
-				this.logger?.info("Message consumed successfully", {
-					consumerName: String(name),
-					queueName
-				});
-				this.amqpClient.ack(msg);
-				messageHandled = true;
-			});
+			state.messageHandled = true;
+		}).andThen((validatedMessage) => this.runHandler(handler, validatedMessage, msg).andThen((handlerResponse) => this.publishReplyIfRpc(msg, view, name, handlerResponse).andTee(() => {
 			this.logger?.info("Message consumed successfully", {
 				consumerName: String(name),
 				queueName
 			});
 			this.amqpClient.ack(msg);
-			messageHandled = true;
-			return okAsync(void 0);
-		}).orElse((handlerError) => {
+			state.messageHandled = true;
+		})).orElse((handlerError) => {
 			this.logger?.error("Error processing message", {
 				consumerName: String(name),
 				queueName,
 				errorType: handlerError.name,
+				retryCount: msg.properties.headers?.["x-delivery-count"] ?? msg.properties.headers?.["x-retry-count"] ?? 0,
 				error: handlerError.message
 			});
-			firstError = handlerError;
 			return handleError({
 				amqpClient: this.amqpClient,
 				logger: this.logger
-			}, handlerError, msg, String(name), consumer);
-		}));
-		return new ResultAsync((async () => {
-			const result = await inner;
-			const durationMs = Date.now() - startTime;
-			if (messageHandled) {
+			}, handlerError, msg, String(name), consumer).andTee(() => {
+				state.messageHandled = true;
+			}).andThen(() => errAsync(new TechnicalError(`Handler "${String(name)}" failed: ${handlerError.message}`, handlerError)));
+		})).andTee(() => {
+			try {
 				endSpanSuccess(span);
-				recordConsumeMetric(this.telemetry, queueName, String(name), true, durationMs);
-			} else {
-				endSpanError(span, result.isErr() ? result.error : firstError ?? /* @__PURE__ */ new Error("Unknown error"));
-				recordConsumeMetric(this.telemetry, queueName, String(name), false, durationMs);
+				recordConsumeMetric(this.telemetry, queueName, String(name), true, Date.now() - startTime);
+			} catch (telemetryError) {
+				this.logger?.warn("Telemetry recording threw; ignoring", {
+					consumerName: String(name),
+					queueName,
+					error: telemetryError
+				});
 			}
-			return result;
-		})());
+		}).orTee((error) => {
+			const reportedError = error.cause instanceof Error ? error.cause : error;
+			try {
+				endSpanError(span, reportedError);
+				recordConsumeMetric(this.telemetry, queueName, String(name), false, Date.now() - startTime);
+			} catch (telemetryError) {
+				this.logger?.warn("Telemetry recording threw; ignoring", {
+					consumerName: String(name),
+					queueName,
+					error: telemetryError
+				});
+			}
+		});
 	}
 	/**
 	* Consume messages one at a time.
@@ -792,9 +838,18 @@ var TypedAmqpWorker = class TypedAmqpWorker {
 				});
 				return;
 			}
+			const state = { messageHandled: false };
 			try {
-				await this.processMessage(msg, view, name, handler);
+				await this.processMessage(msg, view, name, handler, state);
 			} catch (error) {
+				if (state.messageHandled) {
+					this.logger?.error("Uncaught error in consume callback after message was already handled; not nacking", {
+						consumerName: String(name),
+						queueName,
+						error
+					});
+					return;
+				}
 				this.logger?.error("Uncaught error in consume callback; nacking message", {
 					consumerName: String(name),
 					queueName,
@@ -810,46 +865,61 @@ var TypedAmqpWorker = class TypedAmqpWorker {
 //#endregion
 //#region src/handlers.ts
 /**
-* Validate that a consumer exists in the contract
+* Build the list of available handler-target names — every key under
+* `contract.consumers` plus every key under `contract.rpcs`.
 */
-function validateConsumerExists(contract, consumerName) {
+function availableHandlerNames(contract) {
+	const consumers = contract.consumers ? Object.keys(contract.consumers) : [];
+	const rpcs = contract.rpcs ? Object.keys(contract.rpcs) : [];
+	return [...consumers, ...rpcs];
+}
+function formatAvailable(names) {
+	return names.length > 0 ? names.join(", ") : "none";
+}
+/**
+* Validate that a name maps to a contract entry — either a `consumers` key
+* or an `rpcs` key. The two name spaces are disjoint by contract definition.
+*/
+function validateHandlerTargetExists(contract, name) {
 	const consumers = contract.consumers;
-	if (!consumers || !(consumerName in consumers)) {
-		const availableConsumers = consumers ? Object.keys(consumers) : [];
-		const available = availableConsumers.length > 0 ? availableConsumers.join(", ") : "none";
-		throw new Error(`Consumer "${consumerName}" not found in contract. Available consumers: ${available}`);
+	const rpcs = contract.rpcs;
+	if (!(!!consumers && Object.hasOwn(consumers, name)) && !(!!rpcs && Object.hasOwn(rpcs, name))) {
+		const available = formatAvailable(availableHandlerNames(contract));
+		throw new Error(`Handler target "${name}" not found in contract. Available consumers and RPCs: ${available}`);
 	}
 }
 /**
-* Validate that all handlers reference valid consumers
+* Validate that every key in `handlers` maps to a contract entry —
+* either a `consumers` key or an `rpcs` key.
 */
 function validateHandlers(contract, handlers) {
-	const consumers = contract.consumers;
-	const availableConsumers = Object.keys(consumers ?? {});
-	const availableConsumerNames = availableConsumers.length > 0 ? availableConsumers.join(", ") : "none";
-	for (const handlerName of Object.keys(handlers)) if (!consumers || !(handlerName in consumers)) throw new Error(`Consumer "${handlerName}" not found in contract. Available consumers: ${availableConsumerNames}`);
+	for (const handlerName of Object.keys(handlers)) validateHandlerTargetExists(contract, handlerName);
 }
-function defineHandler(contract, consumerName, handler, options) {
-	validateConsumerExists(contract, String(consumerName));
+function defineHandler(contract, name, handler, options) {
+	validateHandlerTargetExists(contract, String(name));
 	if (options) return [handler, options];
 	return handler;
 }
 /**
-* Define multiple type-safe handlers for consumers in a contract.
+* Define multiple type-safe handlers for consumers and RPCs in a contract.
 *
-* **Recommended:** This function creates handlers that return `ResultAsync<void, HandlerError>`,
-* providing explicit error handling and better control over retry behavior.
+* **Recommended:** This function creates handlers that return
+* `ResultAsync<void, HandlerError>` (consumers) or
+* `ResultAsync<TResponse, HandlerError>` (RPCs), providing explicit error
+* handling and better control over retry behavior.
+*
+* The handlers object must contain exactly one entry per `consumers` and
+* `rpcs` key in the contract — see {@link WorkerInferHandlers}.
 *
 * @template TContract - The contract definition type
-* @param contract - The contract definition containing the consumers
-* @param handlers - An object with handler functions for each consumer
+* @param contract - The contract definition containing the consumers and RPCs
+* @param handlers - An object with handler functions for each consumer and RPC
 * @returns A type-safe handlers object that can be used with TypedAmqpWorker
 *
 * @example
 * ```typescript
 * import { defineHandlers, RetryableError } from '@amqp-contract/worker';
-* import { ResultAsync } from 'neverthrow';
-* import { orderContract } from './contract';
+* import { okAsync, ResultAsync } from 'neverthrow';
 *
 * const handlers = defineHandlers(orderContract, {
 *   processOrder: ({ payload }) =>
@@ -857,11 +927,7 @@ function defineHandler(contract, consumerName, handler, options) {
 *       processPayment(payload),
 *       (error) => new RetryableError('Payment failed', error),
 *     ).map(() => undefined),
-*   notifyOrder: ({ payload }) =>
-*     ResultAsync.fromPromise(
-*       sendNotification(payload),
-*       (error) => new RetryableError('Notification failed', error),
-*     ).map(() => undefined),
+*   calculate: ({ payload }) => okAsync({ sum: payload.a + payload.b }),
 * });
 * ```
 */
@@ -870,6 +936,6 @@ function defineHandlers(contract, handlers) {
 	return handlers;
 }
 //#endregion
-export { MessageValidationError, NonRetryableError, RetryableError, TypedAmqpWorker, defineHandler, defineHandlers, isHandlerError, isNonRetryableError, isRetryableError, nonRetryable, retryable };
+export { HandlerError, MessageValidationError, NonRetryableError, RetryableError, TypedAmqpWorker, defineHandler, defineHandlers, isHandlerError, isNonRetryableError, isRetryableError, nonRetryable, retryable };
 
 //# sourceMappingURL=index.mjs.map