@fedify/fedify 2.1.30 → 2.1.31

package/dist/utils/docloader.test.mjs

@@ -5,15 +5,30 @@ import { t as esm_default } from "../esm-DVILvP5e.mjs";
 import { t as assertEquals } from "../assert_equals-Ew3jOFa3.mjs";
 import "../std__assert-DflMZha5.mjs";
 import { t as assertRejects } from "../assert_rejects-WyYSTDDX.mjs";
-import { l as verifyRequest } from "../http-Bjd6I92u.mjs";
+import { u as verifyRequest } from "../http-A9mP2uM7.mjs";
 import { i as rsaPrivateKey2 } from "../keys-CtZLJq76.mjs";
-import { t as getAuthenticatedDocumentLoader } from "../docloader-OLWc7P2D.mjs";
+import { n as getAuthenticatedDocumentLoader, t as createAuthenticatedDocumentLoader } from "../docloader-DOrwedT7.mjs";
 import { mockDocumentLoader, test } from "@fedify/fixture";
 import { FetchError, UrlError } from "@fedify/vocab-runtime";
+import { openDirectFetch, openPublicFetch } from "@fedify/vocab-runtime/internal";
 import { configure, reset } from "@logtape/logtape";
-import dns from "node:dns/promises";
 import { deepStrictEqual, ok, rejects } from "node:assert/strict";
 //#region src/utils/docloader.test.ts
