fixup: clarify Cloudflare trace field names

Author: favonia

README.markdown

@@ -448,7 +448,7 @@ docker run --rm --network host curlimages/curl:latest --fail --show-error --sile
 docker run --rm --network host curlimages/curl:latest --fail --show-error --silent --ipv4 https://connectivity.cloudflareclient.com/cdn-cgi/trace
 ```
 
-If curl reports `Could not resolve host`, fix DNS resolution in the container network. Any other curl failure means that HTTPS endpoint is unavailable under the tested network and IP family. One failed endpoint does not by itself mean detection must fail, because another endpoint can return a valid response first. However, restrictive outbound policies should allow all three hosts to preserve fallback behavior. If any of the three commands succeeds but detection still times out, check the updater logs for response-validation failures, then try increasing `DETECTION_TIMEOUT` (for example, `DETECTION_TIMEOUT=1m`).
+If `curl` reports `Could not resolve host`, fix DNS resolution in the container network. Any other `curl` failure means that HTTPS endpoint is unavailable under the tested network and IP family. One failed endpoint does not by itself mean detection must fail, because another endpoint can return a valid response first. However, restrictive outbound policies should allow all three hosts to preserve fallback behavior. If any of the three commands succeeds but detection still times out, check the updater logs for response-validation failures, then try increasing `DETECTION_TIMEOUT` (for example, `DETECTION_TIMEOUT=1m`).
 
 If that still does not help, please [open a GitHub issue](https://github.com/favonia/cloudflare-ddns/issues/new/choose) and include your setup details, relevant configs with secrets redacted, and any logs you have so that we can investigate further.
 

internal/provider/protocol/cloudflare_trace.go

@@ -262,13 +262,13 @@ func describeCloudflareTraceFailure(failure traceFailure) string {
 		return fmt.Sprintf("failed to parse the provider URL: %v", failure.cause)
 	case traceFailureMismatchedH:
 		return fmt.Sprintf(
-			"the h field %q does not match the expected host %q; please report this at %s",
+			`the "h" field %q does not match the expected host %q; please report this at %s`,
 			failure.observed, failure.expected, pp.IssueReportingURL,
 		)
 	case traceFailureWarpOn:
-		return "the response has warp=on; the detected IP is a Cloudflare WARP egress IP, not your real public IP"
+		return `the "warp" field is "on"; the detected IP is a Cloudflare WARP egress IP, not your real public IP`
 	case traceFailureMissingIP:
-		return "the response does not contain an ip field"
+		return `the response does not contain an "ip" field`
 	case traceFailureUnparseableIP:
 		return fmt.Sprintf("failed to parse the IP address %q", failure.observed)
 	case traceFailureCloudflareIP:
@@ -304,11 +304,11 @@ func reportCloudflareTraceWinnerWarnings(
 	var missingFields string
 	switch {
 	case missingH && missingWarp:
-		missingFields = "the h (host) and warp fields"
+		missingFields = `the "h" (host) and "warp" fields`
 	case missingH:
-		missingFields = "the h (host) field"
+		missingFields = `the "h" (host) field`
 	case missingWarp:
-		missingFields = "the warp field"
+		missingFields = `the "warp" field`
 	default:
 		return
 	}

internal/provider/protocol/cloudflare_trace_test.go

@@ -242,7 +242,7 @@ func TestCloudflareTraceGetRawDataReplaysWinnerWarnings(t *testing.T) {
 	require.True(t, result.Available)
 	require.Equal(t,
 		"Cloudflare trace IPv4 detection succeeded via fallback endpoint "+winnerURL+
-			", but its response is missing the h (host) and warp fields; please report this at "+
+			", but its response is missing the \"h\" (host) and \"warp\" fields; please report this at "+
 			"https://github.com/favonia/cloudflare-ddns/issues/new/choose\n",
 		transcript,
 	)
@@ -270,7 +270,7 @@ func TestCloudflareTraceGetRawDataReportsMissingWarpFromWinner(t *testing.T) {
 	require.True(t, result.Available)
 	require.Equal(t,
 		"Cloudflare trace IPv4 detection succeeded via primary endpoint "+server.URL+
-			"/primary, but its response is missing the warp field; please report this at "+
+			"/primary, but its response is missing the \"warp\" field; please report this at "+
 			"https://github.com/favonia/cloudflare-ddns/issues/new/choose\n",
 		output.String(),
 	)
@@ -488,7 +488,7 @@ func TestCloudflareTraceGetRawData(t *testing.T) {
 				m.EXPECT().Noticef(pp.EmojiImpossible,
 					"Cloudflare trace %s detection succeeded via %s endpoint %s, "+
 						"but its response is missing %s; please report this at %s",
-					"IPv4", "primary", serverURL, "the h (host) field", pp.IssueReportingURL)
+					"IPv4", "primary", serverURL, `the "h" (host) field`, pp.IssueReportingURL)
 			},
 		},
 		"4/mismatched-h": { //nolint:exhaustruct // test fixture sets only exercised fields
@@ -499,7 +499,7 @@ func TestCloudflareTraceGetRawData(t *testing.T) {
 			available: false,
 			prepareMockPP: func(serverURL string, m *mocks.MockPP) {
 				expectCloudflareTraceFailure(m, pp.EmojiImpossible, ipnet.IP4, serverURL, fmt.Sprintf(
-					"the h field %q does not match the expected host %q; please report this at %s",
+					`the "h" field %q does not match the expected host %q; please report this at %s`,
 					"wrong.example.com", hostFromURL(serverURL), pp.IssueReportingURL))
 			},
 		},
@@ -511,7 +511,7 @@ func TestCloudflareTraceGetRawData(t *testing.T) {
 			available: false,
 			prepareMockPP: func(serverURL string, m *mocks.MockPP) {
 				expectCloudflareTraceFailure(m, pp.EmojiError, ipnet.IP4, serverURL,
-					"the response has warp=on; the detected IP is a Cloudflare WARP egress IP, not your real public IP")
+					`the "warp" field is "on"; the detected IP is a Cloudflare WARP egress IP, not your real public IP`)
 			},
 		},
 		"4/missing-warp-warns": { //nolint:exhaustruct // test fixture sets only exercised fields
@@ -524,7 +524,7 @@ func TestCloudflareTraceGetRawData(t *testing.T) {
 				m.EXPECT().Noticef(pp.EmojiImpossible,
 					"Cloudflare trace %s detection succeeded via %s endpoint %s, "+
 						"but its response is missing %s; please report this at %s",
-					"IPv4", "primary", serverURL, "the warp field", pp.IssueReportingURL)
+					"IPv4", "primary", serverURL, `the "warp" field`, pp.IssueReportingURL)
 			},
 		},
 		"4/missing-ip": { //nolint:exhaustruct // test fixture sets only exercised fields
@@ -535,7 +535,7 @@ func TestCloudflareTraceGetRawData(t *testing.T) {
 			available: false,
 			prepareMockPP: func(serverURL string, m *mocks.MockPP) {
 				expectCloudflareTraceFailure(m, pp.EmojiError, ipnet.IP4, serverURL,
-					"the response does not contain an ip field")
+					`the response does not contain an "ip" field`)
 			},
 		},
 		"4/unparseable-ip": { //nolint:exhaustruct // test fixture sets only exercised fields
@@ -615,7 +615,7 @@ func TestCloudflareTraceGetRawData(t *testing.T) {
 			available:    false,
 			prepareMockPP: func(serverURL string, m *mocks.MockPP) {
 				expectCloudflareTraceFailure(m, pp.EmojiError, ipnet.IP4, serverURL,
-					"the response does not contain an ip field")
+					`the response does not contain an "ip" field`)
 			},
 		},
 		"4/lines-without-equals": { //nolint:exhaustruct // test fixture sets only exercised fields
@@ -633,7 +633,7 @@ func TestCloudflareTraceGetRawData(t *testing.T) {
 			available: false,
 			prepareMockPP: func(serverURL string, m *mocks.MockPP) {
 				expectCloudflareTraceFailure(m, pp.EmojiError, ipnet.IP6, serverURL,
-					"the response has warp=on; the detected IP is a Cloudflare WARP egress IP, not your real public IP")
+					`the "warp" field is "on"; the detected IP is a Cloudflare WARP egress IP, not your real public IP`)
 			},
 		},
 		"4/warp-plus-passes": { //nolint:exhaustruct // test fixture sets only exercised fields
@@ -654,7 +654,7 @@ func TestCloudflareTraceGetRawData(t *testing.T) {
 				m.EXPECT().Noticef(pp.EmojiImpossible,
 					"Cloudflare trace %s detection succeeded via %s endpoint %s, "+
 						"but its response is missing %s; please report this at %s",
-					"IPv6", "primary", displayServerURL, "the h (host) field", pp.IssueReportingURL)
+					"IPv6", "primary", displayServerURL, `the "h" (host) field`, pp.IssueReportingURL)
 			},
 		},
 		"6/mismatched-h": { //nolint:exhaustruct // test fixture sets only exercised fields
@@ -665,7 +665,7 @@ func TestCloudflareTraceGetRawData(t *testing.T) {
 			available: false,
 			prepareMockPP: func(serverURL string, m *mocks.MockPP) {
 				expectCloudflareTraceFailure(m, pp.EmojiImpossible, ipnet.IP6, serverURL, fmt.Sprintf(
-					"the h field %q does not match the expected host %q; please report this at %s",
+					`the "h" field %q does not match the expected host %q; please report this at %s`,
 					"wrong.example.com", hostFromURL(serverURL), pp.IssueReportingURL))
 			},
 		},

internal/updater/updater_internal_test.go

@@ -183,8 +183,8 @@ func captureCloudflareTraceDetectionTranscript(
 		notifier:      msg.NotifierMessage.Format(),
 		endpoints:     append([]string(nil), endpoints...),
 		requestCounts: [3]int32{requestCounts[0].Load(), requestCounts[1].Load(), requestCounts[2].Load()},
-		winnerWarnings: strings.Contains(output.String(), "response is missing the h (host)") ||
-			strings.Contains(output.String(), "response is missing the warp field"),
+		winnerWarnings: strings.Contains(output.String(), `response is missing the "h" (host)`) ||
+			strings.Contains(output.String(), `response is missing the "warp" field`),
 	}
 
 	return capture
@@ -243,8 +243,8 @@ func TestCloudflareTraceDetectionTranscript(t *testing.T) {
 					require.False(t, capture.winnerWarnings)
 					host := strings.TrimSuffix(strings.TrimPrefix(capture.endpoints[0], "http://"), "/primary")
 					wantTranscript = fmt.Sprintf(
-						"Cloudflare trace IPv4 detection via %s failed: the response does not contain an ip field\n"+
-							"Cloudflare trace IPv4 detection via %s failed: the h field \"wrong.example\" does not match the expected host \"%s\"; please report this at https://github.com/favonia/cloudflare-ddns/issues/new/choose\n"+
+						"Cloudflare trace IPv4 detection via %s failed: the response does not contain an \"ip\" field\n"+
+							"Cloudflare trace IPv4 detection via %s failed: the \"h\" field \"wrong.example\" does not match the expected host \"%s\"; please report this at https://github.com/favonia/cloudflare-ddns/issues/new/choose\n"+
 							"Cloudflare trace IPv4 detection via %s failed: the detected IP address 2001:db8::1 is not a valid IPv4 address\n"+
 							"No valid IPv4 addresses were detected\n"+
 							"If your network does not support IPv4, you can stop managing it with IP4_PROVIDER=none\n",
@@ -276,12 +276,12 @@ func TestCloudflareTraceDetectionTranscript(t *testing.T) {
 		endpointRole  string
 		missingClause string
 	}{
-		{name: "primary-winner-missing-h", winnerIndex: 0, endpointRole: "primary", missingClause: "but its response is missing the h (host) field"},
-		{name: "primary-winner-missing-warp", winnerIndex: 0, endpointRole: "primary", missingClause: "but its response is missing the warp field"},
-		{name: "primary-winner-missing-both", winnerIndex: 0, endpointRole: "primary", missingClause: "but its response is missing the h (host) and warp fields"},
-		{name: "fallback-winner-missing-h", winnerIndex: 1, endpointRole: "fallback", missingClause: "but its response is missing the h (host) field"},
-		{name: "fallback-winner-missing-warp", winnerIndex: 1, endpointRole: "fallback", missingClause: "but its response is missing the warp field"},
-		{name: "fallback-winner-missing-both", winnerIndex: 1, endpointRole: "fallback", missingClause: "but its response is missing the h (host) and warp fields"},
+		{name: "primary-winner-missing-h", winnerIndex: 0, endpointRole: "primary", missingClause: `but its response is missing the "h" (host) field`},
+		{name: "primary-winner-missing-warp", winnerIndex: 0, endpointRole: "primary", missingClause: `but its response is missing the "warp" field`},
+		{name: "primary-winner-missing-both", winnerIndex: 0, endpointRole: "primary", missingClause: `but its response is missing the "h" (host) and "warp" fields`},
+		{name: "fallback-winner-missing-h", winnerIndex: 1, endpointRole: "fallback", missingClause: `but its response is missing the "h" (host) field`},
+		{name: "fallback-winner-missing-warp", winnerIndex: 1, endpointRole: "fallback", missingClause: `but its response is missing the "warp" field`},
+		{name: "fallback-winner-missing-both", winnerIndex: 1, endpointRole: "fallback", missingClause: `but its response is missing the "h" (host) and "warp" fields`},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
 			t.Parallel()