@fedify/fedify 2.3.0-dev.994 → 2.3.0-pr.809.37

package/dist/{http-aQzN9Ayi.d.ts → http-VyDTd4G3.d.cts}

@@ -1,8 +1,7 @@
-import { Temporal } from "@js-temporal/polyfill";
-import { URLPattern } from "urlpattern-polyfill";
+/// <reference lib="esnext.temporal" />
 import { CryptographicKey, Multikey } from "@fedify/vocab";
-import { TracerProvider } from "@opentelemetry/api";
 import { DocumentLoader } from "@fedify/vocab-runtime";
+import { MeterProvider, TracerProvider } from "@opentelemetry/api";
 
 //#region src/sig/key.d.ts
 /**
@@ -53,6 +52,13 @@ interface FetchKeyOptions {
   * @since 1.3.0
   */
   tracerProvider?: TracerProvider;
+  /**
+  * The OpenTelemetry meter provider to use for recording
+  * `activitypub.key.lookup` and `activitypub.key.lookup.duration`.  If
+  * omitted, the global meter provider is used.
+  * @since 2.3.0
+  */
+  meterProvider?: MeterProvider;
 }
 /**
 * The result of {@link fetchKey}.
@@ -465,6 +471,12 @@ interface VerifyRequestOptions {
   * @since 1.3.0
   */
   tracerProvider?: TracerProvider;
+  /**
+  * The OpenTelemetry meter provider.  If omitted, the global meter provider
+  * is used.
+  * @since 2.3.0
+  */
+  meterProvider?: MeterProvider;
 }
 /**
 * The reason why {@link verifyRequestDetailed} could not verify a request.

package/dist/{http-CrGuipxe.d.cts → http-lf8Hsd91.d.ts}

@@ -1,6 +1,7 @@
+/// <reference lib="esnext.temporal" />
 import { CryptographicKey, Multikey } from "@fedify/vocab";
+import { MeterProvider, TracerProvider } from "@opentelemetry/api";
 import { DocumentLoader } from "@fedify/vocab-runtime";
-import { TracerProvider } from "@opentelemetry/api";
 
 //#region src/sig/key.d.ts
 /**
@@ -51,6 +52,13 @@ interface FetchKeyOptions {
   * @since 1.3.0
   */
   tracerProvider?: TracerProvider;
+  /**
+  * The OpenTelemetry meter provider to use for recording
+  * `activitypub.key.lookup` and `activitypub.key.lookup.duration`.  If
+  * omitted, the global meter provider is used.
+  * @since 2.3.0
+  */
+  meterProvider?: MeterProvider;
 }
 /**
 * The result of {@link fetchKey}.
@@ -463,6 +471,12 @@ interface VerifyRequestOptions {
   * @since 1.3.0
   */
   tracerProvider?: TracerProvider;
