[SSEClient] Add ability to override the http.Client #109

sks · 2025-04-04T16:52:03Z

Gives the users a choice to override the client to be used

Summary by CodeRabbit

New Features
- Added support for configuring the SSE client with a custom HTTP client, providing increased flexibility for testing and specialized client setups.

coderabbitai · 2025-04-04T16:52:12Z

Walkthrough

The pull request introduces a new function WithHTTPClient in both client/sse.go and client/transport/sse.go. This function allows users to specify a custom *http.Client for configuring the SSE client by returning a ClientOption that sets the internal HTTP client used by the SSE implementation. The import statements in client/sse.go were reordered to explicitly include the net/http package before the internal transport package. Additionally, a new subtest was added in client/transport/sse_test.go to verify the behavior of the SSE transport when using a custom HTTP client with a very short timeout. No other logic or control flow changes were made.

Changes

File	Change Summary
client/sse.go	Reordered imports; added `WithHTTPClient(httpClient *http.Client) transport.ClientOption` to wrap transport's HTTP client option.
client/transport/sse.go	Added `WithHTTPClient(httpClient *http.Client) ClientOption` to set a custom HTTP client in the SSE client implementation.
client/transport/sse_test.go	Added subtest "WithHTTPClient" in `TestSSEErrors` to test SSE transport behavior with a custom HTTP client having a very short timeout.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 b568a36 and c04f42a.

📒 Files selected for processing (3)

client/sse.go (1 hunks)
client/transport/sse.go (1 hunks)
client/transport/sse_test.go (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

client/transport/sse.go
client/sse.go

🔇 Additional comments (1)

client/transport/sse_test.go (1)

418-441: Good test implementation for the new WithHTTPClient option!

This test effectively verifies the new functionality by:

Creating a custom HTTP client with an artificially short timeout (1 nanosecond)

Configuring the SSE transport with this custom client using the new WithHTTPClient option

Validating that the timeout from the custom client is properly honored

The test provides a good example of how to use the new feature and successfully addresses the PR comment requesting documentation of the new ability to override the HTTP client.

✨ Finishing Touches

📝 Generate Docstrings

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

ezynda3 · 2025-04-16T17:32:53Z

Could you add a simple test just so its documented how this is used?

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (2)

client/transport/sse.go (2)
48-52: Add documentation comment for the WithHTTPClient function

The function is well-implemented, but it's missing a documentation comment that explains its purpose and usage. Consider adding a comment similar to other option functions in the file.
+// WithHTTPClient sets a custom HTTP client for the SSE transport.
+// This allows users to configure custom timeouts, transport settings, or middleware.
 func WithHTTPClient(httpClient *http.Client) ClientOption {
 	return func(sc *SSE) {
 		sc.httpClient = httpClient
 	}
 }
48-52: Add safety check for nil HTTP client

The function doesn't check if the provided HTTP client is nil. If a nil client is passed and used later, it will cause a panic when HTTP requests are made.
 func WithHTTPClient(httpClient *http.Client) ClientOption {
 	return func(sc *SSE) {
+		if httpClient == nil {
+			return
+		}
 		sc.httpClient = httpClient
 	}
 }

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 91ba3c1 and b568a36.

📒 Files selected for processing (2)

client/sse.go (1 hunks)
client/transport/sse.go (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

client/sse.go

🧰 Additional context used

🧬 Code Graph Analysis (1)

client/transport/sse.go (2)

client/sse.go (1)

WithHTTPClient (15-17)

client/client.go (1)

Client (16-24)

🔇 Additional comments (1)

client/transport/sse.go (1)

48-52: The implementation follows the existing pattern correctly

The implementation of WithHTTPClient follows the same functional options pattern used elsewhere in the codebase (like WithHeaders). This is a good approach for providing configurable options to users while maintaining backward compatibility.

client/transport/sse.go

sks · 2025-04-23T23:47:08Z

Could you add a simple test just so its documented how this is used?

Done

tra4less approved these changes Apr 15, 2025

View reviewed changes

sks mentioned this pull request Apr 15, 2025

sse client add transport option #111

Closed

sks force-pushed the feature/override_http branch from 91ba3c1 to b568a36 Compare April 17, 2025 04:23

coderabbitai bot reviewed Apr 17, 2025

View reviewed changes

client/transport/sse.go Show resolved Hide resolved

[chore][client] Add ability to override the http.Client

c04f42a

sks force-pushed the feature/override_http branch from b568a36 to c04f42a Compare April 17, 2025 13:29

sks requested a review from tra4less April 17, 2025 14:08

Merge remote-tracking branch 'origin/main' into feature/override_http

eeb9205

ezynda3 merged commit df5f67e into mark3labs:main May 1, 2025
2 checks passed

adlternative pushed a commit to adlternative/mcp-go that referenced this pull request May 20, 2025

[chore][client] Add ability to override the http.Client (mark3labs#109)

20163c3

coderabbitai bot mentioned this pull request Jun 2, 2025

[streamable-http] Add ability to override the http.Client #359

Merged

16 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[SSEClient] Add ability to override the http.Client #109

[SSEClient] Add ability to override the http.Client #109

Uh oh!

sks commented Apr 4, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 4, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

ezynda3 commented Apr 16, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

sks commented Apr 23, 2025

Uh oh!

Uh oh!

Uh oh!

[SSEClient] Add ability to override the http.Client #109

[SSEClient] Add ability to override the http.Client #109

Uh oh!

Conversation

sks commented Apr 4, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

ezynda3 commented Apr 16, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sks commented Apr 23, 2025

Uh oh!

Uh oh!

Uh oh!

sks commented Apr 4, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 4, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)