Multiplex http gateway with grpc

[NickCao]

Summary by CodeRabbit

• New Features

  • Enhanced secure communication by transitioning to encrypted connections for incoming requests.
  • Improved API handling, now seamlessly supporting both gRPC and HTTP protocols.

• Chores

  • Updated configuration and dependency setups to enable the new gateway integration.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes update the project to integrate a gRPC gateway. A new plugin configuration entry has been added to the buf.gen.yaml file for the gateway, and a corresponding dependency has been added in go.mod for the grpc-gateway library. In the service implementation, the Start method of the controller is modified to use tls.Listen for secure connections and introduce a gateway multiplexer for routing requests based on protocol details.

Changes

Files	Change Summary
buf.gen.yaml, go.mod	Added a new gateway configuration: a plugin entry specifying buf.build/grpc-ecosystem/gateway in buf.gen.yaml and a dependency on github.com/grpc-ecosystem/grpc-gateway/v2 v2.20.0 in go.mod.
internal/.../controller_service.go	Modified the Start method to switch from net.Listen to tls.Listen for secure connections; introduced gwruntime.NewServeMux() to route requests between gRPC and HTTP gateways.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant TLS_Listener
    participant ControllerService
    participant gRPC_Server
    participant gRPC_Gateway
    Client->>TLS_Listener: Sends request
    TLS_Listener->>ControllerService: Accept connection
    alt Request is gRPC (HTTP/2 & gRPC content-type)
        ControllerService->>gRPC_Server: Forward gRPC request
        gRPC_Server-->>ControllerService: Process and respond
    else HTTP or non-gRPC request
        ControllerService->>gRPC_Gateway: Forward HTTP request
        gRPC_Gateway-->>ControllerService: Process and respond
    end
    ControllerService-->>Client: Return response

Loading

Poem

Hopping through lines of secure code,
I found a new gateway along the road.
TLS now guards the busy lane,
gRPC and HTTP share the train.
With each hop and every byte,
I celebrate changes by day and night.
A rabbit’s cheer for code that’s tight!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aa44e76 and 9fb5193.

⛔ Files ignored due to path filters (2)

• go.sum is excluded by !**/*.sum
• internal/protocol/jumpstarter/client/v1/client.pb.gw.go is excluded by !**/*.pb.gw.go

📒 Files selected for processing (3)

• buf.gen.yaml (1 hunks)
• go.mod (1 hunks)
• internal/service/controller_service.go (3 hunks)

✨ 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

• 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 generate docstrings to generate docstrings for 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.

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.

[NickCao]

Depends on #115

[mangelajo]

🚀