@fedify/fedify 1.4.0-dev.632 → 1.4.0-dev.634

package/CHANGES.md

@@ -21,6 +21,23 @@ To be released.
         to `AuthenticatedDocumentLoaderFactory` type.
      -  `GetAuthenticatedDocumentLoaderOptions` interface became to extend
         `DocumentLoaderFactoryOptions` interface.
+     -  Added a type parameter `TContextData` to `CreateFederationOptions`
+        interface.
+     -  Fedify now assigns a random-generated *http:*/*https:* URI to
+        activities if these do not have explicit `id` properties.  This behavior
+        can be disabled by excluding `autoIdAssigner()` from
+        the `CreateFederationOptions.activityTransformers` option.
+
+ -  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
@@ -57,6 +74,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,95 @@
+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 an origin URI with a fragment which contains an activity
+ * type name with a random UUID:
+ *
+ * ```
+ * https://example.com/#Follow/12345678-1234-5678-1234-567812345678
+ * ```
+ *
+ * @typeParam TContextData The type of the context data.
+ * @param activity The activity to assign an ID to.
+ * @param context The context of the activity.
+ * @return The activity with an ID assigned.
+ * @since 1.4.0
+ */
+export function autoIdAssigner(activity, context) {
+    if (activity.id != null)
+        return activity;
+    const id = new URL(`/#${activity.constructor.name}/${dntShim.crypto.randomUUID()}`, context.origin);
+    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.
+ * @typeParam TContextData The type of the context data.
+ * @param activity The activity to dehydrate the actor property of.
+ * @param context The context of the activity.
+ * @returns The dehydrated activity.
+ * @since 1.4.0
+ */
+export function actorDehydrator(activity, _context) {
+    if (activity.actorIds.length < 1)
+        return activity;
+    return activity.clone({
+        actors: activity.actorIds,
+    });
+}
+/**
+ * Gets the default activity transformers that are applied to all outgoing
+ * activities.
+ * @typeParam TContextData The type of the context data.
+ * @returns The default activity transformers.
+ * @since 1.4.0
+ */
+export function getDefaultActivityTransformers() {
+    return [
+        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.632+c8474d94",
+    "version": "1.4.0-dev.634+89074a8d",
     "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 { getDefaultActivityTransformers } from "../compat/transformers.js";
 import metadata from "../deno.js";
 import { getNodeInfo } from "../nodeinfo/client.js";
 import { handleNodeInfo, handleNodeInfoJrd } from "../nodeinfo/handler.js";
@@ -66,6 +67,7 @@ export class FederationImpl {
     skipSignatureVerification;
     outboxRetryPolicy;
     inboxRetryPolicy;
+    activityTransformers;
     tracerProvider;
     constructor(options) {
         const logger = getLogger(["fedify", "federation"]);
@@ -166,6 +168,8 @@ export class FederationImpl {
             createExponentialBackoffPolicy();
         this.inboxRetryPolicy = options.inboxRetryPolicy ??
             createExponentialBackoffPolicy();
+        this.activityTransformers = options.activityTransformers ??
+            getDefaultActivityTransformers();
         this.tracerProvider = options.tracerProvider ?? trace.getTracerProvider();
     }
     #getTracer() {
@@ -1085,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, origin, } = options;
+        const { preferSharedInbox, immediate, excludeBaseUris, collectionSync, context: ctx, } = 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, ctx);
         }
-        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.");
@@ -1123,7 +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 contextLoader = this.contextLoaderFactory(this.#getLoaderOptions(ctx.origin));
         const activityId = activity.id.href;
         let proofCreated = false;
         let rsaKey = null;
@@ -1207,7 +1207,7 @@ export class FederationImpl {
             keyJwkPairs.push({ keyId: keyId.href, privateKey: privateKeyJwk });
         }
         if (!this.manuallyStartQueue)
-            this.#startQueue(contextData);
+            this.#startQueue(ctx.data);
         const carrier = {};
         propagation.inject(context.active(), carrier);
         const promises = [];
@@ -1215,7 +1215,7 @@ export class FederationImpl {
             const message = {
                 type: "outbox",
                 id: dntShim.crypto.randomUUID(),
-                baseUrl: origin,
+                baseUrl: ctx.origin,
                 keys: keyJwkPairs,
                 activity: jsonLd,
                 activityId: activity.id?.href,
@@ -1976,8 +1976,7 @@ export class ContextImpl {
             keys = [sender];
         }
         const opts = {
-            contextData: this.data,
-            origin: this.origin,
+            context: this,
             ...options,
         };
         let expandedRecipients;

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";