Skip to content
This repository has been archived by the owner on Jan 16, 2025. It is now read-only.

feat(client): Simplify client configuration #110

Merged
merged 2 commits into from
Aug 10, 2024
Merged

feat(client): Simplify client configuration #110

merged 2 commits into from
Aug 10, 2024

Conversation

0x676e67
Copy link
Owner

@0x676e67 0x676e67 commented Aug 10, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a new configuration approach for HTTP clients, utilizing a centralized builder pattern for enhanced simplicity and maintainability.
  • Bug Fixes

    • Resolved issues related to the management of HTTP version configurations, streamlining the setup process.
  • Refactor

    • Simplified the construction of the HTTP client by consolidating various configuration options into a single builder field.
  • Documentation

    • Updated documentation to reflect the transition to BoringSSL for TLS, clarifying the security layer employed by the Client.

Copy link

coderabbitai bot commented Aug 10, 2024

Walkthrough

The recent changes to the HTTP client configuration streamline the Config struct by removing numerous HTTP/1 and HTTP/2 settings. A new builder field utilizing the hyper library's builder pattern centralizes configuration management, enhancing clarity and maintainability. The ClientBuilder implementation has been updated to reflect these changes, simplifying how HTTP clients are constructed and configured. Additionally, the TLS implementation documentation has been updated to reflect the use of BoringSSL for improved security.

Changes

Files Change Summary
src/async_impl/client.rs Removed numerous HTTP configuration fields from Config; added builder: hyper::client::Builder. Updated ClientBuilder methods to configure HTTP options directly on the builder. Simplified the build method to use the new configuration approach.
src/tls/mod.rs Updated documentation to reflect that the Client now uses BoringSSL for TLS, simplifying the explanation by removing specific platform mentions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ClientBuilder
    participant Config
    participant HyperBuilder

    User->>ClientBuilder: Create a new ClientBuilder
    ClientBuilder->>HyperBuilder: Initialize builder
    ClientBuilder->>Config: Set options on builder
    Config->>HyperBuilder: Configure HTTP settings
    ClientBuilder->>User: Return configured client
Loading

Poem

In fields of code where changes bloom,
A rabbit hops, dispelling gloom.
With hyper here, our paths align,
Simplified settings, oh how they shine!
Let's celebrate this cleaner way,
For smoother clients, hip-hip-hooray! 🐇✨


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
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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 676d7b3 and 0b0b9cb.

Files selected for processing (1)
  • src/async_impl/client.rs (21 hunks)
Additional comments not posted (10)
src/async_impl/client.rs (10)

97-97: Addition of builder field is well-structured.

The introduction of the builder field centralizes configuration using the hyper library's builder pattern, enhancing maintainability and clarity.


147-147: Initialization of builder is appropriate.

The builder field is correctly initialized with hyper::Client::builder(), setting up the builder pattern for configuration.


236-246: Consolidation of configuration logic in build method is effective.

The use of builder in the build method simplifies the construction of the HTTP client by consolidating configuration logic.


264-264: Usage of builder in impersonate is consistent with the builder pattern.

The builder is used to set HTTP/2 agent profile, ensuring centralized management of HTTP/2 settings.


Line range hint 699-737: Centralization of HTTP/1 settings improves maintainability.

Methods for HTTP/1 settings now use builder, enhancing consistency and maintainability.


Line range hint 770-878: Centralization of HTTP/2 settings aligns with simplification goals.

Methods for HTTP/2 settings now use builder, which centralizes configuration and simplifies client setup.


1565-1565: Inclusion of builder in fmt_fields is beneficial for debugging.

Including the builder field in fmt_fields enhances the visibility of its state during debugging.


97-97: Removal of individual HTTP settings reduces complexity.

The removal of individual HTTP/1 and HTTP/2 configuration fields reduces complexity and potential redundancy, as these are now encapsulated by the builder.

Also applies to: 147-147, 236-246, 264-264, 699-737, 770-878, 1565-1565


Line range hint 699-878: Streamlined configuration process in ClientBuilder methods.

The methods now directly modify the builder, which streamlines the configuration process and aligns with the builder pattern.


97-97: Overall restructuring enhances maintainability and clarity.

The restructuring centralizes configuration using the builder pattern, improving maintainability and aligning with modern Rust practices.

Also applies to: 147-147, 236-246, 264-264, 699-737, 770-878, 1565-1565

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0b0b9cb and fedb831.

Files selected for processing (1)
  • src/tls/mod.rs (1 hunks)
Additional comments not posted (1)
src/tls/mod.rs (1)

3-5: Documentation update approved.

The updated documentation clearly states that BoringSSL is used for TLS by default, which aligns with the changes in the TLS implementation.

@0x676e67 0x676e67 merged commit c12dce6 into main Aug 10, 2024
1 check passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant