Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Start DRY'ing filtered paginate code #16099

Merged
merged 17 commits into from May 15, 2023

Conversation

ValarDragon
Copy link
Contributor

@ValarDragon ValarDragon commented May 11, 2023

Description

Reduce some of the lines of code in this filtered paginate code. Got linked to it, and got bothered by how much code repetition / extra logic there is.

Feel free to close if not worth the review capacity, or to take over.


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
  • added ! to 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
  • followed the guidelines for building modules
  • included the necessary unit and integration tests - Covered by existing. (See erroneous changes failing earlier!)
  • added a changelog entry to CHANGELOG.md - Not at all user facing
  • included comments for documenting Go code - Strictly makes the code easier to understand imo
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • 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.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@ValarDragon ValarDragon changed the title Start DRY'ing filtered paginate code refactor: Start DRY'ing filtered paginate code May 11, 2023
@@ -85,6 +85,16 @@ func FilteredPaginate(
end := offset + limit

for ; iterator.Valid(); iterator.Next() {
if numHits == end+1 {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I got this wrong right here, because it looks at iterator.Key(). (Which is a different value in this loop)

This is a bit annoying to make consistent with the old behavior. Will adjust the de-duplicated loop to get this consistent

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically the old behavior would ideally worked with numHits = end right here.

But it actually made nextKey skip to the next hit, which is kind of annoying to get to work.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current PR has this problem fixed.

In a later breaking release when redesigning the Filtered paginate, I would recommend changing this behavior. (As it will both be more correct from a performance expectation perspective, and code quality cleanup. We could delete all the extra for loops everywhere.)

However this PR is fully non-breaking.

@ValarDragon ValarDragon marked this pull request as ready for review May 11, 2023 10:14
@ValarDragon ValarDragon requested a review from a team as a code owner May 11, 2023 10:14
@github-prbot github-prbot requested review from a team, mark-rushakoff and facundomedica and removed request for a team May 11, 2023 10:16
@ValarDragon
Copy link
Contributor Author

ValarDragon commented May 11, 2023

Failing tests seem like github issues? (They all say rate limit)

All actual go tests still pass

@ValarDragon
Copy link
Contributor Author

ValarDragon commented May 11, 2023

Ready for review / no more planned updates!

Copy link
Contributor

@testinginprod testinginprod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, minor nit for docs reason. Thanks.

types/query/pagination.go Outdated Show resolved Hide resolved
ValarDragon and others added 2 commits May 12, 2023 12:15
Co-authored-by: testinginprod <98415576+testinginprod@users.noreply.github.com>
@ValarDragon
Copy link
Contributor Author

ValarDragon commented May 15, 2023

Putting into the merge when ready queue (as its blocking another PR), and is fully compatible / not state machine affecting

@ValarDragon ValarDragon added this pull request to the merge queue May 15, 2023
Merged via the queue into main with commit 660e906 May 15, 2023
50 checks passed
@ValarDragon ValarDragon deleted the dev/filtered_paginate_cleanup branch May 15, 2023 19:43
ValarDragon added a commit to osmosis-labs/cosmos-sdk that referenced this pull request May 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants