Modlist updates: add "blockingByList" information and some utility fu…

…nctions to the sdk (#1779) * Add blockingByList to app.bsky.actor.defs#viewerState * Add blocking-by-list behaviors to moderation sdk * Add modlist helper functions to bsky-agent * codegen * hydrate blockingByList in profile viewer state * ignore self-mutes and self-blocks in read path * format * changeset --------- Co-authored-by: Devin Ivy <[email protected]>
bluesky-social · Oct 27, 2023 · 9c98a5b · 9c98a5b
1 parent 35d108c
commit 9c98a5b
Show file tree

Hide file tree

Showing 25 changed files with 303 additions and 23 deletions.
diff --git a/.changeset/giant-humans-argue.md b/.changeset/giant-humans-argue.md
@@ -0,0 +1,5 @@
+---
+'@atproto/api': patch
+---
+
+modlist helpers added to bsky-agent, add blockingByList to viewer state lexicon
diff --git a/lexicons/app/bsky/actor/defs.json b/lexicons/app/bsky/actor/defs.json
@@ -86,6 +86,10 @@
         },
         "blockedBy": { "type": "boolean" },
         "blocking": { "type": "string", "format": "at-uri" },
+        "blockingByList": {
+          "type": "ref",
+          "ref": "app.bsky.graph.defs#listViewBasic"
+        },
         "following": { "type": "string", "format": "at-uri" },
         "followedBy": { "type": "string", "format": "at-uri" }
       }

diff --git a/packages/api/README.md b/packages/api/README.md
@@ -91,6 +91,10 @@ await agent.searchActors(params, opts)
 await agent.searchActorsTypeahead(params, opts)
 await agent.mute(did)
 await agent.unmute(did)
+await agent.muteModList(listUri)
+await agent.unmuteModList(listUri)
+await agent.blockModList(listUri)
+await agent.unblockModList(listUri)
 
 // Notifications
 await agent.listNotifications(params, opts)

