Don't increment messageId for custom ping messages

[dydxwill]

Changelist

don't increment messageId for custom ping messages

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

  • Improved handling of message IDs for subscription and unsubscription processes, ensuring accurate tracking of messages.
  • Added checks for active connections to prevent operations on closed connections.

• Chores

  • Updated logging statements for better clarity on subscription and unsubscription activities.

[coderabbitai]

Walkthrough

The changes in this pull request focus on enhancing the handling of message IDs within the Index class's onMessage method in the WebSocket service. Modifications include incrementing the messageId property after processing subscription and unsubscription messages, ensuring accurate tracking of messages per connection. Additionally, a check for the existence of the connection before incrementing the messageId has been implemented to manage closed connections effectively. Minor adjustments to logging statements were also made for clarity.

Changes

File Path	Change Summary
indexer/services/socks/src/websocket/index.ts	Modified onMessage method to increment messageId after processing subscription/unsubscription messages; added checks for existing connections before incrementing; updated logging statements.

Possibly related PRs

• Fix issue with message-forwarder tests #2002: This PR involves modifications related to message handling in tests, which may connect to the changes in message ID handling in the main PR.
• Fix vulcan post processing metrics not emitted for short term orders #2244: Although primarily focused on metrics, it involves message processing, which could relate to the message handling improvements in the main PR.
• Fix test flakiness due to using inconsistent time. #2485: This PR addresses test flakiness due to time inconsistencies, which may indirectly relate to the message handling logic being tested in the main PR.

Suggested labels

indexer

Poem

🐰 In the world of webs and streams,
Message IDs dance in dreams.
With each subscription, they take flight,
Tracking messages, oh what a sight!
A hop, a skip, they’re handled right,
In the code, they shine so bright! 🌟

---

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 (1)

indexer/services/socks/src/websocket/index.ts (1)

314-315: LGTM with suggestion: Incrementing messageId for unsubscribe messages

This change ensures that each unsubscribe message receives a unique messageId. It's correctly placed after calling this.subscriptions.unsubscribe() and before sending the unsubscribed message. This modification aligns with the PR objective of improving the handling of messageId.

However, to enhance robustness, consider adding a safety check:

Consider adding a safety check before incrementing the messageId:

+  if (this.connections[connectionId]) {
     this.connections[connectionId].messageId += 1;
+  }

This will prevent potential errors if the connection is closed between the unsubscribe operation and the message sending.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ca15c4d and 179766c.

📒 Files selected for processing (1)

• indexer/services/socks/src/websocket/index.ts (2 hunks)

🧰 Additional context used

🔇 Additional comments (2)

indexer/services/socks/src/websocket/index.ts (2)

283-284: LGTM: Incrementing messageId for subscription messages

This change ensures that each subscription message receives a unique messageId. It's correctly placed after validating the subscription message and before calling this.subscriptions.subscribe(). This modification aligns with the PR objective of improving the handling of messageId.

---

Line range hint 1-500: Verify alignment with PR objectives

The changes implemented improve the handling of messageId for subscription and unsubscription messages, which aligns with part of the PR objectives. However, the PR summary mentions a specific change regarding custom ping messages:

The primary change introduced in this PR is the modification of the handling of messageId for custom ping messages, specifically ensuring that the messageId is not incremented for these messages.

This specific change for custom ping messages is not evident in the current implementation. Could you clarify if this aspect of the PR objective has been addressed elsewhere or if it needs to be implemented?

To verify the handling of custom ping messages, you can run the following script:

This will help identify if the custom ping message handling is implemented elsewhere in the codebase.

[dydxwill]

@Mergifyio backport release/indexer/v7.x

[dydxwill]

@Mergifyio backport release/indexer/v6.x

[mergify]

backport release/indexer/v7.x

✅ Backports have been created

• #2497 Don't increment messageId for custom ping messages (backport #2493) has been created for branch release/indexer/v7.x

[mergify]

backport release/indexer/v6.x

✅ Backports have been created

• #2498 Don't increment messageId for custom ping messages (backport #2493) has been created for branch release/indexer/v6.x