@atproto/bsky 0.0.165 → 0.0.167

package/src/data-plane/server/routes/index.ts

@@ -2,6 +2,7 @@ import { ConnectRouter } from '@connectrpc/connect'
 import { IdResolver } from '@atproto/identity'
 import { Service } from '../../../proto/bsky_connect'
 import { Database } from '../db'
+import activitySubscription from './activity-subscription'
 import blocks from './blocks'
 import feedGens from './feed-gens'
 import feeds from './feeds'
@@ -14,7 +15,6 @@ import lists from './lists'
 import moderation from './moderation'
 import mutes from './mutes'
 import notifs from './notifs'
-import privateData from './private-data'
 import profile from './profile'
 import quotes from './quotes'
 import records from './records'
@@ -29,6 +29,7 @@ import threads from './threads'
 export default (db: Database, idResolver: IdResolver) =>
   (router: ConnectRouter) =>
     router.service(Service, {
+      ...activitySubscription(db),
       ...blocks(db),
       ...feedGens(db),
       ...feeds(db),
@@ -41,7 +42,6 @@ export default (db: Database, idResolver: IdResolver) =>
       ...moderation(db),
       ...mutes(db),
       ...notifs(db),
-      ...privateData(db),
       ...profile(db),
       ...quotes(db),
       ...records(db),

package/src/data-plane/server/routes/notifs.ts

@@ -1,7 +1,24 @@
 import { Timestamp } from '@bufbuild/protobuf'
 import { ServiceImpl } from '@connectrpc/connect'
 import { sql } from 'kysely'
+import { keyBy } from '@atproto/common'
+import { jsonStringToLex } from '@atproto/lexicon'
+import {
+  ChatPreference,
+  FilterablePreference,
+  Preference,
+  Preferences,
+} from '../../../lexicon/types/app/bsky/notification/defs'
 import { Service } from '../../../proto/bsky_connect'
+import {
+  ChatNotificationInclude,
+  ChatNotificationPreference,
+  FilterableNotificationPreference,
+  NotificationInclude,
+  NotificationPreference,
+  NotificationPreferences,
+} from '../../../proto/bsky_pb'
+import { Namespaces } from '../../../stash'
 import { Database } from '../db'
 import { IsoSortAtKey } from '../db/pagination'
 import { countAll, notSoftDeletedClause } from '../db/util'
@@ -151,4 +168,82 @@ export default (db: Database): Partial<ServiceImpl<typeof Service>> => ({
       .onConflict((oc) => oc.doNothing())
       .executeTakeFirst()
   },
+
+  async getNotificationPreferences(req) {
+    const { dids } = req
+    if (dids.length === 0) {
+      return { preferences: [] }
+    }
+
+    const res = await db.db
+      .selectFrom('private_data')
+      .selectAll()
+      .where('actorDid', 'in', dids)
+      .where('namespace', '=', Namespaces.AppBskyNotificationDefsPreferences)
+      .where('key', '=', 'self')
+      .execute()
+
+    const byDid = keyBy(res, 'actorDid')
+    const preferences = dids.map((did) => {
+      const row = byDid.get(did)
+      if (!row) {
+        return {}
+      }
+      const p = jsonStringToLex(row.payload) as Preferences
+      return notificationPreferencesLexToProtobuf(p, row.payload)
+    })
+
+    return { preferences }
+  },
 })
+
+export const notificationPreferencesLexToProtobuf = (
+  p: Preferences,
+  json: string,
+): NotificationPreferences => {
+  const lexChatPreferenceToProtobuf = (
+    p: ChatPreference,
+  ): ChatNotificationPreference =>
+    new ChatNotificationPreference({
+      include:
+        p.include === 'accepted'
+          ? ChatNotificationInclude.ACCEPTED
+          : ChatNotificationInclude.ALL,
+      push: { enabled: p.push ?? true },
+    })
+
+  const lexFilterablePreferenceToProtobuf = (
+    p: FilterablePreference,
+  ): FilterableNotificationPreference =>
+    new FilterableNotificationPreference({
+      include:
+        p.include === 'follows'
+          ? NotificationInclude.FOLLOWS
+          : NotificationInclude.ALL,
+      list: { enabled: p.list ?? true },
+      push: { enabled: p.push ?? true },
+    })
+
+  const lexPreferenceToProtobuf = (p: Preference): NotificationPreference =>
+    new NotificationPreference({
+      list: { enabled: p.list ?? true },
+      push: { enabled: p.push ?? true },
+    })
+
+  return new NotificationPreferences({
+    entry: Buffer.from(json),
+    chat: lexChatPreferenceToProtobuf(p.chat),
+    follow: lexFilterablePreferenceToProtobuf(p.follow),
+    like: lexFilterablePreferenceToProtobuf(p.like),
+    likeViaRepost: lexFilterablePreferenceToProtobuf(p.likeViaRepost),
+    mention: lexFilterablePreferenceToProtobuf(p.mention),
+    quote: lexFilterablePreferenceToProtobuf(p.quote),
+    reply: lexFilterablePreferenceToProtobuf(p.reply),
+    repost: lexFilterablePreferenceToProtobuf(p.repost),
+    repostViaRepost: lexFilterablePreferenceToProtobuf(p.repostViaRepost),
+    starterpackJoined: lexPreferenceToProtobuf(p.starterpackJoined),
+    subscribedPost: lexPreferenceToProtobuf(p.subscribedPost),
+    unverified: lexPreferenceToProtobuf(p.unverified),
+    verified: lexPreferenceToProtobuf(p.verified),
+  })
+}

package/src/data-plane/server/routes/profile.ts

@@ -1,6 +1,10 @@
 import { Timestamp } from '@bufbuild/protobuf'
 import { ServiceImpl } from '@connectrpc/connect'
 import { Selectable, sql } from 'kysely'
+import {
+  AppBskyNotificationDeclaration,
+  ChatBskyActorDeclaration,
+} from '@atproto/api'
 import { keyBy } from '@atproto/common'
 import { parseRecordBytes } from '../../../hydration/util'
 import { Service } from '../../../proto/bsky_connect'
@@ -31,6 +35,9 @@ export default (db: Database): Partial<ServiceImpl<typeof Service>> => ({
     const chatDeclarationUris = dids.map(
       (did) => `at://${did}/chat.bsky.actor.declaration/self`,
     )
+    const notifDeclarationUris = dids.map(
+      (did) => `at://${did}/app.bsky.notification.declaration/self`,
+    )
     const { ref } = db.db.dynamic
     const [
       handlesRes,
@@ -38,6 +45,7 @@ export default (db: Database): Partial<ServiceImpl<typeof Service>> => ({
       profiles,
       statuses,
       chatDeclarations,
+      notifDeclarations,
     ] = await Promise.all([
       db.db
         .selectFrom('actor')
@@ -64,6 +72,7 @@ export default (db: Database): Partial<ServiceImpl<typeof Service>> => ({
       getRecords(db)({ uris: profileUris }),
       getRecords(db)({ uris: statusUris }),
       getRecords(db)({ uris: chatDeclarationUris }),
+      getRecords(db)({ uris: notifDeclarationUris }),
     ])
 
     const verificationsBySubjectDid = verificationsReceived.reduce(
@@ -82,7 +91,7 @@ export default (db: Database): Partial<ServiceImpl<typeof Service>> => ({
 
       const status = statuses.records[i]
 
-      const chatDeclaration = parseRecordBytes(
+      const chatDeclaration = parseRecordBytes<ChatBskyActorDeclaration.Record>(
         chatDeclarations.records[i].record,
       )
 
@@ -97,6 +106,28 @@ export default (db: Database): Partial<ServiceImpl<typeof Service>> => ({
         return acc
       }, {} as VerifiedBy)
 
+      const activitySubscription = () => {
+        const record = parseRecordBytes<AppBskyNotificationDeclaration.Record>(
+          notifDeclarations.records[i].record,
+        )
+
+        // The dataplane is responsible for setting the default of "followers" (default according to the lexicon).
+        const defaultVal = 'followers'
+
+        if (typeof record?.allowSubscriptions !== 'string') {
+          return defaultVal
+        }
+
+        switch (record.allowSubscriptions) {
+          case 'followers':
+          case 'mutuals':
+          case 'none':
+            return record.allowSubscriptions
+          default:
+            return defaultVal
+        }
+      }
+
       return {
         exists: !!row,
         handle: row?.handle ?? undefined,
@@ -117,6 +148,7 @@ export default (db: Database): Partial<ServiceImpl<typeof Service>> => ({
         statusRecord: status,
         tags: [],
         profileTags: [],
+        allowActivitySubscriptionsFrom: activitySubscription(),
       }
     })
     return { actors }

package/src/data-plane/server/routes/records.ts

@@ -23,6 +23,10 @@ export default (db: Database): Partial<ServiceImpl<typeof Service>> => ({
   getPostgateRecords: getRecords(db, ids.AppBskyFeedPostgate),
   getLabelerRecords: getRecords(db, ids.AppBskyLabelerService),
   getActorChatDeclarationRecords: getRecords(db, ids.ChatBskyActorDeclaration),
+  getNotificationDeclarationRecords: getRecords(
+    db,
+    ids.AppBskyNotificationDeclaration,
+  ),
   getStarterPackRecords: getRecords(db, ids.AppBskyGraphStarterpack),
   getVerificationRecords: getRecords(db, ids.AppBskyGraphVerification),
   getStatusRecords: getRecords(db, ids.AppBskyActorStatus),

package/src/hydration/actor.ts

@@ -1,17 +1,25 @@
+import { AppBskyNotificationDeclaration } from '@atproto/api'
 import { mapDefined } from '@atproto/common'
 import { DataPlaneClient } from '../data-plane/client'
 import { Record as ProfileRecord } from '../lexicon/types/app/bsky/actor/profile'
 import { Record as StatusRecord } from '../lexicon/types/app/bsky/actor/status'
+import { Record as NotificationDeclarationRecord } from '../lexicon/types/app/bsky/notification/declaration'
 import { Record as ChatDeclarationRecord } from '../lexicon/types/chat/bsky/actor/declaration'
-import { VerificationMeta } from '../proto/bsky_pb'
+import { ActivitySubscription, VerificationMeta } from '../proto/bsky_pb'
 import {
   HydrationMap,
   RecordInfo,
+  isActivitySubscriptionEnabled,
   parseRecord,
   parseString,
   safeTakedownRef,
 } from './util'
 
+type AllowActivitySubscriptions = Extract<
+  AppBskyNotificationDeclaration.Record['allowSubscriptions'],
+  'followers' | 'mutuals' | 'none'
+>
+
 export type Actor = {
   did: string
   handle?: string
@@ -29,6 +37,7 @@ export type Actor = {
   trustedVerifier?: boolean
   verifications: VerificationHydrationState[]
   status?: RecordInfo<StatusRecord>
+  allowActivitySubscriptionsFrom: AllowActivitySubscriptions
 }
 
 export type VerificationHydrationState = {
@@ -46,6 +55,9 @@ export type Actors = HydrationMap<Actor>
 export type ChatDeclaration = RecordInfo<ChatDeclarationRecord>
 
 export type ChatDeclarations = HydrationMap<ChatDeclaration>
+export type NotificationDeclaration = RecordInfo<NotificationDeclarationRecord>
+
+export type NotificationDeclarations = HydrationMap<NotificationDeclaration>
 
 export type Status = RecordInfo<StatusRecord>
 export type Statuses = HydrationMap<Status>
@@ -59,15 +71,25 @@ export type ProfileViewerState = {
   blockingByList?: string
   following?: string
   followedBy?: string
-  knownFollowers?: {
-    count: number
-    followers: string[]
-  }
 }
 
 export type ProfileViewerStates = HydrationMap<ProfileViewerState>
 
-export type KnownFollowers = HydrationMap<ProfileViewerState['knownFollowers']>
+type ActivitySubscriptionState = {
+  post: boolean
+  reply: boolean
+}
+
+export type ActivitySubscriptionStates = HydrationMap<
+  ActivitySubscriptionState | undefined
+>
+
+type KnownFollowersState = {
+  count: number
+  followers: string[]
+}
+
+export type KnownFollowersStates = HydrationMap<KnownFollowersState | undefined>
 
 export type ProfileAgg = {
   followers: number
@@ -177,6 +199,20 @@ export class ActorHydrator {
         },
       )
 
+      const allowActivitySubscriptionsFrom = (
+        val: string,
+      ): AllowActivitySubscriptions => {
+        switch (val) {
+          case 'followers':
+          case 'mutuals':
+          case 'none':
+            return val
+          default:
+            // The dataplane should set the default of "FOLLOWERS". Just in case.
+            return 'followers'
+        }
+      }
+
       return acc.set(did, {
         did,
         handle: parseString(actor.handle),
@@ -194,6 +230,9 @@ export class ActorHydrator {
         trustedVerifier: actor.trustedVerifier,
         verifications,
         status: status,
+        allowActivitySubscriptionsFrom: allowActivitySubscriptionsFrom(
+          actor.allowActivitySubscriptionsFrom,
+        ),
       })
     }, new HydrationMap<Actor>())
   }
@@ -213,6 +252,21 @@ export class ActorHydrator {
     }, new HydrationMap<ChatDeclaration>())
   }
 
+  async getNotificationDeclarations(
+    uris: string[],
+    includeTakedowns = false,
+  ): Promise<NotificationDeclarations> {
+    if (!uris.length) return new HydrationMap<NotificationDeclaration>()
+    const res = await this.dataplane.getActorChatDeclarationRecords({ uris })
+    return uris.reduce((acc, uri, i) => {
+      const record = parseRecord<NotificationDeclarationRecord>(
+        res.records[i],
+        includeTakedowns,
+      )
+      return acc.set(uri, record ?? null)
+    }, new HydrationMap<NotificationDeclaration>())
+  }
+
   async getStatus(uris: string[], includeTakedowns = false): Promise<Statuses> {
     if (!uris.length) return new HydrationMap<Status>()
     const res = await this.dataplane.getStatusRecords({ uris })
@@ -234,10 +288,11 @@ export class ActorHydrator {
       actorDid: viewer,
       targetDids: dids,
     })
+
     return dids.reduce((acc, did, i) => {
       const rels = res.relationships[i]
       if (viewer === did) {
-        // ignore self-follows, self-mutes, self-blocks
+        // ignore self-follows, self-mutes, self-blocks, self-activity-subscriptions
         return acc.set(did, {})
       }
       return acc.set(did, {
@@ -256,8 +311,8 @@ export class ActorHydrator {
   async getKnownFollowers(
     dids: string[],
     viewer: string | null,
-  ): Promise<KnownFollowers> {
-    if (!viewer) return new HydrationMap<ProfileViewerState['knownFollowers']>()
+  ): Promise<KnownFollowersStates> {
+    if (!viewer) return new HydrationMap<KnownFollowersState | undefined>()
     const { results: knownFollowersResults } = await this.dataplane
       .getFollowsFollowing(
         {
@@ -280,7 +335,39 @@ export class ActorHydrator {
             }
           : undefined,
       )
-    }, new HydrationMap<ProfileViewerState['knownFollowers']>())
+    }, new HydrationMap<KnownFollowersState | undefined>())
+  }
+
+  async getActivitySubscriptions(
+    dids: string[],
+    viewer: string | null,
+  ): Promise<ActivitySubscriptionStates> {
+    if (!viewer) {
+      return new HydrationMap<ActivitySubscriptionState | undefined>()
+    }
+
+    const activitySubscription = (val: ActivitySubscription | undefined) => {
+      if (!val) return undefined
+
+      const result = {
+        post: !!val.post,
+        reply: !!val.reply,
+      }
+      if (!isActivitySubscriptionEnabled(result)) return undefined
+
+      return result
+    }
+
+    const { subscriptions } = await this.dataplane
+      .getActivitySubscriptionsByActorAndSubjects(
+        { actorDid: viewer, subjectDids: dids },
+        { signal: AbortSignal.timeout(100) },
+      )
+      .catch(() => ({ subscriptions: [] }))
+
+    return dids.reduce((acc, did, i) => {
+      return acc.set(did, activitySubscription(subscriptions[i]))
+    }, new HydrationMap<ActivitySubscriptionState | undefined>())
   }
 
   async getProfileAggregates(dids: string[]): Promise<ProfileAggs> {

package/src/hydration/hydrator.ts

@@ -12,9 +12,10 @@ import { Notification } from '../proto/bsky_pb'
 import { ParsedLabelers } from '../util'
 import { uriToDid, uriToDid as didFromUri } from '../util/uris'
 import {
+  ActivitySubscriptionStates,
   ActorHydrator,
   Actors,
-  KnownFollowers,
+  KnownFollowersStates,
   ProfileAggs,
   ProfileViewerState,
   ProfileViewerStates,
@@ -121,7 +122,8 @@ export type HydrationState = {
   labelers?: Labelers
   labelerViewers?: LabelerViewerStates
   labelerAggs?: LabelerAggs
-  knownFollowers?: KnownFollowers
+  knownFollowers?: KnownFollowersStates
+  activitySubscriptions?: ActivitySubscriptionStates
   bidirectionalBlocks?: BidirectionalBlocks
   verifications?: Verifications
 }
@@ -175,12 +177,12 @@ export class Hydrator {
       viewer,
     )
     const listUris: string[] = []
-    profileViewers?.forEach((item) => {
+    profileViewers.forEach((item) => {
       listUris.push(...listUrisFromProfileViewer(item))
     })
     const listState = await this.hydrateListsBasic(listUris, ctx)
     // if a list no longer exists or is not a mod list, then remove from viewer state
-    profileViewers?.forEach((item) => {
+    profileViewers.forEach((item) => {
       removeNonModListsFromProfileViewer(item, listState)
     })
 
@@ -239,8 +241,7 @@ export class Hydrator {
     dids: string[],
     ctx: HydrateCtx,
   ): Promise<HydrationState> {
-    let knownFollowers: KnownFollowers = new HydrationMap()
-
+    let knownFollowers: KnownFollowersStates = new HydrationMap()
     try {
       knownFollowers = await this.actor.getKnownFollowers(dids, ctx.viewer)
     } catch (err) {
@@ -250,6 +251,19 @@ export class Hydrator {
       )
     }
 
+    let activitySubscriptions: ActivitySubscriptionStates = new HydrationMap()
+    try {
+      activitySubscriptions = await this.actor.getActivitySubscriptions(
+        dids,
+        ctx.viewer,
+      )
+    } catch (err) {
+      hydrationLogger.error(
+        { err },
+        'Failed to get activity subscriptions state for profiles',
+      )
+    }
+
     const subjectsToKnownFollowersMap = Array.from(
       knownFollowers.keys(),
     ).reduce((acc, did) => {
@@ -281,6 +295,7 @@ export class Hydrator {
     return mergeManyStates(state, starterPackState, {
       profileAggs,
       knownFollowers,
+      activitySubscriptions,
       ctx,
       bidirectionalBlocks,
     })
@@ -1130,6 +1145,13 @@ export class Hydrator {
           uri,
         ) ?? undefined
       )
+    } else if (collection === ids.AppBskyNotificationDeclaration) {
+      if (parsed.rkey !== 'self') return
+      return (
+        (
+          await this.actor.getNotificationDeclarations([uri], includeTakedowns)
+        ).get(uri) ?? undefined
+      )
     } else if (collection === ids.AppBskyActorStatus) {
       if (parsed.rkey !== 'self') return
       return (
@@ -1348,6 +1370,10 @@ export const mergeStates = (
     labelerAggs: mergeMaps(stateA.labelerAggs, stateB.labelerAggs),
     labelerViewers: mergeMaps(stateA.labelerViewers, stateB.labelerViewers),
     knownFollowers: mergeMaps(stateA.knownFollowers, stateB.knownFollowers),
+    activitySubscriptions: mergeMaps(
+      stateA.activitySubscriptions,
+      stateB.activitySubscriptions,
+    ),
     bidirectionalBlocks: mergeNestedMaps(
       stateA.bidirectionalBlocks,
       stateB.bidirectionalBlocks,

package/src/hydration/util.ts

@@ -156,3 +156,11 @@ export const safeTakedownRef = (obj?: {
   if (obj.takedownRef) return obj.takedownRef
   if (obj.takenDown) return 'BSKY-TAKEDOWN-UNKNOWN'
 }
+
+export const isActivitySubscriptionEnabled = ({
+  post,
+  reply,
+}: {
+  post: boolean
+  reply: boolean
+}): boolean => post || reply

package/src/lexicon/lexicons.ts

@@ -4790,10 +4790,14 @@ export const schemaDict = {
             format: 'at-uri',
           },
           knownFollowers: {
+            description:
+              'This property is present only in selected cases, as an optimization.',
             type: 'ref',
             ref: 'lex:app.bsky.actor.defs#knownFollowers',
           },
           activitySubscription: {
+            description:
+              'This property is present only in selected cases, as an optimization.',
             type: 'ref',
             ref: 'lex:app.bsky.notification.defs#activitySubscription',
           },
@@ -10129,6 +10133,7 @@ export const schemaDict = {
               'unverified',
               'like-via-repost',
               'repost-via-repost',
+              'subscribed-post',
             ],
           },
           reasonSubject: {

package/src/lexicon/types/app/bsky/notification/listNotifications.ts

@@ -80,6 +80,7 @@ export interface Notification {
     | 'unverified'
     | 'like-via-repost'
     | 'repost-via-repost'
+    | 'subscribed-post'
     | (string & {})
   reasonSubject?: string
   record: { [_ in string]: unknown }

package/src/proto/bsky_connect.ts

@@ -22,6 +22,10 @@ import {
   DeleteActorMuteResponse,
   DeleteThreadMuteRequest,
   DeleteThreadMuteResponse,
+  GetActivitySubscriptionDidsRequest,
+  GetActivitySubscriptionDidsResponse,
+  GetActivitySubscriptionsByActorAndSubjectsRequest,
+  GetActivitySubscriptionsByActorAndSubjectsResponse,
   GetActorChatDeclarationRecordsRequest,
   GetActorChatDeclarationRecordsResponse,
   GetActorFeedsRequest,
@@ -126,6 +130,8 @@ import {
   GetMutesResponse,
   GetNewUserCountForRangeRequest,
   GetNewUserCountForRangeResponse,
+  GetNotificationDeclarationRecordsRequest,
+  GetNotificationDeclarationRecordsResponse,
   GetNotificationPreferencesRequest,
   GetNotificationPreferencesResponse,
   GetNotificationSeenRequest,
@@ -307,6 +313,15 @@ export const Service = {
       O: GetActorChatDeclarationRecordsResponse,
       kind: MethodKind.Unary,
     },
+    /**
+     * @generated from rpc bsky.Service.GetNotificationDeclarationRecords
+     */
+    getNotificationDeclarationRecords: {
+      name: 'GetNotificationDeclarationRecords',
+      I: GetNotificationDeclarationRecordsRequest,
+      O: GetNotificationDeclarationRecordsResponse,
+      kind: MethodKind.Unary,
+    },
     /**
      * @generated from rpc bsky.Service.GetStatusRecords
      */
@@ -769,6 +784,24 @@ export const Service = {
       O: GetUnreadNotificationCountResponse,
       kind: MethodKind.Unary,
     },
+    /**
+     * @generated from rpc bsky.Service.GetActivitySubscriptionDids
+     */
+    getActivitySubscriptionDids: {
+      name: 'GetActivitySubscriptionDids',
+      I: GetActivitySubscriptionDidsRequest,
+      O: GetActivitySubscriptionDidsResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * @generated from rpc bsky.Service.GetActivitySubscriptionsByActorAndSubjects
+     */
+    getActivitySubscriptionsByActorAndSubjects: {
+      name: 'GetActivitySubscriptionsByActorAndSubjects',
+      I: GetActivitySubscriptionsByActorAndSubjectsRequest,
+      O: GetActivitySubscriptionsByActorAndSubjectsResponse,
+      kind: MethodKind.Unary,
+    },
     /**
      * @generated from rpc bsky.Service.UpdateNotificationSeen
      */