@fedify/fedify 1.4.0-dev.630 → 1.4.0-dev.633

package/CHANGES.md

@@ -8,6 +8,31 @@ Version 1.4.0
 
 To be released.
 
+ -  Document loader and context loader are now configurable with a factory
+    function for more flexibility.
+
+     -  Deprecated `CreateFederationOptions.documentLoader` option.
+        Use `CreateFederationOptions.documentLoaderFactory` option instead.
+     -  Deprecated `CreateFederationOptions.contextLoader` option.
+        Use `CreateFederationOptions.contextLoaderFactory` option instead.
+     -  Added `DocumentLoaderFactory` type.
+     -  Added `DocumentLoaderFactoryOptions` interface.
+     -  Added the second parameter with `DocumentLoaderFactoryOptions` type
+        to `AuthenticatedDocumentLoaderFactory` type.
+     -  `GetAuthenticatedDocumentLoaderOptions` interface became to extend
+        `DocumentLoaderFactoryOptions` interface.
+
+ -  Introduced `ActivityTransformer`s for adjusting outgoing activities
+    before sending them so that some ActivityPub implementations with quirks
+    are satisfied.
+
+     -  Added `@fedify/fedify/compat` module.
+     -  Added `ActivityTransformer` type.
+     -  Added `autoIdAssigner()` function.
+     -  Added `actorDehydrator()` function.
+     -  Added `defaultActivityTransformers` constant.
+     -  Added `CreateFederationOptions.activityTransformers` option.
+
  -  The `suppressError` option of Activity Vocabulary APIs,
     `traverseCollection()` function, and `Context.traverseCollection()` method
     now suppresses errors occurred JSON-LD processing.
@@ -43,6 +68,11 @@ To be released.
 
  -  Added `allowPrivateAddress` option to `LookupWebFingerOptions` interface.
 
