chore: deprecate unnecessary wrapper for DialWithDialer and DialWithTLSConfig (go-ldap#399)

cpuschma · inv2004 · commit 9c4dfbebb8ce · 2023-01-17T15:31:21.000+03:00
diff --git a/conn.go b/conn.go
@@ -119,38 +119,39 @@ type DialOpt func(*DialContext)
 // DialWithDialer updates net.Dialer in DialContext.
 func DialWithDialer(d *net.Dialer) DialOpt {
 	return func(dc *DialContext) {
-		dc.d = d
+		dc.dialer = d
 	}
 }
 
 // DialWithTLSConfig updates tls.Config in DialContext.
 func DialWithTLSConfig(tc *tls.Config) DialOpt {
 	return func(dc *DialContext) {
-		dc.tc = tc
+		dc.tlsConfig = tc
 	}
 }
 
 // DialWithTLSDialer is a wrapper for DialWithTLSConfig with the option to
 // specify a net.Dialer to for example define a timeout or a custom resolver.
+// @deprecated Use DialWithDialer and DialWithTLSConfig instead
 func DialWithTLSDialer(tlsConfig *tls.Config, dialer *net.Dialer) DialOpt {
 	return func(dc *DialContext) {
-		dc.tc = tlsConfig
-		dc.d = dialer
+		dc.tlsConfig = tlsConfig
+		dc.dialer = dialer
 	}
 }
 
 // DialContext contains necessary parameters to dial the given ldap URL.
 type DialContext struct {
-	d  *net.Dialer
-	tc *tls.Config
+	dialer    *net.Dialer
+	tlsConfig *tls.Config
 }
 
 func (dc *DialContext) dial(u *url.URL) (net.Conn, error) {
 	if u.Scheme == "ldapi" {
 		if u.Path == "" || u.Path == "/" {
 			u.Path = "/var/run/slapd/ldapi"
 		}
-		return dc.d.Dial("unix", u.Path)
+		return dc.dialer.Dial("unix", u.Path)
 	}
 
 	host, port, err := net.SplitHostPort(u.Host)
@@ -165,17 +166,17 @@ func (dc *DialContext) dial(u *url.URL) (net.Conn, error) {
 		if port == "" {
 			port = DefaultLdapPort
 		}
-		return dc.d.Dial("udp", net.JoinHostPort(host, port))
+		return dc.dialer.Dial("udp", net.JoinHostPort(host, port))
 	case "ldap":
 		if port == "" {
 			port = DefaultLdapPort
 		}
-		return dc.d.Dial("tcp", net.JoinHostPort(host, port))
+		return dc.dialer.Dial("tcp", net.JoinHostPort(host, port))
 	case "ldaps":
 		if port == "" {
 			port = DefaultLdapsPort
 		}
-		return tls.DialWithDialer(dc.d, "tcp", net.JoinHostPort(host, port), dc.tc)
+		return tls.DialWithDialer(dc.dialer, "tcp", net.JoinHostPort(host, port), dc.tlsConfig)
 	}
 
 	return nil, fmt.Errorf("Unknown scheme '%s'", u.Scheme)
@@ -221,8 +222,8 @@ func DialURL(addr string, opts ...DialOpt) (*Conn, error) {
 	for _, opt := range opts {
 		opt(&dc)
 	}
-	if dc.d == nil {
-		dc.d = &net.Dialer{Timeout: DefaultTimeout}
+	if dc.dialer == nil {
+		dc.dialer = &net.Dialer{Timeout: DefaultTimeout}
 	}
 
 	c, err := dc.dial(u)
diff --git a/v3/conn.go b/v3/conn.go
@@ -119,38 +119,39 @@ type DialOpt func(*DialContext)
 // DialWithDialer updates net.Dialer in DialContext.
 func DialWithDialer(d *net.Dialer) DialOpt {
 	return func(dc *DialContext) {
-		dc.d = d
+		dc.dialer = d
 	}
 }
 
 // DialWithTLSConfig updates tls.Config in DialContext.
 func DialWithTLSConfig(tc *tls.Config) DialOpt {
 	return func(dc *DialContext) {
-		dc.tc = tc
+		dc.tlsConfig = tc
 	}
 }
 
 // DialWithTLSDialer is a wrapper for DialWithTLSConfig with the option to
 // specify a net.Dialer to for example define a timeout or a custom resolver.
+// @deprecated Use DialWithDialer and DialWithTLSConfig instead
 func DialWithTLSDialer(tlsConfig *tls.Config, dialer *net.Dialer) DialOpt {
 	return func(dc *DialContext) {
-		dc.tc = tlsConfig
-		dc.d = dialer
+		dc.tlsConfig = tlsConfig
+		dc.dialer = dialer
 	}
 }
 
 // DialContext contains necessary parameters to dial the given ldap URL.
 type DialContext struct {
-	d  *net.Dialer
-	tc *tls.Config
+	dialer    *net.Dialer
+	tlsConfig *tls.Config
 }
 
 func (dc *DialContext) dial(u *url.URL) (net.Conn, error) {
 	if u.Scheme == "ldapi" {
 		if u.Path == "" || u.Path == "/" {
 			u.Path = "/var/run/slapd/ldapi"
 		}
-		return dc.d.Dial("unix", u.Path)
+		return dc.dialer.Dial("unix", u.Path)
 	}
 
 	host, port, err := net.SplitHostPort(u.Host)
@@ -165,17 +166,17 @@ func (dc *DialContext) dial(u *url.URL) (net.Conn, error) {
 		if port == "" {
 			port = DefaultLdapPort
 		}
-		return dc.d.Dial("udp", net.JoinHostPort(host, port))
+		return dc.dialer.Dial("udp", net.JoinHostPort(host, port))
 	case "ldap":
 		if port == "" {
 			port = DefaultLdapPort
 		}
-		return dc.d.Dial("tcp", net.JoinHostPort(host, port))
+		return dc.dialer.Dial("tcp", net.JoinHostPort(host, port))
 	case "ldaps":
 		if port == "" {
 			port = DefaultLdapsPort
 		}
-		return tls.DialWithDialer(dc.d, "tcp", net.JoinHostPort(host, port), dc.tc)
+		return tls.DialWithDialer(dc.dialer, "tcp", net.JoinHostPort(host, port), dc.tlsConfig)
 	}
 
 	return nil, fmt.Errorf("Unknown scheme '%s'", u.Scheme)
@@ -221,8 +222,8 @@ func DialURL(addr string, opts ...DialOpt) (*Conn, error) {
 	for _, opt := range opts {
 		opt(&dc)
 	}
-	if dc.d == nil {
-		dc.d = &net.Dialer{Timeout: DefaultTimeout}
+	if dc.dialer == nil {
+		dc.dialer = &net.Dialer{Timeout: DefaultTimeout}
 	}
 
 	c, err := dc.dial(u)

Original file line number	Diff line number	Diff line change
`@@ -119,38 +119,39 @@ type DialOpt func(*DialContext)`
`119`	`119`	`// DialWithDialer updates net.Dialer in DialContext.`
`120`	`120`	`func DialWithDialer(d *net.Dialer) DialOpt {`
`121`	`121`	`return func(dc *DialContext) {`
`122`		`- dc.d = d`
	`122`	`+ dc.dialer = d`
`123`	`123`	`}`
`124`	`124`	`}`
`125`	`125`
`126`	`126`	`// DialWithTLSConfig updates tls.Config in DialContext.`
`127`	`127`	`func DialWithTLSConfig(tc *tls.Config) DialOpt {`
`128`	`128`	`return func(dc *DialContext) {`
`129`		`- dc.tc = tc`
	`129`	`+ dc.tlsConfig = tc`
`130`	`130`	`}`
`131`	`131`	`}`
`132`	`132`
`133`	`133`	`// DialWithTLSDialer is a wrapper for DialWithTLSConfig with the option to`
`134`	`134`	`// specify a net.Dialer to for example define a timeout or a custom resolver.`
	`135`	`+// @deprecated Use DialWithDialer and DialWithTLSConfig instead`
`135`	`136`	`func DialWithTLSDialer(tlsConfig tls.Config, dialer net.Dialer) DialOpt {`
`136`	`137`	`return func(dc *DialContext) {`
`137`		`- dc.tc = tlsConfig`
`138`		`- dc.d = dialer`
	`138`	`+ dc.tlsConfig = tlsConfig`
	`139`	`+ dc.dialer = dialer`
`139`	`140`	`}`
`140`	`141`	`}`
`141`	`142`
`142`	`143`	`// DialContext contains necessary parameters to dial the given ldap URL.`
`143`	`144`	`type DialContext struct {`
`144`		`- d *net.Dialer`
`145`		`- tc *tls.Config`
	`145`	`+ dialer *net.Dialer`
	`146`	`+ tlsConfig *tls.Config`
`146`	`147`	`}`
`147`	`148`
`148`	`149`	`func (dc DialContext) dial(u url.URL) (net.Conn, error) {`
`149`	`150`	`if u.Scheme == "ldapi" {`
`150`	`151`	`if u.Path == "" \|\| u.Path == "/" {`
`151`	`152`	`u.Path = "/var/run/slapd/ldapi"`
`152`	`153`	`}`
`153`		`- return dc.d.Dial("unix", u.Path)`
	`154`	`+ return dc.dialer.Dial("unix", u.Path)`
`154`	`155`	`}`
`155`	`156`
`156`	`157`	`host, port, err := net.SplitHostPort(u.Host)`
`@@ -165,17 +166,17 @@ func (dc DialContext) dial(u url.URL) (net.Conn, error) {`
`165`	`166`	`if port == "" {`
`166`	`167`	`port = DefaultLdapPort`
`167`	`168`	`}`
`168`		`- return dc.d.Dial("udp", net.JoinHostPort(host, port))`
	`169`	`+ return dc.dialer.Dial("udp", net.JoinHostPort(host, port))`
`169`	`170`	`case "ldap":`
`170`	`171`	`if port == "" {`
`171`	`172`	`port = DefaultLdapPort`
`172`	`173`	`}`
`173`		`- return dc.d.Dial("tcp", net.JoinHostPort(host, port))`
	`174`	`+ return dc.dialer.Dial("tcp", net.JoinHostPort(host, port))`
`174`	`175`	`case "ldaps":`
`175`	`176`	`if port == "" {`
`176`	`177`	`port = DefaultLdapsPort`
`177`	`178`	`}`
`178`		`- return tls.DialWithDialer(dc.d, "tcp", net.JoinHostPort(host, port), dc.tc)`
	`179`	`+ return tls.DialWithDialer(dc.dialer, "tcp", net.JoinHostPort(host, port), dc.tlsConfig)`
`179`	`180`	`}`
`180`	`181`
`181`	`182`	`return nil, fmt.Errorf("Unknown scheme '%s'", u.Scheme)`
`@@ -221,8 +222,8 @@ func DialURL(addr string, opts ...DialOpt) (*Conn, error) {`
`221`	`222`	`for _, opt := range opts {`
`222`	`223`	`opt(&dc)`
`223`	`224`	`}`
`224`		`- if dc.d == nil {`
`225`		`- dc.d = &net.Dialer{Timeout: DefaultTimeout}`
	`225`	`+ if dc.dialer == nil {`
	`226`	`+ dc.dialer = &net.Dialer{Timeout: DefaultTimeout}`
`226`	`227`	`}`
`227`	`228`
`228`	`229`	`c, err := dc.dial(u)`