feat(client): Add impersonate_with_headers allows optionally setting request headers

[0x676e67]

Summary by CodeRabbit

• New Features
  • Introduced an asynchronous HTTP client that can impersonate specific entities with customizable headers.
  • Added a method to the client builder for enhanced impersonation capabilities while managing headers.
• Improvements
  • Enhanced flexibility in TLS settings application by allowing users to specify whether to apply headers during impersonation.

[coderabbitai]

Warning

Rate limit exceeded

@0x676e67 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 1 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 06f8507 and 5f2a97d.

Walkthrough

This update introduces enhancements to an asynchronous Rust application, enabling the use of HTTP client impersonation through customizable headers. A new method, impersonate_with_headers, improves the ClientBuilder by allowing fine control over header management during impersonation. The application integrates the rquest library, facilitating GET requests to APIs while managing errors effectively. Overall, these changes enhance flexibility and functionality for secure communications in the client.

Changes

Files	Change Summary
examples/...headers.rs	New file for an async Rust application using rquest to perform HTTP requests with entity impersonation and customized headers. Main function manages client creation and handles errors.
src/client/client.rs	Added impersonate_with_headers method in ClientBuilder for header management. Modified impersonate and apply_tls_settings to support new header control logic, enhancing TLS settings flexibility.

Poem

🐇 In the code there hops a change,
With headers set, it feels so strange.
As requests fly with a gentle grace,
Impersonation finds its place.
A builder's charm, a rabbit's cheer,
Let’s hop along, the future's near! 🐇✨

---

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

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

[coderabbitai]

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 3449c2f and 06f8507.

Files selected for processing (2)

• examples/impersonate_with_headers.rs (1 hunks)
• src/client/client.rs (2 hunks)

Additional comments not posted (4)

examples/impersonate_with_headers.rs (1)

1-18: Example Code Approved.

The example demonstrates the use of impersonate_with_headers effectively and appears correct. It provides a clear and concise demonstration of the new functionality.

src/client/client.rs (3)

267-268: Change Approved: impersonate method update.

The impersonate method now correctly delegates to impersonate_with_headers with set_headers set to true, maintaining backward compatibility.

---

270-281: New Method Approved: impersonate_with_headers.

The impersonate_with_headers method is a well-implemented addition that provides conditional header management, enhancing flexibility in client configuration.

---

297-308: Modification Approved: apply_tls_settings method.

The addition of the set_headers parameter to apply_tls_settings allows for conditional header application, which is implemented correctly and enhances the method's flexibility.