@fedify/fedify 1.6.0-dev.814 → 1.6.0-experiment.0

package/dist/federation/router.d.ts

@@ -0,0 +1,91 @@
+import { Temporal } from "@js-temporal/polyfill";
+import { URLPattern } from "urlpattern-polyfill";
+
+//#region federation/router.d.ts
+/**
+* Options for the {@link Router}.
+* @since 0.12.0
+*/
+/**
+ * Options for the {@link Router}.
+ * @since 0.12.0
+ */
+interface RouterOptions {
+  /**
+   * Whether to ignore trailing slashes when matching paths.
+   */
+  trailingSlashInsensitive?: boolean;
+}
+/**
+ * The result of {@link Router.route} method.
+ * @since 1.3.0
+ */
+interface RouterRouteResult {
+  /**
+   * The matched route name.
+   */
+  name: string;
+  /**
+   * The URL template of the matched route.
+   */
+  template: string;
+  /**
+   * The values extracted from the URL.
+   */
+  values: Record<string, string>;
+}
+/**
+ * URL router and constructor based on URI Template
+ * ([RFC 6570](https://tools.ietf.org/html/rfc6570)).
+ */
+declare class Router {
+  #private;
+  /**
+   * Whether to ignore trailing slashes when matching paths.
+   * @since 1.6.0
+   */
+  trailingSlashInsensitive: boolean;
+  /**
+   * Create a new {@link Router}.
+   * @param options Options for the router.
+   */
+  constructor(options?: RouterOptions);
+  /**
+   * Checks if a path name exists in the router.
+   * @param name The name of the path.
+   * @returns `true` if the path name exists, otherwise `false`.
+   */
+  has(name: string): boolean;
+  /**
+   * Adds a new path rule to the router.
+   * @param template The path pattern.
+   * @param name The name of the path.
+   * @returns The names of the variables in the path pattern.
+   */
+  add(template: string, name: string): Set<string>;
+  /**
+   * Resolves a path name and values from a URL, if any match.
+   * @param url The URL to resolve.
+   * @returns The name of the path and its values, if any match.  Otherwise,
+   *          `null`.
+   */
+  route(url: string): RouterRouteResult | null;
+  /**
+   * Constructs a URL/path from a path name and values.
+   * @param name The name of the path.
+   * @param values The values to expand the path with.
+   * @returns The URL/path, if the name exists.  Otherwise, `null`.
+   */
+  build(name: string, values: Record<string, string>): string | null;
+}
+/**
+ * An error thrown by the {@link Router}.
+ */
+declare class RouterError extends Error {
+  /**
+   * Create a new {@link RouterError}.
+   * @param message The error message.
+   */
+  constructor(message: string);
+} //#endregion
+export { Router as Router$1, RouterError as RouterError$1, RouterOptions, RouterRouteResult };

package/dist/federation/router.js

