@evanp/activitypub-bot 0.15.4 → 0.16.2

package/README.md

@@ -276,6 +276,11 @@ Sends an `Undo`/`Like` activity for the passed-in object in [activitystrea.ms](#
 
 Sends an `Announce` activity for the passed-in object in [activitystrea.ms](#activitystreams) form to followers.
 
+#### async unannounceObject (obj)
+
+Sends an `Undo`/`Announce` activity for the passed-in object. The addressees
+match the `Announce` activity being undone.
+
 #### async followActor (actor)
 
 Sends a `Follow` activity for the passed-in actor in [activitystrea.ms](#activitystreams) form.

package/lib/actorstorage.js

@@ -1,6 +1,9 @@
+import AS2 from 'activitystrea.ms'
 import as2 from './activitystreams.js'
 import assert from 'node:assert'
 
+const AS2_NS = 'https://www.w3.org/ns/activitystreams#'
+
 export class ActorStorage {
   #connection = null
   #formatter = null
@@ -256,6 +259,77 @@ export class ActorStorage {
     return usernames
   }
 
+  async getLastActivity (username, type, object) {
+    assert.ok(username, 'username is required')
+    assert.equal(typeof username, 'string', 'username must be a string')
+    assert.ok(type, 'type is required')
+    assert.equal(typeof type, 'string', 'type must be a string')
+    assert.ok(object, 'object is required')
+    assert.equal(typeof object, 'object', 'object must be an object')
+    assert.ok(object.id, 'object.id is required')
+    assert.equal(typeof object.id, 'string', 'object.id must be a string')
+
+    const [result] = await this.#connection.query(
+      `SELECT activity_id
+      FROM lastactivity
+      WHERE username = ? AND type = ? and object_id = ?`,
+      { replacements: [username, this.#clearNS(type), object.id] }
+    )
+
+    return (result.length > 0)
+      ? result[0].activity_id
+      : null
+  }
+
+  async clearLastActivity (username, type, object) {
+    assert.ok(username, 'username is required')
+    assert.equal(typeof username, 'string', 'username must be a string')
+    assert.ok(type, 'type is required')
+    assert.equal(typeof type, 'string', 'type must be a string')
+    assert.ok(object, 'object is required')
+    assert.equal(typeof object, 'object', 'object must be an object')
+    assert.ok(object.id, 'object.id is required')
+    assert.equal(typeof object.id, 'string', 'object.id must be a string')
+
+    await this.#connection.query(
+      `DELETE FROM lastactivity
+      WHERE username = ? AND type = ? and object_id = ?`,
+      { replacements: [username, this.#clearNS(type), object.id] }
+    )
+  }
+
+  async setLastActivity (username, activity) {
+    assert.ok(username, 'username is required')
+    assert.equal(typeof username, 'string', 'username must be a string')
+    assert.ok(activity, 'activity is required')
+    assert.equal(typeof activity, 'object', 'activity must be an object')
+    assert.ok(activity.id, 'activity.id is required')
+    assert.equal(typeof activity.id, 'string', 'id must be a string')
+    assert.ok(activity.type, 'activity.type is required')
+    assert.equal(typeof activity.type, 'string', 'type must be a string')
+    assert.ok(activity.object, 'activity.object is required')
+    assert.equal(typeof activity.object, 'object', 'activity.object must be an object')
+    assert.ok(activity.object.first.id, 'activity.object.id is required')
+    assert.equal(typeof activity.object.first.id, 'string', 'activity.object.id must be a string')
+
+    await this.#connection.query(
+      `
+        INSERT INTO lastactivity (username, type, object_id, activity_id)
+        VALUES (?, ?, ?, ?)
+        ON CONFLICT DO UPDATE
+        SET activity_id = EXCLUDED.activity_id,
+            updatedAt = CURRENT_TIMESTAMP
+      `,
+      { replacements: [
+          username,
+          this.#clearNS(activity.type),
+          activity.object.first.id,
+          activity.id
+        ]
+      }
+    )
+  }
+
   async #getCollectionInfo (username, property) {
     const [result] = await this.#connection.query(
       `SELECT first, totalItems, createdAt, updatedAt
@@ -287,4 +361,10 @@ export class ActorStorage {
     )
     return rows[0][0].item_count
   }
+
+  #clearNS (type) {
+    return (type.startsWith(AS2_NS))
+      ? type.slice(AS2_NS.length)
+      : type
+  }
 }

package/lib/botcontext.js

@@ -143,14 +143,13 @@ export class BotContext {
       attributedTo: this.#formatter.format({ username: this.#botId })
     })
     await this.#objectStorage.create(note)
-    const activity = await as2.import({
+    const activity = await this.#doActivity({
+      '@context': [
+        'https://www.w3.org/ns/activitystreams',
+        'https://purl.archive.org/socialweb/thread/1.0',
+        { ostatus: 'http://ostatus.org/schema/1.0/' }
+      ],
       type: 'Create',
-      id: this.#formatter.format({
-        username: this.#botId,
-        type: 'create',
-        nanoid: nanoid()
-      }),
-      actor: this.#formatter.format({ username: this.#botId }),
       to,
       cc,
       bto,
@@ -158,10 +157,6 @@ export class BotContext {
       audience,
       object: note
     })
-    await this.#objectStorage.create(activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'outbox', activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'inbox', activity)
-    await this.#distributor.distribute(activity, this.#botId)
     return note
   }
 
@@ -205,23 +200,14 @@ export class BotContext {
     const owners = obj.attributedTo
       ? Array.from(obj.attributedTo).map((owner) => owner.id)
       : Array.from(obj.actor).map((owner) => owner.id)
-    const activity = await as2.import({
+    await this.#actorStorage.addToCollection(this.#botId, 'liked', obj)
+    const activity = await this.#doActivity({
       type: 'Like',
-      id: this.#formatter.format({
-        username: this.#botId,
-        type: 'like',
-        nanoid: nanoid()
-      }),
-      actor: this.#formatter.format({ username: this.#botId }),
       object: obj.id,
       to: owners,
       cc: 'https://www.w3.org/ns/activitystreams#Public'
     })
-    await this.#objectStorage.create(activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'outbox', activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'inbox', activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'liked', obj)
-    await this.#distributor.distribute(activity, this.#botId)
+    await this.#actorStorage.setLastActivity(this.#botId, activity)
     return activity
   }
 
@@ -234,93 +220,51 @@ export class BotContext {
     if (!(await this.#actorStorage.isInCollection(this.#botId, 'liked', obj))) {
       throw new Error(`not already liked: ${obj.id} by ${this.#botId}`)
     }
-    const likeActivity = this.#findInOutbox('Like', obj)
+    const likeActivity = this.#actorStorage.getLastActivity(
+      this.#botId,
+      'Like',
+      obj
+    )
     if (!likeActivity) {
       throw new Error('no like activity')
     }
-    const undoActivity = await as2.import({
+    await this.#actorStorage.removeFromCollection(this.#botId, 'liked', obj)
+    return await this.#doActivity({
       type: 'Undo',
-      id: this.#formatter.format({
-        username: this.#botId,
-        type: 'undo',
-        nanoid: nanoid()
-      }),
-      actor: this.#formatter.format({ username: this.#botId }),
       object: likeActivity,
       to: owners,
       cc: 'https://www.w3.org/ns/activitystreams#Public'
     })
-    await this.#objectStorage.create(undoActivity)
-    await this.#actorStorage.addToCollection(
-      this.#botId,
-      'outbox',
-      undoActivity
-    )
-    await this.#actorStorage.addToCollection(
-      this.#botId,
-      'inbox',
-      undoActivity
-    )
-    await this.#actorStorage.removeFromCollection(this.#botId, 'liked', obj)
-    await this.#distributor.distribute(undoActivity, this.#botId)
-    return undoActivity
   }
 
   async followActor (actor) {
     assert.ok(actor)
     assert.equal(typeof actor, 'object')
-    const activity = await as2.import({
-      type: 'Follow',
-      id: this.#formatter.format({
-        username: this.#botId,
-        type: 'follow',
-        nanoid: nanoid()
-      }),
-      actor: this.#formatter.format({ username: this.#botId }),
-      object: actor.id,
-      to: actor.id
-    })
-    await this.#objectStorage.create(activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'outbox', activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'inbox', activity)
     await this.#actorStorage.addToCollection(
       this.#botId,
       'pendingFollowing',
       actor
     )
-    await this.#distributor.distribute(activity, this.#botId)
+    const activity = await this.#doActivity({
+      type: 'Follow',
+      object: actor.id,
+      to: actor.id
+    })
+    await this.#actorStorage.setLastActivity(this.#botId, activity)
     return activity
   }
 
   async unfollowActor (actor) {
     assert.ok(actor)
     assert.equal(typeof actor, 'object')
-    const followActivity = this.#findInOutbox('Follow', actor)
+    const followActivity = this.#actorStorage.getLastActivity(
+      this.#botId,
+      'Follow',
+      actor
+    )
     if (!followActivity) {
       throw new Error('no follow activity')
     }
-    const undoActivity = await as2.import({
-      type: 'Undo',
-      id: this.#formatter.format({
-        username: this.#botId,
-        type: 'undo',
-        nanoid: nanoid()
-      }),
-      actor: this.#formatter.format({ username: this.#botId }),
-      object: followActivity,
-      to: actor.id
-    })
-    await this.#objectStorage.create(undoActivity)
-    await this.#actorStorage.addToCollection(
-      this.#botId,
-      'outbox',
-      undoActivity
-    )
-    await this.#actorStorage.addToCollection(
-      this.#botId,
-      'inbox',
-      undoActivity
-    )
     await this.#actorStorage.removeFromCollection(
       this.#botId,
       'pendingFollowing',