+  /**
+  * The OpenTelemetry meter provider.  If omitted, the global meter provider
+  * is used.
+  * @since 2.3.0
+  */
+  meterProvider?: MeterProvider;
 }
 /**
 * The reason why {@link verifyRequestDetailed} could not verify a request.

package/dist/{key-Bzx--sHD.mjs → key-Dqdlo3mG.mjs}

@@ -1,11 +1,12 @@
 import "@js-temporal/polyfill";
 import "urlpattern-polyfill";
 globalThis.addEventListener = () => {};
-import { n as version, t as name } from "./deno-XBVlKnOX.mjs";
+import { n as version, t as name } from "./deno-BID9qTPk.mjs";
+import { _ as recordKeyLookup, n as getDurationMs, t as classifyFetchError } from "./metrics-ColY3QKj.mjs";
+import { getLogger } from "@logtape/logtape";
 import { CryptographicKey, Object as Object$1, isActor } from "@fedify/vocab";
 import { SpanKind, SpanStatusCode, trace } from "@opentelemetry/api";
 import { FetchError, getDocumentLoader } from "@fedify/vocab-runtime";
-import { getLogger } from "@logtape/logtape";
 //#region src/sig/key.ts
 /**
 * Checks if the given key is valid and supported.  No-op if the key is valid,
@@ -306,24 +307,48 @@ async function resolveFetchedKey(document, cacheKey, keyId, cls, { documentLoade
 	};
 }
 async function fetchKeyWithResult(cacheKey, cls, options, onCachedUnavailable, onFetchError) {
-	const logger = getLogger([
-		"fedify",
-		"sig",
-		"key"
-	]);
-	const keyId = cacheKey.href;
-	const keyCache = options.keyCache;
-	const cached = await getCachedFetchKey(cacheKey, keyId, cls, keyCache, logger);
-	if (cached?.key === null && cached.cached) return await onCachedUnavailable(cacheKey, keyId, keyCache, logger);
-	if (cached != null) return cached;
-	logger.debug("Fetching key {keyId} to verify signature...", { keyId });
-	let document;
+	const start = performance.now();
+	let outcome = { result: "error" };
 	try {
-		document = (await (options.documentLoader ?? getDocumentLoader())(keyId)).document;
-	} catch (error) {
-		return await onFetchError(error, cacheKey, keyId, keyCache, logger);
+		const logger = getLogger([
+			"fedify",
+			"sig",
+			"key"
+		]);
+		const keyId = cacheKey.href;
+		const keyCache = options.keyCache;
+		const cached = await getCachedFetchKey(cacheKey, keyId, cls, keyCache, logger);
+		if (cached?.key === null && cached.cached) {
+			const cachedUnavailable = await onCachedUnavailable(cacheKey, keyId, keyCache, logger);
+			outcome = { result: "hit" };
+			return cachedUnavailable;
+		}
+		if (cached != null) {
+			outcome = { result: "hit" };
+			return cached;
+		}
+		logger.debug("Fetching key {keyId} to verify signature...", { keyId });
+		let document;
+		try {
+			document = (await (options.documentLoader ?? getDocumentLoader())(keyId)).document;
+		} catch (error) {
+			const classified = classifyFetchError(error);
+			const errored = await onFetchError(error, cacheKey, keyId, keyCache, logger);
+			outcome = classified;
+			return errored;
+		}
+		const resolved = await resolveFetchedKey(document, cacheKey, keyId, cls, options, logger);
+		outcome = { result: resolved.key != null ? "fetched" : "invalid" };
+		return resolved;
+	} finally {
+		recordKeyLookup(options.meterProvider, {
+			durationMs: getDurationMs(start),
+			result: outcome.result,
+			remoteUrl: cacheKey,
+			cacheEnabled: options.keyCache != null,
+			statusCode: outcome.statusCode
+		});
 	}
-	return await resolveFetchedKey(document, cacheKey, keyId, cls, options, logger);
 }
 async function fetchKeyInternal(keyId, cls, options = {}) {
 	return await fetchKeyWithResult(typeof keyId === "string" ? new URL(keyId) : keyId, cls, options, (_cacheKey, _keyId, _keyCache, _logger) => {

package/dist/{kv-CbLNp3zQ.d.cts → kv-D6hNiMTK.d.ts}

@@ -1,3 +1,4 @@
+/// <reference lib="esnext.temporal" />
 //#region src/federation/kv.d.ts
 /**
 * A key for a key–value store.  An array of one or more strings.

package/dist/{kv-cache-DI-Sk7-I.cjs → kv-cache-BQ1-zDKX.cjs}

@@ -1,7 +1,7 @@
 const { Temporal } = require("@js-temporal/polyfill");
 const { URLPattern } = require("urlpattern-polyfill");
 require("./chunk-DDcVe30Y.cjs");
-const require_http = require("./http-BrGqJDXL.cjs");
+const require_http = require("./http-CjZwUPiT.cjs");
 let _logtape_logtape = require("@logtape/logtape");
 let es_toolkit = require("es-toolkit");
 let _fedify_vocab_runtime = require("@fedify/vocab-runtime");
@@ -56,10 +56,25 @@ const logger = (0, _logtape_logtape.getLogger)([
 * @param parameters The parameters for the cache.
 * @returns The decorated document loader which is cache-enabled.
 */
