@fedify/amqp 2.0.0-dev.1604 → 2.0.0-dev.1641

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/amqp",
-  "version": "2.0.0-dev.1604+23a1ea67",
+  "version": "2.0.0-dev.1641+6b0c942c",
   "license": "MIT",
   "exports": {
     ".": "./src/mod.ts",
@@ -11,6 +11,7 @@
   },
   "exclude": [
     ".github",
+    "dist",
     "node_modules",
     "npm",
     "pnpm-lock.yaml"

package/dist/_virtual/rolldown_runtime.cjs

@@ -0,0 +1,30 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+
+Object.defineProperty(exports, '__toESM', {
+  enumerable: true,
+  get: function () {
+    return __toESM;
+  }
+});

package/dist/mod.cjs

@@ -0,0 +1,3 @@
+const require_mq = require('./mq.cjs');
+
+exports.AmqpMessageQueue = require_mq.AmqpMessageQueue;

package/dist/mod.d.cts

@@ -0,0 +1,2 @@
+import { AmqpMessageQueue, AmqpMessageQueueOptions } from "./mq.cjs";
+export { AmqpMessageQueue, AmqpMessageQueueOptions };

package/dist/mq.cjs

@@ -0,0 +1,121 @@
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+const node_buffer = require_rolldown_runtime.__toESM(require("node:buffer"));
+
+//#region src/mq.ts
+/**
+* A message queue that uses AMQP.
+*
+* @example
+* ``` typescript
+* import { createFederation } from "@fedify/fedify";
+* import { AmqpMessageQueue } from "@fedify/amqp";
+* import { connect } from "amqplib";
+*
+* const federation = createFederation({
+*   queue: new AmqpMessageQueue(await connect("amqp://localhost")),
+*   // ... other configurations
+* });
+* ```
+*/
+var AmqpMessageQueue = class {
+	#connection;
+	#queue;
+	#delayedQueuePrefix;
+	#durable;
+	#senderChannel;
+	nativeRetrial;
+	/**
+	* Creates a new `AmqpMessageQueue`.
+	* @param connection A connection to the AMQP server.
+	* @param options Options for the message queue.
+	*/
+	constructor(connection, options = {}) {
+		this.#connection = connection;
+		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) {
+		await channel.assertQueue(this.#queue, { durable: this.#durable });
+	}
+	async #getSenderChannel() {
+		if (this.#senderChannel != null) return this.#senderChannel;
+		const channel = await this.#connection.createChannel();
+		this.#senderChannel = channel;
+		this.#prepareQueue(channel);
+		return channel;
+	}
+	async enqueue(message, options) {
+		const channel = await this.#getSenderChannel();
+		const delay = options?.delay?.total("millisecond");
+		let queue;
+		if (delay == null || delay <= 0) queue = this.#queue;
+		else {
+			const delayStr = delay.toLocaleString("en", { useGrouping: false });
+			queue = this.#delayedQueuePrefix + delayStr;
+			await channel.assertQueue(queue, {
+				autoDelete: true,
+				durable: this.#durable,
+				deadLetterExchange: "",
+				deadLetterRoutingKey: this.#queue,
+				messageTtl: delay
+			});
+		}
+		channel.sendToQueue(queue, node_buffer.Buffer.from(JSON.stringify(message), "utf-8"), {
+			persistent: this.#durable,
+			contentType: "application/json"
+		});
+	}
+	async enqueueMany(messages, options) {
+		const channel = await this.#getSenderChannel();
+		const delay = options?.delay?.total("millisecond");
+		let queue;
+		if (delay == null || delay <= 0) queue = this.#queue;
+		else {
+			const delayStr = delay.toLocaleString("en", { useGrouping: false });
+			queue = this.#delayedQueuePrefix + delayStr;
+			await channel.assertQueue(queue, {
+				autoDelete: true,
+				durable: this.#durable,
+				deadLetterExchange: "",
+				deadLetterRoutingKey: this.#queue,
+				messageTtl: delay
+			});
+		}
+		for (const message of messages) channel.sendToQueue(queue, node_buffer.Buffer.from(JSON.stringify(message), "utf-8"), {
+			persistent: this.#durable,
+			contentType: "application/json"
+		});
+	}
+	async listen(handler, options = {}) {
+		const channel = await this.#connection.createChannel();
+		await this.#prepareQueue(channel);
+		await channel.prefetch(1);
+		const reply = await channel.consume(this.#queue, (msg) => {
+			if (msg == null) return;
+			const message = JSON.parse(msg.content.toString("utf-8"));
+			try {
+				const result = handler(message);
+				if (result instanceof Promise) if (this.nativeRetrial) result.then(() => channel.ack(msg)).catch(() => channel.nack(msg, void 0, true));
+				else result.finally(() => channel.ack(msg));
+				else if (this.nativeRetrial) channel.ack(msg);
+			} catch {
+				if (this.nativeRetrial) channel.nack(msg, void 0, 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());
+				});
+			});
+		});
+	}
+};
+
+//#endregion
+exports.AmqpMessageQueue = AmqpMessageQueue;

