@evanp/activitypub-bot 0.24.2 → 0.25.1

package/README.md

@@ -157,6 +157,19 @@ 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.
 
+#### FollowBackBot
+
+A *FollowBackBot* will follow back anyone who follows it. Useful for collecting
+public information.
+
+#### RelayClientBot
+
+A *RelayClientBot* can be the client of a Mastodon or Pleroma relay.
+
+#### RelayServerBot
+
+A *RelayServerBot* will act as a relay server for remote servers.
+
 ## API
 
 Custom bots can implement the [Bot](#bot) interface, which is easiest if you inherit from the `Bot` class.
@@ -203,6 +216,10 @@ Called when the bot is mentioned in an incoming object. Can be used to implement
 Called when the bot is followed by another actor. The first argument is the actor, and the second is the `Follow` activity itself. This method is called after the acceptance has been sent and the new
 follower has been added to the `followers` collection.
 
+#### async onUndoFollow (actor, undoActivity, followActivity)
+
+Called when the bot is unfollowed by another actor. The first argument is the actor, the second is the `Undo` activity, and the third is the `Follow` activity. This method is called after the `followers` and/or `pendingFollowers` collections have been updated.
+
 #### async onLike (object, activity)
 
 Called when one of the bot's objects is liked by another actor. The first argument is the object, and the second is the `Like` activity itself. This method is called after the like has been added to the

package/lib/activityhandler.js

@@ -804,13 +804,16 @@ export class ActivityHandler {
       this.#logger.warn({
         msg: 'Follow activity object is not the bot',
         activity: undoActivity.id,
-        object: object.id
+        object: object.id,
+        botId: this.#botId(bot)
       })
       return
     }
-    if (!(await this.#actorStorage.isInCollection(bot.username, 'followers', actor))) {
+    if (
+      !(await this.#actorStorage.isInCollection(bot.username, 'followers', actor)) &&
+      !(await this.#actorStorage.isInCollection(bot.username, 'pendingFollowers', actor))) {
       this.#logger.warn({
-        msg: 'Undo follow activity from actor not in followers',
+        msg: 'Undo follow activity from actor not in followers or pendingFollowers',
         activity: undoActivity.id,
         followActivity: followActivity.id,
         actor: actor.id
@@ -819,6 +822,18 @@ export class ActivityHandler {
     }
     await this.#actorStorage.removeFromCollection(bot.username, 'followers', actor)
     await this.#actorStorage.removeFromCollection(bot.username, 'pendingFollowers', actor)
+    this.#logger.debug(
+      { bot: this.#botId(bot), activity: undoActivity.id },
+      'Notifying bot of undo follow activity'
+    )
+    try {
+      await bot.onUndoFollow(actor, undoActivity, followActivity)
+    } catch (err) {
+      this.#logger.warn(
+        { err, bot: this.#botId(bot), activity: undoActivity.id },
+        'Error notifying bot of undo follow activity'
+      )
+    }
   }
 
   async onIdle () {

package/lib/bot.js

@@ -56,4 +56,8 @@ export default class Bot {
   async handleActivity (activity) {
     return false
   }
+
+  async onUndoFollow (actor, undoActivity, followActivity) {
+    ; // no-op
+  }
 }

package/lib/botcontext.js

@@ -224,17 +224,32 @@ export class BotContext {
   async followActor (actor) {
     assert.ok(actor)
     assert.equal(typeof actor, 'object')
-    await this.#actorStorage.addToCollection(
-      this.#botId,
-      'pendingFollowing',
-      actor
-    )
-    const activity = await this.#doActivity({
-      type: 'Follow',
-      object: actor.id,
-      to: actor.id
-    })
-    await this.#actorStorage.setLastActivity(this.#botId, activity)
+    let activity
+    if (await this.#actorStorage.isInCollection(this.#botId, 'following', actor) ||
+        await this.#actorStorage.isInCollection(this.#botId, 'pendingFollowing', actor)) {
+      const originalId = await this.#actorStorage.getLastActivity(
+        this.#botId,
+        'Follow',
+        actor
+      )
+      if (!originalId) {
+        throw new Error(`no Follow activity for ${actor.id}`)
+      }
+      activity = await this.#objectStorage.read(originalId)
+    } else {
+      await this.#actorStorage.addToCollection(
+        this.#botId,
+        'pendingFollowing',
+        actor
+      )
+      activity = await this.#doActivity({
+        type: 'Follow',
+        object: actor.id,
+        to: actor.id
+      })
+      await this.#actorStorage.setLastActivity(this.#botId, activity)
+    }
+
     return activity
   }
 