@@ -331,26 +275,16 @@ export class BotContext {
       'following',
       actor
     )
-    await this.#distributor.distribute(undoActivity, this.#botId)
-    return undoActivity
+    return await this.#doActivity({
+      type: 'Undo',
+      object: followActivity,
+      to: actor.id
+    })
   }
 
   async blockActor (actor) {
     assert.ok(actor)
     assert.equal(typeof actor, 'object')
-    const activity = await as2.import({
-      type: 'Block',
-      id: this.#formatter.format({
-        username: this.#botId,
-        type: 'block',
-        nanoid: nanoid()
-      }),
-      actor: this.#formatter.format({ username: this.#botId }),
-      object: actor.id
-    })
-    await this.#objectStorage.create(activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'outbox', activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'inbox', activity)
     await this.#actorStorage.addToCollection(this.#botId, 'blocked', actor)
     for (const coll of [
       'following',
@@ -360,45 +294,34 @@ export class BotContext {
     ]) {
       await this.#actorStorage.removeFromCollection(this.#botId, coll, actor)
     }
-    // Do not distribute!
+    const activity = await this.#doActivity({
+      type: 'Block',
+      object: actor.id
+    }, false)
+    await this.#actorStorage.setLastActivity(this.#botId, activity)
     return activity
   }
 
   async unblockActor (actor) {
     assert.ok(actor)
     assert.equal(typeof actor, 'object')
-    const blockActivity = this.#findInOutbox('Block', actor)
+    const blockActivity = this.#actorStorage.getLastActivity(
+      this.#botId,
+      'Block',
+      actor
+    )
     if (!blockActivity) {
       throw new Error('no block activity')
     }
-    const undoActivity = await as2.import({
-      type: 'Undo',
-      id: this.#formatter.format({
-        username: this.#botId,
-        type: 'undo',
-        nanoid: nanoid()
-      }),
-      actor: this.#formatter.format({ username: this.#botId }),
-      object: blockActivity
-    })
-    await this.#objectStorage.create(undoActivity)
-    await this.#actorStorage.addToCollection(
-      this.#botId,
-      'outbox',
-      undoActivity
-    )
-    await this.#actorStorage.addToCollection(
-      this.#botId,
-      'inbox',
-      undoActivity
-    )
     await this.#actorStorage.removeFromCollection(
       this.#botId,
       'blocked',
       actor
     )
-    // Do not distribute!
-    return undoActivity
+    return await this.#doActivity({
+      type: 'Undo',
+      object: blockActivity
+    }, false)
   }
 
   async updateNote (note, content) {
@@ -410,14 +333,9 @@ export class BotContext {
     exported.content = content
     const updated = await as2.import(exported)
     const { to, cc, bto, bcc, audience } = this.#getRecipients(note)
-    const activity = await as2.import({
+    await this.#objectStorage.update(updated)
+    await this.#doActivity({
       type: 'Update',
-      id: this.#formatter.format({
-        username: this.#botId,
-        type: 'update',
-        nanoid: nanoid()
-      }),
-      actor: this.#formatter.format({ username: this.#botId }),
       object: updated,
       to,
       cc,
@@ -425,11 +343,6 @@ export class BotContext {
       bcc,
       audience
     })
-    await this.#objectStorage.update(updated)
-    await this.#objectStorage.create(activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'outbox', activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'inbox', activity)
-    await this.#distributor.distribute(activity, this.#botId)
     return updated
   }
 
@@ -449,14 +362,9 @@ export class BotContext {
       bcc,
       audience
     })
