@evanp/activitypub-bot 0.44.3 → 0.45.2

package/CHANGELOG.md

@@ -9,6 +9,41 @@ and this project adheres to
 
 ## [Unreleased]
 
+## [0.45.2] - 2026-04-24
+
+### Fixed
+
+- Only send activities with `actor` property as a bare URI,
+  not an embedded object. Fixes interoperability with Misskey.
+- Explicitly set `manuallyApprovesFollowers` to false. Fixes
+  (some) interoperability with Pixelfed.
+
+## [0.45.1] - 2026-04-23
+
+### Fixed
+
+- LitePubRelayClientBot test was not clearing
+  queued jobs
+
+## [0.45.0] - 2026-04-23
+
+### Added
+
+- LoggingBot class for debugging installations
+- addFollowingUnsafe(), removeFollowingUnsafe(), fanoutPublic()
+  methods of BotContext
+
+### Changed
+
+- MastodonRelayClientBot can take an array of relay ids as
+  `relay` option or one as a string
+- MastodonRelayClientBot ignores `unsubscribe`, syncs relay
+  array instead
+- MastodonRelayClientBot adds relay server to `following`
+- MastodonRelayClientBot and LitePubRelayClientBot fan out
+  relay server `Announce` activities to all other bots
+- BotContext constructor takes `bots` argument
+
 ## [0.44.3] - 2026-04-23
 
 ### Fixed

package/README.md

@@ -204,6 +204,13 @@ An *OKBot* instance will reply to any message that it's mentioned in with the co
 
 A *DoNothingBot* instance will only do default stuff, like accepting follows.
 
+#### LoggingBot
+
+A *LoggingBot* behaves like `DoNothingBot` but logs each `Bot` interface
+callback it receives (`onPublic`, `onFollow`, `onMention`, etc.) at `debug`
+level. Useful as a smoke-test bot to confirm that activities are being
+delivered to local bots; silent in production unless log level is lowered.
+
 #### FollowBackBot
 
 A *FollowBackBot* will follow back anyone who follows it. Useful for collecting
@@ -211,7 +218,15 @@ public information.
 
 #### MastodonRelayClientBot
 
-A *MastodonRelayClientBot* can be the client of a Mastodon relay.
+A *MastodonRelayClientBot* can be the client of one or more Mastodon-style
+relays. Its `relay` option accepts either a single actor URL as a string or
+an array of actor URLs; the bot sends a Mastodon-style `Follow`
+(`object: https://www.w3.org/ns/activitystreams#Public`) to each on
+initialize. To unsubscribe from a relay, remove it from the array and
+re-initialize — the bot diffs the new config against the current `following`
+collection and sends an `Undo`/`Follow` for each removed relay. It also
+advertises `Application` actor type, which Mastodon-style relay software
+(e.g. Pleroma-Relay) requires from subscribers.
 
 #### MastodonRelayServerBot
 
@@ -475,6 +490,27 @@ Async generator that yields each actor in this bot's `following` collection, one
 
 Returns `true` if `url` is served by this activitypub-bot instance (i.e. its origin matches the configured `--origin`). Synchronous.
 
+#### async addFollowingUnsafe (actor)
+
+Forcibly adds `actor` to this bot's `following` collection without sending
+a `Follow` or waiting for an `Accept`. Intended for bots (like relay
+clients) whose followship is established through a protocol exchange that
+sits outside the usual Follow/Accept flow. Trust that the caller knows
+what they're doing.
+
+#### async removeFollowingUnsafe (actor)
+
+Forcibly removes `actor` from this bot's `following` collection without
+sending an `Undo`/`Follow`. The protocol-level cleanup is the caller's
+responsibility. Pair with `addFollowingUnsafe()` for symmetry.
+
+#### async fanoutPublic (activity)
+
+Invokes `onPublic(activity)` on every bot registered on the server, so one
+bot can forward a public activity it received through a side-channel
+(e.g. a relay-forwarded `Announce`) to all local bots. Errors in any
+individual bot's `onPublic` are logged and do not interrupt the fanout.
+
 #### async onIdle ()
 
 Resolves when the background distribution queue has drained. Intended for test code that needs to wait for outbound activities to finish being delivered before asserting on their effects.

