fix(cli): use Docker client dialer for Desktop mode#701
Conversation
Signed-off-by: Dorin Geman <dorin.geman@docker.com>
Summary of ChangesHello @doringeman, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses an issue in the command-line interface's handling of Docker Desktop contexts by modifying how HTTP clients are initialized. Previously, it defaulted to Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- The
dockerClientis closed before being used as the dialer inhttp.Transport, which likely results in a use-after-close bug; either deferClose()until after the client is no longer needed or avoid closing it if its dialer is meant to be long-lived. - The custom
DialContextignores thenetworkandaddrparameters and hardwiresdockerClient.Dialer()(ctx), which may cause unexpected behavior if multiple networks/addresses are used; consider either honoring those parameters or documenting why they can be safely ignored in this context.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The `dockerClient` is closed before being used as the dialer in `http.Transport`, which likely results in a use-after-close bug; either defer `Close()` until after the client is no longer needed or avoid closing it if its dialer is meant to be long-lived.
- The custom `DialContext` ignores the `network` and `addr` parameters and hardwires `dockerClient.Dialer()(ctx)`, which may cause unexpected behavior if multiple networks/addresses are used; consider either honoring those parameters or documenting why they can be safely ignored in this context.
## Individual Comments
### Comment 1
<location> `cmd/cli/desktop/context.go:353` </location>
<code_context>
+ if err != nil {
+ return nil, fmt.Errorf("unable to create model runner client: %w", err)
+ }
+ _ = dockerClient.Close()
+ httpClient = &http.Client{
+ Transport: &http.Transport{
</code_context>
<issue_to_address>
**issue (bug_risk):** dockerClient is closed before being used by the custom Transport, which likely leads to invalid connections or panics
Because the `Transport` uses `dockerClient.Dialer()` for all requests, closing `dockerClient` right before wiring up the `Transport` can cause use-after-close, failed connection attempts, or racy behavior. Either keep `dockerClient` alive for as long as the `Transport` is in use, or extract a dialer/connection factory that is independent of the client before closing it. As written, this is a likely functional bug.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| if err != nil { | ||
| return nil, fmt.Errorf("unable to create model runner client: %w", err) | ||
| } | ||
| _ = dockerClient.Close() |
There was a problem hiding this comment.
issue (bug_risk): dockerClient is closed before being used by the custom Transport, which likely leads to invalid connections or panics
Because the Transport uses dockerClient.Dialer() for all requests, closing dockerClient right before wiring up the Transport can cause use-after-close, failed connection attempts, or racy behavior. Either keep dockerClient alive for as long as the Transport is in use, or extract a dialer/connection factory that is independent of the client before closing it. As written, this is a likely functional bug.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
The pull request correctly updates the HTTP client configuration for the Desktop context to utilize the Docker client's dialer, which is a significant improvement for network request handling. However, a critical issue was identified where the Docker client is prematurely closed, potentially leading to connection failures for the newly configured HTTP client.
| if err != nil { | ||
| return nil, fmt.Errorf("unable to create model runner client: %w", err) | ||
| } | ||
| _ = dockerClient.Close() |
There was a problem hiding this comment.
The dockerClient.Close() call here is problematic. The DialContext function, which is assigned to httpClient.Transport.DialContext, relies on dockerClient.Dialer(). If dockerClient is closed, its underlying transport (and thus its dialer) might become invalid, leading to connection errors for the httpClient.
The dockerClient should remain active as long as its dialer is being used by the httpClient. The DialContext closure will implicitly keep the dockerClient alive, so explicitly closing it here is incorrect and can cause runtime issues.
thaJeztah
left a comment
thaJeztah
left a comment
There was a problem hiding this comment.
SGTM - we should look if we can make this juggling more rigid somehow
3 participants
With Docker Desktop with Docker Model Runner enabled: