feat(db): make store sort comparators contract-safe #135
Open
halibobo1205 wants to merge 2 commits into
Open
Conversation
The getAll*/getSpecified* store methods sorted with hand-rolled comparators (`a <= b ? 1 : -1`) that never return 0, violating the Comparator contract: List.sort can throw IllegalArgumentException and the sort intent is unclear. Replace them with Comparator.comparingLong / comparing so equal keys return 0. getSpecifiedProposals must additionally keep equal-expiration proposals in descending-id order. Live execution applies the highest id first and the lowest id last (final value), and the energy/bandwidth price-history loaders rebuild from the tail, so the lowest id must be last. The old never-return-0 comparator produced this order by accident; plain ascending expiration order inverts it and reconstructs the wrong price. Add an explicit descending-id tie-break to preserve the behavior.
Add a custom ErrorProne BugChecker that flags Comparator/compareTo bodies which can never return 0 (e.g. `? 1 : -1`). The built-in ComparisonContractViolated inspects only method declarations, so it cannot see the lambda comparators this repo actually uses; this checker covers the lambda form and method declarations, matching genuine overrides via findSuperMethods so same-named overloads are not flagged. It is a conservative syntactic check (direct constant or ternary-of- constant returns only, no data-flow). Enable it as ERROR in the allowlist, and add the test-helper dependencies to verification-metadata so the checker tests run under strict dependency verification.
|
CodeAnt AI is reviewing your PR. |
Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
codeant-ai
Bot
added
the
size:XL
Owner
Author
|
@codex: review |
|
Codex Review: Didn't find any major issues. Swish! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
|
CodeAnt AI finished reviewing your PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
What does this PR do?
AssetIssueStore,ExchangeStore, andProposalStorewith standardComparatorimplementations.expected price-history reconstruction behavior.
return
0, including lambdas and method declarations.Why is this required?
Comparators that never return
0violate the comparator contract and may causeList.sortto throwIllegalArgumentException.Proposal ordering also affects energy and bandwidth price-history reconstruction.
The descending-ID tie-break ensures proposals with the same expiration time produce
the same final value as live proposal execution.
The custom ErrorProne checker prevents the invalid comparator pattern from being
introduced again and covers lambda comparators that the built-in checker does not.
How was this tested?
CodeAnt-AI Description
Make store sorting contract-safe and preserve equal-expiration proposal order
What Changed
Impact
✅ Fewer sort crashes on large result lists✅ Correct energy price history when proposals expire at the same time✅ Stable asset, exchange, and proposal ordering for users💡 Usage Guide
Checking Your Pull Request
Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.
Talking to CodeAnt AI
Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:
This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.
Example
Preserve Org Learnings with CodeAnt
You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:
This helps CodeAnt AI learn and adapt to your team's coding style and standards.
Example
Retrigger review
Ask CodeAnt AI to review the PR again, by typing:
Check Your Repository Health
To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.