Full Node Streaming - reorder protobuf single length fields before variable length fields

[jonfung-dydx]

Reorders the non-array based debug fields (snapshot, exec mode, block height) before the variable len fields (i.e updates). This does not break any behavior.

Summary by CodeRabbit

• New Features
  • Introduced new fields block_height and exec_mode to enhance the StreamUpdate message structure.
• Improvements
  • Reordered properties within the StreamUpdate and StreamOrderbookUpdate messages for better clarity and context.
  • Updated encoding and decoding logic to align with the new property order, improving data flow.
• Documentation
  • Retained comments for clarity on the purpose of properties in the updated messages.

[coderabbitai]

Walkthrough

The changes in this pull request involve reordering properties within the StreamUpdate and StreamOrderbookUpdate interfaces in TypeScript, as well as modifying the corresponding messages in the Protocol Buffers file. New fields block_height and exec_mode are added to the StreamUpdate message, while existing fields are renumbered to accommodate these additions. The adjustments aim to enhance the structure and clarity of the streamed data without introducing new functionality.

Changes

File Path	Change Summary
indexer/packages/v4-protos/src/codegen/dydxprotocol/clob/query.ts	Reordered properties in StreamUpdate and StreamOrderbookUpdate interfaces; updated encoding/decoding logic.
proto/dydxprotocol/clob/query.proto	Added block_height and exec_mode to StreamUpdate; renumbered existing fields and reordered StreamOrderbookUpdate fields.

Possibly related PRs

• [CT-1178] Only emit finalized subaccount update #2181: Modifies ClobKeeper mock implementation to handle additional parameters for subaccount updates, relevant to the main PR.

Suggested labels

protocol

Poem

🐇 In the garden where data flows,
A rabbit hops where the order grows.
With fields rearranged and new ones in sight,
Our streams now dance in the soft moonlight.
Hooray for the changes, a joyful cheer,
For clarity blooms, and the code is clear! 🌼

Tip

New features

Walkthrough comment now includes:

• Possibly related PRs: A list of potentially related PRs to help you recall past context.
• Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

• Please share any feedback in the discussion post on our Discord.
• Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

---

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 66f27b0 and 54eece7.

Files ignored due to path filters (1)

• protocol/x/clob/types/query.pb.go is excluded by !**/*.pb.go

Files selected for processing (2)

• indexer/packages/v4-protos/src/codegen/dydxprotocol/clob/query.ts (6 hunks)
• proto/dydxprotocol/clob/query.proto (1 hunks)

Additional comments not posted (4)

proto/dydxprotocol/clob/query.proto (2)

185-197: Confirm field additions and renumbering in StreamUpdate.

The addition of block_height and exec_mode at the start of the StreamUpdate message and the renumbering of existing fields within the oneof update_message are noted. Ensure that these changes do not break backward compatibility or that all clients can handle these changes simultaneously.

---

208-213: Confirm field reordering in StreamOrderbookUpdate.

The snapshot field has been moved to be the first field, and the updates field has been renumbered. Confirm that this reordering is consistent with the intended use of these fields in the system.

indexer/packages/v4-protos/src/codegen/dydxprotocol/clob/query.ts (2)

301-304: Confirm property reordering in StreamUpdate.

The properties orderbookUpdate, orderFill, takerOrder, and subaccountUpdate have been moved to the end of the StreamUpdate interface. Confirm that this reordering is consistent with the changes in the protobuf definitions and does not adversely affect serialization or deserialization processes.

Also applies to: 317-320

---

335-340: Confirm property reordering in StreamOrderbookUpdate.

The updates property has been moved to follow the snapshot property. Confirm that this reordering is consistent with the changes in the protobuf definitions and does not adversely affect serialization or deserialization processes.

Also applies to: 355-360

[jonfung-dydx]

@Mergifyio backport release/protocol/v5.2.x

[mergify]

backport release/protocol/v5.2.x

✅ Backports have been created

• #2231 Full Node Streaming - reorder protobuf single length fields before variable length fields (backport #2227) has been created for branch release/protocol/v5.2.x