Fix flaky Candles test

[adamfraser]

Fixes issue from an incorrect merge conflict. Uses the correct start times to test for candle updates.

Summary by CodeRabbit

• Tests
  • Enhanced the test suite for the CandlesGenerator functionality to improve validation of candle creation and updates.
  • Adjusted test logic for candle timing to ensure accurate handling of edge cases.
  • Added assertions for open interest and trade presence to better reflect real-world scenarios.
  • Included comments for clarity on test operations.

[coderabbitai]

Walkthrough

The pull request modifies the test suite for the CandlesGenerator functionality in candles-generator.test.ts. It adjusts the candle creation logic to set the startedAt property to a time 100 minutes prior to the current test time, affecting multiple test cases. The updates ensure that the expected state of candles in the database reflects new startedAt values and correctly updates orderbookMidPriceClose. The structure of the tests is enhanced with additional assertions regarding open interest and trade presence, while comments are added for clarity.

Changes

File Path	Change Summary
indexer/services/ender/tests/lib/candles-generator.test.ts	Adjusted candle creation logic for startedAt, updated assertions for orderbookMidPriceClose, and enhanced test structure with comments.

Possibly related PRs

• Candles HLOC Data #1887: Introduces orderbookMidPriceOpen and orderbookMidPriceClose fields, related to the changes in candle generation tests.
• Adam/ct 1059 address issue with orderbookmidprice calculation #2012: Addresses issues with orderbookMidPrice calculations, relevant to the updates in candle generation logic.
• Fix issue with flaky candle test #2430: Enhances candle generation tests to validate orderbookMidPriceClose and orderbookMidPriceOpen, aligning with the main PR's changes.
• Return undefined from getOrderbookMidPriceMap #2441: Modifies getOrderbookMidPriceMap to return undefined, impacting order book price handling in candle generation.

Suggested reviewers

• dydxwill

🐰 In the garden where candles glow,
A hundred minutes set the flow.
With prices mid and trades in sight,
Our tests now dance in pure delight!
New logic blooms, the edges meet,
In every case, our work's complete! 🌟

---

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.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3566800 and 7679696.

📒 Files selected for processing (1)

• indexer/services/ender/__tests__/lib/candles-generator.test.ts (4 hunks)

🔇 Additional comments (1)

indexer/services/ender/__tests__/lib/candles-generator.test.ts (1)

591-595: Duplicate startTime calculation found

This startTime calculation duplicates code from earlier tests (lines 488-493). Please refer to the previous comment about refactoring into a helper function.

[coderabbitai]

🛠️ Refactor suggestion

Refactor repeated startTime calculation into a helper function

The calculation of startTime by subtracting 100 minutes is duplicated in multiple tests (lines 488-493 and 591-595). Extracting this logic into a helper function will enhance code maintainability and adhere to the DRY principle.

Here is a suggested refactor:

+function getPastStartTime(minutesAgo: number): IsoString {
+  return helpers.calculateNormalizedCandleStartTime(
+    testConstants.createdDateTime.minus({ minutes: minutesAgo }),
+    CandleResolution.ONE_MINUTE,
+  ).toISO();
+}

Then replace in your tests:

-const startTime: IsoString = helpers.calculateNormalizedCandleStartTime(
-  testConstants.createdDateTime.minus({ minutes: 100 }),
-  CandleResolution.ONE_MINUTE,
-).toISO();

with:

+const startTime: IsoString = getPastStartTime(100);

Committable suggestion skipped: line range outside the PR's diff.