fix(api): use Fedify for ActivityPub protocol documents (#337)

* fix(api): use Fedify for ActivityPub protocol documents

* test(api): strengthen Fedify protocol invariants

* docs(api): document Fedify WebFinger proof

* test(api): keep federation properties in Effect

* fix(app): expose WebFinger at browser root

Author: skulidropek

bun.lock

@@ -82,6 +82,7 @@ Optional env:
 
 - `GET /health`
 - `POST /federation/inbox` (ForgeFed `Ticket` / `Offer(Ticket)`, ActivityPub `Accept` / `Reject`)
+- `GET /.well-known/webfinger` (Fedify WebFinger document for the local federation actor)
 - `GET /federation/issues`
 - `GET /federation/actor` (ActivityPub `Person`)
 - `GET /federation/outbox`
@@ -116,6 +117,14 @@ Optional env:
 
 Exchange targets must be explicit. Use `https://exchange.lefine.pro`, an actor URL, or a handle like `code@exchange.lefine.pro`; the API resolves the code actor document, stores its `inbox/outbox/followers/publicKey`, sends `Follow`, and polls the stored `outbox`.
 
+Local ActivityPub documents are serialized with Fedify and use only the supported ActivityStreams and security JSON-LD contexts. Mastodon-specific extension contexts and keys such as `https://purl.archive.org/socialweb/webfinger`, `toot`, `featured`, `featuredTags`, `alsoKnownAs`, `movedTo`, and `interactionPolicy` are not emitted by docker-git.
+
+The local actor is discoverable through WebFinger:
+
+```bash
+./ctl request GET '/.well-known/webfinger?resource=acct:docker-git@social.provercoder.ai'
+```
+
 ```bash
 ./ctl request POST /federation/exchange/subscriptions '{
   "domain":"https://social.provercoder.ai",

packages/api/README.md

@@ -23,6 +23,8 @@
     "@effect/platform": "^0.96.1",
     "@effect/platform-node": "^0.106.0",
     "@effect/schema": "^0.75.5",
+    "@fedify/fedify": "^2.2.3",
+    "@fedify/vocab": "^2.2.3",
     "effect": "^3.21.2",
     "node-pty": "^1.1.0",
     "ws": "^8.20.1"

packages/api/package.json

@@ -1,21 +1,14 @@
 import * as Schema from "effect/Schema"
-import type * as SchemaAST from "effect/SchemaAST"
 
 import {
   activityStreamsJsonLdContext,
-  forgeFedJsonLdContext,
-  securityJsonLdContext,
-  socialWebWebfingerJsonLdContext
+  forgeFedJsonLdContext
 } from "./contracts.js"
 
 export type JsonPrimitive = boolean | number | string | null
 export type JsonValue = JsonPrimitive | JsonObject | ReadonlyArray<JsonValue>
 export type JsonObject = Readonly<{ [key: string]: JsonValue }>
 
-export const exactActivityPubParseOptions: SchemaAST.ParseOptions = {
-  onExcessProperty: "error"
-}
-
 export const JsonValueSchema: Schema.Schema<JsonValue> = Schema.suspend(() =>
   Schema.Union(
     Schema.Null,
@@ -28,67 +21,12 @@ export const JsonValueSchema: Schema.Schema<JsonValue> = Schema.suspend(() =>
 )
 
 const OptionalString = Schema.optional(Schema.String)
-const JsonObjectSchema = Schema.Record({ key: Schema.String, value: JsonValueSchema })
-const JsonLdContextEntrySchema = Schema.Union(Schema.String, JsonObjectSchema)
-const JsonLdIdMappingSchema = Schema.Struct({
-  "@id": Schema.String,
-  "@type": Schema.Literal("@id")
-})
 
 export const ActivityForgeFedJsonLdContextSchema = Schema.Tuple(
   Schema.Literal(activityStreamsJsonLdContext),
   Schema.Literal(forgeFedJsonLdContext)
 )
 
-export const LocalActorJsonLdContextSchema = Schema.Tuple(
-  Schema.Literal(activityStreamsJsonLdContext),
-  Schema.Literal(securityJsonLdContext),
-  Schema.Literal(forgeFedJsonLdContext)
-)
-
-export const MastodonActorContextExtensionsSchema = Schema.Struct({
-  manuallyApprovesFollowers: Schema.String,
-  toot: Schema.String,
-  featured: JsonLdIdMappingSchema,
-  featuredTags: JsonLdIdMappingSchema,
-  alsoKnownAs: JsonLdIdMappingSchema,
-  movedTo: JsonLdIdMappingSchema,
-  schema: Schema.String,
-  PropertyValue: Schema.String,
-  value: Schema.String,
-  discoverable: Schema.String,
-  suspended: Schema.String,
-  memorial: Schema.String,
-  indexable: Schema.String,
-  attributionDomains: JsonLdIdMappingSchema,
-  showFeatured: Schema.String,
-  showMedia: Schema.String,
-  showRepliesInMedia: Schema.String,
-  gts: Schema.String,
-  interactionPolicy: JsonLdIdMappingSchema,
-  canQuote: JsonLdIdMappingSchema,
-  automaticApproval: JsonLdIdMappingSchema,
-  manualApproval: JsonLdIdMappingSchema
-})
-
-export const MastodonActorJsonLdContextSchema = Schema.Tuple(
-  Schema.Literal(activityStreamsJsonLdContext),
-  Schema.Literal(securityJsonLdContext),
-  Schema.Literal(socialWebWebfingerJsonLdContext),
-  MastodonActorContextExtensionsSchema
-)
-
-export const ActorJsonLdContextSchema = Schema.Union(
-  LocalActorJsonLdContextSchema,
-  MastodonActorJsonLdContextSchema
-)
-
-export const JsonLdContextSchema = Schema.Union(
-  Schema.String,
-  JsonObjectSchema,
-  Schema.Array(JsonLdContextEntrySchema)
-)
-
 export const ForgeFedTicketSourceSchema = Schema.Struct({
   content: OptionalString,
   mediaType: OptionalString
@@ -110,118 +48,6 @@ export const ForgeFedTicketSchema = Schema.Struct({
   raw: Schema.optional(JsonValueSchema)
 })
 
-export const ActivityPubPublicKeySchema = Schema.Struct({
-  id: Schema.String,
-  owner: Schema.String,
-  publicKeyPem: Schema.String
-})
-
-const ActivityPubEndpointsSchema = Schema.Struct({
-  sharedInbox: Schema.String
-})
-
-const ActivityPubImageSchema = Schema.Struct({
-  type: Schema.Literal("Image"),
-  mediaType: OptionalString,
-  url: Schema.String,
-  name: OptionalString
-})
-
-const ActivityPubActorAttachmentSchema = Schema.Struct({
-  type: Schema.Literal("PropertyValue"),
-  name: Schema.String,
-  value: Schema.String
-})
-
-const ActivityPubHashtagTagSchema = Schema.Struct({
-  type: Schema.Literal("Hashtag"),
-  name: Schema.String,
-  href: Schema.String
-})
-
-const ActivityPubEmojiTagSchema = Schema.Struct({
-  type: Schema.Literal("Emoji"),
-  id: Schema.String,
-  name: Schema.String,
-  icon: ActivityPubImageSchema,
-  updated: OptionalString
-})
-
-const ActivityPubActorTagSchema = Schema.Union(
-  ActivityPubHashtagTagSchema,
-  ActivityPubEmojiTagSchema
-)
-
-const ActivityPubInteractionApprovalSchema = Schema.Struct({
-  automaticApproval: Schema.optional(Schema.Array(Schema.String)),
-  manualApproval: Schema.optional(Schema.Array(Schema.String))
-}).pipe(
-  Schema.filter((approval) =>
-    approval.automaticApproval !== undefined ||
-    approval.manualApproval !== undefined)
-)
-
-const MastodonInteractionPolicySchema = Schema.Struct({
-  canFeature: Schema.optional(ActivityPubInteractionApprovalSchema),
-  canQuote: Schema.optional(ActivityPubInteractionApprovalSchema)
-}).pipe(
-  Schema.filter((policy) =>
-    policy.canFeature !== undefined ||
-    policy.canQuote !== undefined)
-)
-
-export const LocalActivityPubPersonSchema = Schema.Struct({
-  "@context": LocalActorJsonLdContextSchema,
-  type: Schema.Literal("Person"),
-  id: Schema.String,
-  name: Schema.String,
-  preferredUsername: Schema.String,
-  summary: Schema.String,
-  inbox: Schema.String,
-  outbox: Schema.String,
-  followers: Schema.String,
-  following: Schema.String,
-  liked: Schema.String,
-  publicKey: ActivityPubPublicKeySchema,
-  endpoints: ActivityPubEndpointsSchema
-})
-
-export const MastodonIssueActivityPubPersonSchema = Schema.Struct({
-  "@context": MastodonActorJsonLdContextSchema,
-  id: Schema.String,
-  webfinger: Schema.String,
-  type: Schema.Literal("Person"),
-  following: Schema.String,
-  followers: Schema.String,
-  inbox: Schema.String,
-  outbox: Schema.String,
-  featured: Schema.String,
-  featuredTags: Schema.String,
-  preferredUsername: Schema.String,
-  name: Schema.String,
-  summary: Schema.String,
-  url: Schema.String,
-  manuallyApprovesFollowers: Schema.Boolean,
-  discoverable: Schema.Boolean,
-  indexable: Schema.Boolean,
-  published: Schema.String,
-  memorial: Schema.Boolean,
-  showFeatured: Schema.Boolean,
-  showMedia: Schema.Boolean,
-  showRepliesInMedia: Schema.Boolean,
-  interactionPolicy: MastodonInteractionPolicySchema,
-  featuredCollections: Schema.String,
-  publicKey: ActivityPubPublicKeySchema,
-  tag: Schema.Array(ActivityPubActorTagSchema),
-  attachment: Schema.Array(ActivityPubActorAttachmentSchema),
-  endpoints: ActivityPubEndpointsSchema
-})
-
-export const ActivityPubPersonSchema = Schema.Union(
-  LocalActivityPubPersonSchema,
-  MastodonIssueActivityPubPersonSchema
-)
-
 export const ActivityPubFollowActivitySchema = Schema.Struct({
   "@context": ActivityForgeFedJsonLdContextSchema,
   id: Schema.String,
@@ -239,50 +65,3 @@ export const LocalActivityPubOrderedCollectionSchema = Schema.Struct({
   totalItems: Schema.Number,
   orderedItems: Schema.Array(JsonValueSchema)
 })
-
-export const LocalActivityPubFollowersCollectionSchema = Schema.Struct({
-  "@context": ActivityForgeFedJsonLdContextSchema,
-  type: Schema.Literal("OrderedCollection"),
-  id: Schema.String,
-  totalItems: Schema.Number,
-  first: Schema.String,
-  orderedItems: Schema.Array(JsonValueSchema)
-})
-
-export const MastodonFollowersOrderedCollectionSchema = Schema.Struct({
-  "@context": Schema.Literal(activityStreamsJsonLdContext),
-  id: Schema.String,
-  type: Schema.Literal("OrderedCollection"),
-  totalItems: Schema.Number,
-  first: Schema.String
-})
-
-export const ActivityPubOrderedCollectionSchema = Schema.Union(
-  LocalActivityPubOrderedCollectionSchema,
-  LocalActivityPubFollowersCollectionSchema,
-  MastodonFollowersOrderedCollectionSchema
-)
-
-export const LocalActivityPubOrderedCollectionPageSchema = Schema.Struct({
-  "@context": ActivityForgeFedJsonLdContextSchema,
-  type: Schema.Literal("OrderedCollectionPage"),
-  id: Schema.String,
-  totalItems: Schema.Number,
-  partOf: Schema.String,
-  orderedItems: Schema.Array(JsonValueSchema)
-})
-
-export const MastodonFollowersOrderedCollectionPageSchema = Schema.Struct({
-  "@context": Schema.Literal(activityStreamsJsonLdContext),
-  id: Schema.String,
-  type: Schema.Literal("OrderedCollectionPage"),
-  totalItems: Schema.Number,
-  partOf: Schema.String,
-  next: Schema.String,
-  orderedItems: Schema.Array(Schema.String)
-})
-
-export const ActivityPubOrderedCollectionPageSchema = Schema.Union(
-  LocalActivityPubOrderedCollectionPageSchema,
-  MastodonFollowersOrderedCollectionPageSchema
-)

packages/api/src/api/activitypub-schema.ts

@@ -3,17 +3,9 @@ import type * as Schema from "effect/Schema"
 import type {
   ActivityForgeFedJsonLdContextSchema,
   ActivityPubFollowActivitySchema,
-  ActivityPubOrderedCollectionPageSchema,
-  ActivityPubOrderedCollectionSchema,
-  ActivityPubPersonSchema,
-  ActivityPubPublicKeySchema,
-  ActorJsonLdContextSchema,
   ForgeFedTicketSchema,
   ForgeFedTicketSourceSchema,
-  LocalActivityPubFollowersCollectionSchema,
-  LocalActivityPubOrderedCollectionPageSchema,
-  LocalActivityPubOrderedCollectionSchema,
-  LocalActivityPubPersonSchema
+  LocalActivityPubOrderedCollectionSchema
 } from "./activitypub-schema.js"
 
 export type ProjectStatus = "running" | "stopped" | "unknown"
@@ -560,23 +552,20 @@ export type ContainerTaskSnapshot = {
 export const activityStreamsJsonLdContext = "https://www.w3.org/ns/activitystreams" as const
 export const forgeFedJsonLdContext = "https://forgefed.org/ns" as const
 export const securityJsonLdContext = "https://w3id.org/security/v1" as const
-export const socialWebWebfingerJsonLdContext = "https://purl.archive.org/socialweb/webfinger" as const
 export const activityForgeFedJsonLdContext = [
   activityStreamsJsonLdContext,
   forgeFedJsonLdContext
 ] as const
 export const actorJsonLdContext = [
   activityStreamsJsonLdContext,
-  securityJsonLdContext,
-  forgeFedJsonLdContext
+  securityJsonLdContext
 ] as const
 export const federationJsonLdContentType =
   `application/ld+json; profile="${activityStreamsJsonLdContext}"` as const
 export const federationJsonLdResponseContentType =
   `${federationJsonLdContentType}; charset=utf-8` as const
 
 export type ActivityForgeFedJsonLdContext = Schema.Schema.Type<typeof ActivityForgeFedJsonLdContextSchema>
-export type ActorJsonLdContext = Schema.Schema.Type<typeof ActorJsonLdContextSchema>
 
 export type ForgeFedTicket = Schema.Schema.Type<typeof ForgeFedTicketSchema>
 
@@ -622,22 +611,7 @@ export type FollowStatus = "pending" | "accepted" | "rejected"
 
 export type ActivityPubFollowActivity = Schema.Schema.Type<typeof ActivityPubFollowActivitySchema>
 
-export type ActivityPubPublicKey = Schema.Schema.Type<typeof ActivityPubPublicKeySchema>
-
-export type ActivityPubPerson = Schema.Schema.Type<typeof ActivityPubPersonSchema>
-
-export type LocalActivityPubPerson = Schema.Schema.Type<typeof LocalActivityPubPersonSchema>
-
-export type ActivityPubOrderedCollection = Schema.Schema.Type<typeof ActivityPubOrderedCollectionSchema>
-
-export type LocalActivityPubOrderedCollection =
-  | Schema.Schema.Type<typeof LocalActivityPubOrderedCollectionSchema>
-  | Schema.Schema.Type<typeof LocalActivityPubFollowersCollectionSchema>
-
-export type ActivityPubOrderedCollectionPage = Schema.Schema.Type<typeof ActivityPubOrderedCollectionPageSchema>
-
-export type LocalActivityPubOrderedCollectionPage =
-  Schema.Schema.Type<typeof LocalActivityPubOrderedCollectionPageSchema>
+export type LocalActivityPubOrderedCollection = Schema.Schema.Type<typeof LocalActivityPubOrderedCollectionSchema>
 
 export type FollowSubscription = {
   readonly id: string

packages/api/src/api/contracts.ts

@@ -3,23 +3,10 @@ import * as Schema from "effect/Schema"
 export {
   ActivityForgeFedJsonLdContextSchema,
   ActivityPubFollowActivitySchema,
-  ActivityPubOrderedCollectionPageSchema,
-  ActivityPubOrderedCollectionSchema,
-  ActivityPubPersonSchema,
-  ActivityPubPublicKeySchema,
-  ActorJsonLdContextSchema,
   ForgeFedTicketSchema,
   ForgeFedTicketSourceSchema,
-  JsonLdContextSchema,
   JsonValueSchema,
-  LocalActivityPubFollowersCollectionSchema,
-  LocalActivityPubOrderedCollectionPageSchema,
-  LocalActivityPubOrderedCollectionSchema,
-  LocalActivityPubPersonSchema,
-  MastodonFollowersOrderedCollectionPageSchema,
-  MastodonFollowersOrderedCollectionSchema,
-  MastodonIssueActivityPubPersonSchema,
-  exactActivityPubParseOptions
+  LocalActivityPubOrderedCollectionSchema
 } from "./activitypub-schema.js"
 
 const OptionalString = Schema.optional(Schema.String)