git/gogit: Add support for per client proxying #575
Conversation
Add `WithProxy()`, a `ClientOption` which configures the proxy settings for a `gogit.Client`. All remote operations performed by the client use the configured proxy. Signed-off-by: Sanskar Jaiswal <[email protected]>
Signed-off-by: Sanskar Jaiswal <[email protected]>
Signed-off-by: Sanskar Jaiswal <[email protected]>
hiddeco
added
enhancement
| func (g *Client) getRemoteHEAD(ctx context.Context, url string, ref plumbing.ReferenceName, | ||
| authMethod transport.AuthMethod) (string, error) { |
There was a problem hiding this comment.
Looking at the usage of getRemoteHEAD(), it looks like the authMethod can now be computed just once per client as it needs authOpts and useDefaultKnownHosts which are both properties of the client and don't seem to change in any of the operations.
There was a problem hiding this comment.
Thinking more about the other options like url, all of the g.clone*() methods set the g.repository at the very end. This repository contains the remote address with a default remote name "origin". If these clone operations store the repository info on the client, other methods of the client should be able to default to the available repository. So, the url can become optional for getRemoteHEAD(). It should be able to use the default repository when the passed in URL is empty. The benefit of keeping the URL input is to allow querying other remotes if needed.
Add
WithProxy(), aClientOptionwhich configures the proxy settings for agogit.Client. All remote operations performed by the client will then use the configured proxy.Atm, the only way to use a proxy is to use the standard env vars,
HTTP_PROXY,HTTPS_PROXY, etc. The problem with this is that its configuration at a global level, i.e. all clients will be forced to use these proxy settings. This PR allows for using different proxy settings for different clients, which is particularly helpful when working in multi tenant environments.