Unify pagination interface across all methods (bluesky-social#242)

* Update lexicons for cursor convention, fix minor cid usage in interface * Liked by cursor pagination, temp fix for other tests * Home and author feed cursor pagination * Paginate crud list w/ cursor, minor adjustments to lex and xrpc * Paginate notifications view w/ cursor * Paginate reposts view w/ cursor * Paginate follow views w/ cursor * Paginate user search view w/ cursor * Fix notification tests * Make repoListRecords order desc by default for consistency * Paginate badge memebers view w/ cursor
rcg4u · Oct 17, 2022 · 0820013 · 0820013
1 parent 60a537a
commit 0820013
Show file tree

Hide file tree

Showing 62 changed files with 539 additions and 410 deletions.
diff --git a/lexicons/atproto.com/repoListRecords.json b/lexicons/atproto.com/repoListRecords.json
@@ -17,6 +17,7 @@
       "type": "object",
       "required": ["records"],
       "properties": {
+        "cursor": {"type": "string"},
         "records": {
           "type": "array",
           "items": {
@@ -32,4 +33,4 @@
       }
     }
   }
-}
+}
diff --git a/lexicons/bsky.app/getAuthorFeed.json b/lexicons/bsky.app/getAuthorFeed.json
@@ -14,6 +14,7 @@
       "type": "object",
       "required": ["feed"],
       "properties": {
+        "cursor": {"type": "string"},
         "feed": {
           "type": "array",
           "items": {"$ref": "#/defs/feedItem"}
@@ -24,9 +25,8 @@
   "defs": {
     "feedItem": {
       "type": "object",
-      "required": ["cursor", "uri", "cid", "author", "record", "replyCount", "repostCount", "likeCount", "indexedAt"],
+      "required": ["uri", "cid", "author", "record", "replyCount", "repostCount", "likeCount", "indexedAt"],
       "properties": {
-        "cursor": {"type": "string"},
         "uri": {"type": "string"},
         "cid": {"type": "string"},
         "author": {"$ref": "#/defs/user"},
@@ -95,4 +95,4 @@
       }
     }
   }
-}
+}
diff --git a/lexicons/bsky.app/getBadgeMembers.json b/lexicons/bsky.app/getBadgeMembers.json
@@ -16,6 +16,7 @@
       "properties": {
         "uri": {"type": "string"},
         "cid": {"type": "string"},
+        "cursor": {"type": "string"},
         "members": {
           "type": "array",
           "items": {
@@ -36,4 +37,4 @@
       }
     }
   }
-}
+}
diff --git a/lexicons/bsky.app/getHomeFeed.json b/lexicons/bsky.app/getHomeFeed.json
@@ -14,6 +14,7 @@
       "type": "object",
       "required": ["feed"],
       "properties": {
+        "cursor": {"type": "string"},
         "feed": {
           "type": "array",
           "items": {"$ref": "#/defs/feedItem"}
@@ -24,9 +25,8 @@
   "defs": {
     "feedItem": {
       "type": "object",
-      "required": ["cursor", "uri", "cid", "author", "record", "replyCount", "repostCount", "likeCount", "indexedAt"],
+      "required": ["uri", "cid", "author", "record", "replyCount", "repostCount", "likeCount", "indexedAt"],
       "properties": {
-        "cursor": {"type": "string"},
         "uri": {"type": "string"},
         "cid": {"type": "string"},
         "author": {"$ref": "#/defs/user"},
@@ -95,4 +95,4 @@
       }
     }
   }
-}
+}
diff --git a/lexicons/bsky.app/getLikedBy.json b/lexicons/bsky.app/getLikedBy.json
@@ -16,6 +16,7 @@
       "properties": {
         "uri": {"type": "string"},
         "cid": {"type": "string"},
+        "cursor": {"type": "string"},
         "likedBy": {
           "type": "array",
           "items": {
@@ -36,4 +37,4 @@
       }
     }
   }
-}
+}
diff --git a/lexicons/bsky.app/getNotifications.json b/lexicons/bsky.app/getNotifications.json
@@ -12,6 +12,7 @@
       "type": "object",
       "required": ["notifications"],
       "properties": {
+        "cursor": {"type": "string"},
         "notifications": {
           "type": "array",
           "items": {"$ref": "#/defs/notification"}
@@ -49,4 +50,4 @@
       }
     }
   }
-}
+}
diff --git a/lexicons/bsky.app/getRepostedBy.json b/lexicons/bsky.app/getRepostedBy.json
@@ -15,6 +15,8 @@
       "required": ["uri", "repostedBy"],
       "properties": {
         "uri": {"type": "string"},
+        "cid": {"type": "string"},
+        "cursor": {"type": "string"},
         "repostedBy": {
           "type": "array",
           "items": {
@@ -35,4 +37,4 @@
       }
     }
   }
-}
+}
diff --git a/lexicons/bsky.app/getUserFollowers.json b/lexicons/bsky.app/getUserFollowers.json
@@ -26,6 +26,7 @@
             }
           }
         },
+        "cursor": {"type": "string"},
         "followers": {
           "type": "array",
           "items": {
@@ -46,4 +47,4 @@
       }
     }
   }
-}
+}
diff --git a/lexicons/bsky.app/getUserFollows.json b/lexicons/bsky.app/getUserFollows.json
@@ -26,6 +26,7 @@
             }
           }
         },
+        "cursor": {"type": "string"},
         "follows": {
           "type": "array",
           "items": {
@@ -46,4 +47,4 @@
       }
     }
   }
