Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[IND-171]: Do not send subaccount websocket message for unplaced and unreplaced BEST_EFFORT_OPENED orders #716

Merged
merged 1 commit into from
Oct 27, 2023

Conversation

Christopher-Li
Copy link
Contributor

Changelist

Prevent order placement events that do no place or replace on book and are BEST_EFFORT_OPENED from sending subaccount update messages

Test Plan

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 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.

@linear
Copy link

linear bot commented Oct 27, 2023

IND-171 Determine when to send subaccount websocket message in OrderPlaceHandler

In Vulcan's OrderPlaceHandler, the placeOrder method call may return placeOrderResult.placed=false and placeOrderResult.replaced=false, signifying that no updates were performed on the cache. Currently, we send a subaccount websocket message every time handle(…) is called, regardless of the outcome or changes. We should determine under which scenarios sending a message makes sense.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 27, 2023

Walkthrough

The changes primarily focus on enhancing the 'OrderPlaceHandler' module and its associated test cases. The modifications include the extraction of the 'orderPlace' object from the 'update' parameter and the addition of new parameters to the 'shouldSendSubaccountMessage' method. The test cases have been updated to reflect these changes and a new test case has been added to handle specific order placement statuses.

Changes

File Path Summary
.../vulcan/tests/handlers/order-place-handler.test.ts Test cases in the 'order-place-handler' module have been updated. The 'expectedOrderUuid' parameter has been removed and a new test case has been added to handle 'BEST_EFFORT_OPENED' placement status.
.../vulcan/src/handlers/order-place-handler.ts The OrderPlaceHandler class has been modified to extract the 'orderPlace' object from the 'update' parameter. Two new parameters, 'placeOrderResult' and 'placementStatus', have been added to the 'shouldSendSubaccountMessage' method, and the method's logic has been updated accordingly.

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.json

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between b6f48a3 and fa5421c.
Files selected for processing (2)
  • indexer/services/vulcan/tests/handlers/order-place-handler.test.ts (2} hunks)
  • indexer/services/vulcan/src/handlers/order-place-handler.ts (4} hunks)
Files skipped from review due to trivial changes (2)
  • indexer/services/vulcan/tests/handlers/order-place-handler.test.ts
  • indexer/services/vulcan/src/handlers/order-place-handler.ts

@Christopher-Li Christopher-Li merged commit 6ae2860 into main Oct 27, 2023
11 checks passed
@Christopher-Li Christopher-Li deleted the cl_order_place branch October 27, 2023 19:20
vincentwschau pushed a commit that referenced this pull request Nov 9, 2023
vincentwschau pushed a commit that referenced this pull request Nov 9, 2023
vincentwschau pushed a commit that referenced this pull request Nov 10, 2023
vincentwschau pushed a commit that referenced this pull request Nov 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants