FNS - bounds check raw subscription payload int vals

[jonfung-dydx]

must be >= 0 and <= math.MaxInt32

Summary by CodeRabbit

• New Features

  • Enhanced error handling for parsing subaccount IDs and clob pair IDs, ensuring only valid inputs are processed.

• Bug Fixes

  • Added validation checks to prevent processing of invalid subaccount and clob pair IDs, improving overall system robustness.

[coderabbitai]

Walkthrough

The changes in this pull request focus on enhancing error handling in the protocol/streaming/ws/websocket_server.go file. The modifications include importing the math package for integer range validation, alongside implementing validation checks in the parseSubaccountIds and parseClobPairIds functions. These checks ensure that parsed IDs are within valid integer ranges, returning errors for invalid inputs to improve the robustness of the WebSocket server.

Changes

File Path	Change Summary
protocol/streaming/ws/websocket_server.go	- Imported math package for integer validation. - Added validation checks in parseSubaccountIds and parseClobPairIds functions to ensure IDs are within valid ranges.

Possibly related PRs

• FNS polish - metrics, max msg size, default flag values #2517: The changes in the protocol/streaming/ws/websocket_server.go file in this PR are directly related to the main PR as both involve modifications to the WebSocket server, specifically enhancing the handling of message sizes and improving error handling for subaccount IDs and clob pair IDs.

Suggested labels

protocol

Suggested reviewers

• jayy04
• dydxwill

Poem

In the server's heart, a change so bright,
Valid IDs now dance in the light.
With checks in place, no more will stray,
Subaccounts and clobs, safe on their way.
Hopping with joy, we celebrate this feat,
A robust WebSocket, oh what a treat! 🐇✨

---

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: 0

🧹 Outside diff range and nitpick comments (2)

protocol/streaming/ws/websocket_server.go (2)

126-129: LGTM: Bounds check for subaccount number.

The added validation check ensures that the subaccount number is within the valid range (0 to MaxInt32), which aligns with the PR objective. The error message is clear and informative.

Consider using a constant for the maximum value to improve maintainability:

+const MaxSubaccountNumber = math.MaxInt32

-if number < 0 || number > math.MaxInt32 {
+if number < 0 || number > MaxSubaccountNumber {
    return nil, fmt.Errorf("invalid subaccount number: %s", parts[1])
}

---

152-154: LGTM: Bounds check for clob pair ID.

The added validation check ensures that the clob pair ID is within the valid range (0 to MaxInt32), which aligns with the PR objective. The error message is clear and informative.

For consistency with the parseSubaccountIds function, consider using a constant for the maximum value:

+const MaxClobPairId = math.MaxInt32

-if id < 0 || id > math.MaxInt32 {
+if id < 0 || id > MaxClobPairId {
    return nil, fmt.Errorf("invalid clob pair id: %s", idStr)
}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b829b28 and 47cfb5b.

📒 Files selected for processing (1)

• protocol/streaming/ws/websocket_server.go (3 hunks)

🧰 Additional context used

🔇 Additional comments (2)

protocol/streaming/ws/websocket_server.go (2)

6-6: LGTM: Import of math package.

The addition of the math package import is necessary and correctly placed for the new validation checks using math.MaxInt32.

---

Line range hint 1-193: Overall assessment: Changes meet PR objectives and improve code robustness.

The implemented bounds checks for subaccount numbers and clob pair IDs align with the PR objectives. These changes enhance the error handling and prevent potential issues with invalid input. The implementation is consistent across both parsing functions.

Consider the suggested minor improvements for using constants to define the maximum values, which would enhance maintainability and consistency.

Great job on improving the input validation!