@atproto/bsky 0.0.191 → 0.0.193

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/bsky",
-  "version": "0.0.191",
+  "version": "0.0.193",
   "license": "MIT",
   "description": "Reference implementation of app.bsky App View (Bluesky API)",
   "keywords": [
@@ -52,8 +52,8 @@
     "undici": "^6.19.8",
     "zod": "3.23.8",
     "@atproto-labs/fetch-node": "0.2.0",
-    "@atproto/api": "^0.17.4",
     "@atproto-labs/xrpc-utils": "0.0.22",
+    "@atproto/api": "^0.17.6",
     "@atproto/common": "^0.4.12",
     "@atproto/crypto": "^0.4.4",
     "@atproto/did": "^0.2.1",
@@ -77,9 +77,9 @@
     "jest": "^28.1.2",
     "ts-node": "^10.8.2",
     "typescript": "^5.6.3",
-    "@atproto/api": "^0.17.4",
+    "@atproto/api": "^0.17.6",
     "@atproto/lex-cli": "^0.9.6",
-    "@atproto/pds": "^0.4.187",
+    "@atproto/pds": "^0.4.190",
     "@atproto/xrpc": "^0.7.5"
   },
   "scripts": {

package/src/config.ts

@@ -84,6 +84,7 @@ export interface ServerConfigValues {
   proxyMaxRetries?: number
   proxyPreferCompressed?: boolean
   kws?: KwsConfig
+  debugFieldAllowedDids: Set<string>
 }
 
 export class ServerConfig {
@@ -276,6 +277,10 @@ export class ServerConfig {
       }
     }
 
+    const debugFieldAllowedDids = new Set(
+      envList(process.env.BSKY_DEBUG_FIELD_ALLOWED_DIDS),
+    )
+
     return new ServerConfig({
       version,
       debugMode,
@@ -334,6 +339,7 @@ export class ServerConfig {
       proxyMaxRetries,
       proxyPreferCompressed,
       kws,
+      debugFieldAllowedDids,
       ...stripUndefineds(overrides ?? {}),
     })
   }
@@ -572,6 +578,10 @@ export class ServerConfig {
   get kws() {
     return this.cfg.kws
   }
+
+  get debugFieldAllowedDids() {
+    return this.cfg.debugFieldAllowedDids
+  }
 }
 
 function stripUndefineds(

package/src/hydration/actor.ts

@@ -38,6 +38,15 @@ export type Actor = {
   verifications: VerificationHydrationState[]
   status?: RecordInfo<StatusRecord>
   allowActivitySubscriptionsFrom: AllowActivitySubscriptions
+  /**
+   * Debug information for internal development
+   */
+  debug?: {
+    pagerank?: number
+    accountTags?: string[]
+    profileTags?: string[]
+    [key: string]: unknown
+  }
 }
 
 export type VerificationHydrationState = {
@@ -213,6 +222,12 @@ export class ActorHydrator {
         }
       }
 
+      const debug = {
+        pagerank: actor.pagerank,
+        accountTags: actor.tags,
+        profileTags: actor.profileTags,
+      }
+
       return acc.set(did, {
         did,
         handle: parseString(actor.handle),
@@ -233,6 +248,7 @@ export class ActorHydrator {
         allowActivitySubscriptionsFrom: allowActivitySubscriptionsFrom(
           actor.allowActivitySubscriptionsFrom,
         ),
+        debug,
       })
     }, new HydrationMap<Actor>())
   }

package/src/hydration/feed.ts

@@ -26,6 +26,13 @@ export type Post = RecordInfo<PostRecord> & {
   hasThreadGate: boolean
   hasPostGate: boolean
   tags: Set<string>
+  /**
+   * Debug information for internal development
+   */
+  debug?: {
+    tags?: string[]
+    [key: string]: unknown
+  }
 }
 export type Posts = HydrationMap<Post>
 
@@ -117,6 +124,7 @@ export class FeedHydrator {
       const hasThreadGate = res.meta[i].hasThreadGate
       const hasPostGate = res.meta[i].hasPostGate
       const tags = new Set<string>(res.records[i].tags ?? [])
+      const debug = { tags: Array.from(tags) }
       return acc.set(
         uri,
         record
@@ -127,6 +135,7 @@ export class FeedHydrator {
               hasThreadGate,
               hasPostGate,
               tags,
+              debug,
             }
           : null,
       )

package/src/hydration/hydrator.ts

@@ -80,6 +80,7 @@ export class HydrateCtx {
   includeTakedowns = this.vals.includeTakedowns
   includeActorTakedowns = this.vals.includeActorTakedowns
   include3pBlocks = this.vals.include3pBlocks
+  includeDebugField = this.vals.includeDebugField
   constructor(private vals: HydrateCtxVals) {}
   // Convenience with use with dataplane.getActors cache control
   get skipCacheForViewer() {
@@ -97,6 +98,7 @@ export type HydrateCtxVals = {
   includeTakedowns?: boolean
   includeActorTakedowns?: boolean
   include3pBlocks?: boolean
+  includeDebugField?: boolean
 }
 
 export type HydrationState = {
@@ -156,17 +158,28 @@ export type BidirectionalBlocks = HydrationMap<HydrationMap<boolean>>
 // actor DID -> stash key -> bookmark
 export type Bookmarks = HydrationMap<HydrationMap<Bookmark>>
 
+/**
+ * Additional config passed from `ServerConfig` to the `Hydrator` instance.
+ * Values within this config object may be passed to other sub-hydrators.
+ */
+export type HydratorConfig = {
+  debugFieldAllowedDids: Set<string>
+}
+
 export class Hydrator {
   actor: ActorHydrator
   feed: FeedHydrator
   graph: GraphHydrator
   label: LabelHydrator
   serviceLabelers: Set<string>
+  config: HydratorConfig
 
   constructor(
     public dataplane: DataPlaneClient,
     serviceLabelers: string[] = [],
+    config: HydratorConfig,
   ) {
+    this.config = config
     this.actor = new ActorHydrator(dataplane)
     this.feed = new FeedHydrator(dataplane)
     this.graph = new GraphHydrator(dataplane)
@@ -1283,11 +1296,14 @@ export class Hydrator {
       dids: availableDids,
       redact: vals.labelers.redact,
     }
+    const includeDebugField =
+      !!vals.viewer && this.config.debugFieldAllowedDids.has(vals.viewer)
     return new HydrateCtx({
       labelers: availableLabelers,
       viewer: vals.viewer,
       includeTakedowns: vals.includeTakedowns,
       include3pBlocks: vals.include3pBlocks,
+      includeDebugField,
     })
   }
 

package/src/index.ts

@@ -123,7 +123,9 @@ export class BskyAppView {
       httpVersion: config.dataplaneHttpVersion,
       rejectUnauthorized: !config.dataplaneIgnoreBadTls,
     })
-    const hydrator = new Hydrator(dataplane, config.labelsFromIssuerDids)
+    const hydrator = new Hydrator(dataplane, config.labelsFromIssuerDids, {
+      debugFieldAllowedDids: config.debugFieldAllowedDids,
+    })
     const views = new Views({
       imgUriBuilder: imgUriBuilder,
       videoUriBuilder: videoUriBuilder,

package/src/lexicon/lexicons.ts

@@ -65,6 +65,10 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:app.bsky.actor.defs#statusView',
           },
+          debug: {
+            type: 'unknown',
+            description: 'Debug information for internal development',
+          },
         },
       },
       profileView: {
@@ -127,6 +131,10 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:app.bsky.actor.defs#statusView',
           },
+          debug: {
+            type: 'unknown',
+            description: 'Debug information for internal development',
+          },
         },
       },
       profileViewDetailed: {
@@ -214,6 +222,10 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:app.bsky.actor.defs#statusView',
           },
+          debug: {
+            type: 'unknown',
+            description: 'Debug information for internal development',
+          },
         },
       },
       profileAssociated: {
@@ -1846,6 +1858,10 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:app.bsky.feed.defs#threadgateView',
           },
+          debug: {
+            type: 'unknown',
+            description: 'Debug information for internal development',
+          },
         },
       },
       viewerState: {

package/src/lexicon/types/app/bsky/actor/defs.ts

@@ -34,6 +34,8 @@ export interface ProfileViewBasic {
   createdAt?: string
   verification?: VerificationState
   status?: StatusView
+  /** Debug information for internal development */
+  debug?: { [_ in string]: unknown }
 }
 
 const hashProfileViewBasic = 'profileViewBasic'
@@ -61,6 +63,8 @@ export interface ProfileView {
   labels?: ComAtprotoLabelDefs.Label[]
   verification?: VerificationState
   status?: StatusView
+  /** Debug information for internal development */
+  debug?: { [_ in string]: unknown }
 }
 
 const hashProfileView = 'profileView'
@@ -95,6 +99,8 @@ export interface ProfileViewDetailed {
   pinnedPost?: ComAtprotoRepoStrongRef.Main
   verification?: VerificationState
   status?: StatusView
+  /** Debug information for internal development */
+  debug?: { [_ in string]: unknown }
 }
 
 const hashProfileViewDetailed = 'profileViewDetailed'

package/src/lexicon/types/app/bsky/feed/defs.ts

@@ -45,6 +45,8 @@ export interface PostView {
   viewer?: ViewerState
   labels?: ComAtprotoLabelDefs.Label[]
   threadgate?: ThreadgateView
+  /** Debug information for internal development */
+  debug?: { [_ in string]: unknown }
 }
 
 const hashPostView = 'postView'

package/src/views/index.ts

@@ -367,6 +367,7 @@ export class Views {
       createdAt: actor.createdAt?.toISOString(),
       verification: this.verification(did, state),
       status: this.status(did, state),
+      debug: state.ctx?.includeDebugField ? actor.debug : undefined,
     }
   }
 
@@ -945,6 +946,9 @@ export class Views {
       threadgate: !post.record.reply // only hydrate gate on root post
         ? this.threadgate(threadgateUri, state)
         : undefined,
+      debug: state.ctx?.includeDebugField
+        ? { post: post.debug, author: author.debug }
+        : undefined,
     }
   }
 

package/tests/views/posts-debug.test.ts

@@ -0,0 +1,74 @@
+import { AtpAgent } from '@atproto/api'
+import { SeedClient, TestNetwork, basicSeed } from '@atproto/dev-env'
+import { ids } from '../../src/lexicon/lexicons'
+
+describe('post views w/ debug field', () => {
+  let network: TestNetwork
+  let agent: AtpAgent
+  let sc: SeedClient
+
+  beforeAll(async () => {
+    network = await TestNetwork.create({
+      dbPostgresSchema: 'bsky_views_posts_debug',
+    })
+    agent = network.bsky.getClient()
+    sc = network.getSeedClient()
+    await basicSeed(sc)
+    await network.processAll()
+  })
+
+  afterEach(() => {
+    network.bsky.ctx.cfg.debugFieldAllowedDids.clear()
+  })
+
+  afterAll(async () => {
+    await network.close()
+  })
+
+  it(`does not include debug field for unauthed requests`, async () => {
+    network.bsky.ctx.cfg.debugFieldAllowedDids.add(sc.dids.bob)
+
+    const uris = [sc.posts[sc.dids.alice][0].ref.uriStr]
+    const posts = await agent.api.app.bsky.feed.getPosts({ uris })
+
+    const post = posts.data.posts.at(0)
+    expect(post?.debug).not.toBeDefined()
+  })
+
+  it(`includes debug field for configured user`, async () => {
+    network.bsky.ctx.cfg.debugFieldAllowedDids.add(sc.dids.bob)
+
+    const uris = [sc.posts[sc.dids.alice][0].ref.uriStr]
+    const posts = await agent.api.app.bsky.feed.getPosts(
+      { uris },
+      {
+        headers: await network.serviceHeaders(
+          sc.dids.bob,
+          ids.AppBskyFeedGetPosts,
+        ),
+      },
+    )
+
+    const post = posts.data.posts.at(0)
+    expect(post?.debug).toBeDefined()
+    expect(typeof post?.debug).toBe('object')
+  })
+
+  it(`doesn't include debug field for other users`, async () => {
+    network.bsky.ctx.cfg.debugFieldAllowedDids.add(sc.dids.carol)
+
+    const uris = [sc.posts[sc.dids.alice][0].ref.uriStr]
+    const posts = await agent.api.app.bsky.feed.getPosts(
+      { uris },
+      {
+        headers: await network.serviceHeaders(
+          sc.dids.bob,
+          ids.AppBskyFeedGetPosts,
+        ),
+      },
+    )
+
+    const post = posts.data.posts.at(0)
+    expect(post?.debug).not.toBeDefined()
+  })
+})

