Fix typo and add test for invalid vaults.

vincentwschau commented 3 weeks ago

Changelist

Had a typo when returning valid/invalid vaults. Updated a test to catch this.

Test Plan

Unit test.

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 API functionality to handle multiple vault subaccounts, including validation for invalid entries.
Bug Fixes
- Improved data integrity by filtering vault mappings to include only those corresponding to valid perpetual markets.
Tests
- Added a new test case for scenarios involving two vault subaccounts, one being invalid, to ensure correct API behavior.

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes in this pull request involve updates to the vault-controller test suite and the VaultController class within the megavault API. A new test case has been added to handle scenarios with multiple vault subaccounts, including one invalid entry. Additionally, the getVaultMapping function has been modified to return a filtered mapping of valid vaults, ensuring only those linked to valid perpetual markets are included. This enhances data integrity while maintaining existing method signatures and control flow.

Changes

File	Change Summary
`indexer/services/comlink/__tests__/controllers/api/v4/vault-controller.test.ts`	Updated test case to handle three vault subaccounts, including one invalid. Renamed test case for clarity.
`indexer/services/comlink/src/controllers/api/v4/vault-controller.ts`	Modified `getVaultMapping` function to return filtered `validVaultMapping` instead of `vaultMapping`, ensuring only valid entries are included.

Possibly related PRs

#1513: Updates validation logic for subaccounts, potentially relevant to the handling of vault subaccounts in the test cases.
#2250: Addition of an upsert vault event, which may relate to the handling of multiple vault subaccounts.
#2287: Focus on sending upsert vault events when setting parameters, connecting with updates to vault subaccount handling.
#2376: Enhancements related to the main subaccount's PnL calculations, aligning with the focus on vault subaccounts.
#2403: Introduction of filtering for PnL ticks based on resolution, relating to updates in vault position handling.
#2454: Retrieval of the latest hourly tick for PnL calculations, connecting with vault positions and financial metrics.
#2475: Improvements to performance of vault endpoints through optimized data retrieval, relating to overall enhancements in vault handling.
#2525: Chunked retrieval of funding index maps for vault positions, directly relating to improved handling of vault data.

Suggested reviewers

shrenujb
tqin7

Poem

🐇 In the vaults where treasures lay,
A rabbit hops and starts to play.
With tests that check both strong and weak,
Valid paths are what we seek.
A mapping clear, no room for doubt,
In this code, we dance about! 🌟

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.

vincentwschau commented 2 weeks ago

@Mergifyio backport release/indexer/v7.x

mergify[bot] commented 2 weeks ago

backport release/indexer/v7.x

✅ Backports have been created

* [#2536 Fix typo and add test for invalid vaults. (backport #2535)](https://github.com/dydxprotocol/v4-chain/pull/2536) has been created for branch `release/indexer/v7.x`

dydxprotocol / v4-chain