package/lib/activityhandler.js

@@ -912,11 +912,7 @@ export class ActivityHandler {
     const activity = await as2.import({
       ...activityData,
       id: this.#formatActivityId(bot, activityData.type),
-      actor: {
-        id: this.#botId(bot),
-        name: bot.fullname,
-        type: bot.type
-      },
+      actor: this.#botId(bot),
       published: now,
       updated: now
     })

package/lib/activitystreams.js

@@ -406,4 +406,23 @@ as2.registerContext('https://purl.archive.org/socialweb/webfinger', {
   }
 })
 
+as2.registerContext('https://purl.archive.org/miscellany', {
+  '@context': {
+    as: 'https://www.w3.org/ns/activitystreams#',
+    xsd: 'http://www.w3.org/2001/XMLSchema#',
+    Hashtag: 'as:Hashtag',
+    manuallyApprovesFollowers: {
+      '@id': 'as:manuallyApprovesFollowers',
+      '@type': 'xsd:boolean'
+    },
+    movedTo: {
+      '@id': 'as:movedTo',
+      '@type': '@id'
+    },
+    sensitive: {
+      '@id': 'as:sensitive',
+      '@type': 'xsd:boolean'
+    }
+  }
+})
 export default as2

package/lib/app.js

@@ -143,7 +143,8 @@ export async function makeApp ({ databaseUrl, origin, bots, logLevel = 'silent',
         distributor,
         formatter,
         transformer,
-        logger
+        logger,
+        bots
       )
     ))
   )
@@ -164,7 +165,8 @@ export async function makeApp ({ databaseUrl, origin, bots, logLevel = 'silent',
     distributor,
     formatter,
     transformer,
-    logger
+    logger,
+    bots
   ))
 
   const { workers: deliveryWorkers, runs: deliveryWorkerRuns } = createWorkers(logger, deliveryWorkerCount, DeliveryWorker, jobQueue, logger, { actorStorage, activityHandler, bots })

package/lib/botcontext.js

@@ -25,6 +25,8 @@ export class BotContext {
   #formatter = null
   #transformer = null
   #logger = null
+  #bots
+
   get botId () {
     return this.#botId
   }
@@ -42,7 +44,8 @@ export class BotContext {
     distributor,
     formatter,
     transformer,
-    logger
+    logger,
+    bots
   ) {
     this.#botId = botId
     this.#botDataStorage = botDataStorage
@@ -52,6 +55,7 @@ export class BotContext {
     this.#distributor = distributor
     this.#formatter = formatter
     this.#transformer = transformer
+    this.#bots = bots
     this.#logger = logger.child({ class: 'BotContext', botId })
   }
 
@@ -481,6 +485,37 @@ export class BotContext {
     yield * this.#actorStorage.items(this.#botId, 'following')
   }
 
+  async addFollowingUnsafe (actor) {
+    assert.ok(actor)
+    assert.equal(typeof actor, 'object')
+    await this.#actorStorage.addToCollection(this.#botId, 'following', actor)
+    this.#logger.debug({ actor: actor.id }, 'unsafe add to following')
+  }
+
+  async removeFollowingUnsafe (actor) {
+    assert.ok(actor)
+    assert.equal(typeof actor, 'object')
+    await this.#actorStorage.removeFromCollection(this.#botId, 'following', actor)
+    this.#logger.debug({ actor: actor.id }, 'unsafe remove from following')
+  }
+
+  async fanoutPublic (activity) {
+    assert.ok(activity)
+    assert.equal(typeof activity, 'object')
+    await Promise.all(Object.values(this.#bots).map(async (bot) => {
+      let result
+      try {
+        result = await bot.onPublic(activity)
+      } catch (err) {
+        this.#logger.warn(
+          { err, activity: activity.id, bot: bot.id },
+          'Error handling public activity for bot'
+        )
+      }
+      return result
+    }))
+  }
+
   async #isInCollection (name, obj) {
     assert.ok(name)
     assert.equal(typeof name, 'string')
