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

refractor(tls/settings): Generate configuration using builder mode #121

Merged
merged 2 commits into from
Aug 15, 2024

Conversation

0x676e67
Copy link
Owner

@0x676e67 0x676e67 commented Aug 15, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced TLS settings with a new builder pattern for modular configuration.
    • Introduced a new optional dependency, typed-builder, under the boring-tls feature.
  • Changes

    • Removed default HTTP/2 support, shifting to broader HTTP version acceptance.
    • Updated HTTP version preference configuration reflecting the removal of HTTP/2.
    • Changed visibility of several fields in TLS-related structures to enhance encapsulation.
  • Bug Fixes

    • Addressed issues by removing outdated HTTP/2 functionalities across client implementations.

@0x676e67 0x676e67 merged commit a370f18 into main Aug 15, 2024
1 check passed
@0x676e67 0x676e67 deleted the fix branch August 15, 2024 00:12
Copy link

coderabbitai bot commented Aug 15, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes primarily focus on removing HTTP/2 support across the codebase, shifting towards a more simplified architecture with an emphasis on supporting broader HTTP versions and integrating boring-tls. The use of builder patterns enhances code clarity, while encapsulation is improved by restricting visibility of several fields. Overall, these modifications streamline functionality and simplify dependencies, paving the way for a cleaner and more maintainable library.

Changes

Files Change Summary
Cargo.toml Removed HTTP/2 feature and dependency, adjusted feature flags, added typed-builder as an optional dependency under boring-tls.
examples/pre_configured_tls.rs Transitioned to a builder pattern for TlsSettings, updated http_version_pref to accept all HTTP versions, removed optional TLS version fields.
src/async_impl/client.rs Removed HTTP/2 functionality from ClientBuilder, replaced HTTP/2 preference with a broader support option, updated related structures.
src/blocking/client.rs Updated HTTP/2-related methods' feature flags to boring-tls, indicating a shift in compilation dependencies.
src/lib.rs Adjusted conditional compilation for module exports to require only the boring-tls feature.
src/tls/builder.rs Removed HTTP/2 related conditional compilation, impacting ALPN protocol settings.
src/tls/settings.rs Changed visibility of several fields from public to crate-private, increased encapsulation, and updated structures to utilize the TypedBuilder pattern.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Library
    participant Config
    participant TlsSettings

    User->>Library: Initialize Client
    Library->>Config: Set HTTP Version Preferences
    Config->>TlsSettings: Use Builder Pattern
    TlsSettings->>Library: Return Updated Settings
    Library->>User: Client Ready
Loading

🌟✨ In a world of bytes and bits,
The rabbit hops, and happily sits.
No more HTTP/2's tangled tale,
With boring-tls, we now set sail!
Builder patterns make it neat,
In code we find our rhythmic beat! 🐇🌈


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.

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