+ -  Added more log messages using the [LogTape] library.  Currently the below
+    logger categories are used:
+
+     -  `["fedify", "compat", "transformers"]`
+
  -  Added `-t`/`--traverse` option to the `fedify lookup` subcommand.  [[#195]]
 
  -  Added `-S`/`--suppress-errors` option to the `fedify lookup` subcommand.

package/esm/compat/mod.js

@@ -0,0 +1,2 @@
+export * from "./transformers.js";
+export * from "./types.js";

package/esm/compat/transformers.js

@@ -0,0 +1,85 @@
+import * as dntShim from "../_dnt.shims.js";
+import { getLogger } from "@logtape/logtape";
+const logger = getLogger(["fedify", "compat", "transformers"]);
+/**
+ * An activity transformer that assigns a new random ID to an activity if it
+ * does not already have one.  This is useful for ensuring that activities
+ * have an ID before they are sent to other servers.
+ *
+ * The generated ID is a URN UUID like:
+ *
+ * ```
+ * urn:uuid:12345678-1234-5678-1234-567812345678
+ * ```
+ * @param activity The activity to assign an ID to.
+ * @return The activity with an ID assigned.
+ * @since 1.4.0
+ */
+export function autoIdAssigner(activity) {
+    if (activity.id != null)
+        return activity;
+    const id = new URL(`urn:uuid:${dntShim.crypto.randomUUID()}`);
+    logger.warn("As the activity to send does not have an id, a new id {id} has " +
+        "been generated for it.  However, it is recommended to explicitly " +
+        "set the id for the activity.", { id: id.href });
+    return activity.clone({ id });
+}
+/**
+ * An activity transformer that dehydrates the actor property of an activity
+ * so that it only contains the actor's URI.  For example, suppose we have an
+ * activity like this:
+ *
+ * ```typescript
+ * import { Follow, Person } from "@fedify/fedify/vocab";
+ * const input = new Follow({
+ *   id: new URL("http://example.com/activities/1"),
+ *   actor: new Person({
+ *     id: new URL("http://example.com/actors/1"),
+ *     name: "Alice",
+ *     preferredUsername: "alice",
+ *   }),
+ *   object: new Person({
+ *     id: new URL("http://example.com/actors/2"),
+ *     name: "Bob",
+ *     preferredUsername: "bob",
+ *   }),
+ * });
+ * ```
+ *
+ * The result of applying this transformer would be:
+ *
+ * ```typescript
+ * import { Follow, Person } from "@fedify/fedify/vocab";
+ * const output = new Follow({
+ *   id: new URL("http://example.com/activities/1"),
+ *   actor: new URL("http://example.com/actors/1"),
+ *   object: new Person({
+ *     id: new URL("http://example.com/actors/2"),
+ *     name: "Bob",
+ *     preferredUsername: "bob",
+ *   }),
+ * });
+ * ```
+ *
+ * As some ActivityPub implementations like Threads fail to deal with inlined
+ * actor objects, this transformer can be used to work around this issue.
+ * @param activity The activity to dehydrate the actor property of.
+ * @returns The dehydrated activity.
+ * @since 1.4.0
+ */
+export function actorDehydrator(activity) {
+    if (activity.actorIds.length < 1)
+        return activity;
+    return activity.clone({
+        actors: activity.actorIds,
+    });
+}
+/**
+ * The default activity transformers that are applied to all outgoing
+ * activities.
+ * @since 1.4.0
+ */
+export const defaultActivityTransformers = [
+    autoIdAssigner,
+    actorDehydrator,
+];

package/esm/compat/types.js

@@ -0,0 +1 @@
+export {};

package/esm/deno.js

@@ -1,9 +1,10 @@
 export default {
     "name": "@fedify/fedify",
-    "version": "1.4.0-dev.630+203d67a0",
+    "version": "1.4.0-dev.633+1856bfff",
     "license": "MIT",
     "exports": {
         ".": "./mod.ts",
+        "./compat": "./compat/mod.ts",
         "./federation": "./federation/mod.ts",
         "./nodeinfo": "./nodeinfo/mod.ts",
         "./runtime": "./runtime/mod.ts",

package/esm/federation/middleware.js

@@ -3,6 +3,7 @@ import { verifyObject } from "../mod.js";
 import { getLogger, withContext } from "@logtape/logtape";
 import { context, propagation, SpanKind, SpanStatusCode, trace, } from "@opentelemetry/api";
 import { ATTR_HTTP_REQUEST_HEADER, ATTR_HTTP_REQUEST_METHOD, ATTR_HTTP_RESPONSE_HEADER, ATTR_HTTP_RESPONSE_STATUS_CODE, ATTR_URL_FULL, } from "@opentelemetry/semantic-conventions";
+import { defaultActivityTransformers } from "../compat/transformers.js";
 import metadata from "../deno.js";
 import { getNodeInfo } from "../nodeinfo/client.js";
 import { handleNodeInfo, handleNodeInfoJrd } from "../nodeinfo/handler.js";
@@ -56,8 +57,8 @@ export class FederationImpl {
     inboxListeners;
     inboxErrorHandler;
     sharedInboxKeyDispatcher;
-    documentLoader;
-    contextLoader;
+    documentLoaderFactory;
+    contextLoaderFactory;
     authenticatedDocumentLoaderFactory;
     allowPrivateAddress;
     userAgent;
@@ -66,8 +67,10 @@ export class FederationImpl {
     skipSignatureVerification;
     outboxRetryPolicy;
     inboxRetryPolicy;
+    activityTransformers;
     tracerProvider;
     constructor(options) {
+        const logger = getLogger(["fedify", "federation"]);
         this.kv = options.kv;
         this.kvPrefixes = {
             ...({
@@ -115,12 +118,42 @@ export class FederationImpl {
         }
         const { allowPrivateAddress, userAgent } = options;
         this.allowPrivateAddress = allowPrivateAddress ?? false;
-        this.documentLoader = options.documentLoader ?? kvCache({
-            loader: getDocumentLoader({ allowPrivateAddress, userAgent }),
-            kv: options.kv,
-            prefix: this.kvPrefixes.remoteDocument,
-        });
-        this.contextLoader = options.contextLoader ?? this.documentLoader;
+        if (options.documentLoader != null) {
+            if (options.documentLoaderFactory != null) {
+                throw new TypeError("Cannot set both documentLoader and documentLoaderFactory options " +
+                    "at a time; use documentLoaderFactory only.");
+            }
+            this.documentLoaderFactory = () => options.documentLoader;
+            logger.warn("The documentLoader option is deprecated; use documentLoaderFactory " +
+                "option instead.");
+        }
+        else {
+            this.documentLoaderFactory = options.documentLoaderFactory ??
+                ((opts) => {
+                    return kvCache({
+                        loader: getDocumentLoader({
+                            allowPrivateAddress: opts?.allowPrivateAddress ??
+                                allowPrivateAddress,
+                            userAgent: opts?.userAgent ?? userAgent,
+                        }),
+                        kv: options.kv,
+                        prefix: this.kvPrefixes.remoteDocument,
+                    });
+                });
+        }
+        if (options.contextLoader != null) {
+            if (options.contextLoaderFactory != null) {
+                throw new TypeError("Cannot set both contextLoader and contextLoaderFactory options " +
+                    "at a time; use contextLoaderFactory only.");
+            }
+            this.contextLoaderFactory = () => options.contextLoader;
+            logger.warn("The contextLoader option is deprecated; use contextLoaderFactory " +
+                "option instead.");
+        }
+        else {
+            this.contextLoaderFactory = options.contextLoaderFactory ??
+                this.documentLoaderFactory;
+        }
         this.authenticatedDocumentLoaderFactory =
             options.authenticatedDocumentLoaderFactory ??
                 ((identity) => getAuthenticatedDocumentLoader(identity, {
@@ -135,6 +168,8 @@ export class FederationImpl {
             createExponentialBackoffPolicy();
         this.inboxRetryPolicy = options.inboxRetryPolicy ??
             createExponentialBackoffPolicy();
+        this.activityTransformers = options.activityTransformers ??
+            defaultActivityTransformers;
         this.tracerProvider = options.tracerProvider ?? trace.getTracerProvider();
     }
     #getTracer() {
@@ -252,11 +287,12 @@ export class FederationImpl {
         }
         catch (error) {
             span.setStatus({ code: SpanStatusCode.ERROR, message: String(error) });
+            const loaderOptions = this.#getLoaderOptions(message.baseUrl);
             const activity = await Activity.fromJsonLd(message.activity, {
-                contextLoader: this.contextLoader,
+                contextLoader: this.contextLoaderFactory(loaderOptions),
                 documentLoader: rsaKeyPair == null
-                    ? this.documentLoader
-                    : this.authenticatedDocumentLoaderFactory(rsaKeyPair),
+                    ? this.documentLoaderFactory(loaderOptions)
+                    : this.authenticatedDocumentLoaderFactory(rsaKeyPair, loaderOptions),
                 tracerProvider: this.tracerProvider,
             });
             try {
@@ -435,11 +471,14 @@ export class FederationImpl {
             url.hash = "";
             url.search = "";
         }
+        const loaderOptions = this.#getLoaderOptions(url.origin);
         const ctxOptions = {
             url,
             federation: this,
             data: contextData,
-            documentLoader: opts.documentLoader ?? this.documentLoader,
+            documentLoader: opts.documentLoader ??
+                this.documentLoaderFactory(loaderOptions),
+            contextLoader: this.contextLoaderFactory(loaderOptions),
         };
         if (request == null)
             return new ContextImpl(ctxOptions);
@@ -450,6 +489,18 @@ export class FederationImpl {
             invokedFromObjectDispatcher: opts.invokedFromObjectDispatcher,
         });
     }
+    #getLoaderOptions(origin) {
+        origin = typeof origin === "string"
+            ? new URL(origin).origin
+            : origin.origin;
+        return {
+            allowPrivateAddress: this.allowPrivateAddress,
+            userAgent: typeof this.userAgent === "string" ? this.userAgent : {
+                url: origin,
+                ...this.userAgent,
+            },
+        };
+    }
     setNodeInfoDispatcher(path, dispatcher) {
         if (this.router.has("nodeInfo")) {
             throw new RouterError("NodeInfo dispatcher already set.");
@@ -1038,21 +1089,17 @@ export class FederationImpl {
     }
     async sendActivity(keys, recipients, activity, options, span) {
         const logger = getLogger(["fedify", "federation", "outbox"]);
-        const { preferSharedInbox, immediate, excludeBaseUris, collectionSync, contextData, } = options;
+        const { preferSharedInbox, immediate, excludeBaseUris, collectionSync, contextData, origin, } = options;
         if (keys.length < 1) {
             throw new TypeError("The sender's keys must not be empty.");
         }
         for (const { privateKey } of keys) {
             validateCryptoKey(privateKey, "private");
         }
-        if (activity.id == null) {
-            const id = new URL(`urn:uuid:${dntShim.crypto.randomUUID()}`);
-            activity = activity.clone({ id });
-            logger.warn("As the activity to send does not have an id, a new id {id} has " +
-                "been generated for it.  However, it is recommended to explicitly " +
-                "set the id for the activity.", { id: id.href });
+        for (const activityTransformer of this.activityTransformers) {
+            activity = activityTransformer(activity);
         }
-        span?.setAttribute("activitypub.activity.id", activity.id.href);
+        span?.setAttribute("activitypub.activity.id", activity?.id?.href ?? "");
         if (activity.actorId == null) {
             logger.error("Activity {activityId} to send does not have an actor.", { activity, activityId: activity?.id?.href });
             throw new TypeError("The activity to send must have at least one actor property.");
@@ -1076,6 +1123,7 @@ export class FederationImpl {
         else if (keys.length < 1) {
             throw new TypeError("The keys must not be empty.");
         }
+        const contextLoader = this.contextLoaderFactory(this.#getLoaderOptions(origin));
         const activityId = activity.id.href;
         let proofCreated = false;
         let rsaKey = null;
@@ -1087,7 +1135,7 @@ export class FederationImpl {
             }
             if (privateKey.algorithm.name === "Ed25519") {
                 activity = await signObject(activity, privateKey, keyId, {
-                    contextLoader: this.contextLoader,
+                    contextLoader,
                     tracerProvider: this.tracerProvider,
                 });
                 proofCreated = true;
@@ -1095,7 +1143,7 @@ export class FederationImpl {
         }
         let jsonLd = await activity.toJsonLd({
             format: "compact",
-            contextLoader: this.contextLoader,
+            contextLoader,
         });
         if (rsaKey == null) {
             logger.warn("No supported key found to create a Linked Data signature for " +
@@ -1111,7 +1159,7 @@ export class FederationImpl {
         }
         else {
             jsonLd = await signJsonLd(jsonLd, rsaKey.privateKey, rsaKey.keyId, {
-                contextLoader: this.contextLoader,
+                contextLoader,
                 tracerProvider: this.tracerProvider,
             });
         }
@@ -1167,6 +1215,7 @@ export class FederationImpl {
             const message = {
                 type: "outbox",
                 id: dntShim.crypto.randomUUID(),
+                baseUrl: origin,
                 keys: keyJwkPairs,
                 activity: jsonLd,
                 activityId: activity.id?.href,
@@ -1458,12 +1507,14 @@ export class ContextImpl {
     federation;
     data;
     documentLoader;
+    contextLoader;
     invokedFromActorKeyPairsDispatcher;
-    constructor({ url, federation, data, documentLoader, invokedFromActorKeyPairsDispatcher, }) {
+    constructor({ url, federation, data, documentLoader, contextLoader, invokedFromActorKeyPairsDispatcher, }) {
         this.url = url;
         this.federation = federation;
         this.data = data;
         this.documentLoader = documentLoader;
+        this.contextLoader = contextLoader;
         this.invokedFromActorKeyPairsDispatcher =
             invokedFromActorKeyPairsDispatcher;
     }
@@ -1473,6 +1524,7 @@ export class ContextImpl {
             federation: this.federation,
             data: this.data,
             documentLoader: this.documentLoader,
+            contextLoader: this.contextLoader,
             invokedFromActorKeyPairsDispatcher: this.invokedFromActorKeyPairsDispatcher,
         });
     }
@@ -1485,9 +1537,6 @@ export class ContextImpl {
     get origin() {
         return this.url.origin;
     }
-    get contextLoader() {
-        return this.federation.contextLoader;
-    }
     get tracerProvider() {
         return this.federation.tracerProvider;
     }
@@ -1928,6 +1977,7 @@ export class ContextImpl {
         }
         const opts = {
             contextData: this.data,
+            origin: this.origin,
             ...options,
         };
         let expandedRecipients;
@@ -2322,6 +2372,7 @@ export class InboxContextImpl extends ContextImpl {
             const message = {
                 type: "outbox",
                 id: dntShim.crypto.randomUUID(),
+                baseUrl: this.origin,
                 keys: keyJwkPairs,
                 activity: this.activity,
                 activityId: this.activityId,

package/esm/mod.js

@@ -41,6 +41,7 @@
  *
  * @module
  */
+export * from "./compat/mod.js";
 export * from "./federation/mod.js";
 export * from "./nodeinfo/mod.js";
 export * from "./runtime/mod.js";