package/tests/views/profile-debug.test.ts

@@ -0,0 +1,69 @@
+import { AtpAgent } from '@atproto/api'
+import { SeedClient, TestNetwork, basicSeed } from '@atproto/dev-env'
+import { ids } from '../../src/lexicon/lexicons'
+
+describe('profile views w/ debug field', () => {
+  let network: TestNetwork
+  let agent: AtpAgent
+  let sc: SeedClient
+
+  beforeAll(async () => {
+    network = await TestNetwork.create({
+      dbPostgresSchema: 'bsky_views_profile_debug',
+    })
+    agent = network.bsky.getClient()
+    sc = network.getSeedClient()
+    await basicSeed(sc)
+  })
+
+  afterEach(() => {
+    network.bsky.ctx.cfg.debugFieldAllowedDids.clear()
+  })
+
+  afterAll(async () => {
+    await network.close()
+  })
+
+  it(`does not include debug field for unauthed requests`, async () => {
+    network.bsky.ctx.cfg.debugFieldAllowedDids.add(sc.dids.bob)
+
+    const { data: profile } = await agent.api.app.bsky.actor.getProfile({
+      actor: sc.dids.alice,
+    })
+
+    expect(profile.debug).not.toBeDefined()
+  })
+
+  it(`includes debug field for configured user`, async () => {
+    network.bsky.ctx.cfg.debugFieldAllowedDids.add(sc.dids.bob)
+
+    const { data: profile } = await agent.api.app.bsky.actor.getProfile(
+      { actor: sc.dids.alice },
+      {
+        headers: await network.serviceHeaders(
+          sc.dids.bob,
+          ids.AppBskyActorGetProfile,
+        ),
+      },
+    )
+
+    expect(profile.debug).toBeDefined()
+    expect(typeof profile.debug).toBe('object')
+  })
+
+  it(`doesn't include debug field for other users`, async () => {
+    network.bsky.ctx.cfg.debugFieldAllowedDids.add(sc.dids.carol)
+
+    const { data: profile } = await agent.api.app.bsky.actor.getProfile(
+      { actor: sc.dids.alice },
+      {
+        headers: await network.serviceHeaders(
+          sc.dids.bob,
+          ids.AppBskyActorGetProfile,
+        ),
+      },
+    )
+
+    expect(profile.debug).not.toBeDefined()
+  })
+})

package/tsconfig.tests.tsbuildinfo

