-
Notifications
You must be signed in to change notification settings - Fork 104
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
Start processing aggregate trading rewards from first reward #959
Conversation
WalkthroughThe recent updates have refined the testing and functionality of a trading rewards aggregation feature. Test cases now cover more specific scenarios, with a new test ensuring certain conditions are properly handled. Additionally, the core task logic has been improved to more accurately determine the start time for intervals, particularly when the cache is empty. This enhancement likely aims to improve the reliability and accuracy of reward calculations. Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (2)
- indexer/services/roundtable/tests/tasks/aggregate-trading-rewards.test.ts (3 hunks)
- indexer/services/roundtable/src/tasks/aggregate-trading-rewards.ts (4 hunks)
Additional comments: 6
indexer/services/roundtable/src/tasks/aggregate-trading-rewards.ts (4)
13-13: The addition of the
Ordering
import is noted and appears to be used correctly in the updated methodgetNextIntervalStartWhenCacheEmpty
.160-160: The log message has been updated to provide clarity that the
AggregateTradingRewardsProcessedCache
is empty. This is a good practice for better understanding the system's state during debugging.190-212: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [176-207]
The logic in the
getNextIntervalStartWhenCacheEmpty
method has been adjusted to handle different scenarios for determining the start time. The method now checks for the most recent complete aggregation, the existence of a trading reward, or defaults to the first block in the database. This change is crucial to the bug fix and aligns with the PR objectives to start processing from the first trading reward.
- 193-209: The use of the
Ordering
import within thefindAll
method call is correct and ensures that the trading rewards are ordered by block time in ascending order. This is necessary for the logic that determines the start time for processing rewards.indexer/services/roundtable/__tests__/tasks/aggregate-trading-rewards.test.ts (2)
124-124: The test descriptions have been updated to be more specific, which is a good practice for clarity and understanding the purpose of each test case.
166-200: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [144-195]
A new test case has been added to cover the scenario where the cache is empty, and a trading reward exists. This test ensures that the new logic for determining the start time for processing rewards is functioning as expected. The creation of new data and assertions within this test case are appropriate and necessary for validating the updated behavior.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- indexer/services/roundtable/src/tasks/aggregate-trading-rewards.ts (4 hunks)
Files skipped from review as they are similar to previous changes (1)
- indexer/services/roundtable/src/tasks/aggregate-trading-rewards.ts
at: 'aggregate-trading-rewards#getNextIntervalStartWhenCacheEmpty', | ||
message: 'No trading rewards in database, relying on first block time to pick first start time', | ||
}); | ||
// Since we were able to find the latest block, we assume we can find the first block |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Where in this function are we finding the latest block?
Changelist
Fix bug that in a long running chain with only
trading_rewards
recently introduced, we should process aggregate trading rewards from the first trading reward instead of the first block, other we'll be processing no dataTest Plan
Unit tests
Author/Reviewer Checklist
state-breaking
label.indexer-postgres-breaking
label.PrepareProposal
orProcessProposal
, manually add the labelproposal-breaking
.feature:[feature-name]
.backport/[branch-name]
.refactor
,chore
,bug
.