-}
+}
diff --git a/lexicons/bsky.app/getUsersSearch.json b/lexicons/bsky.app/getUsersSearch.json
@@ -14,11 +14,12 @@
       "type": "object",
       "required": ["users"],
       "properties": {
+        "cursor": {"type": "string"},
         "users": {
           "type": "array",
           "items": {
             "type": "object",
-            "required": ["did", "name", "createdAt", "indexedAt", "cursor"],
+            "required": ["did", "name", "createdAt", "indexedAt"],
             "properties": {
               "did": {"type": "string"},
               "name": {"type": "string"},
@@ -28,8 +29,7 @@
               },
               "description": {"type": "string"},
               "createdAt": {"type": "string", "format": "date-time"},
-              "indexedAt": {"type": "string", "format": "date-time"},
-              "cursor": {"type": "string"}
+              "indexedAt": {"type": "string", "format": "date-time"}
             }
           }
         }

diff --git a/packages/api/src/index.ts b/packages/api/src/index.ts
@@ -626,7 +626,10 @@ export class BadgeRecord {
 
   async list(
     params: Omit<ComAtprotoRepoListRecords.QueryParams, 'collection'>
-  ): Promise<{ records: { uri: string, value: AppBskyBadge.Record }[] }> {
+  ): Promise<{
+    cursor?: string,
+    records: { uri: string, value: AppBskyBadge.Record }[],
+  }> {
     const res = await this._service.xrpc.call('com.atproto.repoListRecords', {
       collection: 'app.bsky.badge',
       ...params,
@@ -681,7 +684,10 @@ export class BadgeAcceptRecord {
 
   async list(
     params: Omit<ComAtprotoRepoListRecords.QueryParams, 'collection'>
-  ): Promise<{ records: { uri: string, value: AppBskyBadgeAccept.Record }[] }> {
+  ): Promise<{
+    cursor?: string,
+    records: { uri: string, value: AppBskyBadgeAccept.Record }[],
+  }> {
     const res = await this._service.xrpc.call('com.atproto.repoListRecords', {
       collection: 'app.bsky.badgeAccept',
       ...params,
@@ -736,7 +742,10 @@ export class BadgeOfferRecord {
 
   async list(
     params: Omit<ComAtprotoRepoListRecords.QueryParams, 'collection'>
-  ): Promise<{ records: { uri: string, value: AppBskyBadgeOffer.Record }[] }> {
+  ): Promise<{
+    cursor?: string,
+    records: { uri: string, value: AppBskyBadgeOffer.Record }[],
+  }> {
     const res = await this._service.xrpc.call('com.atproto.repoListRecords', {
       collection: 'app.bsky.badgeOffer',
       ...params,
@@ -791,7 +800,10 @@ export class FollowRecord {
 
   async list(
     params: Omit<ComAtprotoRepoListRecords.QueryParams, 'collection'>
-  ): Promise<{ records: { uri: string, value: AppBskyFollow.Record }[] }> {
+  ): Promise<{
+    cursor?: string,
+    records: { uri: string, value: AppBskyFollow.Record }[],
+  }> {
     const res = await this._service.xrpc.call('com.atproto.repoListRecords', {
       collection: 'app.bsky.follow',
       ...params,
@@ -846,7 +858,10 @@ export class LikeRecord {
 
   async list(
     params: Omit<ComAtprotoRepoListRecords.QueryParams, 'collection'>
-  ): Promise<{ records: { uri: string, value: AppBskyLike.Record }[] }> {
+  ): Promise<{
+    cursor?: string,
+    records: { uri: string, value: AppBskyLike.Record }[],
+  }> {
     const res = await this._service.xrpc.call('com.atproto.repoListRecords', {
       collection: 'app.bsky.like',
       ...params,
@@ -901,7 +916,10 @@ export class MediaEmbedRecord {
 
   async list(
     params: Omit<ComAtprotoRepoListRecords.QueryParams, 'collection'>
-  ): Promise<{ records: { uri: string, value: AppBskyMediaEmbed.Record }[] }> {
+  ): Promise<{
+    cursor?: string,
+    records: { uri: string, value: AppBskyMediaEmbed.Record }[],
+  }> {
     const res = await this._service.xrpc.call('com.atproto.repoListRecords', {
       collection: 'app.bsky.mediaEmbed',
       ...params,
@@ -956,7 +974,10 @@ export class PostRecord {
 
   async list(
     params: Omit<ComAtprotoRepoListRecords.QueryParams, 'collection'>
-  ): Promise<{ records: { uri: string, value: AppBskyPost.Record }[] }> {
+  ): Promise<{
+    cursor?: string,
+    records: { uri: string, value: AppBskyPost.Record }[],
+  }> {
     const res = await this._service.xrpc.call('com.atproto.repoListRecords', {
       collection: 'app.bsky.post',
       ...params,
@@ -1011,7 +1032,10 @@ export class ProfileRecord {
 
   async list(
     params: Omit<ComAtprotoRepoListRecords.QueryParams, 'collection'>
-  ): Promise<{ records: { uri: string, value: AppBskyProfile.Record }[] }> {
+  ): Promise<{
+    cursor?: string,
+    records: { uri: string, value: AppBskyProfile.Record }[],
+  }> {
     const res = await this._service.xrpc.call('com.atproto.repoListRecords', {
       collection: 'app.bsky.profile',
       ...params,
@@ -1066,7 +1090,10 @@ export class RepostRecord {
 
   async list(
     params: Omit<ComAtprotoRepoListRecords.QueryParams, 'collection'>
-  ): Promise<{ records: { uri: string, value: AppBskyRepost.Record }[] }> {
+  ): Promise<{
+    cursor?: string,
+    records: { uri: string, value: AppBskyRepost.Record }[],
+  }> {
     const res = await this._service.xrpc.call('com.atproto.repoListRecords', {
       collection: 'app.bsky.repost',
       ...params,