feat(katana): add node handle

[kariy]

a super handle that encapsulates all the node components. renamed the old NodeHandle into RpcServer

Summary by CodeRabbit

• New Features

  • Introduced a new Handle struct that encapsulates key components for improved organization and maintainability.
  • Updated the start function to return a Handle instance, enhancing clarity in node state representation.
  • Enhanced the TestSequencer functionality by integrating with the new Handle type for better access to backend components.

• Bug Fixes

  • Streamlined the shutdown process and method calls to improve control flow and reduce potential errors.

• Refactor

  • Simplified the code structure by consolidating node initialization and reducing variable usage for better readability.

[coderabbitai]

Walkthrough

Ohayo, sensei! The changes involve a significant refactoring of the Node and TestSequencer structures within the codebase. A new Handle struct is introduced to encapsulate various components, replacing the previous NodeHandle type. This refactoring simplifies the initialization and access patterns for node components, streamlining the code and enhancing its organization.

Changes

File Path	Change Summary
bin/katana/src/cli/node.rs	Refactored NodeArgs to use a single node variable instead of a tuple for rpc_handle and backend. Updated shutdown process to call node.rpc.handle.stop().
crates/dojo-test-utils/src/sequencer.rs	Replaced NodeHandle with Handle in TestSequencer. Updated methods to access node.rpc.addr and node.backend.config.genesis.accounts(). Modified stop method to call self.handle.rpc.handle.stop().
crates/katana/node/src/lib.rs	Introduced a new Handle struct encapsulating backend, block_producer, pool, and rpc. Changed start function return type from a tuple to Handle. Updated spawn function return type from NodeHandle to RpcServer.

Sequence Diagram(s)

sequenceDiagram
    participant A as Client
    participant B as Node
    participant C as RpcServer

    A->>B: Start Node
    B->>C: Initialize RPC Server
    C-->>B: Return RpcServer
    B-->>A: Return Node

Loading

sequenceDiagram
    participant A as TestSequencer
    participant B as Node

    A->>B: Access Node
    B-->>A: Provide Node details
    A->>B: Stop Node
    B->>C: Stop RpcServer

Loading

Tip

Announcements

• The review status is no longer posted as a separate comment when there are no actionable or nitpick comments. In such cases, the review status is included in the walkthrough comment.
• We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.
• Possibly related PRs: Walkthrough comment now includes a list of potentially related PRs to help you recall past context. Please share any feedback in the discussion post on our Discord.
• Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or configuration file.
• Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 60fb570 and 3415580.

Files selected for processing (2)

• crates/dojo-test-utils/src/sequencer.rs (5 hunks)
• crates/katana/node/src/lib.rs (4 hunks)

Additional comments not posted (10)

crates/dojo-test-utils/src/sequencer.rs (5)

10-10: Ohayo, sensei! The change looks good to me.

The NodeHandle type has been replaced with the new Handle type, which is consistent with the overall refactoring.

---

32-32: Ohayo, sensei! The change is perfect.

The NodeHandle type has been replaced with the new Handle type in the TestSequencer struct, which is consistent with the overall refactoring.

---

48-52: Ohayo, sensei! The changes are looking great.

The TestSequencer initialization has been updated to use the node variable returned by the refactored katana_node::start function, and the url field is now populated using node.rpc.addr, which is consistent with the new Handle type.

---

54-60: Ohayo, sensei! The changes are spot on.

The account field is now populated using node.backend.config.genesis.accounts(), which is consistent with the new Handle type, and the TestSequencer struct initialization has been updated accordingly.

---

82-82: Ohayo, sensei! The changes are looking slick.

The backend, account_at_index, and stop methods have been updated to use the new Handle type, which is consistent with the overall refactoring.

Also applies to: 90-90, 114-114

crates/katana/node/src/lib.rs (5)

52-59: Ohayo, sensei! The new Handle struct is a great addition.

The introduction of the Handle struct enhances the organization of the code by encapsulating various node components, including pool, rpc, backend, and block_producer, into a single entity. This can improve maintainability and clarity.

---

Line range hint 75-226: Ohayo, sensei! The change in the start function's return type is on point.

The return type has been updated to Result<Handle>, reflecting the introduction of the new Handle struct. This change suggests a more cohesive representation of the node's state and components.

---

223-224: Ohayo, sensei! The changes are looking clean.

The introduction of the node_components variable helps to organize the arguments passed to the spawn function, making the code more readable. The spawn function is called with the node_components and server_config arguments, which is consistent with the refactoring.

---

Line range hint 233-303: Ohayo, sensei! The changes in the spawn function are looking solid.

The return type has been updated to Result<RpcServer>, and the NodeHandle struct has been replaced with the RpcServer struct. These changes simplify the return types and align them with the new struct definitions, enhancing the code's clarity and consistency.

---

306-307: Ohayo, sensei! The new RpcServer struct is a nice touch.

The introduction of the RpcServer struct, replacing the NodeHandle struct, is consistent with the overall refactoring and aligns with the changes made to the spawn function's return type. This enhances the code's clarity and consistency.

---

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.

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.

[codecov]

Codecov Report

Attention: Patch coverage is 47.05882% with 9 lines in your changes missing coverage. Please review.

Project coverage is 67.94%. Comparing base (6112180) to head (3415580).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
bin/katana/src/cli/node.rs	0.00%	4 Missing ⚠️
crates/dojo-test-utils/src/sequencer.rs	42.85%	4 Missing ⚠️
crates/katana/node/src/lib.rs	83.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2408      +/-   ##
==========================================
- Coverage   68.13%   67.94%   -0.20%     
==========================================
  Files         364      364              
  Lines       47712    47770      +58     
==========================================
- Hits        32509    32457      -52     
- Misses      15203    15313     +110     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[glihm]

nice refactoring having this handle with everything in it.