client: NegotiateAPIVersion: do not ignore (connection) errors from Ping

thaJeztah · thaJeztah · commit 901b90593d6f · 2024-02-23T14:31:55.000+01:00
NegotiateAPIVersion was ignoring errors returned by Ping. The intent here
was to handle API responses from a daemon that may be in an unhealthy state,
however this case is already handled by Ping itself.

Ping only returns an error when either failing to connect to the API (daemon
not running or permissions errors), or when failing to parse the API response.

Neither of those should be ignored in this code, or considered a successful
"ping", so update the code to return

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/client/client.go b/client/client.go
@@ -307,7 +307,11 @@ func (cli *Client) ClientVersion() string {
 // added (1.24).
 func (cli *Client) NegotiateAPIVersion(ctx context.Context) {
 	if !cli.manualOverride {
-		ping, _ := cli.Ping(ctx)
+		ping, err := cli.Ping(ctx)
+		if err != nil {
+			// FIXME(thaJeztah): Ping returns an error when failing to connect to the API; we should not swallow the error here, and instead returning it.
+			return
+		}
 		cli.negotiateAPIVersionPing(ping)
 	}
 }
diff --git a/client/client_test.go b/client/client_test.go
@@ -354,6 +354,19 @@ func TestNegotiateAPVersionOverride(t *testing.T) {
 	assert.Equal(t, client.ClientVersion(), expected)
 }
 
+// TestNegotiateAPVersionConnectionFailure asserts that we do not modify the
+// API version when failing to connect.
+func TestNegotiateAPVersionConnectionFailure(t *testing.T) {
+	const expected = "9.99"
+
+	client, err := NewClientWithOpts(WithHost("unix:///no-such-socket"))
+	assert.NilError(t, err)
+
+	client.version = expected
+	client.NegotiateAPIVersion(context.Background())
+	assert.Equal(t, client.ClientVersion(), expected)
+}
+
 func TestNegotiateAPIVersionAutomatic(t *testing.T) {
 	var pingVersion string
 	httpClient := newMockClient(func(req *http.Request) (*http.Response, error) {
diff --git a/client/ping.go b/client/ping.go
@@ -14,7 +14,10 @@ import (
 // Ping pings the server and returns the value of the "Docker-Experimental",
 // "Builder-Version", "OS-Type" & "API-Version" headers. It attempts to use
 // a HEAD request on the endpoint, but falls back to GET if HEAD is not supported
-// by the daemon.
+// by the daemon. It ignores internal server errors returned by the API, which
+// may be returned if the daemon is in an unhealthy state, but returns errors
+// for other non-success status codes, failing to connect to the API, or failing
+// to parse the API response.
 func (cli *Client) Ping(ctx context.Context) (types.Ping, error) {
 	var ping types.Ping
 

Original file line number	Diff line number	Diff line change
`@@ -307,7 +307,11 @@ func (cli *Client) ClientVersion() string {`
`307`	`307`	`// added (1.24).`
`308`	`308`	`func (cli *Client) NegotiateAPIVersion(ctx context.Context) {`
`309`	`309`	`if !cli.manualOverride {`
`310`		`- ping, _ := cli.Ping(ctx)`
	`310`	`+ ping, err := cli.Ping(ctx)`
	`311`	`+ if err != nil {`
	`312`	`+ // FIXME(thaJeztah): Ping returns an error when failing to connect to the API; we should not swallow the error here, and instead returning it.`
	`313`	`+ return`
	`314`	`+ }`
`311`	`315`	`cli.negotiateAPIVersionPing(ping)`
`312`	`316`	`}`
`313`	`317`	`}`