[TS-160] Add debug field to PostView and ProfileView*s (#4297)

* Add debug field to lex and proto, codegen

* Include debug field for DIDs configured via env var

* Gen bufs

* Update types and view

* Add debug field to profile views

* Safely populate debug field

* Format

* Use util

* Simplify existence check

* Values may be undefined

* Clarify type

* Update descriptions

* Include default value for dev-env

* Add test harness

(cherry picked from commit 7e49b4cf4cf3cbb989114540081e74f7a34acb6f)

* Use unknown field type instead of serializing

* KISS keep it set stupid

* Fix comments

* Differentiate between source of debug

* Add matching profile view test

* Specifying types of the merged objects isn't really helpful

* Changeset

* Add comment

* Put includeDebugField on HydrateCtx and use in views

* Mutate TestNetwork innards for tests

* Format

* Use separate debug schema for profile test

* Little more terse

* Oops, remove last usage

* Remove vestigial props

* Include other actor metadata

* Simply views, remove debugField

Author: estrattonbailey

.changeset/wicked-monkeys-develop.md

@@ -0,0 +1,5 @@
+---
+"@atproto/bsky": patch
+---
+
+Add `debug` field to `PostView` and `ProfileView*`s

lexicons/app/bsky/actor/defs.json

@@ -32,6 +32,10 @@
         "status": {
           "type": "ref",
           "ref": "#statusView"
+        },
+        "debug": {
+          "type": "unknown",
+          "description": "Debug information for internal development"
         }
       }
     },
@@ -71,6 +75,10 @@
         "status": {
           "type": "ref",
           "ref": "#statusView"
+        },
+        "debug": {
+          "type": "unknown",
+          "description": "Debug information for internal development"
         }
       }
     },
@@ -123,6 +131,10 @@
         "status": {
           "type": "ref",
           "ref": "#statusView"
+        },
+        "debug": {
+          "type": "unknown",
+          "description": "Debug information for internal development"
         }
       }
     },

lexicons/app/bsky/feed/defs.json

@@ -34,7 +34,11 @@
           "type": "array",
           "items": { "type": "ref", "ref": "com.atproto.label.defs#label" }
         },
-        "threadgate": { "type": "ref", "ref": "#threadgateView" }
+        "threadgate": { "type": "ref", "ref": "#threadgateView" },
+        "debug": {
+          "type": "unknown",
+          "description": "Debug information for internal development"
+        }
       }
     },
     "viewerState": {

packages/api/src/client/lexicons.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(

packages/api/src/client/types/app/bsky/actor/defs.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>())
   }

packages/api/src/client/types/app/bsky/feed/defs.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,
       )

packages/bsky/src/config.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,
     })
   }