change: WebFingerLinkDispatcher to WebFingerLinksDispatcher

Co-authored-by: Hong Minhee (洪 民憙) <[email protected]>

Author: dodok8

packages/fedify/src/federation/builder.ts

@@ -22,7 +22,7 @@ import type {
   ObjectAuthorizePredicate,
   ObjectDispatcher,
   SharedInboxKeyDispatcher,
-  WebFingerLinkDispatcher,
+  WebFingerLinksDispatcher,
 } from "./callback.ts";
 import type { Context, RequestContext } from "./context.ts";
 import type {
@@ -49,7 +49,7 @@ export class FederationBuilderImpl<TContextData>
   router: Router;
   actorCallbacks?: ActorCallbacks<TContextData>;
   nodeInfoDispatcher?: NodeInfoDispatcher<TContextData>;
-  webFingerDispatcher?: WebFingerLinkDispatcher<TContextData>;
+  webFingerLinksDispatcher?: WebFingerLinksDispatcher<TContextData>;
   objectCallbacks: Record<string, ObjectCallbacks<TContextData, string>>;
   objectTypeIds: Record<
     string,
@@ -150,7 +150,7 @@ export class FederationBuilderImpl<TContextData>
       ? undefined
       : { ...this.actorCallbacks };
     f.nodeInfoDispatcher = this.nodeInfoDispatcher;
-    f.webFingerDispatcher = this.webFingerDispatcher;
+    f.webFingerLinksDispatcher = this.webFingerLinksDispatcher;
     f.objectCallbacks = { ...this.objectCallbacks };
     f.objectTypeIds = { ...this.objectTypeIds };
     f.inboxPath = this.inboxPath;
@@ -494,10 +494,10 @@ export class FederationBuilderImpl<TContextData>
     this.nodeInfoDispatcher = dispatcher;
   }
 