@@ -0,0 +1,99 @@
+
+      import { Temporal } from "@js-temporal/polyfill";
+      import { URLPattern } from "urlpattern-polyfill";
+    
+import { Router } from "uri-template-router";
+import { parseTemplate } from "url-template";
+
+//#region federation/router.ts
+/**
+* URL router and constructor based on URI Template
+* ([RFC 6570](https://tools.ietf.org/html/rfc6570)).
+*/
+var Router$1 = class {
+	#router;
+	#templates;
+	#templateStrings;
+	/**
+	* Whether to ignore trailing slashes when matching paths.
+	* @since 1.6.0
+	*/
+	trailingSlashInsensitive;
+	/**
+	* Create a new {@link Router}.
+	* @param options Options for the router.
+	*/
+	constructor(options = {}) {
+		this.#router = new Router();
+		this.#templates = {};
+		this.#templateStrings = {};
+		this.trailingSlashInsensitive = options.trailingSlashInsensitive ?? false;
+	}
+	/**
+	* Checks if a path name exists in the router.
+	* @param name The name of the path.
+	* @returns `true` if the path name exists, otherwise `false`.
+	*/
+	has(name) {
+		return name in this.#templates;
+	}
+	/**
+	* Adds a new path rule to the router.
+	* @param template The path pattern.
+	* @param name The name of the path.
+	* @returns The names of the variables in the path pattern.
+	*/
+	add(template, name) {
+		if (!template.startsWith("/")) throw new RouterError("Path must start with a slash.");
+		const rule = this.#router.addTemplate(template, {}, name);
+		this.#templates[name] = parseTemplate(template);
+		this.#templateStrings[name] = template;
+		return new Set(rule.variables.map((v) => v.varname));
+	}
+	/**
+	* Resolves a path name and values from a URL, if any match.
+	* @param url The URL to resolve.
+	* @returns The name of the path and its values, if any match.  Otherwise,
+	*          `null`.
+	*/
+	route(url) {
+		let match = this.#router.resolveURI(url);
+		if (match == null) {
+			if (!this.trailingSlashInsensitive) return null;
+			url = url.endsWith("/") ? url.replace(/\/+$/, "") : `${url}/`;
+			match = this.#router.resolveURI(url);
+			if (match == null) return null;
+		}
+		return {
+			name: match.matchValue,
+			template: this.#templateStrings[match.matchValue],
+			values: match.params
+		};
+	}
+	/**
+	* Constructs a URL/path from a path name and values.
+	* @param name The name of the path.
+	* @param values The values to expand the path with.
+	* @returns The URL/path, if the name exists.  Otherwise, `null`.
+	*/
+	build(name, values) {
+		if (name in this.#templates) return this.#templates[name].expand(values);
+		return null;
+	}
+};
+/**
+* An error thrown by the {@link Router}.
+*/
+var RouterError = class extends Error {
+	/**
+	* Create a new {@link RouterError}.
+	* @param message The error message.
+	*/
+	constructor(message) {
+		super(message);
+		this.name = "RouterError";
+	}
+};
+
+//#endregion
+export { Router$1 as Router, RouterError };

package/dist/federation/router.test.d.ts

@@ -0,0 +1,2 @@
+import { Temporal } from "@js-temporal/polyfill";
+import { URLPattern } from "urlpattern-polyfill";

package/dist/federation/router.test.js

@@ -0,0 +1,78 @@
+
+      import { Temporal } from "@js-temporal/polyfill";
+      import { URLPattern } from "urlpattern-polyfill";
+    
+import { Router, RouterError } from "./router.js";
+import { assertEquals } from "../node_modules/.pnpm/@jsr_std__assert@0.226.0/node_modules/@jsr/std__assert/assert_equals.js";
+import { test } from "../testing/mod.js";
+import { assertThrows } from "../node_modules/.pnpm/@jsr_std__assert@0.226.0/node_modules/@jsr/std__assert/assert_throws.js";
+
+//#region federation/router.test.ts
+function setUp(options = {}) {
+	const router = new Router(options);
+	router.add("/users/{name}", "user");
+	router.add("/users/{name}/posts/{postId}" + (options.trailingSlashInsensitive ? "/" : ""), "post");
+	return router;
+}
+test("Router.add()", () => {
+	const router = new Router();
+	assertEquals(router.add("/users", "users"), new Set());
+	assertEquals(router.add("/users/{name}", "user"), new Set(["name"]));
+	assertEquals(router.add("/users/{name}/posts/{postId}", "post"), new Set(["name", "postId"]));
+	assertThrows(() => router.add("foo", "name"), RouterError);
+});
+test("Router.route()", () => {
+	let router = setUp();
+	assertEquals(router.route("/users/alice"), {
+		name: "user",
+		template: "/users/{name}",
+		values: { name: "alice" }
+	});
+	assertEquals(router.route("/users/bob/"), null);
+	assertEquals(router.route("/users/alice/posts/123"), {
+		name: "post",
+		template: "/users/{name}/posts/{postId}",
+		values: {
+			name: "alice",
+			postId: "123"
+		}
+	});
+	assertEquals(router.route("/users/bob/posts/456/"), null);
+	router = setUp({ trailingSlashInsensitive: true });
+	assertEquals(router.route("/users/alice"), {
+		name: "user",
+		template: "/users/{name}",
+		values: { name: "alice" }
+	});
+	assertEquals(router.route("/users/bob/"), {
+		name: "user",
+		template: "/users/{name}",
+		values: { name: "bob" }
+	});
+	assertEquals(router.route("/users/alice/posts/123"), {
+		name: "post",
+		template: "/users/{name}/posts/{postId}/",
+		values: {
+			name: "alice",
+			postId: "123"
+		}
+	});
+	assertEquals(router.route("/users/bob/posts/456/"), {
+		name: "post",
+		template: "/users/{name}/posts/{postId}/",
+		values: {
+			name: "bob",
+			postId: "456"
+		}
+	});
+});
+test("Router.build()", () => {
+	const router = setUp();
+	assertEquals(router.build("user", { name: "alice" }), "/users/alice");
+	assertEquals(router.build("post", {
+		name: "alice",
+		postId: "123"
+	}), "/users/alice/posts/123");
+});
+
+//#endregion

package/dist/federation/send.d.ts

@@ -0,0 +1,29 @@
+import { Temporal } from "@js-temporal/polyfill";
+import { URLPattern } from "urlpattern-polyfill";
+import { TracerProvider } from "@opentelemetry/api";
+
+//#region federation/send.d.ts
+/**
+* A key pair for an actor who sends an activity.
+* @since 0.10.0
+*/
+
+/**
+ * A key pair for an actor who sends an activity.
+ * @since 0.10.0
+ */
+interface SenderKeyPair {
+  /**
+   * The actor's private key to sign the request.
+   */
+  privateKey: CryptoKey;
+  /**
+   * The public key ID that corresponds to the private key.
+   */
+  keyId: URL;
+} //#endregion
+
+/**
+ * Parameters for {@link sendActivity}.
+ */
+export { SenderKeyPair };

package/dist/federation/send.js

@@ -0,0 +1,127 @@
+
+      import { Temporal } from "@js-temporal/polyfill";
+      import { URLPattern } from "urlpattern-polyfill";
+    
+import { deno_default } from "../deno.js";
+import { doubleKnock } from "../sig/http.js";
+import { getLogger } from "@logtape/logtape";
+import { SpanKind, SpanStatusCode, trace } from "@opentelemetry/api";
+
+//#region federation/send.ts
+/**
+* Extracts the inbox URLs from recipients.
+* @param parameters The parameters to extract the inboxes.
+*                   See also {@link ExtractInboxesParameters}.
+* @returns The inboxes as a map of inbox URL to actor URIs.
+*/
+function extractInboxes({ recipients, preferSharedInbox, excludeBaseUris }) {
+	const inboxes = {};
+	for (const recipient of recipients) {
+		let inbox;
+		let sharedInbox = false;
+		if (preferSharedInbox && recipient.endpoints?.sharedInbox != null) {
+			inbox = recipient.endpoints.sharedInbox;
+			sharedInbox = true;
+		} else inbox = recipient.inboxId;
+		if (inbox != null && recipient.id != null) {
+			if (excludeBaseUris != null && excludeBaseUris.some((u) => u.origin === inbox?.origin)) continue;
+			inboxes[inbox.href] ??= {
+				actorIds: new Set(),
+				sharedInbox
+			};
+			inboxes[inbox.href].actorIds.add(recipient.id.href);
+		}
+	}
+	return inboxes;
+}
+/**
+* Sends an {@link Activity} to an inbox.
+*
+* @param parameters The parameters for sending the activity.
+*                   See also {@link SendActivityParameters}.
+* @throws {Error} If the activity fails to send.
+*/
+function sendActivity(options) {
+	const tracerProvider = options.tracerProvider ?? trace.getTracerProvider();
+	const tracer = tracerProvider.getTracer(deno_default.name, deno_default.version);
+	return tracer.startActiveSpan("activitypub.send_activity", {
+		kind: SpanKind.CLIENT,
+		attributes: { "activitypub.shared_inbox": options.sharedInbox ?? false }
+	}, async (span) => {
+		if (options.activityId != null) span.setAttribute("activitypub.activity.id", options.activityId);
+		if (options.activityType != null) span.setAttribute("activitypub.activity.type", options.activityType);
+		try {
+			await sendActivityInternal({
+				...options,
+				tracerProvider
+			});
+		} catch (e) {
+			span.setStatus({
+				code: SpanStatusCode.ERROR,
+				message: String(e)
+			});
+			throw e;
+		} finally {
+			span.end();
+		}
+	});
+}
+async function sendActivityInternal({ activity, activityId, keys, inbox, headers, specDeterminer, tracerProvider }) {
+	const logger = getLogger([
+		"fedify",
+		"federation",
+		"outbox"
+	]);
+	headers = new Headers(headers);
+	headers.set("Content-Type", "application/activity+json");
+	const request = new Request(inbox, {
+		method: "POST",
+		headers,
+		body: JSON.stringify(activity)
+	});
+	let rsaKey = null;
+	for (const key of keys) if (key.privateKey.algorithm.name === "RSASSA-PKCS1-v1_5") {
+		rsaKey = key;
+		break;
+	}
+	if (rsaKey == null) logger.warn("No supported key found to sign the request to {inbox}.  The request will be sent without a signature.  In order to sign the request, at least one RSASSA-PKCS1-v1_5 key must be provided.", {
+		inbox: inbox.href,
+		keys: keys.map((pair) => ({
+			keyId: pair.keyId.href,
+			privateKey: pair.privateKey
+		}))
+	});
+	let response;
+	try {
+		response = rsaKey == null ? await fetch(request) : await doubleKnock(request, rsaKey, {
+			tracerProvider,
+			specDeterminer
+		});
+	} catch (error) {
+		logger.error("Failed to send activity {activityId} to {inbox}:\n{error}", {
+			activityId,
+			inbox: inbox.href,
+			error
+		});
+		throw error;
+	}
+	if (!response.ok) {
+		let error;
+		try {
+			error = await response.text();
+		} catch (_) {
+			error = "";
+		}
+		logger.error("Failed to send activity {activityId} to {inbox} ({status} {statusText}):\n{error}", {
+			activityId,
+			inbox: inbox.href,
+			status: response.status,
+			statusText: response.statusText,
+			error
+		});
+		throw new Error(`Failed to send activity ${activityId} to ${inbox.href} (${response.status} ${response.statusText}):\n${error}`);
+	}
+}
+
+//#endregion
+export { extractInboxes, sendActivity };

package/dist/federation/send.test.d.ts

@@ -0,0 +1,2 @@
+import { Temporal } from "@js-temporal/polyfill";
+import { URLPattern } from "urlpattern-polyfill";

package/dist/federation/send.test.js

@@ -0,0 +1,214 @@
+
+      import { Temporal } from "@js-temporal/polyfill";
+      import { URLPattern } from "urlpattern-polyfill";
+    
+import { Activity, Application, Endpoints, Group, Person, Service } from "../vocab/vocab.js";
+import { verifyRequest } from "../sig/http.js";
+import { doesActorOwnKey } from "../sig/owner.js";
+import { extractInboxes, sendActivity } from "./send.js";
+import { assert } from "../node_modules/.pnpm/@jsr_std__assert@0.226.0/node_modules/@jsr/std__assert/assert.js";
+import { assertEquals } from "../node_modules/.pnpm/@jsr_std__assert@0.226.0/node_modules/@jsr/std__assert/assert_equals.js";
+import { test } from "../testing/mod.js";
+import { assertFalse } from "../node_modules/.pnpm/@jsr_std__assert@0.226.0/node_modules/@jsr/std__assert/assert_false.js";
+import { assertNotEquals } from "../node_modules/.pnpm/@jsr_std__assert@0.226.0/node_modules/@jsr/std__assert/assert_not_equals.js";
+import { assertRejects } from "../node_modules/.pnpm/@jsr_std__assert@0.226.0/node_modules/@jsr/std__assert/assert_rejects.js";
+import { mockDocumentLoader } from "../testing/docloader.js";
+import { ed25519Multikey, ed25519PrivateKey, rsaPrivateKey2, rsaPublicKey2 } from "../testing/keys.js";
+import { install, mock, uninstall } from "../node_modules/.pnpm/@jsr_hongminhee__deno-mock-fetch@0.3.2/node_modules/@jsr/hongminhee__deno-mock-fetch/mod.js";
+
+//#region federation/send.test.ts
+test("extractInboxes()", () => {
+	const recipients = [
+		new Person({
+			id: new URL("https://example.com/alice"),
+			inbox: new URL("https://example.com/alice/inbox"),
+			endpoints: new Endpoints({ sharedInbox: new URL("https://example.com/inbox") })
+		}),
+		new Application({
+			id: new URL("https://example.com/app"),
+			inbox: new URL("https://example.com/app/inbox"),
+			endpoints: new Endpoints({ sharedInbox: new URL("https://example.com/inbox") })
+		}),
+		new Group({
+			id: new URL("https://example.org/group"),
+			inbox: new URL("https://example.org/group/inbox")
+		}),
+		new Service({
+			id: new URL("https://example.net/service"),
+			inbox: new URL("https://example.net/service/inbox"),
+			endpoints: new Endpoints({ sharedInbox: new URL("https://example.net/inbox") })
+		})
+	];
+	let inboxes = extractInboxes({ recipients });
+	assertEquals(inboxes, {
+		"https://example.com/alice/inbox": {
+			actorIds: new Set(["https://example.com/alice"]),
+			sharedInbox: false
+		},
+		"https://example.com/app/inbox": {
+			actorIds: new Set(["https://example.com/app"]),
+			sharedInbox: false
+		},
+		"https://example.org/group/inbox": {
+			actorIds: new Set(["https://example.org/group"]),
+			sharedInbox: false
+		},
+		"https://example.net/service/inbox": {
+			actorIds: new Set(["https://example.net/service"]),
+			sharedInbox: false
+		}
+	});
+	inboxes = extractInboxes({
+		recipients,
+		preferSharedInbox: true
+	});
+	assertEquals(inboxes, {
+		"https://example.com/inbox": {
+			actorIds: new Set(["https://example.com/alice", "https://example.com/app"]),
+			sharedInbox: true
+		},
+		"https://example.org/group/inbox": {
+			actorIds: new Set(["https://example.org/group"]),
+			sharedInbox: false
+		},
+		"https://example.net/inbox": {
+			actorIds: new Set(["https://example.net/service"]),
+			sharedInbox: true
+		}
+	});
+	inboxes = extractInboxes({
+		recipients,
+		excludeBaseUris: [new URL("https://foo.bar/")]
+	});
+	assertEquals(inboxes, {
+		"https://example.com/alice/inbox": {
+			actorIds: new Set(["https://example.com/alice"]),
+			sharedInbox: false
+		},
+		"https://example.com/app/inbox": {
+			actorIds: new Set(["https://example.com/app"]),
+			sharedInbox: false
+		},
+		"https://example.org/group/inbox": {
+			actorIds: new Set(["https://example.org/group"]),
+			sharedInbox: false
+		},
+		"https://example.net/service/inbox": {
+			actorIds: new Set(["https://example.net/service"]),
+			sharedInbox: false
+		}
+	});
+	inboxes = extractInboxes({
+		recipients,
+		excludeBaseUris: [new URL("https://example.com/")]
+	});
+	assertEquals(inboxes, {
+		"https://example.org/group/inbox": {
+			actorIds: new Set(["https://example.org/group"]),
+			sharedInbox: false
+		},
+		"https://example.net/service/inbox": {
+			actorIds: new Set(["https://example.net/service"]),
+			sharedInbox: false
+		}
+	});
+	inboxes = extractInboxes({
+		recipients,
+		preferSharedInbox: true,
+		excludeBaseUris: [new URL("https://example.com/")]
+	});
+	assertEquals(inboxes, {
+		"https://example.org/group/inbox": {
+			actorIds: new Set(["https://example.org/group"]),
+			sharedInbox: false
+		},
+		"https://example.net/inbox": {
+			actorIds: new Set(["https://example.net/service"]),
+			sharedInbox: true
+		}
+	});
+});
+test("sendActivity()", async (t) => {
+	install();
+	let httpSigVerified = null;
+	let request = null;
+	mock("POST@/inbox", async (req) => {
+		httpSigVerified = false;
+		request = req.clone();
+		const options = {
+			documentLoader: mockDocumentLoader,
+			contextLoader: mockDocumentLoader
+		};
+		const key = await verifyRequest(request, options);
+		const activity = await Activity.fromJsonLd(await request.json(), options);
+		if (key != null && await doesActorOwnKey(activity, key, options)) httpSigVerified = true;
+		if (httpSigVerified) return new Response("", { status: 202 });
+		return new Response("", { status: 401 });
+	});
+	await t.step("success", async () => {
+		const activity = {
+			"@context": "https://www.w3.org/ns/activitystreams",
+			"type": "Create",
+			"id": "https://example.com/activity",
+			"actor": "https://example.com/person"
+		};
+		await sendActivity({
+			activity,
+			keys: [{
+				privateKey: rsaPrivateKey2,
+				keyId: rsaPublicKey2.id
+			}],
+			inbox: new URL("https://example.com/inbox"),
+			headers: new Headers({ "X-Test": "test" })
+		});
+		assert(httpSigVerified);
+		assertNotEquals(request, null);
+		assertEquals(request?.method, "POST");
+		assertEquals(request?.url, "https://example.com/inbox");
+		assertEquals(request?.headers.get("Content-Type"), "application/activity+json");
+		assertEquals(request?.headers.get("X-Test"), "test");
+		httpSigVerified = null;
+		await assertRejects(() => sendActivity({
+			activity: {
+				...activity,
+				actor: "https://example.com/person2"
+			},
+			keys: [{
+				privateKey: ed25519PrivateKey,
+				keyId: ed25519Multikey.id
+			}],
+			inbox: new URL("https://example.com/inbox")
+		}));
+		assertFalse(httpSigVerified);
+		assertNotEquals(request, null);
+		assertEquals(request?.method, "POST");
+		assertEquals(request?.url, "https://example.com/inbox");
+		assertEquals(request?.headers.get("Content-Type"), "application/activity+json");
+	});
+	mock("POST@/inbox2", (_req) => {
+		return new Response("something went wrong", {
+			status: 500,
+			statusText: "Internal Server Error"
+		});
+	});
+	await t.step("failure", async () => {
+		const activity = {
+			"@context": "https://www.w3.org/ns/activitystreams",
+			"type": "Create",
+			"id": "https://example.com/activity",
+			"actor": "https://example.com/person"
+		};
+		await assertRejects(() => sendActivity({
+			activity,
+			activityId: "https://example.com/activity",
+			keys: [{
+				privateKey: rsaPrivateKey2,
+				keyId: rsaPublicKey2.id
+			}],
+			inbox: new URL("https://example.com/inbox2")
+		}), Error, "Failed to send activity https://example.com/activity to https://example.com/inbox2 (500 Internal Server Error):\nsomething went wrong");
+	});
+	uninstall();
+});
+
+//#endregion