@fedify/amqp 0.3.0-dev.16 → 0.3.0-dev.17

package/README.md

@@ -30,6 +30,17 @@ const federation = createFederation({
 });
 ~~~~
 
+The `AmqpMessageQueue` constructor accepts options as the second
+parameter, which can be used to configure the message queue:
+
+~~~~ typescript
+new AmqpMessageQueue(await connect("amqp://localhost"), {
+  queue: "my_queue",
+})
+~~~~
+
+For more details, please refer to the docs of [`AmqpMessageQueueOptions`].
+
 [JSR]: https://jsr.io/@fedify/amqp
 [JSR badge]: https://jsr.io/badges/@fedify/amqp
 [npm]: https://www.npmjs.com/package/@fedify/amqp
@@ -41,6 +52,7 @@ const federation = createFederation({
 [`KvStore`]: https://jsr.io/@fedify/fedify/doc/federation/~/KvStore
 [`MessageQueue`]: https://jsr.io/@fedify/fedify/doc/federation/~/MessageQueue
 [`AmqpMessageQueue`]: https://jsr.io/@fedify/amqp/doc/mq/~/AmqpMessageQueue
+[`AmqpMessageQueueOptions`] https://jsr.io/@fedify/amqp/doc/mq/~/AmqpMessageQueueOptions
 
 
 Installation

package/deno.json

@@ -1,14 +1,14 @@
 {
   "name": "@fedify/amqp",
-  "version": "0.3.0-dev.16+bc8a5574",
+  "version": "0.3.0-dev.17+484159bd",
   "license": "MIT",
   "exports": {
     ".": "./mod.ts",
     "./mq": "./src/mq.ts"
   },
   "imports": {
-    "@alinea/suite": "jsr:@alinea/suite@^0.6.2",
-    "@fedify/fedify": "jsr:@fedify/fedify@^1.5.0",
+    "@fedify/fedify": "jsr:@fedify/fedify@^1.7.0-dev.887+013dabb5",
+    "@hongminhee/suite": "jsr:@hongminhee/suite@^0.6.3",
     "@std/assert": "jsr:@std/assert@^1.0.13",
     "@std/async": "jsr:@std/async@^1.0.13",
     "amqplib": "npm:amqplib@^0.10.8",

package/deno.lock

@@ -1,16 +1,16 @@
 {
   "version": "5",
   "specifiers": {
-    "jsr:@alinea/suite@~0.6.2": "0.6.2",
     "jsr:@es-toolkit/es-toolkit@^1.38.0": "1.39.3",
-    "jsr:@fedify/fedify@^1.5.0": "1.6.1",
+    "jsr:@fedify/fedify@^1.7.0-dev.887+013dabb5": "1.7.0-pr.251.885+560fd10f",
+    "jsr:@hongminhee/suite@~0.6.3": "0.6.3",
     "jsr:@hugoalh/http-header-link@^1.0.2": "1.0.3",
     "jsr:@hugoalh/is-string-singleline@^1.0.4": "1.0.5",
     "jsr:@logtape/logtape@0.11": "0.11.0",
     "jsr:@std/assert@^1.0.13": "1.0.13",
     "jsr:@std/async@^1.0.13": "1.0.13",
     "jsr:@std/internal@^1.0.6": "1.0.8",
-    "npm:@alinea/suite@~0.6.2": "0.6.2",
+    "npm:@hongminhee/suite@~0.6.3": "0.6.3",
     "npm:@js-temporal/polyfill@~0.5.1": "0.5.1",
     "npm:@multiformats/base-x@^4.0.1": "4.0.1",
     "npm:@opentelemetry/api@^1.9.0": "1.9.0",
@@ -33,14 +33,11 @@
     "npm:url-template@^3.1.1": "3.1.1"
   },
   "jsr": {
-    "@alinea/suite@0.6.2": {
-      "integrity": "067948595ee65876c3d76ae40fdf6f321a4afab3566da5ca259559490c95da23"
-    },
     "@es-toolkit/es-toolkit@1.39.3": {
       "integrity": "edd98c3eac732730b61bac8952a31633a778a236e1be144aa32b220c152d1fbe"
     },
-    "@fedify/fedify@1.6.1": {
-      "integrity": "e5712a15c50d8836e6ad617aefa69bb601b12ac335526c54a7ffe339b0128e0c",
+    "@fedify/fedify@1.7.0-pr.251.885+560fd10f": {
+      "integrity": "fb60eaac1b902f32bddbc1ea0171b2bf4903345a497d3aff693ea290f1abc585",
       "dependencies": [
         "jsr:@es-toolkit/es-toolkit",
         "jsr:@hugoalh/http-header-link",
@@ -60,6 +57,9 @@
         "npm:url-template"
       ]
     },
+    "@hongminhee/suite@0.6.3": {
+      "integrity": "429be25d44f30525fcc7ee60e4879e8abc2e09ab625d006c5bd0605e9e8e393c"
+    },
     "@hugoalh/http-header-link@1.0.3": {
       "integrity": "3372096a73d755e3351f7fbd7155db7725874c2682a594a655580e3866563024",
       "dependencies": [
@@ -86,9 +86,6 @@
     }
   },
   "npm": {
-    "@alinea/suite@0.6.2": {
-      "integrity": "sha512-UEYs2OLLb5DCMVE/0C8AAhP+xjKdOujbfL+NIXtcCW0dyeQqxjRVVFu+JH5VsjNxkx9ZNgId0fU4HkoKRU49CQ=="
-    },
     "@babel/generator@7.27.5": {
       "integrity": "sha512-ZGhA37l0e/g2s1Cnzdix0O3aLYm66eF8aufiVteOgnwxgnRP8GoyMj7VWsgWnQbVKXyge7hqrFh2K2TQM6t1Hw==",
       "dependencies": [
@@ -149,6 +146,9 @@
     "@fastify/busboy@2.1.1": {
       "integrity": "sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA=="
     },
+    "@hongminhee/suite@0.6.3": {
+      "integrity": "sha512-jW0scPczSP5Mksq49c9stYIApHGijodCFvpKRcFAWImn5WRs4kVlzNwz9QpblaAvoErN8UsfP7OZl3mIk0VoLA=="
+    },
     "@jridgewell/gen-mapping@0.3.8": {
       "integrity": "sha512-imAbBGkb+ebQyxKgzv5Hu2nmROxoDOXHh80evxdoXNOrvAnVx7zimzc1Oo5h9RlfV4vPXaE2iM5pOFbvOCClWA==",
       "dependencies": [
@@ -664,8 +664,8 @@
   },
   "workspace": {
     "dependencies": [
-      "jsr:@alinea/suite@~0.6.2",
-      "jsr:@fedify/fedify@^1.5.0",
+      "jsr:@fedify/fedify@^1.7.0-dev.887+013dabb5",
+      "jsr:@hongminhee/suite@~0.6.3",
       "jsr:@std/assert@^1.0.13",
       "jsr:@std/async@^1.0.13",
       "npm:amqplib@~0.10.8",
@@ -673,7 +673,7 @@
     ],
     "packageJson": {
       "dependencies": [
-        "npm:@alinea/suite@~0.6.2",
+        "npm:@hongminhee/suite@~0.6.3",
         "npm:@js-temporal/polyfill@~0.5.1",
         "npm:@types/amqplib@~0.10.7",
         "npm:tsdown@~0.12.7",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/amqp",
-  "version": "0.3.0-dev.16+bc8a5574",
+  "version": "0.3.0-dev.17+484159bd",
   "description": "AMQP/RabbitMQ driver for Fedify",
   "keywords": [
     "fedify",
@@ -35,8 +35,12 @@
     },
     "./package.json": "./package.json"
   },
+  "peerDependencies": {
+    "@fedify/fedify": "^1.7.0-dev.887",
+    "amqplib": "^0.10.8"
+  },
   "devDependencies": {
-    "@alinea/suite": "^0.6.2",
+    "@hongminhee/suite": "^0.6.3",
     "@js-temporal/polyfill": "^0.5.1",
     "@std/assert": "npm:@jsr/std__assert@^1.0.13",
     "@std/async": "npm:@jsr/std__async@^1.0.13",
@@ -44,10 +48,6 @@
     "tsdown": "^0.12.7",
     "typescript": "^5.8.3"
   },
-  "peerDependencies": {
-    "@fedify/fedify": "^1.5.0",
-    "amqplib": "^0.10.8"
-  },
   "scripts": {
     "build": "tsdown",
     "prepublish": "tsdown",

package/src/mq.test.ts

@@ -1,6 +1,6 @@
-import { suite } from "@alinea/suite";
+import { suite } from "@hongminhee/suite";
 import * as temporal from "@js-temporal/polyfill";
-import { assertEquals, assertGreater } from "@std/assert";
+import { assert, assertEquals, assertFalse, assertGreater } from "@std/assert";
 import { delay } from "@std/async/delay";
 // @deno-types="npm:@types/amqplib"
 import { type ChannelModel, connect } from "amqplib";
@@ -21,13 +21,16 @@ function getConnection(): Promise<ChannelModel> {
   return connect(url ?? "amqp://localhost");
 }
 
-test("AmqpMessageQueue", async () => {
+test("AmqpMessageQueue", {
+  sanitizeOps: false,
+  sanitizeExit: false,
+  sanitizeResources: false,
+}, async () => {
   const conn = await getConnection();
   const conn2 = await getConnection();
-  const queue = `fedify_queue_${Math.random().toString(36).slice(5)}`;
-  const delayedQueuePrefix = `fedify_delayed_${
-    Math.random().toString(36).slice(5)
-  }_`;
+  const randomSuffix = Math.random().toString(36).substring(2);
+  const queue = `fedify_queue_${randomSuffix}`;
+  const delayedQueuePrefix = `fedify_delayed_${randomSuffix}_`;
   const mq = new AmqpMessageQueue(conn, { queue, delayedQueuePrefix });
   const mq2 = new AmqpMessageQueue(conn2, { queue, delayedQueuePrefix });
 
@@ -99,6 +102,76 @@ test("AmqpMessageQueue", async () => {
   await conn2.close();
 });
 
+test(
+  "AmqpMessageQueue [nativeRetrial: false]",
+  { sanitizeOps: false, sanitizeExit: false, sanitizeResources: false },
+  async () => {
+    const conn = await getConnection();
+    const randomSuffix = Math.random().toString(36).substring(2);
+    const queue = `fedify_queue_${randomSuffix}`;
+    const delayedQueuePrefix = `fedify_delayed_${randomSuffix}_`;
+    const mq = new AmqpMessageQueue(conn, { queue, delayedQueuePrefix });
+    assertFalse(mq.nativeRetrial);
+
+    const controller = new AbortController();
+    let i = 0;
+    const listening = mq.listen((message: string) => {
+      if (message !== "Hello, world!") return;
+      if (i++ < 1) {
+        throw new Error("Test error to check native retrial");
+      }
+    }, { signal: controller.signal });
+
+    await mq.enqueue("Hello, world!");
+
+    await waitFor(() => i >= 1, 15_000);
+    assertEquals(i, 1);
+    await delay(5_000);
+
+    controller.abort();
+    await listening;
+    await conn.close();
+
+    assertEquals(i, 1);
+  },
+);
+
+test(
+  "AmqpMessageQueue [nativeRetrial: true]",
+  { sanitizeOps: false, sanitizeExit: false, sanitizeResources: false },
+  async () => {
+    const conn = await getConnection();
+    const randomSuffix = Math.random().toString(36).substring(2);
+    const queue = `fedify_queue_${randomSuffix}`;
+    const delayedQueuePrefix = `fedify_delayed_${randomSuffix}_`;
+    const mq = new AmqpMessageQueue(conn, {
+      queue,
+      delayedQueuePrefix,
+      nativeRetrial: true,
+    });
+    assert(mq.nativeRetrial);
+
+    const controller = new AbortController();
+    let i = 0;
+    const listening = mq.listen((message: string) => {
+      if (message !== "Hello, world!") return;
+      if (i++ < 1) {
+        throw new Error("Test error to check native retrial");
+      }
+    }, { signal: controller.signal });
+
+    await mq.enqueue("Hello, world!");
+
+    await waitFor(() => i > 1, 15_000);
+
+    controller.abort();
+    await listening;
+    await conn.close();
+
+    assertGreater(i, 1);
+  },
+);
+
 async function waitFor(
   predicate: () => boolean,
   timeoutMs: number,

package/src/mq.ts

@@ -29,6 +29,22 @@ export interface AmqpMessageQueueOptions {
    * @default `true`
    */
   durable?: boolean;
+
+  /**
+   * Whether to use native retrial mechanism. If set to `true`, the queue will
+   * not acknowledge messages that are not processed successfully, allowing
+   * them to be retried later. If set to `false`, messages will be acknowledged
+   * whether they are processed successfully or not.
+   *
+   * Both approaches have their own advantages and disadvantages.  With native
+   * retrials, much less chance of losing messages, but timing of retrials is
+   * less predictable.  With non-native retrials, retrials are handled by Fedify
+   * itself, which allows for more control over the timing and behavior of
+   * retrials, but may result in lost messages if the process crashes before
+   * acknowledging the message.
+   * @default `false`
+   */
+  nativeRetrial?: boolean;
 }
 
 /**
@@ -53,6 +69,8 @@ export class AmqpMessageQueue implements MessageQueue {
   #durable: boolean;
   #senderChannel?: Channel;
 
+  readonly nativeRetrial: boolean;
+
   /**
    * Creates a new `AmqpMessageQueue`.
    * @param connection A connection to the AMQP server.
@@ -66,6 +84,7 @@ export class AmqpMessageQueue implements MessageQueue {
     this.#queue = options.queue ?? "fedify_queue";
     this.#delayedQueuePrefix = options.delayedQueuePrefix ?? "fedify_delayed_";
     this.#durable = options.durable ?? true;
+    this.nativeRetrial = options.nativeRetrial ?? false;
   }
 
   async #prepareQueue(channel: Channel): Promise<void> {
@@ -158,16 +177,33 @@ export class AmqpMessageQueue implements MessageQueue {
     const reply = await channel.consume(this.#queue, (msg) => {
       if (msg == null) return;
       const message = JSON.parse(msg.content.toString("utf-8"));
-      const result = handler(message);
-      if (result instanceof Promise) {
-        result.finally(() => channel.ack(msg));
-      } else {
-        channel.ack(msg);
+      try {
+        const result = handler(message);
+        if (result instanceof Promise) {
+          if (this.nativeRetrial) {
+            result
+              .then(() => channel.ack(msg))
+              .catch(() => channel.nack(msg, undefined, true));
+          } else {
+            result.finally(() => channel.ack(msg));
+          }
+        } else if (this.nativeRetrial) {
+          channel.ack(msg);
+        }
+      } catch {
+        if (this.nativeRetrial) {
+          channel.nack(msg, undefined, true);
+        }
+      } finally {
+        if (!this.nativeRetrial) {
+          channel.ack(msg);
+        }
       }
     }, {
       noAck: false,
     });
     return await new Promise((resolve) => {
+      if (options.signal?.aborted) resolve();
       options.signal?.addEventListener("abort", () => {
         channel.cancel(reply.consumerTag).then(() => {
           channel.close().then(() => resolve());