client: deprecate ErrorConnectionFailed helper

thaJeztah · thaJeztah · commit 846b2272e670 · 2025-02-04T17:16:52.000+01:00
This function was only used internally, and will be removed in the next release.

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/client/errors.go b/client/errors.go
@@ -2,11 +2,11 @@ package client // import "github.com/docker/docker/client"
 
 import (
 	"context"
+	"errors"
 	"fmt"
 
 	"github.com/docker/docker/api/types/versions"
 	"github.com/docker/docker/errdefs"
-	"github.com/pkg/errors"
 )
 
 // errConnectionFailed implements an error returned when connection failed.
@@ -29,10 +29,18 @@ func IsErrConnectionFailed(err error) bool {
 }
 
 // ErrorConnectionFailed returns an error with host in the error message when connection to docker daemon failed.
+//
+// Deprecated: this function was only used internally, and will be removed in the next release.
 func ErrorConnectionFailed(host string) error {
+	return connectionFailed(host)
+}
+
+// connectionFailed returns an error with host in the error message when connection
+// to docker daemon failed.
+func connectionFailed(host string) error {
 	var err error
 	if host == "" {
-		err = fmt.Errorf("Cannot connect to the Docker daemon. Is the docker daemon running on this host?")
+		err = errors.New("Cannot connect to the Docker daemon. Is the docker daemon running on this host?")
 	} else {
 		err = fmt.Errorf("Cannot connect to the Docker daemon at %s. Is the docker daemon running?", host)
 	}
diff --git a/client/request.go b/client/request.go
@@ -168,10 +168,10 @@ func (cli *Client) doRequest(req *http.Request) (serverResponse, error) {
 		if errors.As(err, &nErr) {
 			// FIXME(thaJeztah): any net.Error should be considered a connection error (but we should include the original error)?
 			if nErr.Timeout() {
-				return serverResp, ErrorConnectionFailed(cli.host)
+				return serverResp, connectionFailed(cli.host)
 			}
 			if strings.Contains(nErr.Error(), "connection refused") || strings.Contains(nErr.Error(), "dial unix") {
-				return serverResp, ErrorConnectionFailed(cli.host)
+				return serverResp, connectionFailed(cli.host)
 			}
 		}
 

Original file line number	Diff line number	Diff line change
`@@ -168,10 +168,10 @@ func (cli Client) doRequest(req http.Request) (serverResponse, error) {`
`168`	`168`	`if errors.As(err, &nErr) {`
`169`	`169`	`// FIXME(thaJeztah): any net.Error should be considered a connection error (but we should include the original error)?`
`170`	`170`	`if nErr.Timeout() {`
`171`		`- return serverResp, ErrorConnectionFailed(cli.host)`
	`171`	`+ return serverResp, connectionFailed(cli.host)`
`172`	`172`	`}`
`173`	`173`	`if strings.Contains(nErr.Error(), "connection refused") \|\| strings.Contains(nErr.Error(), "dial unix") {`
`174`		`- return serverResp, ErrorConnectionFailed(cli.host)`
	`174`	`+ return serverResp, connectionFailed(cli.host)`
`175`	`175`	`}`
`176`	`176`	`}`
`177`	`177`