chore: include if direct connection is over private network in ping diagnostics

ethanndickson · ethanndickson · commit 3f99c573bc5d · 2024-11-01T07:01:17.000Z
diff --git a/cli/cliui/agent.go b/cli/cliui/agent.go
@@ -411,7 +411,7 @@ func (d ConnDiags) splitDiagnostics() (general, client, agent []string) {
 	}
 
 	if d.DisableDirect {
-		general = append(general, "❗ Direct connections are disabled locally, by `--disable-direct` or `CODER_DISABLE_DIRECT`")
+		general = append(general, "❗ Direct connections are disabled locally, by `--disable-direct-connections` or `CODER_DISABLE_DIRECT_CONNECTIONS`")
 		if !d.Verbose {
 			return general, client, agent
 		}
diff --git a/cli/ping.go b/cli/ping.go
@@ -128,7 +128,6 @@ func (r *RootCmd) ping() *serpent.Command {
 			}
 
 			if r.disableDirect {
-				_, _ = fmt.Fprintln(inv.Stderr, "Direct connections disabled.")
 				opts.BlockEndpoints = true
 			}
 			if !r.disableNetworkTelemetry {
@@ -197,6 +196,7 @@ func (r *RootCmd) ping() *serpent.Command {
 			results := &pingSummary{
 				Workspace: workspaceName,
 			}
+			var overPrivateNetwork bool
 			n := 0
 			start := time.Now()
 		pingLoop:
@@ -240,6 +240,7 @@ func (r *RootCmd) ping() *serpent.Command {
 						_, _ = fmt.Fprintln(inv.Stdout, "p2p connection established in",
 							pretty.Sprint(cliui.DefaultStyles.DateTimeStamp, time.Since(start).Round(time.Millisecond).String()),
 						)
+						overPrivateNetwork = isPrivateEndpoint(pong.Endpoint)
 					}
 					didP2p = true
 
@@ -276,7 +277,11 @@ func (r *RootCmd) ping() *serpent.Command {
 			}
 
 			if didP2p {
-				_, _ = fmt.Fprintf(inv.Stderr, "✔ You are connected directly (p2p)\n")
+				msg := "✔ You are connected directly (p2p)"
+				if overPrivateNetwork {
+					msg += ", over a private network"
+				}
+				_, _ = fmt.Fprintln(inv.Stderr, msg)
 			} else {
 				_, _ = fmt.Fprintf(inv.Stderr, "❗ You are connected via a DERP relay, not directly (p2p)\n%s#common-problems-with-direct-connections\n", connDiags.TroubleshootingURL)
 			}
@@ -329,3 +334,11 @@ func isAWSIP(awsRanges *cliutil.AWSIPRanges, ni *tailcfg.NetInfo) bool {
 	}
 	return false
 }
+
+func isPrivateEndpoint(endpoint string) bool {
+	ip, err := netip.ParseAddrPort(endpoint)
+	if err != nil {
+		return false
+	}
+	return ip.Addr().IsPrivate()
+}

Original file line number	Diff line number	Diff line change
`@@ -411,7 +411,7 @@ func (d ConnDiags) splitDiagnostics() (general, client, agent []string) {`
`411`	`411`	`}`
`412`	`412`
`413`	`413`	`if d.DisableDirect {`
`414`		- general = append(general, "❗ Direct connections are disabled locally, by `--disable-direct` or `CODER_DISABLE_DIRECT`")
	`414`	+ general = append(general, "❗ Direct connections are disabled locally, by `--disable-direct-connections` or `CODER_DISABLE_DIRECT_CONNECTIONS`")
`415`	`415`	`if !d.Verbose {`
`416`	`416`	`return general, client, agent`
`417`	`417`	`}`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,6 @@ func (r RootCmd) ping() serpent.Command {`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`if r.disableDirect {`
`131`		`- _, _ = fmt.Fprintln(inv.Stderr, "Direct connections disabled.")`
`132`	`131`	`opts.BlockEndpoints = true`
`133`	`132`	`}`
`134`	`133`	`if !r.disableNetworkTelemetry {`
`@@ -197,6 +196,7 @@ func (r RootCmd) ping() serpent.Command {`
`197`	`196`	`results := &pingSummary{`
`198`	`197`	`Workspace: workspaceName,`
`199`	`198`	`}`
	`199`	`+ var overPrivateNetwork bool`
`200`	`200`	`n := 0`
`201`	`201`	`start := time.Now()`
`202`	`202`	`pingLoop:`
`@@ -240,6 +240,7 @@ func (r RootCmd) ping() serpent.Command {`
`240`	`240`	`_, _ = fmt.Fprintln(inv.Stdout, "p2p connection established in",`
`241`	`241`	`pretty.Sprint(cliui.DefaultStyles.DateTimeStamp, time.Since(start).Round(time.Millisecond).String()),`
`242`	`242`	`)`
	`243`	`+ overPrivateNetwork = isPrivateEndpoint(pong.Endpoint)`
`243`	`244`	`}`
`244`	`245`	`didP2p = true`
`245`	`246`
`@@ -276,7 +277,11 @@ func (r RootCmd) ping() serpent.Command {`
`276`	`277`	`}`
`277`	`278`
`278`	`279`	`if didP2p {`
`279`		`- _, _ = fmt.Fprintf(inv.Stderr, "✔ You are connected directly (p2p)\n")`
	`280`	`+ msg := "✔ You are connected directly (p2p)"`
	`281`	`+ if overPrivateNetwork {`
	`282`	`+ msg += ", over a private network"`
	`283`	`+ }`
	`284`	`+ _, _ = fmt.Fprintln(inv.Stderr, msg)`
`280`	`285`	`} else {`
`281`	`286`	`_, _ = fmt.Fprintf(inv.Stderr, "❗ You are connected via a DERP relay, not directly (p2p)\n%s#common-problems-with-direct-connections\n", connDiags.TroubleshootingURL)`
`282`	`287`	`}`
`@@ -329,3 +334,11 @@ func isAWSIP(awsRanges cliutil.AWSIPRanges, ni tailcfg.NetInfo) bool {`
`329`	`334`	`}`
`330`	`335`	`return false`
`331`	`336`	`}`
	`337`	`+`
	`338`	`+func isPrivateEndpoint(endpoint string) bool {`
	`339`	`+ ip, err := netip.ParseAddrPort(endpoint)`
	`340`	`+ if err != nil {`
	`341`	`+ return false`
	`342`	`+ }`
	`343`	`+ return ip.Addr().IsPrivate()`
	`344`	`+}`