Skip to content
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.

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

fix(katana-cli): ensure compilation without server feature #2896

Merged
merged 1 commit into from
Jan 11, 2025

Conversation

glihm
Copy link
Collaborator

@glihm glihm commented Jan 11, 2025

This PR ensures the compilation without the server feature can happen (mostly used in Slot CLI currently).

Summary by CodeRabbit

Release Notes

  • New Features

    • Added optional server configuration with support for metrics and HTTP-RPC server settings
    • Introduced configurable options for server address, port, CORS origins, and connection limits
  • Improvements

    • Enhanced modularity of CLI configuration
    • Added flexible feature flagging for server-related functionality
  • Configuration

    • New options for customizing metrics and server behavior
    • Default settings provided for easy setup and deployment

@glihm glihm requested a review from kariy January 11, 2025 17:37
Copy link

coderabbitai bot commented Jan 11, 2025

Walkthrough

Ohayo, sensei! The changes introduce conditional compilation for server-related features in the Katana CLI. The modifications focus on adding server and metrics configuration options that can be optionally included during compilation using the "server" feature flag. This approach allows for more flexible and modular code structure, enabling developers to include or exclude server-specific functionality based on their build requirements.

Changes

File Changes
crates/katana/cli/src/args.rs - Added conditional #[cfg(feature = "server")] attributes for server-related imports and struct fields
- Added metrics and server fields to NodeArgs struct
- Updated rpc_config method to handle server feature conditionally
crates/katana/cli/src/options.rs - Introduced MetricsOptions struct with configuration for metrics
- Added ServerOptions struct for server configuration
- Created utility functions for default server and metrics settings

Sequence Diagram

Loading
sequenceDiagram
    participant CLI as Katana CLI
    participant Config as Configuration
    participant Server as Server Module

    alt Server Feature Enabled
        CLI->>Config: Configure with server options
        Config->>Server: Initialize server components
        Server-->>Config: Server configuration complete
    else Server Feature Disabled
        CLI->>Config: Use default configuration
        Config-->>CLI: Minimal configuration applied
    end

The sequence diagram illustrates how the CLI handles configuration based on the server feature flag, showing the different paths for enabled and disabled server functionality.


🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
crates/katana/cli/src/args.rs (1)

206-220: Consider tracking the TODO as a separate issue, sensei!

The dev module check at the CLI level is a temporary solution. As noted in the TODO, this validation should be moved to the katana-node level for better architectural design.

Would you like me to create a GitHub issue to track moving the dev module validation to the node level?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c93a058 and ab3ee06.

📒 Files selected for processing (2)
  • crates/katana/cli/src/args.rs (4 hunks)
  • crates/katana/cli/src/options.rs (2 hunks)
🔇 Additional comments (4)
crates/katana/cli/src/options.rs (3)

Line range hint 10-33: Ohayo sensei! Clean organization of feature-gated imports.

The server-related imports are properly wrapped with #[cfg(feature = "server")], aligning well with the goal of making server features optional.


Line range hint 40-65: Well-structured metrics configuration!

The MetricsOptions struct is well-documented and properly feature-gated. The field dependencies are correctly handled through the requires attribute.


Line range hint 82-127: Excellent server configuration structure!

The ServerOptions struct provides a comprehensive set of HTTP-RPC server settings with proper defaults and documentation. The CORS origins handling is particularly well-implemented with custom serialization.

crates/katana/cli/src/args.rs (1)

235-235: Clean default implementation!

The default RPC config for non-server builds is appropriately minimal, perfectly aligning with the PR's objective of making server features optional.

Copy link

codecov bot commented Jan 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.84%. Comparing base (c93a058) to head (ab3ee06).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2896      +/-   ##
==========================================
- Coverage   55.85%   55.84%   -0.01%     
==========================================
  Files         449      449              
  Lines       57730    57730              
==========================================
- Hits        32245    32242       -3     
- Misses      25485    25488       +3     

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

Copy link
Member

@kariy kariy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah sorry for missing this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants