Add cumulativeEntryPrice migration

[dydxwill]

Changelist

[Describe or list the changes made in this PR]

Test Plan

[Describe how this PR was tested (if applicable)]

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

Release Notes

• New Features

  • Introduced a new property, cumulativeEntryPrice, to enhance tracking of entry prices in perpetual positions across various interfaces and models.

• Bug Fixes

  • Improved error handling in tests related to closing positions, ensuring system robustness.

• Tests

  • Expanded test coverage for perpetual position functionalities, including new scenarios for closing positions and handling edge cases.

• Chores

  • Added migration for the cumulativeEntryPrice column in the database, ensuring data integrity and structure.

[coderabbitai[bot]]

Walkthrough

The changes in this pull request introduce a new property, cumulativeEntryPrice, across various components related to perpetual positions. This property is added to types, interfaces, and models, enhancing their structure to track cumulative entry prices effectively. Additionally, test cases are updated to incorporate this new property, ensuring that calculations and validations reflect the changes. A migration script is also included to modify the database schema accordingly, allowing for the storage of this new data.

Changes

File	Change Summary
indexer/packages/postgres/__tests__/db/helpers.test.ts	Added cumulativeEntryPrice to PerpetualPositionFromDatabase type; tests updated to utilize this property.
indexer/packages/postgres/__tests__/helpers/constants.ts	Added cumulativeEntryPrice to defaultPerpetualPosition and isolatedPerpetualPosition objects.
indexer/packages/postgres/__tests__/stores/perpetual-position-table.test.ts	Added and modified tests for PerpetualPositionTable, enhancing coverage and error handling.
indexer/packages/postgres/src/db/helpers.ts	Modified getUnrealizedPnl function to use cumulativeEntryPrice instead of entryPrice.
indexer/packages/postgres/src/db/migrations/migration_files/20241022151729_add_perpetual_positions_cumulative_entry_price.ts	Added migration to include cumulativeEntryPrice column in perpetual_positions table.
indexer/packages/postgres/src/models/perpetual-position-model.ts	Added cumulativeEntryPrice to PerpetualPositionModel class and its schema.
indexer/packages/postgres/src/types/db-model-types.ts	Added cumulativeEntryPrice property to PerpetualPositionFromDatabase interface.
indexer/packages/postgres/src/types/perpetual-position-types.ts	Added cumulativeEntryPrice to several interfaces and an enum related to perpetual positions.
indexer/packages/postgres/src/types/websocket-message-types.ts	Added cumulativeEntryPrice to PerpetualPositionSubaccountMessageContents interface.

Possibly related PRs

• #2415: This PR focuses on fixing the entry price calculation, which is directly related to the changes made in the main PR regarding the cumulativeEntryPrice property in the PerpetualPositionFromDatabase type.
• #2455: This PR reverts the changes made in PR #2415, indicating that it is also related to the entry price calculation, which connects back to the main PR's modifications involving the cumulativeEntryPrice.

Suggested labels

feature:indexer/affiliates

Suggested reviewers

• vincentwschau
• tqin7
• Christopher-Li

🐇 In the garden, I hop and play,
With cumulativeEntryPrice here to stay.
Numbers dance, and tests align,
In perpetual joy, our code will shine!
So let’s celebrate, with carrots in sight,
Our changes are done, all feels just right! 🥕✨

---

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.