package/dist/mq.d.cts

@@ -0,0 +1,72 @@
+import { MessageQueue, MessageQueueEnqueueOptions, MessageQueueListenOptions } from "@fedify/fedify";
+import { ChannelModel } from "amqplib";
+
+//#region src/mq.d.ts
+
+/**
+ * Options for {@link AmqpMessageQueue}.
+ */
+interface AmqpMessageQueueOptions {
+  /**
+   * The name of the queue to use.  Defaults to `"fedify_queue"`.
+   * @default `"fedify_queue"`
+   */
+  queue?: string;
+  /**
+   * The prefix to use for the delayed queue.  Defaults to `"fedify_delayed_"`.
+   * Defaults to `"fedify_delayed_"`.
+   * @default `"fedify_delayed_"`
+   */
+  delayedQueuePrefix?: string;
+  /**
+   * Whether the queue will survive a broker restart.  Defaults to `true`.
+   * @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`
+   * @since 0.3.0
+   */
+  nativeRetrial?: boolean;
+}
+/**
+ * A message queue that uses AMQP.
+ *
+ * @example
+ * ``` typescript
+ * import { createFederation } from "@fedify/fedify";
+ * import { AmqpMessageQueue } from "@fedify/amqp";
+ * import { connect } from "amqplib";
+ *
+ * const federation = createFederation({
+ *   queue: new AmqpMessageQueue(await connect("amqp://localhost")),
+ *   // ... other configurations
+ * });
+ * ```
+ */
+declare class AmqpMessageQueue implements MessageQueue {
+  #private;
+  readonly nativeRetrial: boolean;
+  /**
+   * Creates a new `AmqpMessageQueue`.
+   * @param connection A connection to the AMQP server.
+   * @param options Options for the message queue.
+   */
+  constructor(connection: ChannelModel, options?: AmqpMessageQueueOptions);
+  enqueue(message: any, options?: MessageQueueEnqueueOptions): Promise<void>;
+  enqueueMany(messages: any[], options?: MessageQueueEnqueueOptions): Promise<void>;
+  listen(handler: (message: any) => void | Promise<void>, options?: MessageQueueListenOptions): Promise<void>;
+}
+//#endregion
+export { AmqpMessageQueue, AmqpMessageQueueOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/amqp",
-  "version": "2.0.0-dev.1604+23a1ea67",
+  "version": "2.0.0-dev.1641+6b0c942c",
   "description": "AMQP/RabbitMQ driver for Fedify",
   "keywords": [
     "fedify",
@@ -27,25 +27,35 @@
     "https://github.com/sponsors/dahlia"
   ],
   "type": "module",
-  "main": "./dist/mod.js",
+  "main": "./dist/mod.cjs",
   "module": "./dist/mod.js",
   "types": "./dist/mod.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/mod.d.ts",
+      "types": {
+        "import": "./dist/mod.d.ts",
+        "require": "./dist/mod.d.cts",
+        "default": "./dist/mod.d.ts"
+      },
       "import": "./dist/mod.js",
+      "require": "./dist/mod.cjs",
       "default": "./dist/mod.js"
     },
     "./mq": {
-      "types": "./dist/mq.d.ts",
+      "types": {
+        "import": "./dist/mq.d.ts",
+        "require": "./dist/mq.d.cts",
+        "default": "./dist/mq.d.ts"
+      },
       "import": "./dist/mq.js",
+      "require": "./dist/mq.cjs",
       "default": "./dist/mq.js"
     },
     "./package.json": "./package.json"
   },
   "peerDependencies": {
     "amqplib": "^0.10.8",
-    "@fedify/fedify": "^2.0.0-dev.1604+23a1ea67"
+    "@fedify/fedify": "^2.0.0-dev.1641+6b0c942c"
   },
   "devDependencies": {
     "@alinea/suite": "^0.6.3",

package/tsdown.config.ts

@@ -4,5 +4,6 @@ export default defineConfig({
   entry: ["src/mod.ts", "src/mq.ts"],
   dts: true,
   unbundle: true,
+  format: ["esm", "cjs"],
   platform: "node",
 });