-    const activity = await as2.import({
+    await this.#objectStorage.update(tombstone)
+    return await this.#doActivity({
       type: 'Delete',
-      id: this.#formatter.format({
-        username: this.#botId,
-        type: 'delete',
-        nanoid: nanoid()
-      }),
-      actor: this.#formatter.format({ username: this.#botId }),
       object: tombstone,
       to,
       cc,
@@ -464,12 +372,6 @@ export class BotContext {
       bcc,
       audience
     })
-    await this.#objectStorage.update(tombstone)
-    await this.#objectStorage.create(activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'outbox', activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'inbox', activity)
-    await this.#distributor.distribute(activity, this.#botId)
-    return activity
   }
 
   async toActorId (webfinger) {
@@ -510,14 +412,8 @@ export class BotContext {
     const owners = obj.attributedTo
       ? Array.from(obj.attributedTo).map((owner) => owner.id)
       : Array.from(obj.actor).map((owner) => owner.id)
-    const activity = await as2.import({
+    const activity = await this.#doActivity({
       type: 'Announce',
-      id: this.#formatter.format({
-        username: this.#botId,
-        type: 'Announce',
-        nanoid: nanoid()
-      }),
-      actor: this.#formatter.format({ username: this.#botId }),
       summary: {
         en: `${this.#botId} shared "${await this.#nameOf(obj)}"`
       },
@@ -531,13 +427,32 @@ export class BotContext {
       ],
       cc: owners
     })
-    await this.#objectStorage.create(activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'outbox', activity)
-    await this.#actorStorage.addToCollection(this.#botId, 'inbox', activity)
-    await this.#distributor.distribute(activity, this.#botId)
+    await this.#actorStorage.setLastActivity(this.#botId, activity)
     return activity
   }
 
+  async unannounceObject (obj) {
+    assert.ok(obj)
+    assert.equal(typeof obj, 'object')
+    const announceActivity = await this.#actorStorage.getLastActivity(
+      this.#botId,
+      'Announce',
+      obj
+    )
+    if (!announceActivity) {
+      throw new Error(`No matching announce activity for ${obj.id}`)
+    }
+    const recipients = this.#getRecipients(announceActivity)
+    return await this.#doActivity({
+      type: 'Undo',
+      summary: {
+        en: `${this.#botId} shared "${await this.#nameOf(obj)}"`
+      },
+      object: announceActivity,
+      ...recipients
+    })
+  }
+
   async #findInOutbox (type, obj) {
     const full = `https://www.w3.org/ns/activitystreams#${type}`
     let found = null
@@ -576,6 +491,33 @@ export class BotContext {
     }
   }
 
+  async #doActivity (activityData, distribute = true) {
+    const now = new Date().toISOString()
+    const type = activityData.type || 'Activity'
+    const activity = await as2.import({
+      ...activityData,
+      type,
+      id: this.#formatter.format({
+        username: this.#botId,
+        type: type,
+        nanoid: nanoid()
+      }),
+      actor: {
+        id: this.#formatter.format({ username: this.#botId }),
+        type: 'Service'
+      },
+      published: now,
+      updated: now
+    })
+    await this.#objectStorage.create(activity)
+    await this.#actorStorage.addToCollection(this.#botId, 'outbox', activity)
+    await this.#actorStorage.addToCollection(this.#botId, 'inbox', activity)
+    if (distribute) {
+      await this.#distributor.distribute(activity, this.#botId)
+    }
+    return activity
+  }
+
   async onIdle () {
     await this.#distributor.onIdle()
   }

package/lib/migrations/002-last-activity.js

@@ -0,0 +1,15 @@
+export const id = '002-last-activity'
+
+export async function up (connection) {
+  await connection.query(`
+    CREATE TABLE lastactivity (
+      username varchar(512) NOT NULL,
+      type varchar(512) NOT NULL,
+      object_id varchar(512) NOT NULL,
+      activity_id varchar(512),
+      createdAt DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+      updatedAt DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+      PRIMARY KEY (username, type, object_id)
+    );
+  `)
+}

package/lib/migrations/index.js

@@ -1,7 +1,9 @@
 import { id as initialId, up as initialUp } from './001-initial.js'
+import { id as lastId, up as lastUp } from './002-last-activity.js'
 
 const migrations = [
-  { id: initialId, up: initialUp }
+  { id: initialId, up: initialUp },
+  { id: lastId, up: lastUp }
 ]
 
 export async function runMigrations (connection) {

package/package.json

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