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

package/CHANGES.md

@@ -22,6 +22,17 @@ To be released.
      -  `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.
@@ -57,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.632+c8474d94",
+    "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";
@@ -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 ??
+            defaultActivityTransformers;
         this.tracerProvider = options.tracerProvider ?? trace.getTracerProvider();
     }
     #getTracer() {
@@ -1092,14 +1096,10 @@ export class FederationImpl {
         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.");

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