@atproto/bsky 0.0.166 → 0.0.168

package/tests/views/notifications.test.ts

@@ -1,16 +1,22 @@
-import { AtpAgent } from '@atproto/api'
+import { AppBskyNotificationDeclaration, AtpAgent } from '@atproto/api'
 import { SeedClient, TestNetwork, basicSeed } from '@atproto/dev-env'
-import { Namespaces } from '../../dist/stash'
 import { delayCursor } from '../../src/api/app/bsky/notification/listNotifications'
 import { ids } from '../../src/lexicon/lexicons'
+import { ProfileView } from '../../src/lexicon/types/app/bsky/actor/defs'
 import {
+  ActivitySubscription,
   ChatPreference,
   FilterablePreference,
   Preference,
   Preferences,
 } from '../../src/lexicon/types/app/bsky/notification/defs'
+import {
+  OutputSchema,
+  QueryParams,
+} from '../../src/lexicon/types/app/bsky/notification/listActivitySubscriptions'
 import { Notification } from '../../src/lexicon/types/app/bsky/notification/listNotifications'
 import { InputSchema } from '../../src/lexicon/types/app/bsky/notification/putPreferencesV2'
+import { Namespaces } from '../../src/stash'
 import { forSnapshot, paginateAll } from '../_util'
 
 type Database = TestNetwork['bsky']['db']
