Pinned posts (bluesky-social#2771)

* pinned posts lexicon * codegen * change lexicon, different approach * codegen 2 * dataplane db migration * move pinned post lexicon to right place * add pinned posts optionally to getAuthorFeed * remove type modification * Clarify naming, add viewer state, add tests * return pinnedPost with profileViewDetailed * allow pinned replies in `posts_and_author_threads` * clearer variable naming * annotate type of `items` * boolean --> varchar * reuse authorDid in viewerPinned * simplify test * make pinned post not top post in test * update snapshot * changeset --------- Co-authored-by: Eric Bailey <[email protected]> Co-authored-by: dholms <[email protected]>
iksmn · Sep 26, 2024 · 2676206 · 2676206
1 parent ed325d8
commit 2676206
Show file tree

Hide file tree

Showing 34 changed files with 2,339 additions and 35 deletions.
diff --git a/.changeset/eighty-olives-deliver.md b/.changeset/eighty-olives-deliver.md
@@ -0,0 +1,5 @@
+---
+"@atproto/api": patch
+---
+
+Add pinned posts to profile record and getAuthorFeed
diff --git a/lexicons/app/bsky/actor/defs.json b/lexicons/app/bsky/actor/defs.json
@@ -91,6 +91,10 @@
         "labels": {
           "type": "array",
           "items": { "type": "ref", "ref": "com.atproto.label.defs#label" }
+        },
+        "pinnedPost": {
+          "type": "ref",
+          "ref": "com.atproto.repo.strongRef"
         }
       }
     },

diff --git a/lexicons/app/bsky/actor/profile.json b/lexicons/app/bsky/actor/profile.json
@@ -41,6 +41,10 @@
             "type": "ref",
             "ref": "com.atproto.repo.strongRef"
           },
+          "pinnedPost": {
+            "type": "ref",
+            "ref": "com.atproto.repo.strongRef"
+          },
           "createdAt": { "type": "string", "format": "datetime" }
         }
       }

diff --git a/lexicons/app/bsky/feed/defs.json b/lexicons/app/bsky/feed/defs.json
@@ -44,7 +44,8 @@
         "like": { "type": "string", "format": "at-uri" },
         "threadMuted": { "type": "boolean" },
         "replyDisabled": { "type": "boolean" },
-        "embeddingDisabled": { "type": "boolean" }
+        "embeddingDisabled": { "type": "boolean" },
+        "pinned": { "type": "boolean" }
       }
     },
     "feedViewPost": {
@@ -53,7 +54,7 @@
       "properties": {
         "post": { "type": "ref", "ref": "#postView" },
         "reply": { "type": "ref", "ref": "#replyRef" },
-        "reason": { "type": "union", "refs": ["#reasonRepost"] },
+        "reason": { "type": "union", "refs": ["#reasonRepost", "#reasonPin"] },
         "feedContext": {
           "type": "string",
           "description": "Context provided by feed generator that may be passed back alongside interactions.",
@@ -88,6 +89,10 @@
         "indexedAt": { "type": "string", "format": "datetime" }
       }
     },
+    "reasonPin": {
+      "type": "object",
+      "properties": {}
+    },
     "threadViewPost": {
       "type": "object",
       "required": ["post"],
@@ -171,7 +176,10 @@
       "required": ["post"],
       "properties": {
         "post": { "type": "string", "format": "at-uri" },
-        "reason": { "type": "union", "refs": ["#skeletonReasonRepost"] },
+        "reason": {
+          "type": "union",
+          "refs": ["#skeletonReasonRepost", "#skeletonReasonPin"]
+        },
         "feedContext": {
           "type": "string",
           "description": "Context that will be passed through to client and may be passed to feed generator back alongside interactions.",
@@ -186,6 +194,10 @@
         "repost": { "type": "string", "format": "at-uri" }
       }
     },
+    "skeletonReasonPin": {
+      "type": "object",
+      "properties": {}
+    },
     "threadgateView": {
       "type": "object",
       "properties": {

diff --git a/lexicons/app/bsky/feed/getAuthorFeed.json b/lexicons/app/bsky/feed/getAuthorFeed.json
@@ -27,6 +27,10 @@
               "posts_and_author_threads"
             ],
             "default": "posts_with_replies"
+          },
+          "includePins": {
+            "type": "boolean",
+            "default": false
           }
         }
       },

