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

Add blockHeight to subaccount websocket msg contents #1523

Closed
wants to merge 1 commit into from

Conversation

dydxwill
Copy link
Contributor

@dydxwill dydxwill commented May 15, 2024

Changelist

Add blockHeight to subaccount websocket msg contents

Test Plan

Unit tested.

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
    • Improved message forwarding by including the blockHeight property in message contents, ensuring more accurate data processing.

Copy link
Contributor

coderabbitai bot commented May 15, 2024

Walkthrough

The recent changes focus on incorporating a new blockHeight property into the message processing flow within the socks service of the indexer. This involves updating test files to assert the presence of blockHeight and modifying the getMessageToForward function to extract and include blockHeight in the message contents.

Changes

Files Summary
.../socks/__tests__/helpers/from-kafka-helpers.test.ts Updated assertions to include the blockHeight property in messageToForward.contents.
.../socks/__tests__/lib/message-forwarder.test.ts Added blockHeight to function calls and modified checkBatchMessage to include blockHeight in expected messages.
.../socks/src/helpers/from-kafka-helpers.ts Modified getMessageToForward to check for blockHeight in subaccountMessage and assign it to the contents object.

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
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>.
    • 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 show all the console.log statements in this repository.
    • @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.

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 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

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.

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between f2e72c6 and 704d068.
Files selected for processing (3)
  • indexer/services/socks/tests/helpers/from-kafka-helpers.test.ts (1 hunks)
  • indexer/services/socks/tests/lib/message-forwarder.test.ts (5 hunks)
  • indexer/services/socks/src/helpers/from-kafka-helpers.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • indexer/services/socks/tests/helpers/from-kafka-helpers.test.ts
Additional Context Used
Path-based Instructions (2)
indexer/services/socks/src/helpers/from-kafka-helpers.ts (1)

Pattern **/**: Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.

indexer/services/socks/__tests__/lib/message-forwarder.test.ts (1)

Pattern **/**: Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.

Additional comments not posted (2)
indexer/services/socks/src/helpers/from-kafka-helpers.ts (1)

42-45: Ensure blockHeight is correctly added to contents.

The addition of blockHeight to the contents object is correct and ensures that the blockHeight is included in the forwarded message if it exists in the subaccountMessage.

indexer/services/socks/__tests__/lib/message-forwarder.test.ts (1)

362-362: Ensure blockHeight is correctly included in the expected message comparison.

The addition of blockHeight to the expected message comparison in the checkBatchMessage function is correct and ensures that the blockHeight is included in the batch message validation.

Also applies to: 434-434, 451-451, 564-564, 576-580

@dydxwill dydxwill closed this May 28, 2024
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.

1 participant