Skip to content

chore(oauth): OAuth handler to support functional configuration options #442

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore(oauth): OAuth handler to support functional configuration options #442

wants to merge 2 commits into from

Conversation

appleboy
Copy link

@appleboy appleboy commented Jun 24, 2025 •
edited
Loading

Description

  • Refactored the NewOAuthHandler function to use the functional options pattern, making configuration more flexible and extensible.
  • Added support for injecting a custom HTTP client through the WithOAuthHTTPClient option, allowing advanced control over authentication requests (e.g., timeout, proxy).

fix #440

Motivation

  • This change addresses issue feature: HTTP client option for OAuthHandler #440 by enabling developers to customize the OAuth Handler more easily and improve testability. The previous implementation did not allow for easy HTTP client customization, which limited its flexibility.

Changes

  • NewOAuthHandler now accepts functional options.
  • Introduced WithOAuthHTTPClient for injecting a custom http.Client.
  • Removed the hardcoded HTTP client instantiation to enhance flexibility and testability.

Testing

  • Manually verified that the OAuth flow works as expected with both the default and custom HTTP clients.
  • Automated tests have not been added yet—feedback on specific test cases is welcome.

Notes

  • This is a non-breaking change and should not affect existing usage.
  • If you have additional customization needs or use cases, please share them.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • MCP spec compatibility implementation
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code refactoring (no functional changes)
  • Performance improvement
  • Tests only (no functional changes)
  • Other (please describe):

Checklist

  • My code follows the code style of this project
  • I have performed a self-review of my own code
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the documentation accordingly

MCP Spec Compliance

  • This PR implements a feature defined in the MCP specification
  • Link to relevant spec section: Link text
  • Implementation follows the specification exactly

Additional Information

Summary by CodeRabbit

  • New Features
    • Added support for customizing OAuth HTTP client settings, allowing for more flexible configuration of authentication requests.

@appleboy
chore(oauth): refactor OAuth handler to support functional configurat…
17982da 
…ion options

- Refactor NewOAuthHandler to accept functional options for configuration
- Add support for injecting a custom HTTP client via WithOAuthHTTPClient option

fix mark3labs#440

Signed-off-by: Bo-Yi Wu <[email protected]>
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 24, 2025 •
edited
Loading

Warning

Rate limit exceeded

@appleboy has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 53 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

Reviewing files that changed from the base of the PR and between 17982da and 3671b9d.

📒 Files selected for processing (1)
  • client/transport/oauth_test.go (2 hunks)

Walkthrough

The constructor for OAuthHandler has been updated to accept functional options, enabling the injection of a custom http.Client. A new option function, WithOAuthHTTPClient, was added to facilitate this customization. The default behavior remains unchanged unless the option is explicitly provided.

Changes

Files Change Summary
client/transport/oauth.go Refactored NewOAuthHandler to accept variadic options; added OAuthHandlerOption type and WithOAuthHTTPClient function.

Assessment against linked issues

Objective Addressed Explanation
Allow setting a custom http.Client in OAuthHandler (#440) ✅
Add a functional option to override the default HTTP client in OAuthHandler (#440) ✅
Maintain default behavior if no custom client is provided (#440) ✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were found.

✨ 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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

@appleboy appleboy mentioned this pull request Jun 24, 2025
Open
@appleboy
test: test NewOAuthHandler client configuration behavior
3671b9d 
- Add a test to verify that NewOAuthHandler correctly sets a custom http.Client and uses the default client when none is provided

Signed-off-by: Bo-Yi Wu <[email protected]>
@appleboy
Copy link
Author

@ezynda3 , any feedback?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

feature: HTTP client option for OAuthHandler
1 participant
@appleboy