fix: include pagination.key at reverse mode

[beer-1]

Description

Closes: #20938

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title, you can find examples of the prefixes below:
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• Bug Fixes
  • Fixed the collection reverse iterator to include pagination.key in the result, ensuring more accurate data retrieval.
• Tests
  • Added a new test case to verify correct behavior when using a key with reverse pagination.

[coderabbitai]

Walkthrough

Walkthrough

The changes address a bug in the Cosmos SDK where the collection iterator did not correctly include the pagination.key item when iterating in reverse mode. The getCollIter function in collections_pagination.go has been revised to ensure the prefix is included when adjusting the start key in reverse mode. Additionally, new test cases have been added to validate this behavior.

Changes

File	Change Summary
CHANGELOG.md	Documented the fix for the collection reverse iterator to include pagination.key in the result.
types/query/collections_pagination.go	Updated the getCollIter function to adjust the start key in reverse mode to include the prefix.
types/query/collections_pagination_test.go	Added a new test case "with key and reverse" to validate the correct behavior of the collection iterator in reverse mode with a key.

Assessment against linked issues

Objective (Issue #20938)	Addressed	Explanation
Fix the collection iterator to include pagination.key item when using reverse mode.	✅
Ensure proper adjustment of the start key in reverse mode within the getCollIter function.	✅
Add test cases to verify the correct inclusion of the pagination.key item in reverse mode iterations.	✅

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 10465a6 and f4bea14.

Files selected for processing (3)

• CHANGELOG.md (1 hunks)
• types/query/collections_pagination.go (1 hunks)
• types/query/collections_pagination_test.go (1 hunks)

Additional context used

Path-based instructions (3)

types/query/collections_pagination_test.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

---

Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

types/query/collections_pagination.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

Additional comments not posted (3)

types/query/collections_pagination_test.go (1)

86-95: LGTM! Ensure sufficient test coverage.

The new test case "with key and reverse" is well-structured and appears to correctly verify the desired behavior.

However, ensure that this test case sufficiently covers all edge cases related to the reverse mode with a key.

Verification successful

---

LGTM! Ensure sufficient test coverage.

The new test case "with key and reverse" is well-structured and appears to correctly verify the desired behavior. The presence of multiple test cases in collections_pagination_test.go indicates that pagination functionality, including reverse mode and key handling, is being tested in various scenarios.

• "nil pagination"
• "with key and limit"
• "with reverse"
• "with key and reverse"
• "with offset and count total"
• "filtered no key"
• "filtered with key"

This suggests that edge cases are likely covered.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify if the new test case "with key and reverse" sufficiently covers all edge cases.

# Test: Search for all test cases in the file. Expect: Only occurances of the test case "with key and reverse".
rg --type go -A 5 $'with key and reverse'

Length of output: 431

---

Script:

#!/bin/bash
# Description: List all test case names in collections_pagination_test.go to check for coverage of reverse mode with a key.

# List all test cases in the file
rg --type go '": {' collections_pagination_test.go

Length of output: 124

---

Script:

#!/bin/bash
# Description: List all test case names in collections_pagination_test.go to check for coverage of reverse mode with a key.

# List all test cases in the file
rg --type go '": \{' collections_pagination_test.go

Length of output: 124

---

Script:

#!/bin/bash
# Description: Find the correct path for the collections_pagination_test.go file and list all test case names in it to check for coverage of reverse mode with a key.

# Find all Go test files
fd --type f --extension go --search-path .

# List all test cases in the file once the correct path is identified
rg --type go '": \{' $(fd collections_pagination_test.go)

Length of output: 90416

types/query/collections_pagination.go (1)

335-342: LGTM! But verify the function usage in the codebase.

The changes in getCollIter correctly adjust the start key by including the prefix and increasing the start key to include it in the iteration.

However, ensure that all function calls to getCollIter are consistent with the updated logic.

CHANGELOG.md (1)

121-121: Changelog entry looks good!

The changelog entry clearly describes the fix for the collection reverse iterator to include pagination.key in the result.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f4bea14 and 59fcdb4.

Files selected for processing (1)

• types/query/collections_pagination.go (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• types/query/collections_pagination.go

[facundomedica]

nit: this is not needed, just pass prefix to IterateRaw in the place of end. Although we may want to keep it for readability

[beer-1]

yea I also think it's good for readability

[testinginprod]

lgtm