@@ -20,12 +26,19 @@ describe('notification views', () => {
   let db: Database
 
   let agent: AtpAgent
+  let pdsAgent: AtpAgent
   let sc: SeedClient
 
   // account dids, for convenience
   let alice: string
+  let bob: string
   let carol: string
   let dan: string
+  let eve: string
+  let fred: string
+  let greg: string
+  let han: string
+  let blocked: string
 
   beforeAll(async () => {
     network = await TestNetwork.create({
@@ -33,6 +46,7 @@ describe('notification views', () => {
     })
     db = network.bsky.db
     agent = network.bsky.getClient()
+    pdsAgent = network.pds.getClient()
     sc = network.getSeedClient()
     await basicSeed(sc)
     await network.bsky.db.db
@@ -40,17 +54,49 @@ describe('notification views', () => {
       .set({ trustedVerifier: true })
       .where('did', '=', alice)
       .execute()
+    await sc.createAccount('eve', {
+      email: 'eve@test.com',
+      handle: 'eve.test',
+      password: 'eve-pass',
+    })
+    await sc.createAccount('fred', {
+      email: 'fred@test.com',
+      handle: 'fred.test',
+      password: 'fred-pass',
+    })
+    await sc.createAccount('greg', {
+      email: 'greg@test.com',
+      handle: 'greg.test',
+      password: 'greg-pass',
+    })
+    await sc.createAccount('han', {
+      email: 'han@test.com',
+      handle: 'han.test',
+      password: 'han-pass',
+    })
+    await sc.createAccount('blocked', {
+      email: 'blocked@test.com',
+      handle: 'blocked.test',
+      password: 'blocked-pass',
+    })
     await network.processAll()
+
     alice = sc.dids.alice
+    bob = sc.dids.bob
     carol = sc.dids.carol
     dan = sc.dids.dan
+    eve = sc.dids.eve
+    fred = sc.dids.fred
+    greg = sc.dids.greg
+    han = sc.dids.han
+    blocked = sc.dids.blocked
   })
 
   afterAll(async () => {
     await network.close()
   })
 
-  const sort = (notifs: Notification[]) => {
+  const sortNotifs = (notifs: Notification[]) => {
     // Need to sort because notification ordering is not well-defined
     return notifs.sort((a, b) => {
       const stableUriA = a.uri.replace(
@@ -170,7 +216,9 @@ describe('notification views', () => {
         ),
       },
     )
-    expect(forSnapshot(sort(notifsDan.data.notifications))).toMatchSnapshot()
+    expect(
+      forSnapshot(sortNotifs(notifsDan.data.notifications)),
+    ).toMatchSnapshot()
   })
 
   it('generates notifications for likes', async () => {
@@ -184,7 +232,7 @@ describe('notification views', () => {
       },
     )
 
-    const na = sort(
+    const na = sortNotifs(
       notifsAlice.data.notifications.filter((n) => n.reason === 'like'),
     )
     expect(na).toHaveLength(5)
@@ -202,7 +250,7 @@ describe('notification views', () => {
       },
     )
 
-    const na = sort(
+    const na = sortNotifs(
       notifsAlice.data.notifications.filter((n) => n.reason === 'repost'),
     )
     expect(na).toHaveLength(2)
@@ -228,7 +276,7 @@ describe('notification views', () => {
       },
     )
 
-    const no = sort(
+    const no = sortNotifs(
       notifsOp.data.notifications.filter((n) => n.reason === 'like'),
     )
     // Like from `alice` in this test.
@@ -245,7 +293,7 @@ describe('notification views', () => {
       },
     )
 
-    const nr = sort(
+    const nr = sortNotifs(
       notifsReposter.data.notifications.filter(
         (n) => n.reason === 'like-via-repost',
       ),
@@ -273,7 +321,7 @@ describe('notification views', () => {
       },
     )
 
-    const no = sort(
+    const no = sortNotifs(
       notifsOp.data.notifications.filter((n) => n.reason === 'like'),
     )
     // Like from `alice` in previous test + `carol` on this test.
@@ -290,7 +338,7 @@ describe('notification views', () => {
       },
     )
 
-    const nr = sort(
+    const nr = sortNotifs(
       notifsReposter.data.notifications.filter(
         (n) => n.reason === 'like-via-repost',
       ),
@@ -319,7 +367,7 @@ describe('notification views', () => {
       },
     )
 
-    const no = sort(
+    const no = sortNotifs(
       notifsOp.data.notifications.filter((n) => n.reason === 'repost'),
     )
     // Repost from `carol` in seeds + `alice` on this test.
@@ -336,7 +384,7 @@ describe('notification views', () => {
       },
     )
 
-    const nr = sort(
+    const nr = sortNotifs(
       notifsReposter.data.notifications.filter(
         (n) => n.reason === 'repost-via-repost',
       ),
@@ -363,7 +411,9 @@ describe('notification views', () => {
         ),
       },
     )
-    expect(forSnapshot(sort(notifsBob1.data.notifications))).toMatchSnapshot()
+    expect(
+      forSnapshot(sortNotifs(notifsBob1.data.notifications)),
+    ).toMatchSnapshot()
 
     await sc.unverify(sc.dids.alice, sc.dids.bob)
     await network.processAll()
@@ -376,7 +426,9 @@ describe('notification views', () => {
         ),
       },
     )
-    expect(forSnapshot(sort(notifsBob2.data.notifications))).toMatchSnapshot()
+    expect(
+      forSnapshot(sortNotifs(notifsBob2.data.notifications)),
+    ).toMatchSnapshot()
   })
 
   it('fetches notifications without a last-seen', async () => {
@@ -396,12 +448,12 @@ describe('notification views', () => {
     const readStates = notifs.map((notif) => notif.isRead)
     expect(readStates).toEqual(notifs.map((_, i) => i !== 0)) // only first appears unread
 
-    expect(forSnapshot(sort(notifs))).toMatchSnapshot()
+    expect(forSnapshot(sortNotifs(notifs))).toMatchSnapshot()
   })
 
   it('paginates', async () => {
     const results = (results) =>
-      sort(results.flatMap((res) => res.notifications))
+      sortNotifs(results.flatMap((res) => res.notifications))
     const paginator = async (cursor?: string) => {
       const res = await agent.api.app.bsky.notification.listNotifications(
         { cursor, limit: 6 },
@@ -574,7 +626,7 @@ describe('notification views', () => {
       },
     )
 
-    const notifs = sort(notifRes.data.notifications)
+    const notifs = sortNotifs(notifRes.data.notifications)
     expect(notifs.length).toBe(11)
     expect(forSnapshot(notifs)).toMatchSnapshot()
     expect(notifCount.data.count).toBe(11)
@@ -693,7 +745,7 @@ describe('notification views', () => {
 
   it('paginates filtered notifications', async () => {
     const results = (results) =>
-      sort(results.flatMap((res) => res.notifications))
+      sortNotifs(results.flatMap((res) => res.notifications))
     const paginator = async (cursor?: string) => {
       const res = await agent.app.bsky.notification.listNotifications(
         { reasons: ['mention', 'reply'], cursor, limit: 2 },
@@ -787,7 +839,7 @@ describe('notification views', () => {
       jest.setSystemTime(new Date(firstNotification.sortAt))
 
       const results = (results) =>
-        sort(results.flatMap((res) => res.notifications))
+        sortNotifs(results.flatMap((res) => res.notifications))
       const paginator = async (cursor?: string) => {
         const res =
           await delayAgent.api.app.bsky.notification.listNotifications(
@@ -1131,8 +1183,292 @@ describe('notification views', () => {
       await putAndAssert(input1, expected1)
     })
   })
+
+  describe('activity subscriptions', () => {
+    const sortProfiles = (profiles: ProfileView[]) => {
+      return profiles.sort((a, b) => (a.handle > b.handle ? 1 : -1))
+    }
+
+    const declare = async (actor: string, value: string) => {
+      await pdsAgent.com.atproto.repo.createRecord(
+        {
+          repo: actor,
+          collection: ids.AppBskyNotificationDeclaration,
+          rkey: 'self',
+          record: {
+            allowSubscriptions: value,
+          } as AppBskyNotificationDeclaration.Record,
+        },
+        { headers: sc.getHeaders(actor), encoding: 'application/json' },
+      )
+    }
+
+    const put = async (
+      actor: string,
+      subject: string,
+      val: ActivitySubscription,
+    ) =>
+      agent.app.bsky.notification.putActivitySubscription(
+        {
+          subject,
+          activitySubscription: val,
+        },
+        {
+          headers: await network.serviceHeaders(
+            actor,
+            ids.AppBskyNotificationPutActivitySubscription,
+          ),
+        },
+      )
+
+    const list = async (actor: string, params?: QueryParams) =>
+      agent.app.bsky.notification.listActivitySubscriptions(params ?? {}, {
+        headers: await network.serviceHeaders(
+          actor,
+          ids.AppBskyNotificationListActivitySubscriptions,
+        ),
+      })
+
+    const associatedAllowSub = async (actor: string, subject: string) => {
+      const { data } = await agent.app.bsky.actor.getProfile(
+        { actor: subject },
+        {
+          headers: await network.serviceHeaders(
+            actor,
+            ids.AppBskyActorGetProfile,
+          ),
+        },
+      )
+      return data.associated?.activitySubscription?.allowSubscriptions
+    }
+
+    const viewerActivitySub = async (actor: string, subject: string) => {
+      const { data } = await agent.app.bsky.actor.getProfile(
+        { actor: subject },
+        {
+          headers: await network.serviceHeaders(
+            actor,
+            ids.AppBskyActorGetProfile,
+          ),
+        },
+      )
+      return data.viewer?.activitySubscription
+    }
+
+    beforeAll(async () => {
+      // 'none' declaration.
+      await declare(bob, 'none')
+
+      // 'mutuals' declaration and both follow.
+      await declare(carol, 'mutuals')
+      await sc.follow(alice, carol)
+      await sc.follow(carol, alice)
+
+      // 'mutuals' declaration but only actor follows.
+      await declare(dan, 'mutuals')
+      await sc.follow(alice, dan)
+
+      // 'mutuals' declaration but only subject follows.
+      await declare(eve, 'mutuals')
+      await sc.follow(eve, alice)
+
+      // 'followers' declaration and viewer follows.
+      await declare(fred, 'followers')
+      await sc.follow(alice, fred)
+
+      // 'followers' declaration but viewer does not follow.
+      await declare(greg, 'followers')
+
+      // blocked.
+      await declare(blocked, 'followers')
+      await sc.block(alice, blocked)
+
+      await network.processAll()
+    })
+
+    beforeEach(async () => {
+      await clearActivitySubscription(db)
+    })
+
+    it('lists an empty list of subscriptions', async () => {
+      const actorDid = alice
+
+      const { data } = await list(actorDid)
+
+      expect(data.cursor).toBeUndefined()
+      expect(data.subscriptions).toHaveLength(0)
+    })
+
+    it('does not allow subscribing to self', async () => {
+      const actorDid = alice
+      const promise = put(actorDid, actorDid, { post: true, reply: false })
+
+      await expect(promise).rejects.toThrow('Cannot subscribe to own activity')
+    })
+
+    it('inserts a subscription entry if it does not exist', async () => {
+      const actorDid = alice
+      const subjectDid = fred
+      const val = { post: true, reply: false }
+
+      const { data: createData } = await put(actorDid, subjectDid, val)
+      expect(createData).toStrictEqual({
+        subject: subjectDid,
+        activitySubscription: val,
+      })
+
+      const { data: listData } = await list(actorDid)
+      expect(listData).toEqual({
+        cursor: expect.any(String),
+        subscriptions: [
+          expect.objectContaining({
+            did: subjectDid,
+            viewer: expect.objectContaining({ activitySubscription: val }),
+          }),
+        ],
+      })
+    })
+
+    it('updates a subscription entry if it exists', async () => {
+      const actorDid = alice
+      const subjectDid = fred
+      const valCreate = { post: true, reply: false }
+      const valUpdate = { post: false, reply: true }
+
+      const { data: createData } = await put(actorDid, subjectDid, valCreate)
+      expect(createData).toStrictEqual({
+        subject: subjectDid,
+        activitySubscription: valCreate,
+      })
+
+      const { data: updateData } = await put(actorDid, subjectDid, valUpdate)
+      expect(updateData).toStrictEqual({
+        subject: subjectDid,
+        activitySubscription: valUpdate,
+      })
+
+      const { data: listData } = await list(actorDid)
+      expect(listData).toEqual({
+        cursor: expect.any(String),
+        subscriptions: [
+          expect.objectContaining({
+            did: subjectDid,
+            viewer: expect.objectContaining({
+              activitySubscription: valUpdate,
+            }),
+          }),
+        ],
+      })
+    })
+
+    it('deletes a subscription entry when all options are turned off', async () => {
+      const actorDid = alice
+      const subjectDid = fred
+      const valCreate = { post: true, reply: false }
+      const valDelete = { post: false, reply: false }
+
+      await put(actorDid, subjectDid, valCreate)
+      const { data: list0 } = await list(actorDid)
+      expect(list0.subscriptions).toHaveLength(1)
+
+      await put(actorDid, subjectDid, valDelete)
+      const { data: list1 } = await list(actorDid)
+      expect(list1.subscriptions).toHaveLength(0)
+    })
+
+    it('paginates', async () => {
+      const actorDid = alice
+      const limit = 2
+      const val = { post: true, reply: false }
+
+      await put(actorDid, bob, val)
+      await put(actorDid, carol, val)
+      await put(actorDid, dan, val)
+      await put(actorDid, eve, val)
+      await put(actorDid, fred, val)
+      await put(actorDid, blocked, val) // blocked is removed from the list.
+
+      const results = (results: OutputSchema[]) =>
+        sortProfiles(results.flatMap((res: OutputSchema) => res.subscriptions))
+      const paginator = async (cursor?: string) => {
+        const { data } = await list(actorDid, { cursor, limit })
+        return data
+      }
+
+      const paginatedAll = await paginateAll(paginator)
+      paginatedAll.forEach((res) =>
+        expect(res.subscriptions.length).toBeLessThanOrEqual(limit),
+      )
+
+      const full = await list(actorDid)
+      expect(full.data.subscriptions.length).toEqual(5)
+      expect(results(paginatedAll)).toEqual(results([full.data]))
+    })
+
+    it('gets the declaration record', async () => {
+      const declaration = await pdsAgent.com.atproto.repo.getRecord({
+        repo: carol,
+        collection: 'app.bsky.notification.declaration',
+        rkey: 'self',
+      })
+
+      expect(declaration.data.value.allowSubscriptions).toEqual('mutuals')
+    })
+
+    describe('activity subscription declaration', () => {
+      it('includes the declaration in the profile view', async () => {
+        await expect(associatedAllowSub(alice, bob)).resolves.toBe('none')
+        await expect(associatedAllowSub(alice, carol)).resolves.toBe('mutuals')
+        await expect(associatedAllowSub(alice, dan)).resolves.toBe('mutuals')
+        await expect(associatedAllowSub(alice, eve)).resolves.toBe('mutuals')
+        await expect(associatedAllowSub(alice, fred)).resolves.toBe('followers')
+        await expect(associatedAllowSub(alice, greg)).resolves.toBe('followers')
+      })
+    })
+
+    describe('activity subscription viewer state', () => {
+      it('includes the relationship in the profile view', async () => {
+        const viewer = alice
+        const val = { post: true, reply: true }
+
+        // 'none' declaration.
+        await put(viewer, bob, val)
+        await expect(viewerActivitySub(viewer, bob)).resolves.toBeUndefined()
+
+        // 'mutuals' declaration and both follow.
+        await put(viewer, carol, val)
+        await expect(viewerActivitySub(viewer, carol)).resolves.toStrictEqual(
+          val,
+        )
+
+        // 'mutuals' declaration but only actor follows.
+        await put(viewer, dan, val)
+        await expect(viewerActivitySub(viewer, dan)).resolves.toBeUndefined()
+
+        // 'mutuals' declaration but only subject follows.
+        await put(viewer, eve, val)
+        await expect(viewerActivitySub(viewer, eve)).resolves.toBeUndefined()
+
+        // 'followers' declaration and viewer follows.
+        await put(viewer, fred, val)
+        await expect(viewerActivitySub(viewer, carol)).resolves.toStrictEqual(
+          val,
+        )
+
+        // 'followers' declaration but viewer does not follow.
+        await expect(viewerActivitySub(viewer, greg)).resolves.toBeUndefined()
+
+        // no declaration
+        await expect(viewerActivitySub(viewer, han)).resolves.toBeUndefined()
+      })
+    })
+  })
 })
 
 const clearPrivateData = async (db: Database) => {
   await db.db.deleteFrom('private_data').execute()
 }
+
+const clearActivitySubscription = async (db: Database) => {
+  await db.db.deleteFrom('activity_subscription').execute()
+}