Cherry pick changes from #1 and #7

[gartnera]

Cherry pick some missing _ = stream.Close() from #1.

From #7:

• the switch from _ = stream.Close() to _ = stream.Reset()
• a timeout on a channel write
• making removePeerGroup public and calling it during other cleanup logic

Summary by CodeRabbit

• New Features

  • Improved message handling for better resource management in communication streams.
  • Introduced a timeout mechanism for sending messages, enhancing error handling and logging.
  • Enhanced cleanup process for peer group management during key signing operations.

• Bug Fixes

  • Stream management now resets instead of closing, preventing potential unresponsive behavior.

• Refactor

  • Updated method naming conventions for consistency and clarity across the codebase.

[coderabbitai]

Walkthrough

Walkthrough

The changes involve significant modifications to the handling of streams and message processing within the Communication and PartyCoordinator classes, as well as enhancements in the TssServer struct. Key alterations include replacing stream closure with stream reset operations, introducing timeout mechanisms for message sending, and renaming methods to adhere to Go's naming conventions. These updates aim to improve resource management and maintainability across the codebase.

Changes

Files	Change Summary
p2p/communication.go, p2p/party_coordinator.go	Modifications to stream handling, replacing stream.Close() with stream.Reset() in multiple functions. Added timeout for message sending. Renamed removePeerGroup to RemovePeerGroup.
tss/keysign.go	Added invocation of RemovePeerGroup in the KeySign method after releasing streams, enhancing peer group management cleanup.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Communication
    participant PartyCoordinator
    participant TssServer

    Client->>Communication: Send Message
    Communication->>PartyCoordinator: Process Message
    PartyCoordinator->>Communication: Reset Stream
    Communication->>Communication: Wait for Channel (10s)
    alt Timeout
        Communication->>Client: Log Warning
    else Success
        Communication->>PartyCoordinator: Forward Message
    end
    TssServer->>PartyCoordinator: Key Sign Request
    PartyCoordinator->>TssServer: Release Streams
    TssServer->>PartyCoordinator: Remove Peer Group

Loading

---

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

Outside diff range, codebase verification and nitpick comments (1)

p2p/communication.go (1)

180-189: Enhanced error handling and resource management in message processing.

The modifications in the readFromStream method, specifically the use of stream.Reset() at line 180 and the introduction of a timeout mechanism at lines 184-189, are well-thought-out improvements. These changes enhance the robustness and reliability of the communication process by ensuring resources are not wasted and the system remains responsive.

Consider adding more detailed logging at each step of the new timeout mechanism to aid in debugging and ensure that any issues can be traced more effectively.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9f5ae81 and b576693.

Files selected for processing (3)

• p2p/communication.go (1 hunks)
• p2p/party_coordinator.go (6 hunks)
• tss/keysign.go (1 hunks)

Additional comments not posted (2)

tss/keysign.go (1)

222-223: Proper placement of peer group cleanup.

The addition of t.partyCoordinator.RemovePeerGroup(msgID) at line 223 is correctly placed within the defer block to ensure cleanup is handled after stream releases. This change aligns with the PR's objectives to enhance resource management.

Please verify that the removal of peer groups does not interfere with ongoing operations that might still need access to these groups. This can be done by reviewing all usages of peer groups across the application to ensure there are no unintended side effects.

p2p/party_coordinator.go (1)

75-75: Stream management improvements and method renaming.

The changes to use stream.Reset() in various methods (lines 75, 98, 134) and the renaming of removePeerGroup to RemovePeerGroup (line 185) are well-implemented. These modifications enhance the robustness of stream management and improve the code's readability and maintainability by adhering to Go's naming conventions.

Ensure that the new stream handling logic is consistently applied across all relevant parts of the application to maintain uniformity and prevent any potential issues related to stream management.

Also applies to: 98-98, 134-134, 185-185