-function kvCache({ loader, kv, prefix, rules }) {
+function kvCache({ loader, kv, prefix, rules, meterProvider, kind }) {
 	const keyPrefix = prefix ?? ["_fedify", "remoteDocument"];
 	rules ??= [[new URLPattern({}), Temporal.Duration.from({ minutes: 5 })]];
 	for (const [p, duration] of rules) if (Temporal.Duration.compare(duration, { days: 30 }) > 0) throw new TypeError("The maximum cache duration is 30 days: " + (p instanceof URLPattern ? `${p.protocol}://${p.username}:${p.password}@${p.hostname}:${p.port}/${p.pathname}?${p.search}#${p.hash}` : p.toString()));
+	const lookupKind = kind ?? "object";
+	function emitCacheMetric(url, result) {
+		if (meterProvider == null) return;
+		let remoteUrl;
+		try {
+			remoteUrl = new URL(url);
+		} catch {
+			remoteUrl = void 0;
+		}
+		require_http.recordDocumentCache(meterProvider, {
+			kind: lookupKind,
+			result,
+			remoteUrl
+		});
+	}
 	return async (url, options) => {
 		if (url in _fedify_vocab_runtime.preloadedContexts) {
 			logger.debug("Using preloaded context: {url}.", { url });
@@ -82,6 +97,7 @@ function kvCache({ loader, kv, prefix, rules }) {
 			});
 		}
 		if (cache == null) {
+			emitCacheMetric(url, "miss");
 			const remoteDoc = await loader(url, options);
 			try {
 				await kv.set(key, remoteDoc, { ttl: match });
@@ -93,12 +109,13 @@ function kvCache({ loader, kv, prefix, rules }) {
 			}
 			return remoteDoc;
 		}
+		emitCacheMetric(url, "hit");
 		return cache;
 	};
 }
 function matchRule(url, rules) {
 	for (const [pattern, d] of rules) {
-		const duration = d instanceof Temporal.Duration ? d : Temporal.Duration.from(d);
+		const duration = Temporal.Duration.from(d);
 		if (typeof pattern === "string") {
 			if (url === pattern) return duration;
 			continue;

package/dist/{kv-cache-EMIqoIuB.js → kv-cache-Dh2ZH9Gr.js}

@@ -1,6 +1,6 @@
 import { Temporal } from "@js-temporal/polyfill";
 import { URLPattern } from "urlpattern-polyfill";
-import { d as validateCryptoKey, t as doubleKnock } from "./http-B4rrzxtg.js";
+import { C as recordDocumentCache, d as validateCryptoKey, t as doubleKnock } from "./http-B47Jg9iX.js";
 import { getLogger } from "@logtape/logtape";
 import { curry } from "es-toolkit";
 import { UrlError, createActivityPubRequest, getRemoteDocument, logRequest, preloadedContexts, validatePublicUrl } from "@fedify/vocab-runtime";
@@ -55,10 +55,25 @@ const logger = getLogger([
 * @param parameters The parameters for the cache.
 * @returns The decorated document loader which is cache-enabled.
 */
-function kvCache({ loader, kv, prefix, rules }) {
+function kvCache({ loader, kv, prefix, rules, meterProvider, kind }) {
 	const keyPrefix = prefix ?? ["_fedify", "remoteDocument"];
 	rules ??= [[new URLPattern({}), Temporal.Duration.from({ minutes: 5 })]];
 	for (const [p, duration] of rules) if (Temporal.Duration.compare(duration, { days: 30 }) > 0) throw new TypeError("The maximum cache duration is 30 days: " + (p instanceof URLPattern ? `${p.protocol}://${p.username}:${p.password}@${p.hostname}:${p.port}/${p.pathname}?${p.search}#${p.hash}` : p.toString()));
+	const lookupKind = kind ?? "object";
+	function emitCacheMetric(url, result) {
+		if (meterProvider == null) return;
+		let remoteUrl;
+		try {
+			remoteUrl = new URL(url);
+		} catch {
+			remoteUrl = void 0;
+		}
+		recordDocumentCache(meterProvider, {
+			kind: lookupKind,
+			result,
+			remoteUrl
+		});
+	}
 	return async (url, options) => {
 		if (url in preloadedContexts) {
 			logger.debug("Using preloaded context: {url}.", { url });
@@ -81,6 +96,7 @@ function kvCache({ loader, kv, prefix, rules }) {
 			});
 		}
 		if (cache == null) {
+			emitCacheMetric(url, "miss");
 			const remoteDoc = await loader(url, options);
 			try {
 				await kv.set(key, remoteDoc, { ttl: match });
@@ -92,12 +108,13 @@ function kvCache({ loader, kv, prefix, rules }) {
 			}
 			return remoteDoc;
 		}
+		emitCacheMetric(url, "hit");
 		return cache;
 	};
 }
 function matchRule(url, rules) {
 	for (const [pattern, d] of rules) {
-		const duration = d instanceof Temporal.Duration ? d : Temporal.Duration.from(d);
+		const duration = Temporal.Duration.from(d);
 		if (typeof pattern === "string") {
 			if (url === pattern) return duration;
 			continue;

package/dist/{kv-cache-U__xU4qR.mjs → kv-cache-DhLkLv0P.mjs}

@@ -1,8 +1,9 @@
 import { Temporal } from "@js-temporal/polyfill";
 import { URLPattern } from "urlpattern-polyfill";
 globalThis.addEventListener = () => {};
-import { preloadedContexts } from "@fedify/vocab-runtime";
+import { p as recordDocumentCache } from "./metrics-ColY3QKj.mjs";
 import { getLogger } from "@logtape/logtape";
+import { preloadedContexts } from "@fedify/vocab-runtime";
 //#region src/utils/kv-cache.ts
 const logger = getLogger([
 	"fedify",
@@ -44,10 +45,25 @@ var MockKvStore = class {
 * @param parameters The parameters for the cache.
 * @returns The decorated document loader which is cache-enabled.
 */
-function kvCache({ loader, kv, prefix, rules }) {
+function kvCache({ loader, kv, prefix, rules, meterProvider, kind }) {
 	const keyPrefix = prefix ?? ["_fedify", "remoteDocument"];
 	rules ??= [[new URLPattern({}), Temporal.Duration.from({ minutes: 5 })]];
 	for (const [p, duration] of rules) if (Temporal.Duration.compare(duration, { days: 30 }) > 0) throw new TypeError("The maximum cache duration is 30 days: " + (p instanceof URLPattern ? `${p.protocol}://${p.username}:${p.password}@${p.hostname}:${p.port}/${p.pathname}?${p.search}#${p.hash}` : p.toString()));
+	const lookupKind = kind ?? "object";
+	function emitCacheMetric(url, result) {
+		if (meterProvider == null) return;
+		let remoteUrl;
+		try {
+			remoteUrl = new URL(url);
+		} catch {
+			remoteUrl = void 0;
+		}
+		recordDocumentCache(meterProvider, {
+			kind: lookupKind,
+			result,
+			remoteUrl
+		});
+	}
 	return async (url, options) => {
 		if (url in preloadedContexts) {
 			logger.debug("Using preloaded context: {url}.", { url });
@@ -70,6 +86,7 @@ function kvCache({ loader, kv, prefix, rules }) {
 			});
 		}
 		if (cache == null) {
+			emitCacheMetric(url, "miss");
 			const remoteDoc = await loader(url, options);
 			try {
 				await kv.set(key, remoteDoc, { ttl: match });
@@ -81,12 +98,13 @@ function kvCache({ loader, kv, prefix, rules }) {
 			}
 			return remoteDoc;
 		}
+		emitCacheMetric(url, "hit");
 		return cache;
 	};
 }
 function matchRule(url, rules) {
 	for (const [pattern, d] of rules) {
-		const duration = d instanceof Temporal.Duration ? d : Temporal.Duration.from(d);
+		const duration = Temporal.Duration.from(d);
 		if (typeof pattern === "string") {
 			if (url === pattern) return duration;
 			continue;

package/dist/{kv-GFYnFoOl.d.ts → kv-gJ8LYbxX.d.cts}

@@ -1,6 +1,4 @@
-import { Temporal } from "@js-temporal/polyfill";
-import { URLPattern } from "urlpattern-polyfill";
-
+/// <reference lib="esnext.temporal" />
 //#region src/federation/kv.d.ts
 /**
 * A key for a key–value store.  An array of one or more strings.