@@ -420,13 +435,13 @@ export class BotContext {
   #getRecipients (obj) {
     assert.ok(obj)
     assert.strictEqual(typeof obj, 'object', 'obj must be an object')
-    const to = obj.to ? Array.from(obj.to).map((to) => to.id) : null
-    const cc = obj.cc ? Array.from(obj.cc).map((cc) => cc.id) : null
-    const bto = obj.bto ? Array.from(obj.bto).map((bto) => bto.id) : null
-    const bcc = obj.bcc ? Array.from(obj.bcc).map((bcc) => bcc.id) : null
+    const to = obj.to ? Array.from(obj.to).map((to) => to.id) : undefined
+    const cc = obj.cc ? Array.from(obj.cc).map((cc) => cc.id) : undefined
+    const bto = obj.bto ? Array.from(obj.bto).map((bto) => bto.id) : undefined
+    const bcc = obj.bcc ? Array.from(obj.bcc).map((bcc) => bcc.id) : undefined
     const audience = obj.audience
       ? Array.from(obj.audience).map((audience) => audience.id)
-      : null
+      : undefined
     return { to, cc, bto, bcc, audience }
   }
 
@@ -445,7 +460,7 @@ export class BotContext {
   async #doActivity (activityData, distribute = true) {
     const now = new Date().toISOString()
     const type = activityData.type || 'Activity'
-    const activity = await as2.import({
+    const json = {
       ...activityData,
       type,
       id: this.#formatter.format({
@@ -459,7 +474,14 @@ export class BotContext {
       },
       published: now,
       updated: now
-    })
+    }
+    let activity
+    try {
+      activity = await as2.import(json)
+    } catch (err) {
+      this.#logger.warn({ err, json, method: '#doActivity' }, 'Import error')
+      throw err
+    }
     await this.#objectStorage.create(activity)
     await this.#actorStorage.addToCollection(this.#botId, 'outbox', activity)
     await this.#actorStorage.addToCollection(this.#botId, 'inbox', activity)
@@ -488,7 +510,7 @@ export class BotContext {
         type,
         object: {
           id: obj.id,
-          type: obj.type
+          ...(obj.type && { type: obj.type })
         }
       },
       ...recipients

package/lib/botfactory.js

@@ -21,4 +21,8 @@ export default class BotFactory {
   async onPublic (activity) {
     ; // no-op
   }
+
+  async actorOK (actorId, activity) {
+    return false
+  }
 }

package/lib/bots/followback.js

@@ -0,0 +1,33 @@
+import Bot from '../bot.js'
+
+const DEFAULT_NAME = 'FollowBackBot'
+const DEFAULT_DESCRIPTION = 'A bot that follows you back'
+
+export default class FollowBackBot extends Bot {
+  #fullname
+  #description
+
+  constructor (username, { fullname = DEFAULT_NAME, description = DEFAULT_DESCRIPTION } = {}) {
+    super(username)
+    this.#fullname = fullname
+    this.#description = description
+  }
+
+  get fullname () {
+    return this.#fullname
+  }
+
+  get description () {
+    return this.#description
+  }
+
+  async onFollow (actor, activity) {
+    this._context.logger.info({ actorId: actor.id }, 'Following user back')
+    await this._context.followActor(actor)
+  }
+
+  async onUndoFollow (actor, undoActivity, followActivity) {
+    this._context.logger.info({ actorId: actor.id }, 'Unfollowing user back')
+    await this._context.unfollowActor(actor)
+  }
+}

package/lib/bots/relayclient.js

@@ -22,6 +22,10 @@ export default class RelayClientBot extends Bot {
     return 'A bot for subscribing to relays'
   }
 
+  get key () {
+    return `follow:${this.#relay}`
+  }
+
   async initialize (context) {
     super.initialize(context)
     this._context.logger.info(
@@ -29,11 +33,12 @@ export default class RelayClientBot extends Bot {
       'Initialising relay client'
     )
     if (this.#unsubscribe) {
-      if (await this._context.hasData(`follow:${this.#relay}`)) {
+      if (await this._context.hasData(this.key)) {
         await this.#unfollowRelay()
       }
     } else {
-      if (!(await this._context.hasData(`follow:${this.#relay}`))) {
+      if (!(await this._context.hasData(this.key)) ||
+        ((await this._context.getData(this.key)) == null)) {
         await this.#followRelay()
       }
     }
@@ -70,11 +75,11 @@ export default class RelayClientBot extends Bot {
       { relay: this.#relay, activity: activity.id },
       'Saving follow for later'
     )
-    this._context.setData(`follow:${this.#relay}`, activity.id)
+    this._context.setData(this.key, activity.id)
   }
 
   async #unfollowRelay () {
-    const activityId = await this._context.getData(`follow:${this.#relay}`)
+    const activityId = await this._context.getData(this.key)
     this._context.logger.info(
       { relay: this.#relay, activity: activityId },
       'Unfollowing relay'
@@ -92,11 +97,11 @@ export default class RelayClientBot extends Bot {
       { relay: this.#relay },
       'Clearing follow data'
     )
-    this._context.setData(`follow:${this.#relay}`, null)
+    this._context.deleteData(this.key)
   }
 
   async #handleAccept (activity) {
-    const activityId = await this._context.getData(`follow:${this.#relay}`)
+    const activityId = await this._context.getData(this.key)
     if (activity.object?.first?.id === activityId) {
       this._context.logger.info(
         { accept: activity.id, follow: activityId },
@@ -109,7 +114,7 @@ export default class RelayClientBot extends Bot {
   }
 
   async #handleReject (activity) {
-    const activityId = await this._context.getData(`follow:${this.#relay}`)
+    const activityId = await this._context.getData(this.key)
     if (activity.object?.first?.id === activityId) {
       this._context.logger.info(
         { accept: activity.id, follow: activityId },

package/lib/index.js

@@ -5,3 +5,4 @@ export { default as OKBot } from './bots/ok.js'
 export { default as DoNothingBot } from './bots/donothing.js'
 export { default as RelayClientBot } from './bots/relayclient.js'
 export { default as RelayServerBot } from './bots/relayserver.js'
+export { default as FollowBackBot } from './bots/followback.js'

package/lib/routes/sharedinbox.js

@@ -15,7 +15,10 @@ async function asyncSome (array, asyncPredicate) {
 }
 
 async function actorOK (subject, activity, bots) {
-  await asyncSome(Object.values(bots), bot => bot.actorOK(subject, activity))
+  return await asyncSome(
+    Object.values(bots),
+    bot => bot.actorOK(subject, activity)
+  )
 }
 
 router.post('/shared/inbox', async (req, res, next) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evanp/activitypub-bot",
-  "version": "0.24.2",
+  "version": "0.25.1",
   "description": "server-side ActivityPub bot framework",
   "type": "module",
   "main": "lib/index.js",
@@ -43,7 +43,7 @@
     "sequelize": "^6.37.7"
   },
   "devDependencies": {
-    "@evanp/activitypub-nock": "^0.5.0",
+    "@evanp/activitypub-nock": "^0.6.0",
     "eslint": "^8.57.1",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.29.1",