@evanp/activitypub-bot 0.44.2 → 0.45.1

package/CHANGELOG.md

@@ -9,6 +9,39 @@ and this project adheres to
 
 ## [Unreleased]
 
+## [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
+
+- MastodonRelayClientBot has type 'Application' to work
+  with relay servers like Pleroma-Relay that require it
+
 ## [0.44.2] - 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/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')

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,38 @@
+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 () {
+    return 'Application'
   }
 
   get fullname () {
@@ -22,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)
       }
     }
   }
@@ -52,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,
@@ -94,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
@@ -114,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 },
@@ -125,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/package.json

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

package/.eslintrc

@@ -1,7 +0,0 @@
-env:
-  node: true
-  es2022: true
-parserOptions:
-  sourceType: module
-extends:
-  - standard

package/.markdownlint.json

@@ -1,4 +0,0 @@
-{
-  "MD013": { "code_blocks": false },
-  "MD024": { "siblings_only": true }
-}

package/CODE_OF_CONDUCT.md

@@ -1,129 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-mailto:contact@socialwebfoundation.org.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq).
-Translations are available at
-[https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).