[CT-1307] Make pnl ticks computation consistent within a transaction.

vincentwschau commented 2 weeks ago

Changelist

Fetch the latest block within the same transaction as other PnL tick data to avoid race conditions.

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.

Summary by CodeRabbit

New Features
- Enhanced PnL tick creation process by integrating the latest block data for improved accuracy.
Bug Fixes
- Updated test cases to reflect changes in the parameters and logic for creating new PnL ticks.
Documentation
- Clarified method signatures and updated internal documentation to align with new function parameters.

linear[bot] commented 2 weeks ago

CT-1307 PnL task race condition

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes in this pull request focus on modifying the pnl-ticks-helper module, specifically the getNewPnlTicks function and its associated tests. The handling of blockHeight and blockTime has been streamlined, with these parameters being removed from the function signature and replaced by values derived from the latest block. The test suite has been updated to reflect these changes, ensuring accuracy in the creation of new PnL ticks. Additionally, minor adjustments have been made to the test lifecycle management.

Changes

File Path	Change Summary
`indexer/services/roundtable/__tests__/helpers/pnl-ticks-helper.test.ts`	Updated tests for `getNewPnlTicks` to reflect changes in parameters and logic; adjusted setup and teardown processes for better state management.
`indexer/services/roundtable/src/helpers/pnl-ticks-helper.ts`	Modified `getPnlTicksCreateObjects` to remove `blockHeight` and `blockTime`, now fetching values from `latestBlock`; updated logging statements.
`indexer/services/roundtable/src/tasks/create-pnl-ticks.ts`	Changed `runTask` to call `getPnlTicksCreateObjects` with only `txId`, simplifying the function's input parameters.

Possibly related PRs

#1662: Modifies the handling of PnL ticks, directly related to the updates in the getNewPnlTicks function.
#1965: Includes changes to test cases for PnL ticks, aligning with updates made in the main PR's test suite.
#2446: Focuses on fixing issues with PnL aggregation, relevant to the changes in PnL tick creation.
#2540: Addresses de-duplication and filtering of PnL ticks for megavaults, closely related to modifications in PnL tick creation and validation.

Suggested labels

indexer, feature:indexer/affiliates

🐰 In the garden where the ticks grow,
A new way to count, as we now know.
With blocks and time, we’ve made it clear,
Creating PnL ticks brings us cheer!
So hop along, let’s test and play,
With every tick, we’ll find our way! 🥕

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

dydxprotocol / v4-chain