fix: pagination

[gfyrag]

Fixes LX-52

[coderabbitai]

Walkthrough

This change updates the pagination logic in the ledger storage layer to allow overriding the default pagination column with a user-specified column. The test for transaction ordering is also updated to reflect the new logic, ensuring that transactions can be sorted and paginated by columns other than the default.

Changes

File(s)	Summary
internal/storage/ledger/paginator_column.go internal/storage/ledger/paginator_offset.go	Added logic to override the default pagination column with a user-specified column in the paginate methods.
test/e2e/api_transactions_list_test.go	Modified transaction ordering test to match new pagination and sorting behavior.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Storage
    participant DB

    Client->>API: Request transactions with order=effective
    API->>Storage: Paginate(query with Column="timestamp")
    Storage->>DB: SQL query using pagination column (timestamp)
    DB-->>Storage: Paginated transactions
    Storage-->>API: Transactions sorted by requested column
    API-->>Client: Response with ordered transactions

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Ensure transactions are sorted by the requested column (e.g., timestamp) instead of always using the default (insertedAt) (LX-52)	✅
Update tests to verify correct ordering and pagination by the specified column (LX-52)	✅

Possibly related PRs

• fix: reverse query param on transactions list #911: Adds dynamic ordering based on a reverse query parameter, closely related to this PR's changes in pagination and ordering logic.

Suggested reviewers

• laouji
• flemzord

Poem

In the ledger fields where queries hop,
Now columns shift and orders swap.
With every page and sorted row,
The right results are sure to show!
🐇✨

So here’s a cheer for code so neat—
Pagination now is quite the treat!

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7b80907 and b7c5b69.

📒 Files selected for processing (3)

• internal/storage/ledger/paginator_column.go (1 hunks)
• internal/storage/ledger/paginator_offset.go (1 hunks)
• test/e2e/api_transactions_list_test.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Tests

🔇 Additional comments (3)

internal/storage/ledger/paginator_column.go (1)

24-26: Good improvement to support custom pagination columns.

The addition of this conditional logic allows overriding the default pagination column with a user-specified one, making the pagination system more flexible.

internal/storage/ledger/paginator_offset.go (1)

20-22: Good implementation for custom column pagination support.

This change mirrors the one in paginator_column.go, ensuring consistent behavior across both pagination types (column and offset-based). The implementation is clean and properly defaults to the original behavior when no column is specified.

test/e2e/api_transactions_list_test.go (1)

214-220: Updated test correctly verifies the new pagination behavior.

The test modification properly validates that transactions are correctly ordered by timestamp when using the "effective" ordering. The approach of sorting the full list, taking a suffix, and reversing it accurately reflects how the pagination system now works with custom columns.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Commit Unit Tests in branch hotfix/v2.2/pagination-custom-columns
• Post Copyable Unit Tests in Comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.