docs: add comment about contextDialer

elastic · Jan 19, 2024 · 3c03c15 · 3c03c15
1 parent 27ba8ec
commit 3c03c15
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/transport/proxy.go b/transport/proxy.go
@@ -97,6 +97,9 @@ func ProxyDialer(log *logp.Logger, config *ProxyConfig, forward Dialer) (Dialer,
 		}
 
 		contextDialer, ok := dialer.(Dialer)
+		// This will never be executed because the proxy package always returns
+		// a ContextDialer but they didn't break the interface for backward compatibiliy.
+		// See golang/go#58376
 		if !ok {
 			contextDialer = DialerFunc(func(ctx context.Context, network, address string) (net.Conn, error) {
 				return dialer.Dial(network, address)