Fix flaky vault test.

[vincentwschau]

Changelist

Data points in the unit tests can be filtered out due to the default limit of 3 days of hourly PnL ticks based on the day, causing the test to be flaky.

Test Plan

Re-ran 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

• Tests
  • Introduced a configuration variable for vault PnL history hours to enhance testing flexibility.
  • Updated test setup and teardown processes to dynamically adjust and reset the configuration for historical PnL data retrieval.
  • Added comments for improved readability and maintainability of test code.

[coderabbitai]

Walkthrough

The changes involve the introduction of a configuration variable for vault PnL history hours in the vault-controller.test.ts file. The test setup is modified to set this variable to 168 hours before each test and reset it afterward. This allows for more flexible testing of historical PnL retrieval without altering the structure or assertions of the existing test cases. Comments are added to enhance the clarity of the configuration changes.

Changes

File Path	Change Summary
indexer/services/comlink/__tests__/controllers/api/v4/vault-controller.test.ts	Introduced a configuration variable for vault PnL history hours, updated test setup and teardown, added comments for clarity.

Possibly related PRs

• [TRA-571] Add resolution argument to vault PnL endpoint. #2282: Enhances the testing of the vault controller's historical PnL endpoints, related to the configuration variable changes.
• Use vault table rather than placeholder config flags to fetch vaults. #2364: Modifies the vault-controller to fetch vaults directly from the database, aligning with improved test setups.
• Include getting main subaccount equity / pnl for megavault PnL query. #2376: Includes enhancements for retrieving the main subaccount's equity for PnL calculations, relevant to the test setup adjustments.
• Filter out to single tick per interval. #2403: Introduces a filtering function for PnL ticks, related to handling historical PnL data in tests.

Suggested labels

indexer

Suggested reviewers

• shrenujb

Poem

In the vault where numbers play,
A change was made, hip-hip-hooray!
With hours set to one-six-eight,
Our tests now dance, oh what a fate!
A hop, a skip, a PnL cheer,
For clearer tests, we hold so dear! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d89e1a5 and a1ad2ea.

📒 Files selected for processing (1)

• indexer/services/comlink/tests/controllers/api/v4/vault-controller.test.ts (4 hunks)

🔇 Additional comments (5)

indexer/services/comlink/__tests__/controllers/api/v4/vault-controller.test.ts (5)

24-24: LGTM: Import statement for config module added.

The addition of the import statement for the config module is necessary and correctly placed.

---

41-41: LGTM: Variable added to store original VAULT_PNL_HISTORY_HOURS value.

The addition of vaultPnlHistoryHoursPrev is a good practice. It allows for restoring the original configuration after the tests, ensuring that the tests don't have side effects on the global configuration.

---

53-54: LGTM: VAULT_PNL_HISTORY_HOURS set to 168 hours (1 week) for tests.

Setting config.VAULT_PNL_HISTORY_HOURS to 168 ensures that the tests consistently use a week's worth of hourly PnL ticks. The added comment clearly explains the purpose of this change, improving code readability.

---

116-116: LGTM: VAULT_PNL_HISTORY_HOURS restored after each test.

Resetting config.VAULT_PNL_HISTORY_HOURS to its original value in the afterEach hook is crucial. This ensures that the configuration change doesn't affect other tests and maintains the initial state of the configuration.

---

24-24: Summary: Changes improve test reliability by standardizing VAULT_PNL_HISTORY_HOURS.

These changes effectively address the flaky vault test issue mentioned in the PR objectives. By setting VAULT_PNL_HISTORY_HOURS to a consistent value of 168 hours (1 week) for all tests, you ensure that the same amount of data is always available, regardless of when the tests are run. This standardization reduces the likelihood of data points being filtered out based on the day, thus improving test reliability.

The careful management of the configuration value, including storing the original value and restoring it after each test, demonstrates good testing practices. These changes should result in more consistent and reliable test outcomes.

Also applies to: 41-41, 53-54, 116-116

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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>, 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[vincentwschau]

@Mergifyio backport release/indexer/v7.x

[mergify]

backport release/indexer/v7.x

✅ Backports have been created

• #2424 Fix flaky vault test. (backport #2422) has been created for branch release/indexer/v7.x