+const identity = {
+	keyId: new URL("https://example.com/key2"),
+	privateKey: rsaPrivateKey2
+};
+const directDeps = { openHop: openDirectFetch };
+function publicPolicyHop(lookup) {
+	return async (url) => {
+		await (await openPublicFetch(url, { lookup })).close();
+		return openDirectFetch(url);
+	};
+}
+const publicLookup = () => Promise.resolve([{
+	address: "8.8.8.8",
+	family: 4
+}]);
 test("getAuthenticatedDocumentLoader()", async (t) => {
 	esm_default.spyGlobal();
 	esm_default.get("begin:https://example.com/object", async (cl) => {
@@ -25,10 +40,7 @@ test("getAuthenticatedDocumentLoader()", async (t) => {
 		return new Response(JSON.stringify(v != null), { headers: { "Content-Type": "application/json" } });
 	});
 	await t.step("test", async () => {
-		assertEquals(await (await getAuthenticatedDocumentLoader({
-			keyId: new URL("https://example.com/key2"),
-			privateKey: rsaPrivateKey2
-		}))("https://example.com/object"), {
+		assertEquals(await createAuthenticatedDocumentLoader(identity, {}, directDeps)("https://example.com/object"), {
 			contextUrl: null,
 			documentUrl: "https://example.com/object",
 			document: true
@@ -58,21 +70,16 @@ test("getAuthenticatedDocumentLoader() validates redirects", async (t) => {
 		privateRequestCount++;
 		return Response.json({ private: true });
 	});
+	const policyDeps = { openHop: publicPolicyHop(publicLookup) };
 	await t.step("deny public-to-private redirects", async () => {
-		const loader = getAuthenticatedDocumentLoader({
-			keyId: new URL("https://example.com/key2"),
-			privateKey: rsaPrivateKey2
-		});
+		const loader = createAuthenticatedDocumentLoader(identity, {}, policyDeps);
 		await assertRejects(() => loader("https://example.com/redirect-to-private"), UrlError);
 		assertEquals(privateRequestCount, 0);
 	});
 	esm_default.get("https://example.com/redirect-to-public", () => Response.redirect("https://www.example.com/document", 302));
 	esm_default.get("https://www.example.com/document", () => Response.json({ public: true }));
 	await t.step("allow public-to-public redirects", async () => {
-		assertEquals((await getAuthenticatedDocumentLoader({
-			keyId: new URL("https://example.com/key2"),
-			privateKey: rsaPrivateKey2
-		})("https://example.com/redirect-to-public")).document, { public: true });
+		assertEquals((await createAuthenticatedDocumentLoader(identity, {}, policyDeps)("https://example.com/redirect-to-public")).document, { public: true });
 	});
 	await t.step("allow private redirects when explicitly enabled", async () => {
 		assertEquals((await getAuthenticatedDocumentLoader({
@@ -102,10 +109,7 @@ test("getAuthenticatedDocumentLoader() cancellation", async (t) => {
 						});
 					}, 1e3);
 				}));
-				const loader = getAuthenticatedDocumentLoader({
-					keyId: new URL("https://example.com/key2"),
-					privateKey: rsaPrivateKey2
-				});
+				const loader = createAuthenticatedDocumentLoader(identity, {}, directDeps);
 				const controller = new AbortController();
 				const promise = loader("https://example.com/slow-object", { signal: controller.signal });
 				controller.abort();
@@ -116,10 +120,7 @@ test("getAuthenticatedDocumentLoader() cancellation", async (t) => {
 			}
 		});
 		await t.step("immediate cancellation", async () => {
-			const loader = getAuthenticatedDocumentLoader({
-				keyId: new URL("https://example.com/key2"),
-				privateKey: rsaPrivateKey2
-			});
+			const loader = createAuthenticatedDocumentLoader(identity, {}, directDeps);
 			const controller = new AbortController();
 			controller.abort();
 			await assertRejects(() => loader("https://example.com/object", { signal: controller.signal }), Error);
@@ -152,21 +153,17 @@ test("getAuthenticatedDocumentLoader() bounds JSON after redirects", async () =>
 		esm_default.hardReset();
 	}
 });
-test("getAuthenticatedDocumentLoader() logs DNS failures as such", { ignore: "Deno" in globalThis && (await Deno.permissions.query({ name: "net" })).state !== "granted" }, async (t) => {
-	const loader = getAuthenticatedDocumentLoader({
-		keyId: new URL("https://example.com/key2"),
-		privateKey: rsaPrivateKey2
-	});
+test("getAuthenticatedDocumentLoader() logs DNS failures as such", async (t) => {
 	for (const result of [
 		"throws",
 		"empty",
 		"private"
 	]) await t.step(result, async () => {
-		const originalLookup = dns.lookup;
-		dns.lookup = (() => result === "throws" ? Promise.reject(/* @__PURE__ */ new Error("Resolver unavailable")) : Promise.resolve(result === "empty" ? [] : [{
+		const lookup = () => result === "throws" ? Promise.reject(/* @__PURE__ */ new Error("Resolver unavailable")) : Promise.resolve(result === "empty" ? [] : [{
 			address: "127.0.0.1",
 			family: 4
-		}]));
+		}]);
+		const loader = createAuthenticatedDocumentLoader(identity, {}, { openHop: (url) => openPublicFetch(url, { lookup }) });
 		const records = [];
 		await configure({
 			sinks: { buffer: (record) => records.push(record) },
@@ -200,7 +197,6 @@ test("getAuthenticatedDocumentLoader() logs DNS failures as such", { ignore: "De
 			assertEquals(records[0].properties.error, error);
 		} finally {
 			await reset();
-			dns.lookup = originalLookup;
 		}
 	});
 });
@@ -445,6 +441,211 @@ test("getAuthenticatedDocumentLoader() rejects cancellation before fetching", as
 		esm_default.hardReset();
 	}
 });
+test("getAuthenticatedDocumentLoader() closes each hop before opening the next", async (t) => {
+	await t.step("redirect", async () => {
+		const start = "https://example.com/lifecycle/start";
+		const next = "https://example.com/lifecycle/document";
+		const hops = recordHops((request) => request.url === start ? {
+			status: 302,
+			headers: { Location: next },
+			body: "Found"
+		} : {
+			headers: { "Content-Type": "application/activity+json" },
+			body: "{\"done\":true}"
+		});
+		deepStrictEqual(await createAuthenticatedDocumentLoader(identity, {}, hops)(start), {
+			contextUrl: null,
+			document: { done: true },
+			documentUrl: next
+		});
+		deepStrictEqual(hops.events, [
+			`open ${start}`,
+			`fetch #1 ${start}`,
+			"cancel #1",
+			`close ${start}`,
+			`open ${next}`,
+			`fetch #2 ${next}`,
+			"consumed #2",
+			`close ${next}`
+		]);
+		hops.assertInvariants();
+	});
+	await t.step("Link header alternate", async () => {
+		const start = "https://example.com/lifecycle/page";
+		const next = "https://example.com/lifecycle/alternate";
+		const hops = recordHops((request) => request.url === start ? {
+			headers: {
+				"Content-Type": "text/plain",
+				Link: `<${next}>; rel="alternate"; type="application/activity+json"`
+			},
+			body: "not JSON"
+		} : {
+			headers: { "Content-Type": "application/activity+json" },
+			body: "{\"done\":true}"
+		});
+		deepStrictEqual((await createAuthenticatedDocumentLoader(identity, {}, hops)(start)).document, { done: true });
+		deepStrictEqual(hops.events, [
+			`open ${start}`,
+			`fetch #1 ${start}`,
+			"cancel #1",
+			`close ${start}`,
+			`open ${next}`,
+			`fetch #2 ${next}`,
+			"consumed #2",
+			`close ${next}`
+		]);
+		hops.assertInvariants();
+	});
+	await t.step("one lookup per hop", async () => {
+		const start = "https://first.example/start";
+		const next = "https://second.example/document";
+		const lookups = [];
+		const lookup = (hostname) => {
+			lookups.push(hostname);
+			return Promise.resolve([{
+				address: "8.8.8.8",
+				family: 4
+			}]);
+		};
+		await withFetchStub((request) => new URL(request.url).pathname === "/start" ? Response.redirect(next, 302) : Response.json({ done: true }), async (fetched) => {
+			deepStrictEqual((await createAuthenticatedDocumentLoader(identity, {}, { openHop: (url) => openPublicFetch(url, { lookup }) })(start)).document, { done: true });
+			deepStrictEqual(lookups, ["first.example", "second.example"]);
+			deepStrictEqual(fetched.length, 2);
+		});
+	});
+});
+async function captureLogs(fn) {
+	const records = [];
+	await configure({
+		sinks: { buffer: (record) => records.push(record) },
+		loggers: [{
+			category: "fedify",
+			sinks: ["buffer"],
+			lowestLevel: "debug"
+		}, {
+			category: ["logtape", "meta"],
+			sinks: []
+		}],
+		reset: true
+	});
+	try {
+		await fn();
+		await new Promise((resolve) => setTimeout(resolve, 0));
+	} finally {
+		await reset();
+	}
+	return records;
+}
+function getCancelFailures(records) {
+	return records.filter((r) => r.rawMessage === "Failed to cancel the response body from {url}: {error}").map((r) => r.properties.error.message);
+}
+const linkAlternate = (next) => ({
+	headers: {
+		"Content-Type": "text/plain",
+		Link: `<${next}>; rel="alternate"; type="application/activity+json"`
+	},
+	body: "not JSON"
+});
+const jsonDocument = {
+	headers: { "Content-Type": "application/activity+json" },
+	body: "{\"done\":true}"
+};
+test("getAuthenticatedDocumentLoader() logs bodies failing to cancel and loads the next hop", async (t) => {
+	for (const kind of ["redirect", "Link header alternate"]) await t.step(kind, async () => {
+		const start = "https://example.com/lifecycle/cancel-failure";
+		const next = "https://example.com/lifecycle/cancel-failure-next";
+		const hops = recordHops((request) => request.url === start ? {
+			...kind === "redirect" ? {
+				status: 302,
+				headers: { Location: next },
+				body: "Found"
+			} : linkAlternate(next),
+			failCancel: true
+		} : jsonDocument);
+		const loader = createAuthenticatedDocumentLoader(identity, {}, hops);
+		let document;
+		const records = await captureLogs(async () => {
+			document = (await loader(start)).document;
+		});
+		deepStrictEqual(document, { done: true });
+		deepStrictEqual(hops.events, [
+			`open ${start}`,
+			`fetch #1 ${start}`,
+			"cancel #1",
+			`close ${start}`,
+			`open ${next}`,
+			`fetch #2 ${next}`,
+			"consumed #2",
+			`close ${next}`
+		]);
+		deepStrictEqual(getCancelFailures(records), ["cancel #1 failed"]);
+		hops.assertInvariants();
+	});
+});
+test("getAuthenticatedDocumentLoader() is not blocked by a body cancellation that never settles", async (t) => {
+	await t.step("redirect and Link header alternate", async () => {
+		const start = "https://example.com/lifecycle/hanging-start";
+		const page = "https://example.com/lifecycle/hanging-page";
+		const next = "https://example.com/lifecycle/hanging-document";
+		const hops = recordHops((request) => ({
+			...request.url === start ? {
+				status: 302,
+				headers: { Location: page },
+				body: "Found"
+			} : request.url === page ? linkAlternate(next) : jsonDocument,
+			hangCancel: true
+		}));
+		deepStrictEqual((await createAuthenticatedDocumentLoader(identity, {}, hops)(start)).document, { done: true });
+		deepStrictEqual(hops.events, [
+			`open ${start}`,
+			`fetch #1 ${start}`,
+			"cancel #1",
+			`close ${start}`,
+			`open ${page}`,
+			`fetch #2 ${page}`,
+			"cancel #2",
+			`close ${page}`,
+			`open ${next}`,
+			`fetch #3 ${next}`,
+			"consumed #3",
+			`close ${next}`
+		]);
+		hops.assertInvariants();
+	});
+	await t.step("not found", async () => {
+		const url = "https://example.com/lifecycle/hanging-missing";
+		const hops = recordHops(() => ({
+			status: 404,
+			body: "Not Found",
+			hangCancel: true
+		}));
+		await rejects(createAuthenticatedDocumentLoader(identity, {}, hops)(url), FetchError);
+		deepStrictEqual(hops.events.slice(0, 2), [`open ${url}`, `fetch #1 ${url}`]);
+		deepStrictEqual(hops.events.at(-1), `close ${url}`);
+		hops.assertInvariants();
+	});
+});
+test("getAuthenticatedDocumentLoader() completes with responses cloned by fetch-mock", async () => {
+	esm_default.mockGlobal();
+	try {
+		const base = "https://example.com/tee/";
+		esm_default.get(`${base}start`, () => new Response("Found", {
+			status: 302,
+			headers: { Location: `${base}page` }
+		}));
+		esm_default.get(`${base}page`, () => new Response("not JSON", { headers: {
+			"Content-Type": "text/plain",
+			Link: `<${base}document>; rel="alternate"; type="application/activity+json"`
+		} }));
+		esm_default.get(`${base}document`, () => new Response("{\"done\":true}", { headers: { "Content-Type": "application/activity+json" } }));
+		esm_default.get(`${base}missing`, () => new Response("Not Found", { status: 404 }));
+		const loader = createAuthenticatedDocumentLoader(identity, {}, directDeps);
+		deepStrictEqual((await loader(`${base}start`)).document, { done: true });
+		await rejects(loader(`${base}missing`), FetchError);
+	} finally {
+		esm_default.hardReset();
+	}
+});
 const unsupportedUrls = [
 	"ftp://example.com/collection",
 	"file:///collection",
@@ -579,5 +780,88 @@ for (const url of unsupportedUrls) {
 		});
 	});
 }
+function createRecordedResponse(events, index, init, cancelSuffix = () => "") {
+	const bytes = new TextEncoder().encode(init.body ?? "");
+	const chunkSize = init.chunkSize ?? 256;
+	let offset = 0;
+	let settled = false;
+	const body = new ReadableStream({
+		pull(controller) {
+			if (offset >= bytes.length) {
+				settled = true;
+				events.push(`consumed #${index}`);
+				controller.close();
+				return;
+			}
+			controller.enqueue(bytes.slice(offset, offset + chunkSize));
+			offset += chunkSize;
+		},
+		cancel() {
+			settled = true;
+			events.push(`cancel #${index}${cancelSuffix()}`);
+			if (init.failCancel) throw new Error(`cancel #${index} failed`);
+			if (init.hangCancel) return new Promise(() => {});
+		}
+	}, { highWaterMark: 0 });
+	return {
+		response: new Response(body, {
+			status: init.status ?? 200,
+			headers: init.headers
+		}),
+		settled: () => settled
+	};
+}
+function recordHops(respond) {
+	const events = [];
+	const requests = [];
+	const unsettledAtClose = [];
+	let opens = 0;
+	let closes = 0;
+	let fetches = 0;
+	return {
+		events,
+		requests,
+		openHop(url) {
+			opens++;
+			events.push(`open ${url}`);
+			const tracked = [];
+			let closed = false;
+			let closing = false;
+			return Promise.resolve({
+				url: new URL(url),
+				async fetch(input, init) {
+					if (closed) throw new TypeError("The session is closed.");
+					const request = new Request(input instanceof Request ? input.clone() : input, init);
+					const index = ++fetches;
+					requests.push(request);
+					events.push(`fetch #${index} ${request.url}`);
+					const recorded = createRecordedResponse(events, index, await respond(request, index), () => closing ? " by close" : "");
+					tracked.push({
+						...recorded,
+						index
+					});
+					return recorded.response;
+				},
+				close() {
+					if (closed) return Promise.resolve();
+					closed = true;
+					closes++;
+					closing = true;
+					for (const { response, settled, index } of tracked) {
+						if (settled()) continue;
+						if (response.body?.locked) unsettledAtClose.push(index);
+						else response.body?.cancel().catch(() => {});
+					}
+					events.push(`close ${url}`);
+					return Promise.resolve();
+				}
+			});
+		},
+		assertInvariants() {
+			deepStrictEqual(opens, closes);
+			deepStrictEqual(unsettledAtClose, []);
+		}
+	};
+}
 //#endregion
 export {};

package/dist/utils/mod.cjs

@@ -1,6 +1,6 @@
 const { Temporal } = require("@js-temporal/polyfill");
 const { URLPattern } = require("urlpattern-polyfill");
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_kv_cache = require("../kv-cache-BxSx_Iyp.cjs");
+const require_kv_cache = require("../kv-cache-Cqmm-yQa.cjs");
 exports.getAuthenticatedDocumentLoader = require_kv_cache.getAuthenticatedDocumentLoader;
 exports.kvCache = require_kv_cache.kvCache;

package/dist/utils/mod.d.cts

@@ -1,3 +1,3 @@
 /// <reference lib="esnext.temporal" />
-import { n as getAuthenticatedDocumentLoader, t as kvCache } from "../mod-Cn9GJ5ex.cjs";
+import { n as getAuthenticatedDocumentLoader, t as kvCache } from "../mod-Co7LEK9X.cjs";
 export { getAuthenticatedDocumentLoader, kvCache };

package/dist/utils/mod.d.ts

@@ -1,3 +1,3 @@
 /// <reference lib="esnext.temporal" />
-import { n as getAuthenticatedDocumentLoader, t as kvCache } from "../mod-DNEgTI8M.js";
+import { n as getAuthenticatedDocumentLoader, t as kvCache } from "../mod-BRnwh2oy.js";
 export { getAuthenticatedDocumentLoader, kvCache };

package/dist/utils/mod.js

@@ -1,4 +1,4 @@
 import { Temporal } from "@js-temporal/polyfill";
 import { URLPattern } from "urlpattern-polyfill";
-import { n as getAuthenticatedDocumentLoader, t as kvCache } from "../kv-cache-ImApO425.js";
+import { n as getAuthenticatedDocumentLoader, t as kvCache } from "../kv-cache-DQcyZL5T.js";
 export { getAuthenticatedDocumentLoader, kvCache };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/fedify",
-  "version": "2.1.30",
+  "version": "2.1.31",
   "description": "An ActivityPub server framework",
   "keywords": [
     "ActivityPub",
@@ -132,7 +132,7 @@
   "dependencies": {
     "@js-temporal/polyfill": "^0.5.1",
     "@logtape/logtape": "^2.0.5",
-    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/api": "~1.9.0",
     "@opentelemetry/core": "^2.5.0",
     "@opentelemetry/sdk-trace-base": "^2.5.0",
     "@opentelemetry/semantic-conventions": "^1.39.0",
@@ -144,9 +144,9 @@
     "uri-template-router": "^1.0.0",
     "url-template": "^3.1.1",
     "urlpattern-polyfill": "^10.1.0",
-    "@fedify/vocab": "2.1.30",
-    "@fedify/webfinger": "2.1.30",
-    "@fedify/vocab-runtime": "2.1.30"
+    "@fedify/vocab-runtime": "2.1.31",
+    "@fedify/webfinger": "2.1.31",
+    "@fedify/vocab": "2.1.31"
   },
   "devDependencies": {
     "@std/assert": "npm:@jsr/std__assert@^0.226.0",
@@ -159,7 +159,7 @@
     "typescript": "^6.0.0",
     "wrangler": "^4.17.0",
     "@fedify/fixture": "2.0.0",
-    "@fedify/vocab-tools": "^2.1.30"
+    "@fedify/vocab-tools": "^2.1.31"
   },
   "scripts": {
     "build:self": "tsdown",

package/dist/docloader-OLWc7P2D.mjs

@@ -1,82 +0,0 @@
-import "@js-temporal/polyfill";
-import "urlpattern-polyfill";
-globalThis.addEventListener = () => {};
-import { s as validateCryptoKey } from "./key-ClQh9Qqh.mjs";
-import { n as doubleKnock } from "./http-Bjd6I92u.mjs";
-import { curry } from "es-toolkit";
-import { FetchError, UrlError, createActivityPubRequest, getRemoteDocument, logRequest, validatePublicUrl } from "@fedify/vocab-runtime";
-import { getLogger } from "@logtape/logtape";
-//#region src/utils/docloader.ts
-const logger = getLogger([
-	"fedify",
-	"utils",
-	"docloader"
-]);
-const DEFAULT_MAX_REDIRECTION = 20;
-/**
-* Gets an authenticated {@link DocumentLoader} for the given identity.
-* Note that an authenticated document loader intentionally does not cache
-* the fetched documents.
-* At most 20 HTTP redirects and alternate document links are followed in total
-* per call.  Revisiting a URL within that chain throws a {@link FetchError}.
-* @param identity The identity to get the document loader for.
-*                 The actor's key pair.
-* @param options The options for the document loader.
-* @returns The authenticated document loader.
-* @throws {TypeError} If the key is invalid or unsupported.
-* @since 0.4.0
-*/
-function getAuthenticatedDocumentLoader(identity, { allowPrivateAddress, userAgent, specDeterminer, tracerProvider } = {}) {
-	validateCryptoKey(identity.privateKey);
-	async function load(url, options, redirected = 0, visited = /* @__PURE__ */ new Set()) {
-		options?.signal?.throwIfAborted();
-		let currentUrl = new URL(url).href;
-		await validateUrl(currentUrl);
-		visited.add(currentUrl);
-		const originalRequest = createActivityPubRequest(currentUrl, { userAgent });
-		function follow(nextUrl) {
-			options?.signal?.throwIfAborted();
-			if (redirected >= DEFAULT_MAX_REDIRECTION) throw new FetchError(currentUrl, `Too many redirections (${redirected + 1})`);
-			if (visited.has(nextUrl)) throw new FetchError(currentUrl, `Redirect loop detected: ${nextUrl}`);
-			redirected++;
-		}
-		const response = await doubleKnock(originalRequest, identity, {
-			specDeterminer,
-			log: curry(logRequest)(logger),
-			tracerProvider,
-			signal: options?.signal,
-			validateRedirect: async (nextUrl) => {
-				follow(nextUrl);
-				await validateUrl(nextUrl);
-				visited.add(nextUrl);
-				currentUrl = nextUrl;
-			}
-		});
-		return getRemoteDocument(currentUrl, response, (alternateUrl) => {
-			follow(alternateUrl);
-			return load(alternateUrl, options, redirected, visited);
-		});
-	}
-	async function validateUrl(url) {
-		const parsedUrl = new URL(url);
-		const protocol = parsedUrl.protocol;
-		if (protocol !== "http:" && protocol !== "https:") throw new UrlError(`Unsupported protocol: ${protocol}`);
-		if (parsedUrl.username !== "" || parsedUrl.password !== "") throw new UrlError("URLs with credentials are not allowed");
-		if (!allowPrivateAddress) try {
-			await validatePublicUrl(url);
-		} catch (error) {
-			if (error instanceof UrlError) if (error.reason === "dns") logger.debug("DNS lookup failed for {url}", {
-				url,
-				error
-			});
-			else logger.error("Disallowed private URL: {url}", {
-				url,
-				error
-			});
-			throw error;
-		}
-	}
-	return (url, options) => load(url, options);
-}
-//#endregion
-export { getAuthenticatedDocumentLoader as t };