@fedify/fedify 1.3.0-dev.565 → 1.3.0-dev.569

package/CHANGES.md

@@ -61,6 +61,7 @@ To be released.
 
  -  Fedify now supports OpenTelemetry for tracing.  [[#170]]
 
+     -  Added `Context.tracerProvider` property.
      -  Added `CreateFederationOptions.tracerProvider` option.
      -  Added `LookupWebFingerOptions.tracerProvider` option.
      -  Added `LookupObjectOptions.tracerProvider` option.
@@ -71,8 +72,17 @@ To be released.
      -  Added `VerifyProofOptions.tracerProvider` option.
      -  Added `VerifyObjectOptions.tracerProvider` option.
      -  Added `SignObjectOptions.tracerProvider` option.
+     -  Added `VerifySignatureOptions.tracerProvider` option.
      -  Added `VerifyJsonLdOptions.tracerProvider` option.
      -  Added `SignJsonLdOptions.tracerProvider` option.
+     -  Added `DoesActorOwnKeyOptions.tracerProvider` option.
+     -  Added `GetKeyOwnerOptions.tracerProvider` option.
+
+     -  Added `tracerProvider` option to the following Activity Vocabulary APIs:
+
+         -  The second parameters of constructors.
+         -  The second parameters of `fromJsonLd()` static methods.
+         -  The second parameters of `get*()` methods.
 
  -  Added `@fedify/fedify/x/sveltekit` module for integrating with [SvelteKit]
     hook.  [[#171], [#183] by Jiyu Park]

package/esm/deno.js

@@ -1,6 +1,6 @@
 export default {
     "name": "@fedify/fedify",
-    "version": "1.3.0-dev.565+37191e25",
+    "version": "1.3.0-dev.569+d97ee744",
     "license": "MIT",
     "exports": {
         ".": "./mod.ts",

package/esm/federation/middleware.js

@@ -11,6 +11,7 @@ import { hasSignature, signJsonLd } from "../sig/ld.js";
 import { getKeyOwner } from "../sig/owner.js";
 import { signObject } from "../sig/proof.js";
 import { lookupObject, traverseCollection, } from "../vocab/lookup.js";
+import { getTypeId } from "../vocab/type.js";
 import { Activity, CryptographicKey, Multikey, } from "../vocab/vocab.js";
 import { handleWebFinger } from "../webfinger/handler.js";
 import { buildCollectionSynchronizationHeader } from "./collection.js";
@@ -204,6 +205,7 @@ export class FederationImpl {
                 documentLoader: rsaKeyPair == null
                     ? this.documentLoader
                     : this.authenticatedDocumentLoaderFactory(rsaKeyPair),
+                tracerProvider: this.tracerProvider,
             });
             try {
                 this.onOutboxError?.(error, activity);
@@ -401,7 +403,29 @@ export class FederationImpl {
         }
         const callbacks = {
             dispatcher: async (context, identifier) => {
-                const actor = await dispatcher(context, identifier);
+                const actor = await this.#getTracer().startActiveSpan("activitypub.dispatch_actor", { kind: SpanKind.SERVER }, async (span) => {
+                    try {
+                        const actor = await dispatcher(context, identifier);
+                        span.setAttribute("activitypub.actor.id", (actor?.id ?? context.getActorUri(identifier)).href);
+                        if (actor == null) {
+                            span.setStatus({ code: SpanStatusCode.ERROR });
+                        }
+                        else {
+                            span.setAttribute("activitypub.actor.type", getTypeId(actor).href);
+                        }
+                        return actor;
+                    }
+                    catch (error) {
+                        span.setStatus({
+                            code: SpanStatusCode.ERROR,
+                            message: String(error),
+                        });
+                        throw error;
+                    }
+                    finally {
+                        span.end();
+                    }
+                });
                 if (actor == null)
                     return null;
                 const logger = getLogger(["fedify", "federation", "actor"]);
@@ -535,8 +559,22 @@ export class FederationImpl {
         };
         this.actorCallbacks = callbacks;
         const setters = {
-            setKeyPairsDispatcher(dispatcher) {
-                callbacks.keyPairsDispatcher = dispatcher;
+            setKeyPairsDispatcher: (dispatcher) => {
+                callbacks.keyPairsDispatcher = (ctx, identifier) => this.#getTracer().startActiveSpan("activitypub.dispatch_actor_key_pairs", { kind: SpanKind.SERVER }, async (span) => {
+                    try {
+                        return await dispatcher(ctx, identifier);
+                    }
+                    catch (e) {
+                        span.setStatus({
+                            code: SpanStatusCode.ERROR,
+                            message: String(e),
+                        });
+                        throw e;
+                    }
+                    finally {
+                        span.end();
+                    }
+                });
                 return setters;
             },
             mapHandle(mapper) {
@@ -1301,6 +1339,9 @@ export class ContextImpl {
     get contextLoader() {
         return this.federation.contextLoader;
     }
+    get tracerProvider() {
+        return this.federation.tracerProvider;
+    }
     getNodeInfoUri() {
         const path = this.federation.router.build("nodeInfo", {});
         if (path == null) {
@@ -1638,7 +1679,7 @@ export class ContextImpl {
             documentLoader: options.documentLoader ?? this.documentLoader,
             contextLoader: options.contextLoader ?? this.contextLoader,
             userAgent: options.userAgent ?? this.federation.userAgent,
-            tracerProvider: options.tracerProvider ?? this.federation.tracerProvider,
+            tracerProvider: options.tracerProvider ?? this.tracerProvider,
         });
     }
     traverseCollection(collection, options = {}) {
@@ -1805,7 +1846,7 @@ class RequestContextImpl extends ContextImpl {
         return this.#signedKey = await verifyRequest(this.request, {
             ...this,
             timeWindow: this.federation.signatureTimeWindow,
-            tracerProvider: this.federation.tracerProvider,
+            tracerProvider: this.tracerProvider,
         });
     }
     #signedKeyOwner = undefined;
@@ -1935,7 +1976,7 @@ export class InboxContextImpl extends ContextImpl {
                     activity: this.activity,
                     activityId: activityId,
                     inbox: new URL(inbox),
-                    tracerProvider: this.federation.tracerProvider,
+                    tracerProvider: this.tracerProvider,
                 }));
             }
             await Promise.all(promises);

package/esm/sig/http.js

@@ -135,7 +135,7 @@ export async function verifyRequest(request, options = {}) {
         }
     });
 }
-async function verifyRequestInternal(request, span, { documentLoader, contextLoader, timeWindow, currentTime, keyCache, } = {}) {
+async function verifyRequestInternal(request, span, { documentLoader, contextLoader, timeWindow, currentTime, keyCache, tracerProvider, } = {}) {
     const logger = getLogger(["fedify", "sig", "http"]);
     if (request.bodyUsed) {
         logger.error("Failed to verify; the request body is already consumed.", { url: request.url });
@@ -244,6 +244,7 @@ async function verifyRequestInternal(request, span, { documentLoader, contextLoa
         documentLoader,
         contextLoader,
         keyCache,
+        tracerProvider,
     });
     if (key == null)
         return null;

package/esm/sig/key.js

@@ -106,7 +106,7 @@ export async function importJwk(jwk, type) {
  */
 export async function fetchKey(keyId, 
 // deno-lint-ignore no-explicit-any
-cls, { documentLoader, contextLoader, keyCache } = {}) {
+cls, { documentLoader, contextLoader, keyCache, tracerProvider } = {}) {
     const logger = getLogger(["fedify", "sig", "key"]);
     const cacheKey = typeof keyId === "string" ? new URL(keyId) : keyId;
     keyId = typeof keyId === "string" ? keyId : keyId.href;
@@ -140,6 +140,7 @@ cls, { documentLoader, contextLoader, keyCache } = {}) {
         object = await Object.fromJsonLd(document, {
             documentLoader,
             contextLoader,
+            tracerProvider,
         });
     }
     catch (e) {
@@ -149,6 +150,7 @@ cls, { documentLoader, contextLoader, keyCache } = {}) {
             object = await cls.fromJsonLd(document, {
                 documentLoader,
                 contextLoader,
+                tracerProvider,
             });
         }
         catch (e) {
@@ -166,8 +168,12 @@ cls, { documentLoader, contextLoader, keyCache } = {}) {
     else if (isActor(object)) {
         // @ts-ignore: cls is either CryptographicKey or Multikey
         const keys = cls === CryptographicKey
-            ? object.getPublicKeys({ documentLoader, contextLoader })
-            : object.getAssertionMethods({ documentLoader, contextLoader });
+            ? object.getPublicKeys({ documentLoader, contextLoader, tracerProvider })
+            : object.getAssertionMethods({
+                documentLoader,
+                contextLoader,
+                tracerProvider,
+            });
         for await (const k of keys) {
             if (k.id?.href === keyId) {
                 key = k;

package/esm/sig/owner.js

@@ -1,3 +1,4 @@
+import { trace } from "@opentelemetry/api";
 import { getDocumentLoader, } from "../runtime/docloader.js";
 import { isActor } from "../vocab/actor.js";
 import { CryptographicKey, Object as ASObject, } from "../vocab/vocab.js";
@@ -30,8 +31,10 @@ export async function doesActorOwnKey(activity, key, options) {
  * @param options Options for getting the key owner.
  * @returns The actor that owns the key, or `null` if the key has no known
  *          owner.
+ * @since 0.7.0
  */
 export async function getKeyOwner(keyId, options) {
+    const tracerProvider = options.tracerProvider ?? trace.getTracerProvider();
     const documentLoader = options.documentLoader ?? getDocumentLoader();
     const contextLoader = options.contextLoader ?? getDocumentLoader();
     let object;
@@ -54,6 +57,7 @@ export async function getKeyOwner(keyId, options) {
             object = await ASObject.fromJsonLd(keyDoc, {
                 documentLoader,
                 contextLoader,
+                tracerProvider,
             });
         }
         catch (e) {
@@ -63,6 +67,7 @@ export async function getKeyOwner(keyId, options) {
                 object = await CryptographicKey.fromJsonLd(keyDoc, {
                     documentLoader,
                     contextLoader,
+                    tracerProvider,
                 });
             }
             catch (e) {
@@ -76,7 +81,11 @@ export async function getKeyOwner(keyId, options) {
     if (object instanceof CryptographicKey) {
         if (object.ownerId == null)
             return null;
-        owner = await object.getOwner({ documentLoader, contextLoader });
+        owner = await object.getOwner({
+            documentLoader,
+            contextLoader,
+            tracerProvider,
+        });
     }
     else if (isActor(object)) {
         owner = object;

package/esm/vocab/lookup.js

@@ -119,6 +119,7 @@ async function lookupObjectInternal(identifier, options = {}) {
         return await Object.fromJsonLd(document, {
             documentLoader,
             contextLoader: options.contextLoader,
+            tracerProvider: options.tracerProvider,
         });
     }
     catch (error) {