Fix broken vulcan tests

[roy-dydx]

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

• Bug Fixes

  • Enhanced test assertions for OrderPlaceHandler, OrderRemoveHandler, OrderUpdateHandler, and onMessage functions to allow for more flexible parameter matching, improving test robustness.

• Tests

  • Updated assertions to include empty strings as valid parameters, accommodating varying instances and enhancing the reliability of test outcomes.

• New Features

  • Added an instance identifier to the metadata returned by the getMetadata method, providing additional context for logging and debugging.

[coderabbitai]

Walkthrough

The changes involve updates to various test files for the OrderPlaceHandler, OrderRemoveHandler, OrderUpdateHandler, and onMessage functions. These updates primarily focus on modifying assertions to include an empty string ("") as a parameter in stats.increment and stats.timing method calls. Additionally, the getMetadata method in the Handler class has been modified to return an instance identifier. These adjustments enhance the clarity and robustness of the tests without altering the core functionality of the functions being tested.

Changes

File Path	Change Summary
indexer/services/vulcan/__tests__/handlers/order-place-handler.test.ts, indexer/services/vulcan/__tests__/handlers/order-remove-handler.test.ts, indexer/services/vulcan/__tests__/handlers/order-update-handler.test.ts, indexer/services/vulcan/__tests__/lib/on-message.test.ts	Updated assertions to include an empty string ("") for parameters in stats.increment and stats.timing methods, enhancing clarity in tests.
indexer/services/vulcan/src/handlers/handler.ts	Modified getMetadata() method to include an instance property using getInstanceId() for enhanced metadata context.

Possibly related PRs

• Add instance to vulcan metrics #2265: The changes in this PR involve adding an instance parameter to various metrics tracking functions, which aligns with the updates made in the main PR regarding the inclusion of an empty string as a valid input for the stats.increment and stats.timing methods.

Poem

🐰 In the land where code does hop,
Tests now flex, they never stop.
With an empty string, they dance and play,
Validating logic in a clever way.
So here's to changes, bright and spry,
A leap for tests, oh my, oh my! 🌟

---

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 generate interesting stats about this repository and render them as a table.
  -- @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: 0

Outside diff range and nitpick comments (1)

indexer/services/vulcan/__tests__/lib/send-message-helper.test.ts (1)

231-231: Consider removing or populating the instance property.

The instance property is added to the tags object with an empty string value. If this property is not being utilized, consider removing it to keep the code clean and concise.

If the instance property is intended to capture relevant information, ensure it is populated with a meaningful value that provides useful insights for tracking or categorization purposes.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c2476c0 and 8dc005c.

Files selected for processing (6)

• indexer/services/vulcan/tests/handlers/order-place-handler.test.ts (1 hunks)
• indexer/services/vulcan/tests/handlers/order-remove-handler.test.ts (3 hunks)
• indexer/services/vulcan/tests/handlers/order-update-handler.test.ts (5 hunks)
• indexer/services/vulcan/tests/lib/on-message.test.ts (8 hunks)
• indexer/services/vulcan/tests/lib/send-message-helper.test.ts (1 hunks)
• indexer/services/vulcan/src/handlers/handler.ts (2 hunks)

Files skipped from review as they are similar to previous changes (5)

• indexer/services/vulcan/tests/handlers/order-place-handler.test.ts
• indexer/services/vulcan/tests/handlers/order-remove-handler.test.ts
• indexer/services/vulcan/tests/handlers/order-update-handler.test.ts
• indexer/services/vulcan/tests/lib/on-message.test.ts
• indexer/services/vulcan/src/handlers/handler.ts

[roy-dydx]

@Mergifyio backport release/indexer/v5.x

[mergify]

backport release/indexer/v5.x

✅ Backports have been created

• #2270 Fix broken vulcan tests (backport #2268) has been created for branch release/indexer/v5.x

[roy-dydx]

https://github.com/Mergifyio backport release/indexer/v6.x

[mergify]

backport release/indexer/v6.x

✅ Backports have been created

• #2271 Fix broken vulcan tests (backport #2268) has been created for branch release/indexer/v6.x