@fedify/fedify 1.5.0-dev.715 → 1.5.0-dev.717

package/CHANGES.md

@@ -27,9 +27,28 @@ To be released.
  -  The `fetchKey()` function became to choose the public key of the actor
     if `keyId` has no fragment and the actor has only one public key.  [[#211]]
 
+ -  Added an optional parameter with `GetSignedKeyOptions` type to
+    the `RequestContext.getSignedKey()` method.
+
+ -  Added `GetSignedKeyOptions` interface.
+
  -  Added an optional parameter with `GetKeyOwnerOptions` type to
     the `RequestContext.getSignedKeyOwner()` method.
 
+ -  Deprecated the parameters of the `AuthorizePredicate` and
+    `ObjectAuthorizePredicate` types to get the signed key and its owner
+    in favor of the `RequestContext.getSignedKey()` and
+    `RequestContext.getSignedKeyOwner()` methods.
+
+     -  Deprecated the third parameter of the `AuthorizePredicate` type in favor
+        of the `RequestContext.getSignedKey()` method.
+     -  Deprecated the fourth parameter of the `AuthorizePredicate` type in
+        favor of the `RequestContext.getSignedKeyOwner()` method.
+     -  Deprecated the third parameter of the `ObjectAuthorizePredicate` type in
+        favor of the `RequestContext.getSignedKey()` method.
+     -  Deprecated the fourth parameter of the `ObjectAuthorizePredicate` type
+        in favor of the `RequestContext.getSignedKeyOwner()` method.
+
  -  Fixed a bug of the `fedify inbox` command where it had failed to render
     the web interface when the `fedify` command was installed using
     `deno install` command from JSR.
@@ -43,6 +62,11 @@ To be released.
  -  Internalized the [multibase] package, which is obsolete and no longer
     maintained.  [[#127], [#215] by Fróði Karlsson]
 
+ -  Added more log messages using the [LogTape] library.  Currently the below
+    logger categories are used:
+
+     -  `["fedify", "federation", "object"]`
+
 [#127]: https://github.com/fedify-dev/fedify/issues/127
 [#209]: https://github.com/fedify-dev/fedify/issues/209
 [#211]: https://github.com/fedify-dev/fedify/issues/211

package/esm/deno.js

@@ -1,6 +1,6 @@
 export default {
     "name": "@fedify/fedify",
-    "version": "1.5.0-dev.715+385929d4",
+    "version": "1.5.0-dev.717+38e2fb51",
     "license": "MIT",
     "exports": {
         ".": "./mod.ts",

package/esm/federation/handler.js

@@ -35,8 +35,26 @@ export async function handleActor(request, { identifier, context, actorDispatche
     if (!acceptsJsonLd(request))
         return await onNotAcceptable(request);
     if (authorizePredicate != null) {
-        const key = await context.getSignedKey();
-        const keyOwner = await context.getSignedKeyOwner();
+        let key = await context.getSignedKey();
+        key = key?.clone({}, {
+            // @ts-expect-error: $warning is not part of the type definition
+            $warning: {
+                category: ["fedify", "federation", "actor"],
+                message: "The third parameter of AuthorizePredicate is deprecated " +
+                    "in favor of RequestContext.getSignedKey() method.  The third " +
+                    "parameter will be removed in a future release.",
+            },
+        }) ?? null;
+        let keyOwner = await context.getSignedKeyOwner();
+        keyOwner = keyOwner?.clone({}, {
+            // @ts-expect-error: $warning is not part of the type definition
+            $warning: {
+                category: ["fedify", "federation", "actor"],
+                message: "The fourth parameter of AuthorizePredicate is deprecated " +
+                    "in favor of RequestContext.getSignedKeyOwner() method.  The " +
+                    "fourth parameter will be removed in a future release.",
+            },
+        }) ?? null;
         if (!await authorizePredicate(context, identifier, key, keyOwner)) {
             return await onUnauthorized(request);
         }
@@ -58,8 +76,26 @@ export async function handleObject(request, { values, context, objectDispatcher,
     if (!acceptsJsonLd(request))
         return await onNotAcceptable(request);
     if (authorizePredicate != null) {
-        const key = await context.getSignedKey();
-        const keyOwner = await context.getSignedKeyOwner();
+        let key = await context.getSignedKey();
+        key = key?.clone({}, {
+            // @ts-expect-error: $warning is not part of the type definition
+            $warning: {
+                category: ["fedify", "federation", "object"],
+                message: "The third parameter of ObjectAuthorizePredicate is " +
+                    "deprecated in favor of RequestContext.getSignedKey() method.  " +
+                    "The third parameter will be removed in a future release.",
+            },
+        }) ?? null;
+        let keyOwner = await context.getSignedKeyOwner();
+        keyOwner = keyOwner?.clone({}, {
+            // @ts-expect-error: $warning is not part of the type definition
+            $warning: {
+                category: ["fedify", "federation", "object"],
+                message: "The fourth parameter of ObjectAuthorizePredicate is " +
+                    "deprecated in favor of RequestContext.getSignedKeyOwner() method.  " +
+                    "The fourth parameter will be removed in a future release.",
+            },
+        }) ?? null;
         if (!await authorizePredicate(context, values, key, keyOwner)) {
             return await onUnauthorized(request);
         }
@@ -193,8 +229,26 @@ export async function handleCollection(request, { name, identifier, uriGetter, f
     if (!acceptsJsonLd(request))
         return await onNotAcceptable(request);
     if (collectionCallbacks.authorizePredicate != null) {
-        const key = await context.getSignedKey();
-        const keyOwner = await context.getSignedKeyOwner();
+        let key = await context.getSignedKey();
+        key = key?.clone({}, {
+            // @ts-expect-error: $warning is not part of the type definition
+            $warning: {
+                category: ["fedify", "federation", "collection"],
+                message: "The third parameter of AuthorizePredicate is deprecated in " +
+                    "favor of RequestContext.getSignedKey() method.  The third " +
+                    "parameter will be removed in a future release.",
+            },
+        }) ?? null;
+        let keyOwner = await context.getSignedKeyOwner();
+        keyOwner = keyOwner?.clone({}, {
+            // @ts-expect-error: $warning is not part of the type definition
+            $warning: {
+                category: ["fedify", "federation", "collection"],
+                message: "The fourth parameter of AuthorizePredicate is deprecated in " +
+                    "favor of RequestContext.getSignedKeyOwner() method.  The fourth " +
+                    "parameter will be removed in a future release.",
+            },
+        }) ?? null;
         if (!await collectionCallbacks.authorizePredicate(context, identifier, key, keyOwner)) {
             return await onUnauthorized(request);
         }

package/esm/federation/middleware.js

@@ -2234,20 +2234,22 @@ class RequestContextImpl extends ContextImpl {
         }), values);
     }
     #signedKey = undefined;
-    async getSignedKey() {
-        if (this.#signedKey !== undefined)
+    async getSignedKey(options = {}) {
+        if (this.#signedKey != null)
             return this.#signedKey;
         return this.#signedKey = await verifyRequest(this.request, {
             ...this,
+            contextLoader: options.contextLoader ?? this.contextLoader,
+            documentLoader: options.documentLoader ?? this.documentLoader,
             timeWindow: this.federation.signatureTimeWindow,
-            tracerProvider: this.tracerProvider,
+            tracerProvider: options.tracerProvider ?? this.tracerProvider,
         });
     }
     #signedKeyOwner = undefined;
     async getSignedKeyOwner(options = {}) {
-        if (this.#signedKeyOwner !== undefined)
+        if (this.#signedKeyOwner != null)
             return this.#signedKeyOwner;
-        const key = await this.getSignedKey();
+        const key = await this.getSignedKey(options);
         if (key == null)
             return this.#signedKeyOwner = null;
         return this.#signedKeyOwner = await getKeyOwner(key, {