feat(tx-cache): Pagination types and impl #131

Evalir · 2025-10-23T15:44:58Z

Adds cursor-based pagination types to the tx-cache crate. This allows us to implement pagination on the cache, and for the tx-cache client to be able to use pagination queries.

Getting all items in one of the collections in the cache is as simple as:

getting items in the collection, which will return a PaginationInfo
passing the cursor returned from PaginationInfo into the next request. This can easily be done by .into()ing a PaginationInfo into a PaginationParams.
do this repeatedly until there are no more pages. PaginationInfo has an utility method to detect this.

These changes are not breaking for the current tx cache consumers.

Evalir · 2025-10-23T15:45:14Z

feat(tx-cache): Pagination types and impl #131 👈 (View in Graphite)
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

wip

rswanson · 2025-10-27T15:54:57Z

is this a breaking change for existing consumers of the api? i.e. if they are using an older version of the builder will their builder break if I deploy this version of the tx cache?

Evalir · 2025-10-27T16:05:57Z

Not technically a breaking change. The builder will still be able to fetch items from the cache as serde can partially deserialize JSON (it's a self-described format). They will be missing the pagination info, which is fine for now. I've added partial deser tests on the companion pagination PR to confirm this.

prestwich · 2025-10-30T14:12:25Z

these changes are currently breaking, as serde will expect pagination info to be present unless given a specific serde(default) or similar attribute tag

prestwich · 2025-10-30T14:13:33Z

I would prefer to see something like:

pub enum CacheResponse<T> { 
    Paginated{
        inner: T,
        pagination: PaginationInfo
    },
    Unpaginated(T),
}

Evalir · 2025-10-31T11:01:17Z

took a stab at the suggestion @prestwich, wdyt?

prestwich

add serde roundtrip tests with what you think these json objects should look like.

If pagination params is a query, I don't think it's appropriate to use serde. Instead, there should be a method to apply it to a url?

prestwich · 2025-11-03T15:47:03Z

crates/tx-cache/src/types.rs

+    /// The cursor to start from.
+    cursor: Option<String>,
+    /// The number of items to return.
+    limit: Option<u32>,


missing serde tags for if missing or none

missing serde renames

prestwich · 2025-11-03T15:47:53Z

crates/tx-cache/src/types.rs

+/// Represents the pagination information from a transaction cache response.
+/// This applies to all GET endpoints that return a list of items.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct PaginationInfo {


Missing serde for missing/none on next_cursor

prestwich · 2025-11-03T15:48:00Z

crates/tx-cache/src/types.rs

+/// Represents the pagination information from a transaction cache response.
+/// This applies to all GET endpoints that return a list of items.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct PaginationInfo {


missing serde renames

isn't has_next_page redundant? shouldn't we use presence/absence of a next_cursor to indicate this?

prestwich · 2025-11-03T15:48:53Z

crates/tx-cache/src/types.rs

+
+impl From<PaginationInfo> for PaginationParams {
+    fn from(info: PaginationInfo) -> Self {
+        Self { cursor: info.into_next_cursor(), limit: None }


this feels like an inappropriate from impl. Maybe a next_page(&self, page_size: Option<usize>) function instead?

prestwich · 2025-11-03T15:50:21Z

crates/tx-cache/src/types.rs


+/// A response from the transaction cache, containing an item.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub enum CacheResponse<T> {


missing serde tags

prestwich · 2025-11-06T15:10:20Z

crates/tx-cache/src/types.rs

@@ -1,18 +1,21 @@
 //! The endpoints for the transaction cache.
+use std::collections::HashMap;
+


nit remove newline

prestwich · 2025-11-06T15:11:59Z

crates/tx-cache/src/client.rs

    }

-    async fn get_inner_with_query<T>(
+    async fn get_inner_with_query<C: CursorKey, T>(


if you make a trait for the output you can remove the C here and avoid specifying it in turbofish elsewhere

trait CacheObject { type Key: CursorKey; }

Evalir force-pushed the evalir/cache-pagination branch 2 times, most recently from 695f90e to 38133ea Compare October 23, 2025 15:52

feat(tx-cache): Pagination types and impl

9c99eeb

wip

Evalir force-pushed the evalir/cache-pagination branch from 38133ea to 9c99eeb Compare October 23, 2025 16:32

Evalir marked this pull request as ready for review October 23, 2025 16:34

Evalir requested a review from a team as a code owner October 23, 2025 16:34

Evalir added 2 commits October 23, 2025 18:38

chore: from impl for paginationinfo/params

b75dd84

chore: extra helper fns

0e483ea

feat: re-design pagination to contain a CacheResponse<T>

4df75cc

prestwich reviewed Nov 3, 2025

View reviewed changes

chore: adapt client

d90cb4d

prestwich requested changes Nov 6, 2025

View reviewed changes

		@@ -1,18 +1,21 @@
		//! The endpoints for the transaction cache.
		use std::collections::HashMap;

feat(tx-cache): Pagination types and impl #131

Are you sure you want to change the base?

feat(tx-cache): Pagination types and impl #131

Conversation

Evalir commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Evalir commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rswanson commented Oct 27, 2025

Uh oh!

Evalir commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

prestwich commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

prestwich commented Oct 30, 2025

Uh oh!

Evalir commented Oct 31, 2025

Uh oh!

prestwich left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Evalir commented Oct 23, 2025 •

edited

Loading

Evalir commented Oct 23, 2025 •

edited

Loading

Evalir commented Oct 27, 2025 •

edited

Loading

prestwich commented Oct 30, 2025 •

edited

Loading