-  setWebFingerLinkDispatcher(
-    dispatcher: WebFingerLinkDispatcher<TContextData>,
+  setWebFingerLinksDispatcher(
+    dispatcher: WebFingerLinksDispatcher<TContextData>,
   ): void {
-    this.webFingerDispatcher = dispatcher;
+    this.webFingerLinksDispatcher = dispatcher;
   }
 
   setObjectDispatcher<TObject extends Object, TParam extends string>(

packages/fedify/src/federation/callback.ts

@@ -21,9 +21,10 @@ export type NodeInfoDispatcher<TContextData> = (
  *
  * @template TContextData The context data to pass to the {@link Context}.
  */
-export type WebFingerLinkDispatcher<TContextData> = (
+export type WebFingerLinksDispatcher<TContextData> = (
   context: RequestContext<TContextData>,
-) => Link[] | Promise<Link[]>;
+  resource: URL,
+) => readonly Link[] | Promise<readonly Link[]>;
 
 /**
  * A callback that dispatches an {@link Actor} object.

packages/fedify/src/federation/federation.ts

@@ -28,7 +28,7 @@ import type {
   ObjectDispatcher,
   OutboxErrorHandler,
   SharedInboxKeyDispatcher,
-  WebFingerLinkDispatcher,
+  WebFingerLinksDispatcher,
 } from "./callback.ts";
 import type { Context, RequestContext } from "./context.ts";
 import type { KvStore } from "./kv.ts";
@@ -84,8 +84,8 @@ export interface Federatable<TContextData> {
    * Registers a links dispatcher to WebFinger
    * @param dispatcher A links dispatcher callback to register.
    */
-  setWebFingerLinkDispatcher(
-    dispatcher: WebFingerLinkDispatcher<TContextData>,
+  setWebFingerLinksDispatcher(
+    dispatcher: WebFingerLinksDispatcher<TContextData>,
   ): void;
 
   /**

packages/fedify/src/federation/middleware.ts

@@ -16,9 +16,9 @@ import {
   ATTR_HTTP_RESPONSE_STATUS_CODE,
   ATTR_URL_FULL,
 } from "@opentelemetry/semantic-conventions";
+import metadata from "../../deno.json" with { type: "json" };
 import { getDefaultActivityTransformers } from "../compat/transformers.ts";
 import type { ActivityTransformer } from "../compat/types.ts";
-import metadata from "../../deno.json" with { type: "json" };
 import { getNodeInfo, type GetNodeInfoOptions } from "../nodeinfo/client.ts";
 import { handleNodeInfo, handleNodeInfoJrd } from "../nodeinfo/handler.ts";
 import type { JsonValue, NodeInfo } from "../nodeinfo/types.ts";
@@ -1280,7 +1280,7 @@ export class FederationImpl<TContextData>
           actorDispatcher: this.actorCallbacks?.dispatcher,
           actorHandleMapper: this.actorCallbacks?.handleMapper,
           actorAliasMapper: this.actorCallbacks?.aliasMapper,
-          webFingerLinkDispatcher: this.webFingerDispatcher,
+          webFingerLinksDispatcher: this.webFingerLinksDispatcher,
           onNotFound,
           tracer,
         });

packages/fedify/src/webfinger/handler.test.ts

@@ -3,7 +3,7 @@ import type {
   ActorAliasMapper,
   ActorDispatcher,
   ActorHandleMapper,
-  WebFingerLinkDispatcher,
+  WebFingerLinksDispatcher,
 } from "../federation/callback.ts";
 import type { RequestContext } from "../federation/context.ts";
 import { MemoryKvStore } from "../federation/kv.ts";
@@ -540,8 +540,8 @@ test("handleWebFinger()", async (t) => {
     assertEquals(await response.json(), expectedForHostnameWithPort);
   });
 
-  await t.step("webFingerLinkDispatcher", async () => {
-    const webFingerLinkDispatcher: WebFingerLinkDispatcher<void> = (_ctx) => {
+  await t.step("webFingerLinksDispatcher", async () => {
+    const webFingerLinksDispatcher: WebFingerLinksDispatcher<void> = (_ctx) => {
       return [
         {
           rel: "http://ostatus.org/schema/1.0/subscribe",
@@ -557,7 +557,7 @@ test("handleWebFinger()", async (t) => {
     const response = await handleWebFinger(request, {
       context,
       actorDispatcher,
-      webFingerLinkDispatcher,
+      webFingerLinksDispatcher,
       onNotFound,
     });
 

packages/fedify/src/webfinger/handler.ts

@@ -6,7 +6,7 @@ import type {
   ActorAliasMapper,
   ActorDispatcher,
   ActorHandleMapper,
-  WebFingerLinkDispatcher,
+  WebFingerLinksDispatcher,
 } from "../federation/callback.ts";
 import type { RequestContext } from "../federation/context.ts";
 import { Link as LinkObject } from "../vocab/mod.ts";
@@ -51,7 +51,7 @@ export interface WebFingerHandlerParameters<TContextData> {
   /**
    * The callback for dispatching the Links of webFinger.
    */
-  webFingerLinkDispatcher?: WebFingerLinkDispatcher<TContextData>;
+  webFingerLinksDispatcher?: WebFingerLinksDispatcher<TContextData>;
 
   /**
    * The function to call when the actor is not found.
@@ -118,7 +118,7 @@ async function handleWebFingerInternal<TContextData>(
     actorAliasMapper,
     onNotFound,
     span,
-    webFingerLinkDispatcher,
+    webFingerLinksDispatcher,
   }: WebFingerHandlerParameters<TContextData>,
 ): Promise<Response> {
   if (actorDispatcher == null) {
@@ -231,8 +231,8 @@ async function handleWebFingerInternal<TContextData>(
     links.push(link);
   }
 
-  if (webFingerLinkDispatcher != null) {
-    const customLinks = await webFingerLinkDispatcher(context);
+  if (webFingerLinksDispatcher != null) {
+    const customLinks = await webFingerLinksDispatcher(context, context.url);
     if (customLinks != null) {
       for (const link of customLinks) {
         links.push(link);

packages/testing/src/mock.ts

@@ -21,7 +21,7 @@ import type {
   SendActivityOptions,
   SendActivityOptionsForCollection,
   SenderKeyPair,
-  WebFingerLinkDispatcher,
+  WebFingerLinksDispatcher,
 } from "@fedify/fedify/federation";
 import type { JsonValue, NodeInfo } from "@fedify/fedify/nodeinfo";
 import type { DocumentLoader } from "@fedify/fedify/runtime";
@@ -109,7 +109,7 @@ export class MockFederation<TContextData> implements Federation<TContextData> {
   private activeQueues: Set<"inbox" | "outbox" | "fanout"> = new Set();
   public sentCounter = 0;
   private nodeInfoDispatcher?: NodeInfoDispatcher<TContextData>;
-  private webFingerDispatcher?: WebFingerLinkDispatcher<TContextData>;
+  private webFingerDispatcher?: WebFingerLinksDispatcher<TContextData>;
   private actorDispatchers: Map<string, ActorDispatcher<TContextData>> =
     new Map();
   public actorPath?: string;
@@ -192,8 +192,8 @@ export class MockFederation<TContextData> implements Federation<TContextData> {
     this.nodeInfoPath = path;
   }
 
-  setWebFingerLinkDispatcher(
-    dispatcher: WebFingerLinkDispatcher<TContextData>,
+  setWebFingerLinksDispatcher(
+    dispatcher: WebFingerLinksDispatcher<TContextData>,
   ): void {
     this.webFingerDispatcher = dispatcher;
   }