diff --git a/packages/api/definitions/moderation-behaviors.d.ts b/packages/api/definitions/moderation-behaviors.d.ts
@@ -32,6 +32,7 @@ export interface ModerationBehaviors {
     string,
     {
       blocking: boolean
+      blockingByList: boolean
       blockedBy: boolean
       muted: boolean
       mutedByList: boolean

diff --git a/packages/api/definitions/profile-moderation-behaviors.json b/packages/api/definitions/profile-moderation-behaviors.json
@@ -2,45 +2,59 @@
   "users": {
     "self": {
       "blocking": false,
+      "blockingByList": false,
       "blockedBy": false,
       "muted": false,
       "mutedByList": false
     },
     "alice": {
       "blocking": false,
+      "blockingByList": false,
       "blockedBy": false,
       "muted": false,
       "mutedByList": false
     },
     "bob": {
       "blocking": true,
+      "blockingByList": false,
       "blockedBy": false,
       "muted": false,
       "mutedByList": false
     },
     "carla": {
       "blocking": false,
+      "blockingByList": false,
       "blockedBy": true,
       "muted": false,
       "mutedByList": false
     },
     "dan": {
       "blocking": false,
+      "blockingByList": false,
       "blockedBy": false,
       "muted": true,
       "mutedByList": false
     },
     "elise": {
       "blocking": false,
+      "blockingByList": false,
       "blockedBy": false,
       "muted": false,
       "mutedByList": true
     },
     "fern": {
       "blocking": true,
+      "blockingByList": false,
       "blockedBy": true,
       "muted": false,
       "mutedByList": false
+    },
+    "georgia": {
+      "blocking": false,
+      "blockingByList": true,
+      "blockedBy": false,
+      "muted": false,
+      "mutedByList": false
     }
   },
   "configurations": {
@@ -377,6 +391,17 @@
       }
     },
 
+    "Mute/block: Blocking-by-list user": {
+      "cfg": "none",
+      "subject": "profile",
+      "author": "georgia",
+      "labels": {},
+      "behaviors": {
+        "account": { "cause": "blocking-by-list", "filter": true },
+        "avatar": { "blur": true, "noOverride": true }
+      }
+    },
+
     "Mute/block: Blocked by user": {
       "cfg": "none",
       "subject": "profile",

diff --git a/packages/api/docs/moderation-behaviors/profiles.md b/packages/api/docs/moderation-behaviors/profiles.md
@@ -547,6 +547,23 @@ Key:
 </td>
 </tr>
 
+<tr>
+<td><strong>Mute/block: Blocking-by-list user</strong></td>
+<td>
+❌
+</td>
+<td>
+
+</td>
+<td>
+
+</td>
+<td>
+🚫
+
+</td>
+</tr>
+
 <tr>
 <td><strong>Mute/block: Blocked by user</strong></td>
 <td>

diff --git a/packages/api/src/bsky-agent.ts b/packages/api/src/bsky-agent.ts
@@ -258,6 +258,49 @@ export class BskyAgent extends AtpAgent {
     return this.api.app.bsky.graph.unmuteActor({ actor })
   }
 
+  async muteModList(uri: string) {
+    return this.api.app.bsky.graph.muteActorList({
+      list: uri,
+    })
+  }
+
+  async unmuteModList(uri: string) {
+    return this.api.app.bsky.graph.unmuteActorList({
+      list: uri,
+    })
+  }
+
+  async blockModList(uri: string) {
+    if (!this.session) {
+      throw new Error('Not logged in')
+    }
+    return await this.api.app.bsky.graph.listblock.create(
+      { repo: this.session.did },
+      {
+        subject: uri,
+        createdAt: new Date().toISOString(),
+      },
+    )
+  }
+
+  async unblockModList(uri: string) {
+    if (!this.session) {
+      throw new Error('Not logged in')
+    }
+    const listInfo = await this.api.app.bsky.graph.getList({
+      list: uri,
+      limit: 1,
+    })
+    if (!listInfo.data.list.viewer?.blocked) {
+      return
+    }
+    const { rkey } = new AtUri(listInfo.data.list.viewer.blocked)
+    return await this.api.app.bsky.graph.listblock.delete({
+      repo: this.session.did,
+      rkey,
+    })
+  }
+
   async updateSeenNotifications(seenAt?: string) {
     seenAt = seenAt || new Date().toISOString()
     return this.api.app.bsky.notification.updateSeen({

diff --git a/packages/api/src/client/lexicons.ts b/packages/api/src/client/lexicons.ts
@@ -3827,6 +3827,10 @@ export const schemaDict = {
             type: 'string',
             format: 'at-uri',
           },
+          blockingByList: {
+            type: 'ref',
+            ref: 'lex:app.bsky.graph.defs#listViewBasic',
+          },
           following: {
             type: 'string',
             format: 'at-uri',

diff --git a/packages/api/src/client/types/app/bsky/actor/defs.ts b/packages/api/src/client/types/app/bsky/actor/defs.ts
@@ -87,6 +87,7 @@ export interface ViewerState {
   mutedByList?: AppBskyGraphDefs.ListViewBasic
   blockedBy?: boolean
   blocking?: string
+  blockingByList?: AppBskyGraphDefs.ListViewBasic
   following?: string
   followedBy?: string
   [k: string]: unknown

diff --git a/packages/api/src/moderation/accumulator.ts b/packages/api/src/moderation/accumulator.ts
@@ -1,4 +1,5 @@
 import { AppBskyGraphDefs } from '../client/index'
+import { AtUri } from '@atproto/syntax'
 import {
   Label,
   LabelPreference,
@@ -28,6 +29,18 @@ export class ModerationCauseAccumulator {
     }
   }
 
+  addBlockingByList(
+    blockingByList: AppBskyGraphDefs.ListViewBasic | undefined,
+  ) {
+    if (blockingByList) {
+      this.causes.push({
+        type: 'blocking',
+        source: { type: 'list', list: blockingByList },
+        priority: 3,
+      })
+    }
+  }
+
   addBlockedBy(blockedBy: boolean | undefined) {
     if (blockedBy) {
       this.causes.push({

diff --git a/packages/api/src/moderation/subjects/account.ts b/packages/api/src/moderation/subjects/account.ts
@@ -20,7 +20,13 @@ export function decideAccount(
       acc.addMuted(subject.viewer?.muted)
     }
   }
-  acc.addBlocking(subject.viewer?.blocking)
+  if (subject.viewer?.blocking) {
+    if (subject.viewer?.blockingByList) {
+      acc.addBlockingByList(subject.viewer?.blockingByList)
+    } else {
+      acc.addBlocking(subject.viewer?.blocking)
+    }
+  }
   acc.addBlockedBy(subject.viewer?.blockedBy)
 
   for (const label of filterAccountLabels(subject.labels)) {

diff --git a/packages/api/tests/util/index.ts b/packages/api/tests/util/index.ts
@@ -135,13 +135,15 @@ export const mock = {
     mutedByList,
     blockedBy,
     blocking,
+    blockingByList,
     following,
     followedBy,
   }: {
     muted?: boolean
     mutedByList?: AppBskyGraphDefs.ListViewBasic
     blockedBy?: boolean
     blocking?: string
+    blockingByList?: AppBskyGraphDefs.ListViewBasic
     following?: string
     followedBy?: string
   }): AppBskyActorDefs.ViewerState {
@@ -150,6 +152,7 @@ export const mock = {
       mutedByList,
       blockedBy,
       blocking,
+      blockingByList,
       following,
       followedBy,
     }

diff --git a/packages/api/tests/util/moderation-behavior.ts b/packages/api/tests/util/moderation-behavior.ts
@@ -25,6 +25,10 @@ expect.extend({
       if (actual.cause.source.type === 'list') {
         cause = 'muted-by-list'
       }
+    } else if (actual.cause?.type === 'blocking') {
+      if (actual.cause.source.type === 'list') {
+        cause = 'blocking-by-list'
+      }
     }
     if (!expected) {
       if (!ignoreCause && actual.cause) {
@@ -153,8 +157,12 @@ export class ModerationBehaviorSuiteRunner {
           ? m.listViewBasic({ name: 'Fake List' })
           : undefined,
         blockedBy: def.blockedBy,
-        blocking: def.blocking
-          ? 'at://did:web:self.test/app.bsky.graph.block/fake'
+        blocking:
+          def.blocking || def.blockingByList
+            ? 'at://did:web:self.test/app.bsky.graph.block/fake'
+            : undefined,
+        blockingByList: def.blockingByList
+          ? m.listViewBasic({ name: 'Fake List' })
           : undefined,
       }),
     })

diff --git a/packages/bsky/src/lexicon/lexicons.ts b/packages/bsky/src/lexicon/lexicons.ts
@@ -3827,6 +3827,10 @@ export const schemaDict = {
             type: 'string',
             format: 'at-uri',
           },
+          blockingByList: {
+            type: 'ref',
+            ref: 'lex:app.bsky.graph.defs#listViewBasic',
+          },
           following: {
             type: 'string',
             format: 'at-uri',

diff --git a/packages/bsky/src/lexicon/types/app/bsky/actor/defs.ts b/packages/bsky/src/lexicon/types/app/bsky/actor/defs.ts
@@ -87,6 +87,7 @@ export interface ViewerState {
   mutedByList?: AppBskyGraphDefs.ListViewBasic
   blockedBy?: boolean
   blocking?: string
+  blockingByList?: AppBskyGraphDefs.ListViewBasic
   following?: string
   followedBy?: string
   [k: string]: unknown

diff --git a/packages/bsky/src/services/actor/types.ts b/packages/bsky/src/services/actor/types.ts
@@ -16,6 +16,7 @@ export type ActorInfo = {
     mutedByList?: ListViewBasic
     blockedBy?: boolean
     blocking?: string
+    blockingByList?: ListViewBasic
     following?: string
     followedBy?: string
   }

diff --git a/packages/bsky/src/services/actor/views.ts b/packages/bsky/src/services/actor/views.ts
@@ -137,10 +137,13 @@ export class ActorViews {
       ),
     ])
     const listUris = mapDefined(profiles, ({ did }) => {
-      const list = viewer && bam.muteList([viewer, did])
-      if (!list) return
-      return list
-    })
+      const muteList = viewer && bam.muteList([viewer, did])
+      const blockList = viewer && bam.blockList([viewer, did])
+      const lists: string[] = []
+      if (muteList) lists.push(muteList)
+      if (blockList) lists.push(blockList)
+      return lists
+    }).flat()
     const lists = await this.services.graph.getListViews(listUris, viewer)
     return { profilesDetailed: toMapByDid(profiles), labels, bam, lists }
   }
@@ -168,6 +171,11 @@ export class ActorViews {
         mutedByListUri && lists[mutedByListUri]
           ? this.services.graph.formatListViewBasic(lists[mutedByListUri])
           : undefined
+      const blockingByListUri = viewer && bam.blockList([viewer, did])
+      const blockingByList =
+        blockingByListUri && lists[blockingByListUri]
+          ? this.services.graph.formatListViewBasic(lists[blockingByListUri])
+          : undefined
       const actorLabels = labels[did] ?? []
       const selfLabels = getSelfLabels({
         uri: prof.profileUri,
@@ -194,6 +202,7 @@ export class ActorViews {
               mutedByList,
               blockedBy: !!bam.blockedBy([viewer, did]),
               blocking: bam.blocking([viewer, did]) ?? undefined,
+              blockingByList,
               following:
                 prof?.viewerFollowing && !bam.block([viewer, did])
                   ? prof.viewerFollowing
@@ -265,10 +274,13 @@ export class ActorViews {
       ),
     ])
     const listUris = mapDefined(profiles, ({ did }) => {
-      const list = viewer && bam.muteList([viewer, did])
-      if (!list) return
-      return list
-    })
+      const muteList = viewer && bam.muteList([viewer, did])
+      const blockList = viewer && bam.blockList([viewer, did])
+      const lists: string[] = []
+      if (muteList) lists.push(muteList)
+      if (blockList) lists.push(blockList)
+      return lists
+    }).flat()
     const lists = await this.services.graph.getListViews(listUris, viewer)
     return { profiles: toMapByDid(profiles), labels, bam, lists }
   }
@@ -298,6 +310,11 @@ export class ActorViews {
         mutedByListUri && lists[mutedByListUri]
           ? this.services.graph.formatListViewBasic(lists[mutedByListUri])
           : undefined
+      const blockingByListUri = viewer && bam.blockList([viewer, did])
+      const blockingByList =
+        blockingByListUri && lists[blockingByListUri]
+          ? this.services.graph.formatListViewBasic(lists[blockingByListUri])
+          : undefined
       const actorLabels = labels[did] ?? []
       const selfLabels = getSelfLabels({
         uri: prof.profileUri,
@@ -320,6 +337,7 @@ export class ActorViews {
               mutedByList,
               blockedBy: !!bam.blockedBy([viewer, did]),
               blocking: bam.blocking([viewer, did]) ?? undefined,
+              blockingByList,
               following:
                 prof?.viewerFollowing && !bam.block([viewer, did])
                   ? prof.viewerFollowing
-Original file line number
+Diff line change
@@ Expand Up / @@ -547,6 +547,23 @@ Key: @@
     </td>
     </tr>
+    <tr>
+    <td><strong>Mute/block: Blocking-by-list user</strong></td>
+    <td>
+    ❌
+    </td>
+    <td>
+    </td>
+    <td>
+    </td>
+    <td>
+    🚫
+    </td>
+    </tr>
     <tr>
     <td><strong>Mute/block: Blocked by user</strong></td>
     <td>
@@ Expand Down @@