@@ -1 +1 @@
-{"root":["./tests/_util.ts","./tests/auth.test.ts","./tests/blob-resolver.test.ts","./tests/entryway-auth.test.ts","./tests/etcd.test.ts","./tests/feed-generation.test.ts","./tests/label-hydration.test.ts","./tests/postgates.test.ts","./tests/query-labels.test.ts","./tests/redis-cache.test.ts","./tests/server.test.ts","./tests/stash.test.ts","./tests/admin/admin-auth.test.ts","./tests/admin/moderation.test.ts","./tests/data-plane/db.test.ts","./tests/data-plane/duplicate-records.test.ts","./tests/data-plane/handle-invalidation.test.ts","./tests/data-plane/indexing.test.ts","./tests/data-plane/subscription.test.ts","./tests/data-plane/thread-mutes.test.ts","./tests/hydration/util.test.ts","./tests/image/server.test.ts","./tests/image/sharp.test.ts","./tests/image/uri.test.ts","./tests/seed/feed-hidden-replies.ts","./tests/seed/get-suggested-starter-packs.ts","./tests/seed/get-trends.ts","./tests/seed/known-followers.ts","./tests/seed/postgates.ts","./tests/views/account-deactivation.test.ts","./tests/views/actor-likes.test.ts","./tests/views/actor-search.test.ts","./tests/views/age-assurance.test.ts","./tests/views/author-feed.test.ts","./tests/views/block-lists.test.ts","./tests/views/blocks.test.ts","./tests/views/bookmarks.test.ts","./tests/views/feed-hidden-replies.test.ts","./tests/views/feed-view-post.test.ts","./tests/views/follows.test.ts","./tests/views/get-config.test.ts","./tests/views/get-suggested-starter-packs.test.ts","./tests/views/get-trends.test.ts","./tests/views/known-followers.test.ts","./tests/views/labeler-service.test.ts","./tests/views/labels-needs-review.test.ts","./tests/views/labels-takedown.test.ts","./tests/views/likes.test.ts","./tests/views/list-feed.test.ts","./tests/views/lists.test.ts","./tests/views/mute-lists.test.ts","./tests/views/mutes.test.ts","./tests/views/notifications.test.ts","./tests/views/posts.test.ts","./tests/views/profile.test.ts","./tests/views/quotes.test.ts","./tests/views/reposts.test.ts","./tests/views/starter-packs.test.ts","./tests/views/suggested-follows.test.ts","./tests/views/suggestions.test.ts","./tests/views/thread-v2.test.ts","./tests/views/thread.test.ts","./tests/views/threadgating.test.ts","./tests/views/timeline.test.ts","./tests/views/verification.test.ts"],"version":"5.8.3"}
+{"root":["./tests/_util.ts","./tests/auth.test.ts","./tests/blob-resolver.test.ts","./tests/entryway-auth.test.ts","./tests/etcd.test.ts","./tests/feed-generation.test.ts","./tests/label-hydration.test.ts","./tests/postgates.test.ts","./tests/query-labels.test.ts","./tests/redis-cache.test.ts","./tests/server.test.ts","./tests/stash.test.ts","./tests/admin/admin-auth.test.ts","./tests/admin/moderation.test.ts","./tests/data-plane/db.test.ts","./tests/data-plane/duplicate-records.test.ts","./tests/data-plane/handle-invalidation.test.ts","./tests/data-plane/indexing.test.ts","./tests/data-plane/subscription.test.ts","./tests/data-plane/thread-mutes.test.ts","./tests/hydration/util.test.ts","./tests/image/server.test.ts","./tests/image/sharp.test.ts","./tests/image/uri.test.ts","./tests/seed/feed-hidden-replies.ts","./tests/seed/get-suggested-starter-packs.ts","./tests/seed/get-trends.ts","./tests/seed/known-followers.ts","./tests/seed/postgates.ts","./tests/views/account-deactivation.test.ts","./tests/views/actor-likes.test.ts","./tests/views/actor-search.test.ts","./tests/views/age-assurance.test.ts","./tests/views/author-feed.test.ts","./tests/views/block-lists.test.ts","./tests/views/blocks.test.ts","./tests/views/bookmarks.test.ts","./tests/views/feed-hidden-replies.test.ts","./tests/views/feed-view-post.test.ts","./tests/views/follows.test.ts","./tests/views/get-config.test.ts","./tests/views/get-suggested-starter-packs.test.ts","./tests/views/get-trends.test.ts","./tests/views/known-followers.test.ts","./tests/views/labeler-service.test.ts","./tests/views/labels-needs-review.test.ts","./tests/views/labels-takedown.test.ts","./tests/views/likes.test.ts","./tests/views/list-feed.test.ts","./tests/views/lists.test.ts","./tests/views/mute-lists.test.ts","./tests/views/mutes.test.ts","./tests/views/notifications.test.ts","./tests/views/posts-debug.test.ts","./tests/views/posts.test.ts","./tests/views/profile-debug.test.ts","./tests/views/profile.test.ts","./tests/views/quotes.test.ts","./tests/views/reposts.test.ts","./tests/views/starter-packs.test.ts","./tests/views/suggested-follows.test.ts","./tests/views/suggestions.test.ts","./tests/views/thread-v2.test.ts","./tests/views/thread.test.ts","./tests/views/threadgating.test.ts","./tests/views/timeline.test.ts","./tests/views/verification.test.ts"],"version":"5.8.3"}