@fedify/fedify 1.0.0-dev.405 → 1.0.0-dev.407

package/CHANGES.md

@@ -109,10 +109,14 @@ To be released.
     the activity to be sent only once.  It had added Object Integrity Proofs
     to the activity for every recipient before.
 
+ -  Added `ParallelMessageQueue` class.  [[#106]]
+
  -  WebFinger responses now include <http://webfinger.net/rel/avatar> links
     if the `Actor` object returned by the actor dispatcher has `icon`/`icons`
     property.
 
+ -  `DenoKvMessageQueue` now implements `Disposable` interface.
+
  -  The `fedify inbox` command now sends `Delete(Application)` activities when
     it's terminated so that the peers can clean up data related to the temporary
     actor.  [[#135]]
@@ -123,6 +127,7 @@ To be released.
      -  `["fedify", "sig", "ld"]`
 
 [Linked Data Signatures]: https://web.archive.org/web/20170923124140/https://w3c-dvcg.github.io/ld-signatures/
+[#106]: https://github.com/dahlia/fedify/issues/106
 [#135]: https://github.com/dahlia/fedify/issues/135
 [#137]: https://github.com/dahlia/fedify/issues/137
 

package/esm/federation/mq.js

@@ -1,4 +1,10 @@
 // deno-lint-ignore-file no-explicit-any
+/**
+ * Additional options for enqueuing a message in a queue.
+ *
+ * @since 0.5.0
+ */
+import * as dntShim from "../_dnt.shims.js";
 /**
  * A message queue that processes messages in the same process.
  * Do not use this in production as it does not persist messages.
@@ -7,9 +13,6 @@
  */
 export class InProcessMessageQueue {
     #handlers = [];
-    /**
-     * {@inheritDoc Queue.enqueue}
-     */
     enqueue(message, options) {
         const delay = options?.delay == null
             ? 0
@@ -20,10 +23,65 @@ export class InProcessMessageQueue {
         }, delay);
         return Promise.resolve();
     }
+    listen(handler) {
+        this.#handlers.push(handler);
+    }
+}
+/**
+ * A message queue that processes messages in parallel.  It takes another
+ * {@link MessageQueue}, and processes messages in parallel up to a certain
+ * number of workers.
+ *
+ * Actually, it's rather a decorator than a queue itself.
+ *
+ * Note that the workers do not run in truly parallel, in the sense that they
+ * are not running in separate threads or processes.  They are running in the
+ * same process, but are scheduled to run in parallel.  Hence, this is useful
+ * for I/O-bound tasks, but not for CPU-bound tasks, which is okay for Fedify's
+ * workloads.
+ *
+ * @since 1.0.0
+ */
+export class ParallelMessageQueue {
+    queue;
+    workers;
     /**
-     * {@inheritDoc Queue.listen}
+     * Constructs a new {@link ParallelMessageQueue} with the given queue and
+     * number of workers.
+     * @param queue The message queue to use under the hood.  Note that
+     *              {@link ParallelMessageQueue} cannot be nested.
+     * @param workers The number of workers to process messages in parallel.
+     * @throws {TypeError} If the given queue is an instance of
+     *                     {@link ParallelMessageQueue}.
      */
+    constructor(queue, workers) {
+        if (queue instanceof ParallelMessageQueue) {
+            throw new TypeError("Cannot nest ParallelMessageQueue.");
+        }
+        this.queue = queue;
+        this.workers = workers;
+    }
+    enqueue(message, options) {
+        return this.queue.enqueue(message, options);
+    }
     listen(handler) {
-        this.#handlers.push(handler);
+        const workers = new Map();
+        this.queue.listen(async (message) => {
+            while (workers.size >= this.workers) {
+                const consumedId = await Promise.any(workers.values());
+                workers.delete(consumedId);
+            }
+            const workerId = dntShim.crypto.randomUUID();
+            const promise = this.#work(workerId, handler, message);
+            workers.set(workerId, promise);
+        });
+    }
+    async #work(workerId, handler, message) {
+        await this.#sleep(0);
+        await handler(message);
+        return workerId;
+    }
+    #sleep(ms) {
+        return new Promise((resolve) => setTimeout(resolve, ms));
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/fedify",
-  "version": "1.0.0-dev.405+276c412a",
+  "version": "1.0.0-dev.407+a9266a09",
   "description": "An ActivityPub server framework",
   "keywords": [
     "ActivityPub",

package/types/federation/mq.d.ts

@@ -38,13 +38,39 @@ export interface MessageQueue {
  */
 export declare class InProcessMessageQueue implements MessageQueue {
     #private;
-    /**
-     * {@inheritDoc Queue.enqueue}
-     */
     enqueue(message: any, options?: MessageQueueEnqueueOptions): Promise<void>;
+    listen(handler: (message: any) => Promise<void> | void): void;
+}
+/**
+ * A message queue that processes messages in parallel.  It takes another
+ * {@link MessageQueue}, and processes messages in parallel up to a certain
+ * number of workers.
+ *
+ * Actually, it's rather a decorator than a queue itself.
+ *
+ * Note that the workers do not run in truly parallel, in the sense that they
+ * are not running in separate threads or processes.  They are running in the
+ * same process, but are scheduled to run in parallel.  Hence, this is useful
+ * for I/O-bound tasks, but not for CPU-bound tasks, which is okay for Fedify's
+ * workloads.
+ *
+ * @since 1.0.0
+ */
+export declare class ParallelMessageQueue implements MessageQueue {
+    #private;
+    readonly queue: MessageQueue;
+    readonly workers: number;
     /**
-     * {@inheritDoc Queue.listen}
+     * Constructs a new {@link ParallelMessageQueue} with the given queue and
+     * number of workers.
+     * @param queue The message queue to use under the hood.  Note that
+     *              {@link ParallelMessageQueue} cannot be nested.
+     * @param workers The number of workers to process messages in parallel.
+     * @throws {TypeError} If the given queue is an instance of
+     *                     {@link ParallelMessageQueue}.
      */
+    constructor(queue: MessageQueue, workers: number);
+    enqueue(message: any, options?: MessageQueueEnqueueOptions): Promise<void>;
     listen(handler: (message: any) => Promise<void> | void): void;
 }
 //# sourceMappingURL=mq.d.ts.map

package/types/federation/mq.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mq.d.ts","sourceRoot":"","sources":["../../src/federation/mq.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAE5C,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3E;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;CAC/D;AAED;;;;;GAKG;AACH,qBAAa,qBAAsB,YAAW,YAAY;;IAGxD;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IAU1E;;OAEG;IACH,MAAM,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI;CAG9D"}
+{"version":3,"file":"mq.d.ts","sourceRoot":"","sources":["../../src/federation/mq.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAE5C,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3E;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;CAC/D;AAED;;;;;GAKG;AACH,qBAAa,qBAAsB,YAAW,YAAY;;IAGxD,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IAU1E,MAAM,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI;CAG9D;AAID;;;;;;;;;;;;;;GAcG;AACH,qBAAa,oBAAqB,YAAW,YAAY;;IACvD,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;;;;;;;OAQG;gBACS,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM;IAQhD,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1E,MAAM,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI;CA0B9D"}