@evanp/activitypub-bot 0.8.0 → 0.11.0

package/tests/utils/nock.js

@@ -3,10 +3,20 @@ import nock from 'nock'
 import crypto from 'node:crypto'
 import { promisify } from 'node:util'
 
+const PAGE_SIZE = 20
+
 const generateKeyPair = promisify(crypto.generateKeyPair)
 
+const defaultDomain = 'social.example'
+
 const domains = new Map()
-domains['social.example'] = new Map()
+domains[defaultDomain] = new Map()
+
+const graph = new Map()
+graph[defaultDomain] = new Map()
+
+const collections = new Map()
+collections[defaultDomain] = new Map()
 
 const newKeyPair = async () => {
   return await generateKeyPair(
@@ -25,7 +35,7 @@ const newKeyPair = async () => {
   )
 }
 
-export const getPair = async (username, domain = 'social.example') => {
+export const getPair = async (username, domain = defaultDomain) => {
   if (!domains.has(domain)) {
     domains.set(domain, new Map())
   }
@@ -36,17 +46,57 @@ export const getPair = async (username, domain = 'social.example') => {
   return domains.get(domain).get(username)
 }
 
-export const getPublicKey = async (username, domain = 'social.example') => {
+export const getPublicKey = async (username, domain = defaultDomain) => {
   const pair = await getPair(username, domain)
   return pair.publicKey
 }
 
-export const getPrivateKey = async (username, domain = 'social.example') => {
+export const getPrivateKey = async (username, domain = defaultDomain) => {
   const pair = await getPair(username, domain)
   return pair.privateKey
 }
 
-export const nockSignature = async ({ method = 'GET', url, date, digest = null, username, domain = 'social.example' }) => {
+function ensureGraph (domain, username) {
+  if (!graph.has(domain)) {
+    graph.set(domain, new Map())
+  }
+  if (!graph.get(domain).has(username)) {
+    graph.get(domain).set(username, new Map())
+    graph.get(domain).get(username).set('followers', [])
+    graph.get(domain).get(username).set('following', [])
+  }
+  return graph.get(domain).get(username)
+}
+
+export function addFollower (username, id, domain = defaultDomain) {
+  ensureGraph(domain, username).get('followers').unshift(id)
+}
+
+export function addFollowing (username, id, domain = defaultDomain) {
+  ensureGraph(domain, username).get('following').unshift(id)
+}
+
+function ensureCollection (domain, username, collection) {
+  if (!collections.has(domain)) {
+    collections.set(domain, new Map())
+  }
+  const dc = collections.get(domain)
+  if (!dc.has(username)) {
+    dc.set(username, new Map())
+  }
+  const dcu = dc.get(username)
+  if (!dcu.has(collection)) {
+    dcu.set(collection, [])
+  }
+  const dcuc = dcu.get(collection)
+  return dcuc
+}
+
+export function addToCollection (username, collection, item, domain = defaultDomain) {
+  ensureCollection(domain, username, collection).unshift(item)
+}
+
+export const nockSignature = async ({ method = 'GET', url, date, digest = null, username, domain = defaultDomain }) => {
   const privateKey = await getPrivateKey(username, domain)
   const keyId = nockFormat({ username, key: true, domain })
   const parsed = new URL(url)
@@ -66,7 +116,7 @@ export const nockSignature = async ({ method = 'GET', url, date, digest = null,
   return `keyId="${keyId}",headers="(request-target) host date${(digest) ? ' digest' : ''}",signature="${signature.replace(/"/g, '\\"')}",algorithm="rsa-sha256"`
 }
 
-export const nockSignatureFragment = async ({ method = 'GET', url, date, digest = null, username, domain = 'social.example' }) => {
+export const nockSignatureFragment = async ({ method = 'GET', url, date, digest = null, username, domain = defaultDomain }) => {
   const keyId = nockFormat({ username, domain }) + '#main-key'
   const privateKey = await getPrivateKey(username, domain)
   const parsed = new URL(url)
@@ -86,10 +136,10 @@ export const nockSignatureFragment = async ({ method = 'GET', url, date, digest
   return `keyId="${keyId}",headers="(request-target) host date${(digest) ? ' digest' : ''}",signature="${signature.replace(/"/g, '\\"')}",algorithm="rsa-sha256"`
 }
 
-export const nockKeyRotate = async (username, domain = 'social.example') =>
+export const nockKeyRotate = async (username, domain = defaultDomain) =>
   domains.get(domain).set(username, await newKeyPair(username))
 
-export const makeActor = async (username, domain = 'social.example') =>
+export const makeActor = async (username, domain = defaultDomain) =>
   await as2.import({
     '@context': [
       'https://www.w3.org/ns/activitystreams',
@@ -124,7 +174,8 @@ export async function makeObject (
   username,
   type,
   num,
-  domain = 'social.example') {
+  domain = defaultDomain,
+  extra = {}) {
   const props = {
     '@context': [
       'https://www.w3.org/ns/activitystreams',
@@ -133,7 +184,8 @@ export async function makeObject (
     ],
     id: nockFormat({ username, type, num, domain }),
     type: uppercase(type),
-    to: 'as:Public'
+    to: 'as:Public',
+    ...extra
   }
   if (isActivityType(type)) {
     props.actor = nockFormat({ username, domain })
@@ -149,7 +201,7 @@ export async function makeObject (
   return as2.import(props)
 }
 
-export const makeTransitive = (username, type, num, obj, domain = 'social.example') =>
+export const makeTransitive = (username, type, num, obj, domain = defaultDomain) =>
   as2.import({
     id: nockFormat({ username, type, num, obj, domain }),
     type: uppercase(type),
@@ -159,7 +211,7 @@ export const makeTransitive = (username, type, num, obj, domain = 'social.exampl
   })
 
 const uppercase = (str) => str.charAt(0).toUpperCase() + str.slice(1)
-const lowercase = (str) => str.charAt(0).toLowerCase() + str.slice(1)
+const lowercase = (str) => str.toLowerCase()
 
 export const postInbox = {}
 
@@ -169,10 +221,28 @@ export const resetInbox = () => {
   }
 }
 
-export const nockSetup = (domain) =>
+const requestHeaders = new Map()
+
+export function getRequestHeaders (uri) {
+  return requestHeaders.get(uri)
+}
+
+export const resetRequestHeaders = () => {
+  requestHeaders.clear()
+}
+
+const captureRequestHeaders = (domain, uri, req) => {
+  const url = new URL(uri, `https://${domain}`).toString()
+  const headers = req?.headers || {}
+  requestHeaders.set(url, headers)
+}
+
+export const nockSetup = (domain, logger = null) =>
   nock(`https://${domain}`)
+    .persist()
     .get(/^\/.well-known\/webfinger/)
-    .reply(async (uri, requestBody) => {
+    .reply(async function (uri, requestBody) {
+      captureRequestHeaders(domain, uri, this?.req)
       const parsed = new URL(uri, `https://${domain}`)
       const resource = parsed.searchParams.get('resource')
       if (!resource) {
@@ -194,17 +264,18 @@ export const nockSetup = (domain) =>
         { 'Content-Type': 'application/jrd+json' }]
     })
     .get(/^\/user\/(\w+)$/)
-    .reply(async (uri, requestBody) => {
+    .reply(async function (uri, requestBody) {
+      captureRequestHeaders(domain, uri, this?.req)
       const username = uri.match(/^\/user\/(\w+)$/)[1]
       const actor = await makeActor(username, domain)
-      const actorText = await actor.prettyWrite(
+      const actorText = await actor.write(
         { additional_context: 'https://w3id.org/security/v1' }
       )
       return [200, actorText, { 'Content-Type': 'application/activity+json' }]
     })
-    .persist()
     .post(/^\/user\/(\w+)\/inbox$/)
-    .reply(async (uri, requestBody) => {
+    .reply(async function (uri, requestBody) {
+      captureRequestHeaders(domain, uri, this?.req)
       const username = uri.match(/^\/user\/(\w+)\/inbox$/)[1]
       if (username in postInbox) {
         postInbox[username] += 1
@@ -213,9 +284,13 @@ export const nockSetup = (domain) =>
       }
       return [202, 'accepted']
     })
-    .persist()
+    .get(/^\/user\/(\w+)\/inbox$/)
+    .reply(async function (uri, requestBody) {
+      return [403, 'forbidden']
+    })
     .get(/^\/user\/(\w+)\/publickey$/)
-    .reply(async (uri, requestBody) => {
+    .reply(async function (uri, requestBody) {
+      captureRequestHeaders(domain, uri, this?.req)
       const username = uri.match(/^\/user\/(\w+)\/publickey$/)[1]
       const publicKey = await as2.import({
         '@context': [
@@ -227,25 +302,169 @@ export const nockSetup = (domain) =>
         type: 'CryptographicKey',
         publicKeyPem: await getPublicKey(username, domain)
       })
-      const publicKeyText = await publicKey.prettyWrite(
+      const publicKeyText = await publicKey.write(
         { additional_context: 'https://w3id.org/security/v1' }
       )
       return [200, publicKeyText, { 'Content-Type': 'application/activity+json' }]
     })
-    .persist()
+    .get(/^\/user\/(\w+)\/followers$/)
+    .reply(async function (uri, requestBody) {
+      captureRequestHeaders(domain, uri, this?.req)
+      const username = uri.match(/^\/user\/(\w+)\/followers$/)[1]
+      const items = ensureGraph(domain, username).get('followers')
+      const followers = await as2.import({
+        '@context': [
+          'https://www.w3.org/ns/activitystreams',
+          'https://w3id.org/fep/5711'
+        ],
+        id: `https://${domain}/user/${username}/followers`,
+        attributedTo: `https://${domain}/user/${username}`,
+        to: 'as:Public',
+        followersOf: `https://${domain}/user/${username}`,
+        type: 'OrderedCollection',
+        totalItems: items.length,
+        items
+      })
+      const followersText = await followers.write(
+        { additional_context: 'https://w3id.org/fep/5711' }
+      )
+      return [200, followersText, { 'Content-Type': 'application/activity+json' }]
+    })
+    .get(/^\/user\/(\w+)\/following$/)
+    .reply(async function (uri, requestBody) {
+      captureRequestHeaders(domain, uri, this?.req)
+      const username = uri.match(/^\/user\/(\w+)\/following$/)[1]
+      const items = ensureGraph(domain, username).get('following')
+      const following = await as2.import({
+        '@context': [
+          'https://www.w3.org/ns/activitystreams',
+          'https://w3id.org/fep/5711'
+        ],
+        id: `https://${domain}/user/${username}/following`,
+        attributedTo: `https://${domain}/user/${username}`,
+        to: 'as:Public',
+        followersOf: `https://${domain}/user/${username}`,
+        type: 'OrderedCollection',
+        totalItems: items.length,
+        items
+      })
+      const followingText = await following.write(
+        { additional_context: 'https://w3id.org/fep/5711' }
+      )
+      return [200, followingText, { 'Content-Type': 'application/activity+json' }]
+    })
+    .get(/^\/user\/(\w+)\/collection\/(\d+)$/)
+    .reply(async function (uri, requestBody) {
+      logger?.debug('Capturing request headers')
+      captureRequestHeaders(domain, uri, this?.req)
+      logger?.debug('Matching parameters')
+      const match = uri.match(/^\/user\/(\w+)\/collection\/(\d+)$/)
+      const username = match[1]
+      const type = 'Collection'
+      const num = parseInt(match[2])
+      logger?.debug('Ensuring collection')
+      const items = ensureCollection(domain, username, num)
+      logger?.debug('Making collection object')
+      const summary = `${num} collection by ${username}`
+      const obj = await makeObject(username, type, num, domain, { items, summary })
+      logger?.debug('Writing collection object to text')
+      const objText = await obj.write({ useOriginalContext: true })
+      logger?.debug('Sending output')
+      return [200, objText, { 'Content-Type': 'application/activity+json' }]
+    })
+    .get(/^\/user\/(\w+)\/orderedcollection\/(\d+)$/)
+    .reply(async function (uri, requestBody) {
+      captureRequestHeaders(domain, uri, this?.req)
+      const match = uri.match(/^\/user\/(\w+)\/orderedcollection\/(\d+)$/)
+      const username = match[1]
+      const type = 'OrderedCollection'
+      const num = parseInt(match[2])
+      const orderedItems = ensureCollection(domain, username, num)
+      const summary = `${num} ordered collection by ${username}`
+      const obj = await makeObject(username, type, num, domain, { orderedItems, summary })
+      const objText = await obj.write({ useOriginalContext: true })
+      return [200, objText, { 'Content-Type': 'application/activity+json' }]
+    })
+    .get(/^\/user\/(\w+)\/pagedcollection\/(\d+)$/)
+    .reply(async function (uri, requestBody) {
+      captureRequestHeaders(domain, uri, this?.req)
+      const match = uri.match(/^\/user\/(\w+)\/pagedcollection\/(\d+)$/)
+      const username = match[1]
+      const type = 'Collection'
+      const num = parseInt(match[2])
+      const items = ensureCollection(domain, username, num)
+      const totalItems = items.length
+      const first = (totalItems > 0)
+        ? nockFormat({ username, domain, type: 'PagedCollection', num, page: 0 })
+        : undefined
+      const obj = await makeObject(username, type, num, domain, { totalItems, first })
+      const objText = await obj.write({ useOriginalContext: true })
+      return [200, objText, { 'Content-Type': 'application/activity+json' }]
+    })
+    .get(/^\/user\/(\w+)\/pagedcollection\/(\d+)\/page\/(\d+)$/)
+    .reply(async function (uri, requestBody) {
+      captureRequestHeaders(domain, uri, this?.req)
+      const match = uri.match(/^\/user\/(\w+)\/pagedcollection\/(\d+)\/page\/(\d+)$/)
+      const username = match[1]
+      const type = 'CollectionPage'
+      const num = parseInt(match[2])
+      const page = parseInt(match[3])
+      const allItems = ensureCollection(domain, username, num)
+      const items = allItems.slice(page * PAGE_SIZE, (page + 1) * PAGE_SIZE)
+      const next = (allItems.length > (page + 1) * PAGE_SIZE)
+        ? nockFormat({ username, domain, type: 'PagedCollection', num, page: page + 1 })
+        : undefined
+      const obj = await makeObject(username, type, num, domain, { items, next })
+      const objText = await obj.write({ useOriginalContext: true })
+      return [200, objText, { 'Content-Type': 'application/activity+json' }]
+    })
+    .get(/^\/user\/(\w+)\/pagedorderedcollection\/(\d+)$/)
+    .reply(async function (uri, requestBody) {
+      captureRequestHeaders(domain, uri, this?.req)
+      const match = uri.match(/^\/user\/(\w+)\/pagedorderedcollection\/(\d+)$/)
+      const username = match[1]
+      const type = 'OrderedCollection'
+      const num = parseInt(match[2])
+      const items = ensureCollection(domain, username, num)
+      const totalItems = items.length
+      const first = (totalItems > 0)
+        ? nockFormat({ username, domain, type: 'PagedOrderedCollection', num, page: 0 })
+        : undefined
+      const obj = await makeObject(username, type, num, domain, { totalItems, first })
+      const objText = await obj.write({ useOriginalContext: true })
+      return [200, objText, { 'Content-Type': 'application/activity+json' }]
+    })
+    .get(/^\/user\/(\w+)\/pagedorderedcollection\/(\d+)\/page\/(\d+)$/)
+    .reply(async function (uri, requestBody) {
+      captureRequestHeaders(domain, uri, this?.req)
+      const match = uri.match(/^\/user\/(\w+)\/pagedorderedcollection\/(\d+)\/page\/(\d+)$/)
+      const username = match[1]
+      const type = 'OrderedCollectionPage'
+      const num = parseInt(match[2])
+      const page = parseInt(match[3])
+      const allItems = ensureCollection(domain, username, num)
+      const orderedItems = allItems.slice(page * PAGE_SIZE, (page + 1) * PAGE_SIZE)
+      const next = (allItems.length > (page + 1) * PAGE_SIZE)
+        ? nockFormat({ username, domain, type: 'PagedOrderedCollection', num, page: page + 1 })
+        : undefined
+      const obj = await makeObject(username, type, num, domain, { orderedItems, next })
+      const objText = await obj.write({ useOriginalContext: true })
+      return [200, objText, { 'Content-Type': 'application/activity+json' }]
+    })
     .get(/^\/user\/(\w+)\/(\w+)\/(\d+)$/)
-    .reply(async (uri, requestBody) => {
+    .reply(async function (uri, requestBody) {
+      captureRequestHeaders(domain, uri, this?.req)
       const match = uri.match(/^\/user\/(\w+)\/(\w+)\/(\d+)$/)
       const username = match[1]
       const type = uppercase(match[2])
       const num = match[3]
       const obj = await makeObject(username, type, num, domain)
-      const objText = await obj.prettyWrite({ useOriginalContext: true })
+      const objText = await obj.write({ useOriginalContext: true })
       return [200, objText, { 'Content-Type': 'application/activity+json' }]
     })
-    .persist()
     .get(/^\/user\/(\w+)\/(\w+)\/(\d+)\/(.*)$/)
-    .reply(async (uri, requestBody) => {
+    .reply(async function (uri, requestBody) {
+      captureRequestHeaders(domain, uri, this?.req)
       const match = uri.match(/^\/user\/(\w+)\/(\w+)\/(\d+)\/(.*)$/)
       const username = match[1]
       const type = match[2]
@@ -256,10 +475,12 @@ export const nockSetup = (domain) =>
       return [200, actText, { 'Content-Type': 'application/activity+json' }]
     })
 
-export function nockFormat ({ username, type, num, obj, key, domain = 'social.example' }) {
+export function nockFormat ({ username, type, num, obj, key, collection, page, domain = defaultDomain }) {
   let url = `https://${domain}/user/${username}`
   if (key) {
     url = `${url}/publickey`
+  } else if (collection) {
+    url = `${url}/${collection}`
   } else {
     if (type && num) {
       url = `${url}/${lowercase(type)}/${num}`
@@ -269,6 +490,8 @@ export function nockFormat ({ username, type, num, obj, key, domain = 'social.ex
         } else {
           url = `${url}/${obj}`
         }
+      } else if (typeof page === 'number') {
+        url = `${url}/page/${page}`
       }
     }
   }

package/.github/workflows/main-docker.yml

@@ -1,45 +0,0 @@
-name: Build and push Docker image
-
-on:
-  workflow_dispatch:
-  push:
-    branches:
-      - main
-
-permissions:
-  contents: read
-  packages: write
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    env:
-      REGISTRY: ghcr.io
-      REPOSITORY: evanp/activitypub-bot
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v2
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
-
-      - name: Log in to GitHub Container Registry
-        uses: docker/login-action@v1
-        with:
-          registry: ${{ env.REGISTRY }}
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Build and push
-        uses: docker/build-push-action@v5
-        with:
-          context: .
-          push: true
-          platforms: linux/amd64,linux/arm64
-          tags: |
-            ${{ env.REGISTRY }}/${{ env.REPOSITORY }}:latest
-            ${{ env.REGISTRY }}/${{ env.REPOSITORY }}:${{ github.sha }}
-          cache-from: type=registry,ref=${{ env.REGISTRY }}/${{ env.REPOSITORY }}:latest
-          cache-to: type=inline

package/index.js

@@ -1,23 +0,0 @@
-import { makeApp } from './lib/app.js'
-
-const DATABASE_URL = process.env.DATABASE_URL || 'sqlite::memory:'
-const ORIGIN = process.env.ORIGIN || 'https://activitypubbot.test'
-const PORT = process.env.PORT || 9000 // HAL
-const BOTS_CONFIG_FILE = process.env.BOTS_CONFIG_FILE || './bots/index.js'
-const LOG_LEVEL = process.env.LOG_LEVEL || (process.env.NODE_ENV === 'test' ? 'silent' : 'info')
-
-const bots = (await import(BOTS_CONFIG_FILE)).default
-
-const app = await makeApp(DATABASE_URL, ORIGIN, bots, LOG_LEVEL)
-
-const server = app.listen(parseInt(PORT), () => {
-  app.locals.logger.info(`Listening on port ${PORT}`)
-})
-
-process.on('SIGTERM', () => {
-  console.log('Received SIGTERM')
-  server.close(async () => {
-    await app.cleanup()
-    process.exit(0)
-  })
-})