Skip to content

feat(hopr-lib): Add a reserved flag to the KeepAlive Session message #7263

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 23, 2025
Merged

feat(hopr-lib): Add a reserved flag to the KeepAlive Session message #7263

merged 1 commit into from
Jun 23, 2025
+24 −8

Conversation

NumberFour8
Copy link
Contributor

This allows KeepAlive to evolve in the future, without changing the backwards compatibility.

@NumberFour8
Add a reserved flag to the KeepAlive Session message
0d6d59f 
This allows KeepAlive to evolve in the future, without changing the backwards compatibility.
@NumberFour8 NumberFour8 added this to the 3.0.0 milestone Jun 23, 2025
@NumberFour8 NumberFour8 requested a review from a team June 23, 2025 09:22
@NumberFour8 NumberFour8 self-assigned this Jun 23, 2025
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 23, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

The changes introduce a new struct, KeepAliveMessage<T>, to encapsulate the session ID and a reserved flags field for the KeepAlive variant of the StartProtocol enum. All usages, encoding/decoding logic, and test code were updated to use this struct instead of a raw session ID.

Changes

File(s) Change Summary
transport/session/src/initiation.rs Replaced StartProtocol::KeepAlive(T) with StartProtocol::KeepAlive(KeepAliveMessage<T>); added struct KeepAliveMessage<T> with id and flags; updated encoding/decoding and tests; added From<T> for KeepAliveMessage<T>.
transport/session/src/manager.rs Updated construction and pattern matching for StartProtocol::KeepAlive to use KeepAliveMessage<T> instead of raw session ID.

Sequence Diagram(s)

sequenceDiagram
    participant SessionManager
    participant StartProtocol
    participant KeepAliveMessage

    SessionManager->>KeepAliveMessage: Create from session_id (.into())
    KeepAliveMessage->>StartProtocol: Wrap in KeepAlive variant
    StartProtocol->>SessionManager: Message received (KeepAlive)
    SessionManager->>KeepAliveMessage: Extract id from msg.id
Loading

Suggested reviewers

  • Teebor-Choka
📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a2b0727 and 0d6d59f.

📒 Files selected for processing (2)
  • transport/session/src/initiation.rs (5 hunks)
  • transport/session/src/manager.rs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: hoprd / docker
  • GitHub Check: hopli / docker
  • GitHub Check: Docs / Rust docs
  • GitHub Check: Linter
  • GitHub Check: zizmor
  • GitHub Check: Build Candidate Binaries (hopli)
  • GitHub Check: tests-unit-nightly
  • GitHub Check: tests-smart-contracts
  • GitHub Check: Build Candidate Binaries (hoprd)
  • GitHub Check: tests-unit
🔇 Additional comments (10)
transport/session/src/initiation.rs (8)

90-91: LGTM! Clean enum variant refactoring.

The change from KeepAlive(T) to KeepAlive(KeepAliveMessage<T>) properly encapsulates the keep-alive data and enables future extensibility.

93-100: Well-designed struct with clear documentation.

The KeepAliveMessage<T> struct properly encapsulates the session ID and reserved flags field. The documentation clearly indicates the flags field is reserved for future use and currently always zero.

102-106: Excellent convenience implementation.

The From<T> implementation provides a clean way to convert session IDs to KeepAliveMessage while properly initializing the flags field to zero.

140-142: Encoding logic correctly updated.

The encoding now properly serializes the entire KeepAliveMessage struct instead of just the session ID, which is necessary for the new format.

184-187: Decoding logic properly handles the new struct.

The decoding correctly deserializes the KeepAliveMessage struct, maintaining consistency with the encoding changes.

349-349: Test correctly uses the new conversion pattern.

Using 10.into() properly tests the From<T> implementation for converting session IDs to KeepAliveMessage.

407-407: Test updated appropriately for new message format.

The test correctly uses .into() to convert the SessionId to KeepAliveMessage, ensuring the packet size constraints are tested with the new format.

419-419: SURB capacity test properly updated.

The test correctly uses the new message format to verify that KeepAlive messages allow for maximum SURBs in the packet.

transport/session/src/manager.rs (2)

435-435: Correct usage of the new message format.

Using session_id.into() properly converts the session ID to a KeepAliveMessage with flags set to zero, maintaining backward compatibility while enabling future extensibility.

927-928: Pattern matching correctly updated for new message structure.

The change from StartProtocol::KeepAlive(session_id) to StartProtocol::KeepAlive(msg) with subsequent extraction of msg.id properly handles the new KeepAliveMessage struct while maintaining the same functionality.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

@NumberFour8 NumberFour8 marked this pull request as ready for review June 23, 2025 09:22
@Teebor-Choka Teebor-Choka changed the title Add a reserved flag to the KeepAlive Session message feat(hopr-lib): Add a reserved flag to the KeepAlive Session message Jun 23, 2025
@NumberFour8 NumberFour8 merged commit 8971d64 into master Jun 23, 2025
43 of 48 checks passed
@NumberFour8 NumberFour8 deleted the lukas/add-keep-alive-flag branch June 23, 2025 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Teebor-Choka Teebor-Choka Teebor-Choka approved these changes

Assignees

@NumberFour8 NumberFour8

Labels
crate:hopr-transport-session
Projects
None yet
Milestone
3.0.0
Development

Successfully merging this pull request may close these issues.
2 participants
@NumberFour8 @Teebor-Choka