@@ -540,9 +575,7 @@ export class BotContext {
         type,
         nanoid: nanoid()
       }),
-      actor: {
-        id: this.#formatter.format({ username: this.#botId })
-      },
+      actor: this.#formatter.format({ username: this.#botId }),
       published: now,
       updated: now
     }

package/lib/bots/litepubrelayclient.js

@@ -4,6 +4,7 @@ import Bot from '../bot.js'
 
 const NS = 'https://www.w3.org/ns/activitystreams#'
 const CREATE = `${NS}Create`
+const ANNOUNCE = `${NS}Announce`
 
 const DEFAULT_NAME = 'LitePubRelayClientBot'
 const DEFAULT_DESCRIPTION = 'A LitePub relay client'
@@ -75,6 +76,26 @@ export default class LitePubRelayClientBot extends Bot {
     }
   }
 
+  async handleActivity (activity) {
+    if (activity.type === ANNOUNCE) {
+      return await this.#handleAnnounce(activity)
+    } else {
+      return false
+    }
+  }
+
+  async #handleAnnounce (activity) {
+    if (this.#relay.includes(activity.actor?.first?.id)) {
+      this._context.logger.debug(
+        { activity: activity.id },
+        'fanning out relay announce activity'
+      )
+      await this._context.fanoutPublic(activity)
+      return true
+    }
+    return false
+  }
+
   async #hasAnyFollower () {
     for await (const actor of this._context.followers()) {
       if (this.#relay.includes(actor.id)) {

package/lib/bots/logging.js

@@ -0,0 +1,103 @@
+import Bot from '../bot.js'
+
+const DEFAULT_FULLNAME = 'Logging Bot'
+const DEFAULT_DESCRIPTION = 'A bot that logs callback events.'
+
+export default class LoggingBot extends Bot {
+  constructor (username, options = {}) {
+    super(username, {
+      fullname: DEFAULT_FULLNAME,
+      description: DEFAULT_DESCRIPTION,
+      ...options
+    })
+  }
+
+  async onMention (object, activity) {
+    this._context.logger.debug(
+      {
+        class: this.constructor.name,
+        object: await object.export(),
+        activity: await activity.export()
+      },
+      'onMention'
+    )
+  }
+
+  async onFollow (actor, activity) {
+    this._context.logger.debug(
+      {
+        class: this.constructor.name,
+        actor: await actor.export(),
+        activity: await activity.export()
+      },
+      'onFollow'
+    )
+  }
+
+  async onLike (object, activity) {
+    this._context.logger.debug(
+      {
+        class: this.constructor.name,
+        object: await object.export(),
+        activity: await activity.export()
+      },
+      'onLike'
+    )
+  }
+
+  async onAnnounce (object, activity) {
+    this._context.logger.debug(
+      {
+        class: this.constructor.name,
+        object: await object.export(),
+        activity: await activity.export()
+      },
+      'onAnnounce'
+    )
+  }
+
+  async onPublic (activity) {
+    this._context.logger.debug(
+      {
+        class: this.constructor.name,
+        activity: await activity.export()
+      },
+      'onPublic'
+    )
+  }
+
+  async actorOK (actorId, activity) {
+    this._context.logger.debug(
+      {
+        class: this.constructor.name,
+        actorId,
+        activity: await activity.export()
+      },
+      'actorOK'
+    )
+    return false
+  }
+
+  async handleActivity (activity) {
+    this._context.logger.debug(
+      {
+        class: this.constructor.name,
+        activity: await activity.export()
+      },
+      'handleActivity'
+    )
+    return false
+  }
+
+  async onUndoFollow (actor, undoActivity, followActivity) {
+    this._context.logger.debug(
+      {
+        class: this.constructor.name,
+        actor: await actor.export(),
+        undoActivity: await undoActivity.export(),
+        followActivity: await followActivity.export()
+      },
+      'onUndoFollow'
+    )
+  }
+}

package/lib/bots/mastodonrelayclient.js

@@ -1,17 +1,34 @@
+import assert from 'node:assert'
+
 import Bot from '../bot.js'
 
 const NS = 'https://www.w3.org/ns/activitystreams#'
 const ACCEPT = `${NS}Accept`
 const REJECT = `${NS}Reject`
+const ANNOUNCE = `${NS}Announce`
 
 export default class MastodonRelayClientBot extends Bot {
   #relay
-  #unsubscribe
+  #relayForwarding
 
   constructor (username, options = {}) {
+    if (typeof username !== 'string') {
+      throw new Error('username must be a string')
+    }
+    if (typeof options !== 'object') {
+      throw new Error('options must be an object')
+    }
+    if (typeof options.relay !== 'string' &&
+        !Array.isArray(options.relay)) {
+      throw new Error('relay option must be a string or array')
+    }
     super(username, options)
-    this.#relay = options.relay
-    this.#unsubscribe = !!options.unsubscribe
+    this.#relay = Array.isArray(options.relay)
+      ? options.relay
+      : [options.relay]
+    this.#relayForwarding = ('relayForwarding' in options)
+      ? options.relayForwarding
+      : true
   }
 
   get type () {
@@ -26,24 +43,29 @@ export default class MastodonRelayClientBot extends Bot {
     return 'A bot for subscribing to relays'
   }
 
-  get key () {
-    return `follow:${this.#relay}`
-  }
-
   async initialize (context) {
-    super.initialize(context)
+    await super.initialize(context)
     this._context.logger.info(
-      { relay: this.#relay, unsubscribe: this.#unsubscribe },
+      { relay: this.#relay },
       'Initialising relay client'
     )
-    if (this.#unsubscribe) {
-      if (await this._context.hasData(this.key)) {
-        await this.#unfollowRelay()
+
+    assert.ok(Array.isArray(this.#relay))
+
+    const toFollow = new Set(this.#relay)
+
+    for await (const actor of this._context.following()) {
+      if (toFollow.has(actor.id)) {
+        toFollow.delete(actor.id)
+      } else {
+        await this.#unfollowRelay(actor)
       }
-    } else {
-      if (!(await this._context.hasData(this.key)) ||
-        ((await this._context.getData(this.key)) == null)) {
-        await this.#followRelay()
+    }
+
+    for (const id of toFollow) {
+      const actor = await this._context.getObject(id)
+      if (!await this.#hasFollowActivity(actor)) {
+        await this.#followRelay(actor)
       }
     }
   }
@@ -56,40 +78,42 @@ export default class MastodonRelayClientBot extends Bot {
       return await this.#handleAccept(activity)
     } else if (activity.type === REJECT) {
       return await this.#handleReject(activity)
+    } else if (activity.type === ANNOUNCE) {
+      return await this.#handleAnnounce(activity)
     } else {
       return false
     }
   }
 
   async actorOK (actorId, activity) {
-    return (actorId === this.#relay && !this.#unsubscribe)
+    return this.#relay.includes(actorId)
   }
 
-  async #followRelay () {
+  async #followRelay (actor) {
     this._context.logger.info(
-      { relay: this.#relay },
+      { relay: actor.id },
       'Following relay'
     )
     const activity = await this._context.doActivity({
-      to: this.#relay,
+      to: actor.id,
       type: 'Follow',
       object: 'https://www.w3.org/ns/activitystreams#Public'
     })
     this._context.logger.info(
-      { relay: this.#relay, activity: activity.id },
+      { relay: actor.id, activity: activity.id },
       'Saving follow for later'
     )
-    this._context.setData(this.key, activity.id)
+    await this.#setFollowActivity(actor, activity)
   }
 
-  async #unfollowRelay () {
-    const activityId = await this._context.getData(this.key)
+  async #unfollowRelay (actor) {
+    const activityId = await this.#getFollowActivity(actor)
     this._context.logger.info(
-      { relay: this.#relay, activity: activityId },
+      { relay: actor.id, activity: activityId },
       'Unfollowing relay'
     )
     await this._context.doActivity({
-      to: this.#relay,
+      to: actor.id,
       type: 'Undo',
       object: {
         id: activityId,
@@ -98,19 +122,22 @@ export default class MastodonRelayClientBot extends Bot {
       }
     })
     this._context.logger.info(
-      { relay: this.#relay },
+      { relay: actor.id },
       'Clearing follow data'
     )
-    this._context.deleteData(this.key)
+    await this._context.removeFollowingUnsafe(actor)
+    await this.#deleteFollowActivity(actor)
   }
 
   async #handleAccept (activity) {
-    const activityId = await this._context.getData(this.key)
+    const actor = activity.actor?.first
+    const activityId = await this.#getFollowActivity(actor)
     if (activity.object?.first?.id === activityId) {
       this._context.logger.info(
         { accept: activity.id, follow: activityId },
         'Follow accepted'
       )
+      await this._context.addFollowingUnsafe(activity.actor.first)
       return true
     } else {
       return false
@@ -118,7 +145,8 @@ export default class MastodonRelayClientBot extends Bot {
   }
 
   async #handleReject (activity) {
-    const activityId = await this._context.getData(this.key)
+    const actor = activity.actor?.first
+    const activityId = await this.#getFollowActivity(actor)
     if (activity.object?.first?.id === activityId) {
       this._context.logger.info(
         { accept: activity.id, follow: activityId },
@@ -129,4 +157,32 @@ export default class MastodonRelayClientBot extends Bot {
       return false
     }
   }
+
+  async #handleAnnounce (activity) {
+    if (this.#relay.includes(activity.actor?.first?.id)) {
+      await this._context.fanoutPublic(activity)
+      return true
+    }
+    return false
+  }
+
+  async #setFollowActivity (actor, activity) {
+    const key = `follow:${actor.id}`
+    return await this._context.setData(key, activity.id)
+  }
+
+  async #getFollowActivity (actor) {
+    const key = `follow:${actor.id}`
+    return await this._context.getData(key)
+  }
+
+  async #deleteFollowActivity (actor) {
+    const key = `follow:${actor.id}`
+    return await this._context.deleteData(key)
+  }
+
+  async #hasFollowActivity (actor) {
+    const key = `follow:${actor.id}`
+    return await this._context.hasData(key)
+  }
 }

package/lib/index.js

@@ -8,3 +8,4 @@ export { default as MastodonRelayServerBot, default as RelayServerBot } from './
 export { default as FollowBackBot } from './bots/followback.js'
 export { default as LitePubRelayClientBot } from './bots/litepubrelayclient.js'
 export { default as LitePubRelayServerBot } from './bots/litepubrelayserver.js'
+export { default as LoggingBot } from './bots/logging.js'

package/lib/routes/user.js

@@ -37,7 +37,8 @@ router.get('/user/:username', async (req, res, next) => {
     '@context': [
       'https://www.w3.org/ns/activitystreams',
       'https://w3id.org/security/v1',
-      'https://purl.archive.org/socialweb/webfinger'
+      'https://purl.archive.org/socialweb/webfinger',
+      'https://purl.archive.org/miscellany'
     ],
     id: formatter.format({ username }),
     type: bot.type,
@@ -67,7 +68,8 @@ router.get('/user/:username', async (req, res, next) => {
       href: formatter.format({ username, type: 'profile' }),
       type: 'Link',
       mediaType: 'text/html'
-    }
+    },
+    manuallyApprovesFollowers: false
   })
   res.status(200)
   res.type(as2.mediaType)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evanp/activitypub-bot",
-  "version": "0.44.3",
+  "version": "0.45.2",
   "description": "server-side ActivityPub bot framework",
   "type": "module",
   "main": "lib/index.js",