@fedify/fedify 1.3.0-dev.502 → 1.3.0-dev.508

package/CHANGES.md

@@ -8,6 +8,15 @@ Version 1.3.0
 
 To be released.
 
+ -  `MessageQueue`s now can be differently configured for incoming and outgoing
+    activities.
+
+     -  Changed the type of `CreateFederationOptions.queue` option to
+        `FederationQueueOptions | MessageQueue | undefined` (was `MessageQueue |
+        undefined`).
+     -  Added `FederationQueueOptions` interface.
+     -  Added `FederationStartQueueOptions.queue` option.
+
  -  Fedify now makes HTTP requests with the proper `User-Agent` header. [[#162]]
 
      -  Added `getUserAgent()` function.
@@ -33,6 +42,63 @@ To be released.
 [#162]: https://github.com/dahlia/fedify/issues/162
 
 
+Version 1.2.6
+-------------
+
+Released on December 19, 2024.
+
+ -  Fix a bug where `Actor`'s `inbox` and `outbox` properties had not been
+    able to be set to an `OrderedCollectionPage` object, even though it is
+    a subtype of `OrderedCollection` according to Activity Vocabulary
+    specification.  [[#165]]
+
+     -  The type of `Application()` constructor's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The type of `Application.clone()` method's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The return type of `Application.getInbox()` and
+        `Application.getOutbox()` methods is now `OrderedCollection |
+        OrderedCollectionPage | null` (was `OrderedCollection | null`).
+     -  The type of `Group()` constructor's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The type of `Group.clone()` method's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The return type of `Group.getInbox()` and `Group.getOutbox()` methods
+        is now `OrderedCollection | OrderedCollectionPage | null` (was
+        `OrderedCollection | null`).
+     -  The type of `Organization()` constructor's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The type of `Organization.clone()` method's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The return type of `Organization.getInbox()` and
+        `Organization.getOutbox()` methods is now `OrderedCollection |
+        OrderedCollectionPage | null` (was `OrderedCollection | null`).
+     -  The type of `Person()` constructor's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The type of `Person.clone()` method's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The return type of `Person.getInbox()` and `Person.getOutbox()` methods
+        is now `OrderedCollection | OrderedCollectionPage | null` (was
+        `OrderedCollection | null`).
+     -  The type of `Service()` constructor's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The type of `Service.clone()` method's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The return type of `Service.getInbox()` and `Service.getOutbox()`
+        methods is now `OrderedCollection | OrderedCollectionPage | null` (was
+        `OrderedCollection | null`).
+
+
 Version 1.2.5
 -------------
 
@@ -157,6 +223,63 @@ Released on October 31, 2024.
 [#118]: https://github.com/dahlia/fedify/issues/118
 
 
+Version 1.1.6
+-------------
+
+Released on November 19, 2024.
+
+ -  Fix a bug where `Actor`'s `inbox` and `outbox` properties had not been
+    able to be set to an `OrderedCollectionPage` object, even though it is
+    a subtype of `OrderedCollection` according to Activity Vocabulary
+    specification.  [[#165]]
+
+     -  The type of `Application()` constructor's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The type of `Application.clone()` method's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The return type of `Application.getInbox()` and
+        `Application.getOutbox()` methods is now `OrderedCollection |
+        OrderedCollectionPage | null` (was `OrderedCollection | null`).
+     -  The type of `Group()` constructor's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The type of `Group.clone()` method's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The return type of `Group.getInbox()` and `Group.getOutbox()` methods
+        is now `OrderedCollection | OrderedCollectionPage | null` (was
+        `OrderedCollection | null`).
+     -  The type of `Organization()` constructor's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The type of `Organization.clone()` method's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The return type of `Organization.getInbox()` and
+        `Organization.getOutbox()` methods is now `OrderedCollection |
+        OrderedCollectionPage | null` (was `OrderedCollection | null`).
+     -  The type of `Person()` constructor's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The type of `Person.clone()` method's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The return type of `Person.getInbox()` and `Person.getOutbox()` methods
+        is now `OrderedCollection | OrderedCollectionPage | null` (was
+        `OrderedCollection | null`).
+     -  The type of `Service()` constructor's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The type of `Service.clone()` method's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The return type of `Service.getInbox()` and `Service.getOutbox()`
+        methods is now `OrderedCollection | OrderedCollectionPage | null` (was
+        `OrderedCollection | null`).
+
+
 Version 1.1.5
 -------------
 
@@ -322,6 +445,63 @@ Released on October 20, 2024.
 [#150]: https://github.com/dahlia/fedify/issues/150
 
 
+Version 1.0.10
+--------------
+
+Released on December 19, 2024.
+
+ -  Fix a bug where `Actor`'s `inbox` and `outbox` properties had not been
+    able to be set to an `OrderedCollectionPage` object, even though it is
+    a subtype of `OrderedCollection` according to Activity Vocabulary
+    specification.  [[#165]]
+
+     -  The type of `Application()` constructor's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The type of `Application.clone()` method's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The return type of `Application.getInbox()` and
+        `Application.getOutbox()` methods is now `OrderedCollection |
+        OrderedCollectionPage | null` (was `OrderedCollection | null`).
+     -  The type of `Group()` constructor's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The type of `Group.clone()` method's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The return type of `Group.getInbox()` and `Group.getOutbox()` methods
+        is now `OrderedCollection | OrderedCollectionPage | null` (was
+        `OrderedCollection | null`).
+     -  The type of `Organization()` constructor's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The type of `Organization.clone()` method's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The return type of `Organization.getInbox()` and
+        `Organization.getOutbox()` methods is now `OrderedCollection |
+        OrderedCollectionPage | null` (was `OrderedCollection | null`).
+     -  The type of `Person()` constructor's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The type of `Person.clone()` method's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The return type of `Person.getInbox()` and `Person.getOutbox()` methods
+        is now `OrderedCollection | OrderedCollectionPage | null` (was
+        `OrderedCollection | null`).
+     -  The type of `Service()` constructor's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The type of `Service.clone()` method's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The return type of `Service.getInbox()` and `Service.getOutbox()`
+        methods is now `OrderedCollection | OrderedCollectionPage | null` (was
+        `OrderedCollection | null`).
+
+
 Version 1.0.9
 -------------
 
@@ -606,6 +786,65 @@ Released on September 26, 2024.
 [#137]: https://github.com/dahlia/fedify/issues/137
 
 
+Version 0.15.8
+--------------
+
+Released on November 159, 2024.
+
+ -  Fix a bug where `Actor`'s `inbox` and `outbox` properties had not been
+    able to be set to an `OrderedCollectionPage` object, even though it is
+    a subtype of `OrderedCollection` according to Activity Vocabulary
+    specification.  [[#165]]
+
+     -  The type of `Application()` constructor's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The type of `Application.clone()` method's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The return type of `Application.getInbox()` and
+        `Application.getOutbox()` methods is now `OrderedCollection |
+        OrderedCollectionPage | null` (was `OrderedCollection | null`).
+     -  The type of `Group()` constructor's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The type of `Group.clone()` method's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The return type of `Group.getInbox()` and `Group.getOutbox()` methods
+        is now `OrderedCollection | OrderedCollectionPage | null` (was
+        `OrderedCollection | null`).
+     -  The type of `Organization()` constructor's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The type of `Organization.clone()` method's `inbox` and `outbox` options
+        is now `OrderedCollection | OrderedCollectionPage | null | undefined`
+        (was `OrderedCollection | null | undefined`).
+     -  The return type of `Organization.getInbox()` and
+        `Organization.getOutbox()` methods is now `OrderedCollection |
+        OrderedCollectionPage | null` (was `OrderedCollection | null`).
+     -  The type of `Person()` constructor's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The type of `Person.clone()` method's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The return type of `Person.getInbox()` and `Person.getOutbox()` methods
+        is now `OrderedCollection | OrderedCollectionPage | null` (was
+        `OrderedCollection | null`).
+     -  The type of `Service()` constructor's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The type of `Service.clone()` method's `inbox` and `outbox` options is
+        now `OrderedCollection | OrderedCollectionPage | null | undefined` (was
+        `OrderedCollection | null | undefined`).
+     -  The return type of `Service.getInbox()` and `Service.getOutbox()`
+        methods is now `OrderedCollection | OrderedCollectionPage | null` (was
+        `OrderedCollection | null`).
+
+[#165]: https://github.com/dahlia/fedify/issues/165
+
+
 Version 0.15.7
 --------------
 

package/esm/deno.js

@@ -1,6 +1,6 @@
 export default {
     "name": "@fedify/fedify",
-    "version": "1.3.0-dev.502+58ce0c02",
+    "version": "1.3.0-dev.508+e0101b9f",
     "license": "MIT",
     "exports": {
         ".": "./mod.ts",

package/esm/federation/middleware.js

@@ -28,8 +28,10 @@ export function createFederation(options) {
 export class FederationImpl {
     kv;
     kvPrefixes;
-    queue;
-    queueStarted;
+    inboxQueue;
+    outboxQueue;
+    inboxQueueStarted;
+    outboxQueueStarted;
     manuallyStartQueue;
     router;
     nodeInfoDispatcher;
@@ -66,8 +68,20 @@ export class FederationImpl {
             }),
             ...(options.kvPrefixes ?? {}),
         };
-        this.queue = options.queue;
-        this.queueStarted = false;
+        if (options.queue == null) {
+            this.inboxQueue = undefined;
+            this.outboxQueue = undefined;
+        }
+        else if ("enqueue" in options.queue && "listen" in options.queue) {
+            this.inboxQueue = options.queue;
+            this.outboxQueue = options.queue;
+        }
+        else {
+            this.inboxQueue = options.queue.inbox;
+            this.outboxQueue = options.queue.outbox;
+        }
+        this.inboxQueueStarted = false;
+        this.outboxQueueStarted = false;
         this.manuallyStartQueue = options.manuallyStartQueue ?? false;
         this.router = new Router({
             trailingSlashInsensitive: options.trailingSlashInsensitive,
@@ -112,13 +126,26 @@ export class FederationImpl {
         this.inboxRetryPolicy = options.inboxRetryPolicy ??
             createExponentialBackoffPolicy();
     }
-    async #startQueue(ctxData, signal) {
-        if (this.queue != null && !this.queueStarted) {
-            const logger = getLogger(["fedify", "federation", "queue"]);
-            logger.debug("Starting a task queue.");
-            this.queueStarted = true;
-            await this.queue?.listen((msg) => this.#listenQueue(ctxData, msg), { signal });
-        }
+    async #startQueue(ctxData, signal, queue) {
+        if (this.inboxQueue == null && this.outboxQueue == null)
+            return;
+        const logger = getLogger(["fedify", "federation", "queue"]);
+        const promises = [];
+        if (this.inboxQueue != null && (queue == null || queue === "inbox") &&
+            !this.inboxQueueStarted) {
+            logger.debug("Starting an inbox task worker.");
+            this.inboxQueueStarted = true;
+            promises.push(this.inboxQueue.listen((msg) => this.#listenQueue(ctxData, msg), { signal }));
+        }
+        if (this.outboxQueue != null &&
+            this.outboxQueue !== this.inboxQueue &&
+            (queue == null || queue === "outbox") &&
+            !this.outboxQueueStarted) {
+            logger.debug("Starting an outbox task worker.");
+            this.outboxQueueStarted = true;
+            promises.push(this.outboxQueue.listen((msg) => this.#listenQueue(ctxData, msg), { signal }));
+        }
+        await Promise.all(promises);
     }
     #listenQueue(ctxData, message) {
         return withContext({ messageId: message.id }, async () => {
@@ -182,7 +209,7 @@ export class FederationImpl {
             if (delay != null) {
                 logger.error("Failed to send activity {activityId} to {inbox} (attempt " +
                     "#{attempt}); retry...:\n{error}", { ...logData, error });
-                this.queue?.enqueue({
+                this.outboxQueue?.enqueue({
                     ...message,
                     attempt: message.attempt + 1,
                 }, {
@@ -276,7 +303,7 @@ export class FederationImpl {
                     activity: message.activity,
                     recipient: message.identifier,
                 });
-                this.queue?.enqueue({
+                this.inboxQueue?.enqueue({
                     ...message,
                     attempt: message.attempt + 1,
                 }, {
@@ -308,7 +335,7 @@ export class FederationImpl {
         });
     }
     startQueue(contextData, options = {}) {
-        return this.#startQueue(contextData, options.signal);
+        return this.#startQueue(contextData, options.signal, options.queue);
     }
     createContext(urlOrRequest, contextData) {
         return urlOrRequest instanceof Request
@@ -928,7 +955,7 @@ export class FederationImpl {
                 })),
             });
         }
-        if (immediate || this.queue == null) {
+        if (immediate || this.outboxQueue == null) {
             if (immediate) {
                 logger.debug("Sending activity immediately without queue since immediate option " +
                     "is set.", { activityId: activity.id.href, activity: jsonLd });
@@ -973,7 +1000,7 @@ export class FederationImpl {
                     "Collection-Synchronization": await buildCollectionSynchronizationHeader(collectionSync, inboxes[inbox]),
                 },
             };
-            this.queue.enqueue(message);
+            this.outboxQueue.enqueue(message);
         }
     }
     fetch(request, options) {
@@ -1107,7 +1134,7 @@ export class FederationImpl {
                     inboxContextFactory: context.toInboxContext.bind(context),
                     kv: this.kv,
                     kvPrefixes: this.kvPrefixes,
-                    queue: this.queue,
+                    queue: this.inboxQueue,
                     actorDispatcher: this.actorCallbacks?.dispatcher,
                     inboxListeners: this.inboxListeners,
                     inboxErrorHandler: this.inboxErrorHandler,
@@ -1838,7 +1865,7 @@ export class InboxContextImpl extends ContextImpl {
             activityId,
             activity: this.activity,
         });
-        if (options?.immediate || this.federation.queue == null) {
+        if (options?.immediate || this.federation.outboxQueue == null) {
             if (options?.immediate) {
                 logger.debug("Forwarding activity immediately without queue since immediate " +
                     "option is set.");
@@ -1877,7 +1904,7 @@ export class InboxContextImpl extends ContextImpl {
                 attempt: 0,
                 headers: {},
             };
-            this.federation.queue.enqueue(message);
+            this.federation.outboxQueue.enqueue(message);
         }
     }
 }

package/esm/testing/fixtures/example.com/orderedcollectionpage

@@ -0,0 +1,24 @@
+{
+  "@context": "https://www.w3.org/ns/activitystreams",
+  "id": "https://example.com/orderedcollectionpage",
+  "type": "OrderedCollectionPage",
+  "partOf": "https://example.com/orderedcollectionpage",
+  "totalItems": 1,
+  "orderedItems": [
+    {
+      "id": "https://example.com/activities/1",
+      "type": "Create",
+      "published": "2024-11-19T15:24:56Z",
+      "actor": "https://example.com/users/1",
+      "to": "https://www.w3.org/ns/activitystreams#Public",
+      "object": {
+        "id": "https://example.com/notes/1",
+        "type": "Note",
+        "content": "This is a simple note",
+        "attributedTo": "https://example.com/users/1",
+        "to": "https://www.w3.org/ns/activitystreams#Public",
+        "published": "2024-11-19T15:24:56Z"
+      }
+    }
+  ]
+}

package/esm/vocab/application.yaml

@@ -106,6 +106,7 @@ properties:
     and dropping any activities already seen.
   range:
   - "https://www.w3.org/ns/activitystreams#OrderedCollection"
+  - "https://www.w3.org/ns/activitystreams#OrderedCollectionPage"
 
 - singularName: outbox
   functional: true
@@ -124,6 +125,7 @@ properties:
     implementing and deploying the server.
   range:
   - "https://www.w3.org/ns/activitystreams#OrderedCollection"
+  - "https://www.w3.org/ns/activitystreams#OrderedCollectionPage"
 
 - singularName: following
   functional: true

package/esm/vocab/group.yaml

@@ -106,6 +106,7 @@ properties:
     and dropping any activities already seen.
   range:
   - "https://www.w3.org/ns/activitystreams#OrderedCollection"
+  - "https://www.w3.org/ns/activitystreams#OrderedCollectionPage"
 
 - singularName: outbox
   functional: true
@@ -124,6 +125,7 @@ properties:
     implementing and deploying the server.
   range:
   - "https://www.w3.org/ns/activitystreams#OrderedCollection"
+  - "https://www.w3.org/ns/activitystreams#OrderedCollectionPage"
 
 - singularName: following
   functional: true

package/esm/vocab/organization.yaml

@@ -106,6 +106,7 @@ properties:
     and dropping any activities already seen.
   range:
   - "https://www.w3.org/ns/activitystreams#OrderedCollection"
+  - "https://www.w3.org/ns/activitystreams#OrderedCollectionPage"
 
 - singularName: outbox
   functional: true
@@ -124,6 +125,7 @@ properties:
     implementing and deploying the server.
   range:
   - "https://www.w3.org/ns/activitystreams#OrderedCollection"
+  - "https://www.w3.org/ns/activitystreams#OrderedCollectionPage"
 
 - singularName: following
   functional: true

package/esm/vocab/person.yaml

@@ -106,6 +106,7 @@ properties:
     and dropping any activities already seen.
   range:
   - "https://www.w3.org/ns/activitystreams#OrderedCollection"
+  - "https://www.w3.org/ns/activitystreams#OrderedCollectionPage"
 
 - singularName: outbox
   functional: true
@@ -124,6 +125,7 @@ properties:
     implementing and deploying the server.
   range:
   - "https://www.w3.org/ns/activitystreams#OrderedCollection"
+  - "https://www.w3.org/ns/activitystreams#OrderedCollectionPage"
 
 - singularName: following
   functional: true

package/esm/vocab/service.yaml

@@ -106,6 +106,7 @@ properties:
     and dropping any activities already seen.
   range:
   - "https://www.w3.org/ns/activitystreams#OrderedCollection"
+  - "https://www.w3.org/ns/activitystreams#OrderedCollectionPage"
 
 - singularName: outbox
   functional: true
@@ -124,6 +125,7 @@ properties:
     implementing and deploying the server.
   range:
   - "https://www.w3.org/ns/activitystreams#OrderedCollection"
+  - "https://www.w3.org/ns/activitystreams#OrderedCollectionPage"
 
 - singularName: following
   functional: true