diff --git a/lexicons/app/bsky/feed/threadgate.json b/lexicons/app/bsky/feed/threadgate.json
@@ -5,7 +5,7 @@
     "main": {
       "type": "record",
       "key": "tid",
-      "description": "Record defining interaction gating rules for a thread (aka, reply controls). The record key (rkey) of the threadgate record must match the record key of the thread's root post, and that record must be in the same repository..",
+      "description": "Record defining interaction gating rules for a thread (aka, reply controls). The record key (rkey) of the threadgate record must match the record key of the thread's root post, and that record must be in the same repository.",
       "record": {
         "type": "object",
         "required": ["post", "createdAt"],

diff --git a/packages/api/src/client/lexicons.ts b/packages/api/src/client/lexicons.ts
@@ -4190,6 +4190,10 @@ export const schemaDict = {
               ref: 'lex:com.atproto.label.defs#label',
             },
           },
+          pinnedPost: {
+            type: 'ref',
+            ref: 'lex:com.atproto.repo.strongRef',
+          },
         },
       },
       profileAssociated: {
@@ -4812,6 +4816,10 @@ export const schemaDict = {
               type: 'ref',
               ref: 'lex:com.atproto.repo.strongRef',
             },
+            pinnedPost: {
+              type: 'ref',
+              ref: 'lex:com.atproto.repo.strongRef',
+            },
             createdAt: {
               type: 'string',
               format: 'datetime',
@@ -5468,6 +5476,9 @@ export const schemaDict = {
           embeddingDisabled: {
             type: 'boolean',
           },
+          pinned: {
+            type: 'boolean',
+          },
         },
       },
       feedViewPost: {
@@ -5484,7 +5495,10 @@ export const schemaDict = {
           },
           reason: {
             type: 'union',
-            refs: ['lex:app.bsky.feed.defs#reasonRepost'],
+            refs: [
+              'lex:app.bsky.feed.defs#reasonRepost',
+              'lex:app.bsky.feed.defs#reasonPin',
+            ],
           },
           feedContext: {
             type: 'string',
@@ -5536,6 +5550,10 @@ export const schemaDict = {
           },
         },
       },
+      reasonPin: {
+        type: 'object',
+        properties: {},
+      },
       threadViewPost: {
         type: 'object',
         required: ['post'],
@@ -5693,7 +5711,10 @@ export const schemaDict = {
           },
           reason: {
             type: 'union',
-            refs: ['lex:app.bsky.feed.defs#skeletonReasonRepost'],
+            refs: [
+              'lex:app.bsky.feed.defs#skeletonReasonRepost',
+              'lex:app.bsky.feed.defs#skeletonReasonPin',
+            ],
           },
           feedContext: {
             type: 'string',
@@ -5713,6 +5734,10 @@ export const schemaDict = {
           },
         },
       },
+      skeletonReasonPin: {
+        type: 'object',
+        properties: {},
+      },
       threadgateView: {
         type: 'object',
         properties: {
@@ -6078,6 +6103,10 @@ export const schemaDict = {
               ],
               default: 'posts_with_replies',
             },
+            includePins: {
+              type: 'boolean',
+              default: false,
+            },
           },
         },
         output: {
@@ -7162,7 +7191,7 @@ export const schemaDict = {
         type: 'record',
         key: 'tid',
         description:
-          "Record defining interaction gating rules for a thread (aka, reply controls). The record key (rkey) of the threadgate record must match the record key of the thread's root post, and that record must be in the same repository..",
+          "Record defining interaction gating rules for a thread (aka, reply controls). The record key (rkey) of the threadgate record must match the record key of the thread's root post, and that record must be in the same repository.",
         record: {
           type: 'object',
           required: ['post', 'createdAt'],

diff --git a/packages/api/src/client/types/app/bsky/actor/defs.ts b/packages/api/src/client/types/app/bsky/actor/defs.ts
@@ -7,6 +7,7 @@ import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
 import * as ComAtprotoLabelDefs from '../../../com/atproto/label/defs'
 import * as AppBskyGraphDefs from '../graph/defs'
+import * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef'
 
 export interface ProfileViewBasic {
   did: string
@@ -74,6 +75,7 @@ export interface ProfileViewDetailed {
   createdAt?: string
   viewer?: ViewerState
   labels?: ComAtprotoLabelDefs.Label[]
+  pinnedPost?: ComAtprotoRepoStrongRef.Main
   [k: string]: unknown
 }
 

diff --git a/packages/api/src/client/types/app/bsky/actor/profile.ts b/packages/api/src/client/types/app/bsky/actor/profile.ts
@@ -20,6 +20,7 @@ export interface Record {
     | ComAtprotoLabelDefs.SelfLabels
     | { $type: string; [k: string]: unknown }
   joinedViaStarterPack?: ComAtprotoRepoStrongRef.Main
+  pinnedPost?: ComAtprotoRepoStrongRef.Main
   createdAt?: string
   [k: string]: unknown
 }

diff --git a/packages/api/src/client/types/app/bsky/feed/defs.ts b/packages/api/src/client/types/app/bsky/feed/defs.ts
@@ -55,6 +55,7 @@ export interface ViewerState {
   threadMuted?: boolean
   replyDisabled?: boolean
   embeddingDisabled?: boolean
+  pinned?: boolean
   [k: string]: unknown
 }
 
@@ -73,7 +74,7 @@ export function validateViewerState(v: unknown): ValidationResult {
 export interface FeedViewPost {
   post: PostView
   reply?: ReplyRef
-  reason?: ReasonRepost | { $type: string; [k: string]: unknown }
+  reason?: ReasonRepost | ReasonPin | { $type: string; [k: string]: unknown }
   /** Context provided by feed generator that may be passed back alongside interactions. */
   feedContext?: string
   [k: string]: unknown
@@ -134,6 +135,22 @@ export function validateReasonRepost(v: unknown): ValidationResult {
   return lexicons.validate('app.bsky.feed.defs#reasonRepost', v)
 }
 
+export interface ReasonPin {
+  [k: string]: unknown
+}
+
+export function isReasonPin(v: unknown): v is ReasonPin {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.feed.defs#reasonPin'
+  )
+}
+
+export function validateReasonPin(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.feed.defs#reasonPin', v)
+}
+
 export interface ThreadViewPost {
   post: PostView
   parent?:
@@ -265,7 +282,10 @@ export function validateGeneratorViewerState(v: unknown): ValidationResult {
 
 export interface SkeletonFeedPost {
   post: string
-  reason?: SkeletonReasonRepost | { $type: string; [k: string]: unknown }
+  reason?:
+    | SkeletonReasonRepost
+    | SkeletonReasonPin
+    | { $type: string; [k: string]: unknown }
   /** Context that will be passed through to client and may be passed to feed generator back alongside interactions. */
   feedContext?: string
   [k: string]: unknown
@@ -300,6 +320,22 @@ export function validateSkeletonReasonRepost(v: unknown): ValidationResult {
   return lexicons.validate('app.bsky.feed.defs#skeletonReasonRepost', v)
 }
 
+export interface SkeletonReasonPin {
+  [k: string]: unknown
+}
+
+export function isSkeletonReasonPin(v: unknown): v is SkeletonReasonPin {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.feed.defs#skeletonReasonPin'
+  )
+}
+
+export function validateSkeletonReasonPin(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.feed.defs#skeletonReasonPin', v)
+}
+
 export interface ThreadgateView {
   uri?: string
   cid?: string

diff --git a/packages/api/src/client/types/app/bsky/feed/getAuthorFeed.ts b/packages/api/src/client/types/app/bsky/feed/getAuthorFeed.ts
@@ -19,6 +19,7 @@ export interface QueryParams {
     | 'posts_with_media'
     | 'posts_and_author_threads'
     | (string & {})
+  includePins?: boolean
 }
 
 export type InputSchema = undefined

diff --git a/packages/bsky/src/api/app/bsky/feed/getAuthorFeed.ts b/packages/bsky/src/api/app/bsky/feed/getAuthorFeed.ts
@@ -79,21 +79,46 @@ export const skeleton = async (inputs: {
   if (clearlyBadCursor(params.cursor)) {
     return { actor, filter: params.filter, items: [] }
   }
+
+  const isFirstPageRequest = !params.cursor
+  const shouldInsertPinnedPost =
+    isFirstPageRequest && params.includePins && !!actor.profile?.pinnedPost
+
   const res = await ctx.dataplane.getAuthorFeed({
     actorDid: did,
     limit: params.limit,
     cursor: params.cursor,
     feedType: FILTER_TO_FEED_TYPE[params.filter],
   })
+
+  let items: FeedItem[] = res.items.map((item) => ({
+    post: { uri: item.uri, cid: item.cid || undefined },
+    repost: item.repost
+      ? { uri: item.repost, cid: item.repostCid || undefined }
+      : undefined,
+  }))
+
+  if (shouldInsertPinnedPost && actor.profile?.pinnedPost) {
+    const pinnedItem = {
+      post: {
+        uri: actor.profile.pinnedPost.uri,
+        cid: actor.profile.pinnedPost.cid,
+      },
+      authorPinned: true,
+    }
+    if (params.limit === 1) {
+      items[0] = pinnedItem
+    } else {
+      // filter pinned post from first page only
+      items = items.filter((item) => item.post.uri !== pinnedItem.post.uri)
+      items.unshift(pinnedItem)
+    }
+  }
+
   return {
     actor,
     filter: params.filter,
-    items: res.items.map((item) => ({
-      post: { uri: item.uri, cid: item.cid || undefined },
-      repost: item.repost
-        ? { uri: item.repost, cid: item.repostCid || undefined }
-        : undefined,
-    })),
+    items,
     cursor: parseString(res.cursor),
   }
 }
@@ -147,7 +172,7 @@ const noBlocksOrMutedReposts = (inputs: {
     skeleton.items = skeleton.items.filter((item) => {
       return (
         checkBlocksAndMutes(item) &&
-        (item.repost || selfThread.ok(item.post.uri))
+        (item.repost || item.authorPinned || selfThread.ok(item.post.uri))
       )
     })
   } else {

diff --git a/packages/bsky/src/data-plane/server/db/migrations/20240831T134810923Z-pinned-posts.ts b/packages/bsky/src/data-plane/server/db/migrations/20240831T134810923Z-pinned-posts.ts
@@ -0,0 +1,17 @@
+import { Kysely } from 'kysely'
+
+export async function up(db: Kysely<unknown>): Promise<void> {
+  await db.schema
+    .alterTable('profile')
+    .addColumn('pinnedPost', 'varchar')
+    .execute()
+  await db.schema
+    .alterTable('profile')
+    .addColumn('pinnedPostCid', 'varchar')
+    .execute()
+}
+
+export async function down(db: Kysely<unknown>): Promise<void> {
+  await db.schema.alterTable('profile').dropColumn('pinnedPost').execute()
+  await db.schema.alterTable('profile').dropColumn('pinnedPostCid').execute()
+}
diff --git a/packages/bsky/src/data-plane/server/db/migrations/index.ts b/packages/bsky/src/data-plane/server/db/migrations/index.ts
@@ -43,3 +43,4 @@ export * as _20240723T220703655Z from './20240723T220703655Z-quotes'
 export * as _20240801T193939827Z from './20240801T193939827Z-post-gate'
 export * as _20240808T224251220Z from './20240808T224251220Z-post-gate-flags'
 export * as _20240829T211238293Z from './20240829T211238293Z-simplify-actor-sync'
+export * as _20240831T134810923Z from './20240831T134810923Z-pinned-posts'
diff --git a/packages/bsky/src/data-plane/server/db/tables/profile.ts b/packages/bsky/src/data-plane/server/db/tables/profile.ts
@@ -9,6 +9,8 @@ export interface Profile {
   avatarCid: string | null
   bannerCid: string | null
   joinedViaStarterPackUri: string | null
+  pinnedPost: string | null
+  pinnedPostCid: string | null
   createdAt: string
   indexedAt: string
 }