test(api): cover federation jsonld document routes

Author: skulidropek

packages/api/src/http.ts

@@ -602,6 +602,34 @@ export const federationActorDocumentResponse = () =>
     return yield* _(jsonLdResponse(makeFederationActorDocument(context), 200))
   }).pipe(Effect.catchAll(errorResponse))
 
+export const federationOutboxDocumentResponse = () =>
+  Effect.gen(function*(_) {
+    const request = yield* _(HttpServerRequest.HttpServerRequest)
+    const context = yield* _(resolveFederationContext(request))
+    return yield* _(jsonLdResponse(makeFederationOutboxCollection(context), 200))
+  }).pipe(Effect.catchAll(errorResponse))
+
+export const federationFollowersDocumentResponse = () =>
+  Effect.gen(function*(_) {
+    const request = yield* _(HttpServerRequest.HttpServerRequest)
+    const context = yield* _(resolveFederationContext(request))
+    return yield* _(jsonLdResponse(makeFederationFollowersCollection(context), 200))
+  }).pipe(Effect.catchAll(errorResponse))
+
+export const federationFollowingDocumentResponse = () =>
+  Effect.gen(function*(_) {
+    const request = yield* _(HttpServerRequest.HttpServerRequest)
+    const context = yield* _(resolveFederationContext(request))
+    return yield* _(jsonLdResponse(makeFederationFollowingCollection(context), 200))
+  }).pipe(Effect.catchAll(errorResponse))
+
+export const federationLikedDocumentResponse = () =>
+  Effect.gen(function*(_) {
+    const request = yield* _(HttpServerRequest.HttpServerRequest)
+    const context = yield* _(resolveFederationContext(request))
+    return yield* _(jsonLdResponse(makeFederationLikedCollection(context), 200))
+  }).pipe(Effect.catchAll(errorResponse))
+
 const terminalWebSocketUpgradeResponse = Effect.gen(function*(_) {
   const request = yield* _(HttpServerRequest.HttpServerRequest)
   const upgrade = readHeader(request, "upgrade")?.toLowerCase()
@@ -870,35 +898,19 @@ export const makeRouter = () => {
     ),
     HttpRouter.get(
       "/federation/outbox",
-      Effect.gen(function*(_) {
-        const request = yield* _(HttpServerRequest.HttpServerRequest)
-        const context = yield* _(resolveFederationContext(request))
-        return yield* _(jsonLdResponse(makeFederationOutboxCollection(context), 200))
-      }).pipe(Effect.catchAll(errorResponse))
+      federationOutboxDocumentResponse()
     ),
     HttpRouter.get(
       "/federation/followers",
-      Effect.gen(function*(_) {
-        const request = yield* _(HttpServerRequest.HttpServerRequest)
-        const context = yield* _(resolveFederationContext(request))
-        return yield* _(jsonLdResponse(makeFederationFollowersCollection(context), 200))
-      }).pipe(Effect.catchAll(errorResponse))
+      federationFollowersDocumentResponse()
     ),
     HttpRouter.get(
       "/federation/following",
-      Effect.gen(function*(_) {
-        const request = yield* _(HttpServerRequest.HttpServerRequest)
-        const context = yield* _(resolveFederationContext(request))
-        return yield* _(jsonLdResponse(makeFederationFollowingCollection(context), 200))
-      }).pipe(Effect.catchAll(errorResponse))
+      federationFollowingDocumentResponse()
     ),
     HttpRouter.get(
       "/federation/liked",
-      Effect.gen(function*(_) {
-        const request = yield* _(HttpServerRequest.HttpServerRequest)
-        const context = yield* _(resolveFederationContext(request))
-        return yield* _(jsonLdResponse(makeFederationLikedCollection(context), 200))
-      }).pipe(Effect.catchAll(errorResponse))
+      federationLikedDocumentResponse()
     ),
     HttpRouter.get(
       "/federation/status",

packages/api/src/services/federation.ts

@@ -106,7 +106,6 @@ const defaultActorUsername = "docker-git"
 const activityJsonContentType = "application/activity+json"
 const activityAcceptHeader = `${federationJsonLdContentType}, ${activityJsonContentType}, application/json`
 const defaultExchangeQueue = "code"
-const stateVersion = 1 as const
 const exchangeEventLimit = 100
 
 const issueStore: Map<string, FederationIssueRecord> = new Map()
@@ -380,7 +379,7 @@ const normalizeHttpUrl = (
   })
 
 const serializeState = (): StoredFederationState => ({
-  version: stateVersion,
+  version: 1,
   issues: [...issueStore.values()],
   follows: [...followStore.values()],
   processedOutboxItems: [...processedOutboxItems],
@@ -1494,13 +1493,13 @@ const fetchOutbox = (
   fetchJson(url, "Exchange outbox").pipe(
     Effect.flatMap((record) =>
       requireFederationJsonLdContext(record, "Exchange outbox").pipe(
-        Effect.as({
+        Effect.map((): ActivityPubOrderedCollection => ({
           "@context": activityForgeFedJsonLdContext,
-          type: "OrderedCollection" as const,
+          type: "OrderedCollection",
           id: readOptionalString(record, "id") ?? url,
           totalItems: typeof record["totalItems"] === "number" ? record["totalItems"] : 0,
           orderedItems: Array.isArray(record["orderedItems"]) ? record["orderedItems"] : []
-        })
+        }))
       )
     )
   )

packages/api/tests/http-config.test.ts

@@ -5,12 +5,17 @@ import { Effect } from "effect"
 import fc from "fast-check"
 
 import {
+  activityForgeFedJsonLdContext,
   actorJsonLdContext,
   federationJsonLdResponseContentType
 } from "../src/api/contracts.js"
 import {
   federationActorDocumentResponse,
   federationExchangeStatusResponse,
+  federationFollowersDocumentResponse,
+  federationFollowingDocumentResponse,
+  federationLikedDocumentResponse,
+  federationOutboxDocumentResponse,
   resolveConfiguredFederationPublicOrigin
 } from "../src/http.js"
 import { clearFederationState } from "../src/services/federation.js"
@@ -52,7 +57,11 @@ const federationDocumentHandler = HttpApp.toWebHandler(
   Effect.flatten(
     HttpRouter.toHttpApp(
       HttpRouter.empty.pipe(
-        HttpRouter.get("/federation/actor", federationActorDocumentResponse())
+        HttpRouter.get("/federation/actor", federationActorDocumentResponse()),
+        HttpRouter.get("/federation/outbox", federationOutboxDocumentResponse()),
+        HttpRouter.get("/federation/followers", federationFollowersDocumentResponse()),
+        HttpRouter.get("/federation/following", federationFollowingDocumentResponse()),
+        HttpRouter.get("/federation/liked", federationLikedDocumentResponse())
       )
     )
   )
@@ -118,6 +127,44 @@ const parseJsonObject = (raw: string): object | null => {
 const readField = (value: object | null, key: string): unknown =>
   value === null ? undefined : Reflect.get(value, key)
 
+const federationDocumentCases: ReadonlyArray<{
+  readonly path: string
+  readonly expectedContext: unknown
+  readonly expectedId: string
+  readonly expectedType: string
+}> = [
+  {
+    path: "/federation/actor",
+    expectedContext: actorJsonLdContext,
+    expectedId: "https://public.example.test/federation/actor",
+    expectedType: "Person"
+  },
+  {
+    path: "/federation/outbox",
+    expectedContext: activityForgeFedJsonLdContext,
+    expectedId: "https://public.example.test/federation/outbox",
+    expectedType: "OrderedCollection"
+  },
+  {
+    path: "/federation/followers",
+    expectedContext: activityForgeFedJsonLdContext,
+    expectedId: "https://public.example.test/federation/followers",
+    expectedType: "OrderedCollection"
+  },
+  {
+    path: "/federation/following",
+    expectedContext: activityForgeFedJsonLdContext,
+    expectedId: "https://public.example.test/federation/following",
+    expectedType: "OrderedCollection"
+  },
+  {
+    path: "/federation/liked",
+    expectedContext: activityForgeFedJsonLdContext,
+    expectedId: "https://public.example.test/federation/liked",
+    expectedType: "OrderedCollection"
+  }
+]
+
 describe("api http config", () => {
   it.effect("ignores empty federation public origin values", () =>
     Effect.sync(() => {
@@ -180,16 +227,19 @@ describe("api http config", () => {
       expect(Array.isArray(readField(payload, "recentEvents"))).toBe(true)
     }))
 
-  it.effect("serves federation actor documents as JSON-LD", () =>
-    Effect.gen(function*(_) {
-      yield* _(Effect.sync(() => clearFederationState()))
+  for (const documentCase of federationDocumentCases) {
+    it.effect(`serves ${documentCase.path} as JSON-LD`, () =>
+      Effect.gen(function*(_) {
+        yield* _(Effect.sync(() => clearFederationState()))
 
-      const actor = yield* _(readFederationDocumentRoute("/federation/actor"))
-      const payload = parseJsonObject(actor.body)
+        const document = yield* _(readFederationDocumentRoute(documentCase.path))
+        const payload = parseJsonObject(document.body)
 
-      expect(actor.status).toBe(200)
-      expect(actor.contentType).toBe(federationJsonLdResponseContentType)
-      expect(readField(payload, "@context")).toEqual(actorJsonLdContext)
-      expect(readField(payload, "id")).toBe("https://public.example.test/federation/actor")
-    }))
+        expect(document.status).toBe(200)
+        expect(document.contentType).toBe(federationJsonLdResponseContentType)
+        expect(readField(payload, "@context")).toEqual(documentCase.expectedContext)
+        expect(readField(payload, "type")).toBe(documentCase.expectedType)
+        expect(readField(payload, "id")).toBe(documentCase.expectedId)
+      }))
+  }
 })