@zdavison/matador 4.0.3 → 4.2.0

package/dist/core/matador.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"matador.d.ts","sourceRoot":"","sources":["../../src/core/matador.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAQ/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAKrD,OAAO,KAAK,EAAgB,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,KAAK,EACV,aAAa,EACb,UAAU,EACV,KAAK,EACL,UAAU,EACV,YAAY,EACb,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAGnE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,qCAAqC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B,6BAA6B;IAC7B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,uEAAuE;IACvE,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAE/B,sDAAsD;IACtD,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;IAErD,sCAAsC;IACtC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAEnC,0BAA0B;IAC1B,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAE/C,6BAA6B;IAC7B,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IAE9D;;;;;OAKG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IAEvD;;;;;OAKG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEjD;;;;;OAKG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/C;;;;;;;OAOG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;;;;;;OAQG;IACH,QAAQ,CAAC,2BAA2B,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3D;AAED;;;;;;;;;GASG;AACH,qBAAa,OAAQ,YAAW,UAAU;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IACxB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;IAC9B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAC1C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IACvB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IACxB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC;IACjC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAoB;IAChD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAsB;IACpD,OAAO,CAAC,OAAO,CAAS;IAExB;;;;;;OAMG;gBACS,MAAM,EAAE,aAAa,EAAE,KAAK,CAAC,EAAE,YAAY;IAgDvD;;OAEG;IACH,QAAQ,CAAC,CAAC,EACR,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EACzB,WAAW,EAAE,SAAS,aAAa,EAAE,GACpC,IAAI;IAKP;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI;IAc3C;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAiE5B;;;;;;;;;;;;OAYG;IACG,IAAI,CAAC,CAAC,EACV,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EACzB,IAAI,EAAE,CAAC,EACP,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,UAAU,CAAC;IAChB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC;IAuC3E;;OAEG;IACH,gBAAgB,IAAI,aAAa;IAIjC;;OAEG;IACH,MAAM,IAAI,OAAO;IAIjB;;OAEG;IACG,WAAW,CAAC,SAAS,SAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAatD;;;;;;;;;;;OAWG;IACG,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC;IAQvC;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAU/B;;OAEG;IACH,WAAW,IAAI,OAAO;YAIR,cAAc;CAM7B"}
+{"version":3,"file":"matador.d.ts","sourceRoot":"","sources":["../../src/core/matador.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAQ/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAKrD,OAAO,KAAK,EAAgB,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,KAAK,EACV,aAAa,EACb,UAAU,EACV,KAAK,EACL,UAAU,EACV,YAAY,EACb,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAGnE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,qCAAqC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B,6BAA6B;IAC7B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B,uEAAuE;IACvE,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAE/B,sDAAsD;IACtD,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;IAErD,sCAAsC;IACtC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAEnC,0BAA0B;IAC1B,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAE/C,6BAA6B;IAC7B,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IAE9D;;;;;OAKG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IAEvD;;;;;OAKG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEjD;;;;;OAKG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/C;;;;;;;OAOG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;;;;;;OAQG;IACH,QAAQ,CAAC,2BAA2B,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3D;AAED;;;;;;;;;GASG;AACH,qBAAa,OAAQ,YAAW,UAAU;IACxC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IACxB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;IAC9B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAC1C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IACvB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IACxB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC;IACjC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAoB;IAChD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAsB;IACpD,OAAO,CAAC,OAAO,CAAS;IAExB;;;;;;OAMG;gBACS,MAAM,EAAE,aAAa,EAAE,KAAK,CAAC,EAAE,YAAY;IAgDvD;;OAEG;IACH,QAAQ,CAAC,CAAC,EACR,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EACzB,WAAW,EAAE,SAAS,aAAa,EAAE,GACpC,IAAI;IAKP;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI;IAc3C;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAoE5B;;;;;;;;;;;;OAYG;IACG,IAAI,CAAC,CAAC,EACV,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EACzB,IAAI,EAAE,CAAC,EACP,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,UAAU,CAAC;IAChB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC;IAuC3E;;OAEG;IACH,gBAAgB,IAAI,aAAa;IAIjC;;OAEG;IACH,MAAM,IAAI,OAAO;IAIjB;;OAEG;IACG,WAAW,CAAC,SAAS,SAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAatD;;;;;;;;;;;OAWG;IACG,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC;IAQvC;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAU/B;;OAEG;IACH,WAAW,IAAI,OAAO;YAIR,cAAc;CAM7B"}

package/dist/core/matador.js

@@ -141,6 +141,10 @@ export class Matador {
         else {
             this.hooks.logger.info('[Matador] 🟡 Worker not subscribing to any queues (consumeFrom is empty).');
         }
+        // Mark as started
+        // Needed for the subscribe calls below, as we might start getting messages
+        // that could send events before the code here finishes subscribing to all the queues
+        this.started = true;
         for (const queueName of this.consumeFrom) {
             const qualifiedName = resolveTargetQueueName(this.topology, queueName);
             const queueDef = findQueueDefinition(this.topology, queueName);
@@ -158,7 +162,6 @@ export class Matador {
                 : undefined);
             this.subscriptions.push(subscription);
         }
-        this.started = true;
     }
     async send(eventOrClass, dataOrOptions, maybeOptions) {
         if (!this.started) {

package/dist/index.cjs

@@ -1893,10 +1893,20 @@ var ProcessingPipeline = class {
         durationMs: performance.now() - startTime
       };
     }
+    const isResumable = isResumableSubscriber(subscriber);
+    const shouldProcessResult = await this.handleShouldProcess(
+      envelope,
+      subscriberDef,
+      isResumable,
+      receipt,
+      startTime
+    );
+    if (!shouldProcessResult.success) {
+      return shouldProcessResult;
+    }
     let result;
     let error;
     let context;
-    const isResumable = isResumableSubscriber(subscriber);
     let existingCheckpoint;
     if (isResumable) {
       existingCheckpoint = await this.checkpointStore.get(envelope.id);
@@ -1972,10 +1982,69 @@ var ProcessingPipeline = class {
       subscriber: subscriberDef,
       receipt
     });
+    return await this.handleFailure(
+      error,
+      decision,
+      envelope,
+      subscriberDef,
+      isResumable,
+      receipt,
+      durationMs
+    );
+  }
+  /**
+   * Runs the retry policy's pre-processing check.
+   *
+   * This returns a terminal `ProcessResult` if the message should be skipped (dead-lettered/discarded) without ever invoking the callback,
+   * or a success result if shouldProcess passes and we should continue processing the message.
+   * @param envelope - The message envelope
+   * @param subscriberDef - The subscriber definition
+   * @param isResumable - Whether the subscriber is resumable
+   * @param receipt - The message receipt
+   * @param startTime - The start time of the processing
+   * @returns A `ProcessResult` indicating if we should continue with processing the message, or fail it preemptively
+   */
+  async handleShouldProcess(envelope, subscriberDef, isResumable, receipt, startTime) {
+    const decision = this.retryPolicy.shouldProcess({
+      envelope,
+      subscriber: subscriberDef,
+      receipt
+    });
+    if (decision.action === "process") {
+      return {
+        success: true,
+        durationMs: 0
+      };
+    }
+    const durationMs = performance.now() - startTime;
+    const error = new Error(decision.reason);
+    return await this.handleFailure(
+      error,
+      decision,
+      envelope,
+      subscriberDef,
+      isResumable,
+      receipt,
+      durationMs
+    );
+  }
+  /**
+   * Performs failure handling and cleanup based on retry decision (e.g. dead-letter).
+   *
+   * @param error - The error from the processing attempt
+   * @param decision - The decision from executing the appropriate retry policy check
+   * @param envelope - The message envelope
+   * @param subscriberDef - The subscriber definition
+   * @param isResumable - Whether the subscriber is resumable
+   * @param receipt - The message receipt
+   * @param durationMs - The duration of processing
+   * @returns A `ProcessResult` indicating failure
+   */
+  async handleFailure(error, decision, envelope, subscriberDef, isResumable, receipt, durationMs) {
     envelope.docket.lastError = error.message;
     envelope.docket.firstError ??= error.message;
-    if (decision.action === "dead-letter" && context) {
-      await context.clear();
+    if (decision.action === "dead-letter" && isResumable) {
+      await this.checkpointStore.delete(envelope.id);
       await this.hooks.onCheckpointCleared?.({
         envelope,
         subscriber: subscriberDef,
@@ -2081,15 +2150,46 @@ var StandardRetryPolicy = class {
   constructor(config = {}) {
     this.config = { ...defaultRetryConfig, ...config };
   }
+  /**
+   * Check if the message should be dead-lettered before the subscriber callback is invoked.
+   * This is needed when a subscriber crashes and the `shouldRetry` policy is never executed.
+   *
+   * Uses the same delivery-count threshold as `shouldRetry` poison check, so an
+   * already-poisoned message is dead-lettered without ever running the callback again.
+   *
+   * Checks the subscriber idempotency setting to prevent processing when a previous attempt crashed.
+   *
+   * @param context - The shouldProcess context.
+   * @returns A 'process' decision if subscriber processing should be attempted; a dead-letter decision otherwise.
+   */
+  shouldProcess(context) {
+    const poisonError = this.checkPoisoned(context.envelope, context.receipt);
+    if (poisonError) {
+      return {
+        action: "dead-letter",
+        queue: "undeliverable",
+        reason: poisonError.message
+      };
+    }
+    const idempotencyError = this.checkIdempotency(
+      context.envelope,
+      context.receipt,
+      context.subscriber
+    );
+    if (idempotencyError) {
+      return {
+        action: "dead-letter",
+        queue: "undeliverable",
+        reason: idempotencyError.message
+      };
+    }
+    return { action: "process" };
+  }
   shouldRetry(context) {
     const { envelope, error, subscriber, receipt } = context;
     const errorMessage = error.message;
-    if (receipt.deliveryCount >= this.config.maxDeliveries) {
-      const poisonError = new MessageMaybePoisonedError(
-        envelope.id,
-        receipt.deliveryCount,
-        this.config.maxDeliveries
-      );
+    const poisonError = this.checkPoisoned(envelope, receipt);
+    if (poisonError) {
       return {
         action: "dead-letter",
         queue: "undeliverable",
@@ -2130,15 +2230,17 @@ var StandardRetryPolicy = class {
         reason: `max attempts exceeded (${this.config.maxAttempts})`
       };
     }
-    if (receipt.redelivered && (subscriber.idempotent === "no" || subscriber.idempotent === "unknown")) {
-      const idempotentError = new IdempotentMessageCannotRetryError(
-        envelope.id,
-        subscriber.name
-      );
+    const idempotencyError = this.checkIdempotency(
+      envelope,
+      receipt,
+      subscriber,
+      error
+    );
+    if (idempotencyError) {
       return {
         action: "dead-letter",
         queue: "undeliverable",
-        reason: idempotentError.message
+        reason: idempotencyError.message
       };
     }
     return {
@@ -2151,6 +2253,41 @@ var StandardRetryPolicy = class {
     const delay = this.config.baseDelay * this.config.backoffMultiplier ** (attempt - 1);
     return Math.min(delay, this.config.maxDelay);
   }
+  /**
+   * Checks the native delivery count against the poison threshold
+   *
+   * @param envelope - The message envelope.
+   * @param receipt - The message receipt.
+   * @returns A MessageMaybePoisonedError if the message is poisoned; null otherwise
+   */
+  checkPoisoned(envelope, receipt) {
+    if (receipt.deliveryCount >= this.config.maxDeliveries) {
+      return new MessageMaybePoisonedError(
+        envelope.id,
+        receipt.deliveryCount,
+        this.config.maxDeliveries
+      );
+    }
+    return null;
+  }
+  /**
+   * Checks whether the subscriber allows retries based on its idempotency setting
+   *
+   * @param envelope - The message envelope.
+   * @param receipt - The message receipt.
+   * @param subscriber - The subscriber definition
+   * @param error - The processing error, if it exists
+   * @returns A IdempotentMessageCannotRetryError if the message is poisoned; null otherwise
+   */
+  checkIdempotency(envelope, receipt, subscriber, error) {
+    if ((error || receipt.redelivered) && (subscriber.idempotent === "no" || subscriber.idempotent === "unknown")) {
+      return new IdempotentMessageCannotRetryError(
+        envelope.id,
+        subscriber.name
+      );
+    }
+    return null;
+  }
 };
 
 // src/schema/types.ts
@@ -2461,6 +2598,7 @@ var Matador = class {
         "[Matador] \u{1F7E1} Worker not subscribing to any queues (consumeFrom is empty)."
       );
     }
+    this.started = true;
     for (const queueName of this.consumeFrom) {
       const qualifiedName = resolveTargetQueueName(this.topology, queueName);
       const queueDef = findQueueDefinition(this.topology, queueName);
@@ -2479,7 +2617,6 @@ var Matador = class {
       );
       this.subscriptions.push(subscription);
     }
-    this.started = true;
   }
   async send(eventOrClass, dataOrOptions, maybeOptions) {
     if (!this.started) {
@@ -3626,6 +3763,9 @@ var RabbitMQTransport = class {
     if (queueDef.consumerTimeout) {
       queueOptions.arguments["x-consumer-timeout"] = queueDef.consumerTimeout;
     }
+    if (queueDef.singleActiveConsumer) {
+      queueOptions.arguments["x-single-active-consumer"] = true;
+    }
     return queueOptions;
   }
   async assertWorkQueue(channel, topology, queueDef) {