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

Start processing aggregate trading rewards from first reward #959

Merged
merged 2 commits into from
Jan 11, 2024

Conversation

Christopher-Li
Copy link
Contributor

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 data

Test Plan

Unit tests

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Copy link
Contributor

coderabbitai bot commented Jan 11, 2024

Walkthrough

The 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

File Path Changes
indexer/services/roundtable/__tests__/tasks/aggregate-trading-rewards.test.ts Updated test descriptions for clarity, added a new test case with specific conditions, and included additional data creation and assertions.
indexer/services/roundtable/src/tasks/aggregate-trading-rewards.ts Imported Ordering, modified a log message, and updated getNextIntervalStartWhenCacheEmpty method to better handle start time determination.

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

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits Files that changed from the base of the PR and between b4fd6fe and 7d7690f.
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 method getNextIntervalStartWhenCacheEmpty.

  • 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 the findAll 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits Files that changed from the base of the PR and between 7d7690f and fed2717.
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
Copy link
Contributor

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?

@Christopher-Li Christopher-Li merged commit c42ab34 into main Jan 11, 2024
11 checks passed
@Christopher-Li Christopher-Li deleted the cl_aggregate_bug_fix branch January 11, 2024 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants