review comments

- add doc string
- unexport
- delete low value tests

Author: burmudar

internal/api/api.go

@@ -99,7 +99,7 @@ func buildTransport(opts ClientOpts, flags *Flags) *http.Transport {
 	}
 
 	if opts.ProxyURL != nil || opts.ProxyPath != "" {
-		transport = NewProxyTransport(transport, opts.ProxyURL, opts.ProxyPath)
+		transport = withProxyTransport(transport, opts.ProxyURL, opts.ProxyPath)
 	}
 
 	return transport

internal/api/api_test.go

@@ -11,10 +11,13 @@ import (
 	"net/url"
 )
 
-func NewProxyTransport(base *http.Transport, proxyURL *url.URL, proxyPath string) *http.Transport {
-	// Clone so that we don't change the original transport
-	transport := base.Clone()
-
+// withProxyTransport modifies the given transport to handle proxying of unix, socks5 and http connections.
+//
+// Note: baseTransport is considered to be a clone created with transport.Clone()
+//
+// - If a the proxyPath is not empty, a unix socket proxy is created.
+// - Otherwise, the proxyURL is used to determine if we should proxy socks5 / http connections
+func withProxyTransport(baseTransport *http.Transport, proxyURL *url.URL, proxyPath string) *http.Transport {
 	handshakeTLS := func(ctx context.Context, conn net.Conn, addr string) (net.Conn, error) {
 		// Extract the hostname (without the port) for TLS SNI
 		host, _, err := net.SplitHostPort(addr)
@@ -25,7 +28,7 @@ func NewProxyTransport(base *http.Transport, proxyURL *url.URL, proxyPath string
 			ServerName: host,
 			// Pull InsecureSkipVerify from the target host transport
 			// so that insecure-skip-verify flag settings are honored for the proxy server
-			InsecureSkipVerify: transport.TLSClientConfig.InsecureSkipVerify,
+			InsecureSkipVerify: baseTransport.TLSClientConfig.InsecureSkipVerify,
 		})
 		if err := tlsConn.HandshakeContext(ctx); err != nil {
 			return nil, err
@@ -45,15 +48,15 @@ func NewProxyTransport(base *http.Transport, proxyURL *url.URL, proxyPath string
 			}
 			return handshakeTLS(ctx, conn, addr)
 		}
-		transport.DialContext = dial
-		transport.DialTLSContext = dialTLS
+		baseTransport.DialContext = dial
+		baseTransport.DialTLSContext = dialTLS
 		// clear out any system proxy settings
-		transport.Proxy = nil
+		baseTransport.Proxy = nil
 	} else if proxyURL != nil {
 		switch proxyURL.Scheme {
 		case "socks5", "socks5h":
 			// SOCKS proxies work out of the box - no need to manually dial
-			transport.Proxy = http.ProxyURL(proxyURL)
+			baseTransport.Proxy = http.ProxyURL(proxyURL)
 		case "http", "https":
 			dial := func(ctx context.Context, network, addr string) (net.Conn, error) {
 				// Dial the proxy
@@ -121,12 +124,12 @@ func NewProxyTransport(base *http.Transport, proxyURL *url.URL, proxyPath string
 				}
 				return handshakeTLS(ctx, conn, addr)
 			}
-			transport.DialContext = dial
-			transport.DialTLSContext = dialTLS
+			baseTransport.DialContext = dial
+			baseTransport.DialTLSContext = dialTLS
 			// clear out any system proxy settings
-			transport.Proxy = nil
+			baseTransport.Proxy = nil
 		}
 	}
 
-	return transport
+	return baseTransport
 }