feat(cli): add p2p diagnostics to ping

ethanndickson · ethanndickson · commit 6b50ee0ffe2a · 2024-08-26T04:23:15.000Z
diff --git a/cli/cliui/agent.go b/cli/cliui/agent.go
@@ -12,6 +12,7 @@ import (
 	"golang.org/x/xerrors"
 
 	"github.com/coder/coder/v2/codersdk"
+	"github.com/coder/coder/v2/codersdk/workspacesdk"
 	"github.com/coder/coder/v2/tailnet"
 )
 
@@ -346,3 +347,30 @@ func PeerDiagnostics(w io.Writer, d tailnet.PeerDiagnostics) {
 		_, _ = fmt.Fprint(w, "✘ Wireguard is not connected\n")
 	}
 }
+
+type ConnDiags struct {
+	Info    *workspacesdk.AgentConnectionInfo
+	PingP2P bool
+	// TODO: More diagnostics
+}
+
+func ConnDiagnostics(w io.Writer, d ConnDiags) {
+	if d.PingP2P {
+		_, _ = fmt.Fprintln(w, "✔ You are connected directly, peer-to-peer (p2p).")
+		return
+	}
+	_, _ = fmt.Fprintln(w, "❗ You are connected via a DERP relay, not directly, peer-to-peer (p2p).")
+
+	if d.Info == nil {
+		return
+	}
+
+	if d.Info.DisableDirectConnections {
+		_, _ = fmt.Fprintln(w, "❗ Your Coder administrator has blocked direct connections.")
+		return
+	}
+
+	if !d.Info.DERPMap.HasSTUN() {
+		_, _ = fmt.Fprintln(w, "✘ The workspace agent appears to be unable to reach any STUN servers.\nhttps://coder.com/docs/networking/stun")
+	}
+}
diff --git a/cli/ping.go b/cli/ping.go
@@ -140,6 +140,15 @@ func (r *RootCmd) ping() *serpent.Command {
 				if n == int(pingNum) {
 					diags := conn.GetPeerDiagnostics()
 					cliui.PeerDiagnostics(inv.Stdout, diags)
+
+					connDiags := cliui.ConnDiags{
+						PingP2P: didP2p,
+					}
+					connInfo, err := workspacesdk.New(client).AgentConnectionInfo(ctx, workspaceAgent.ID)
+					if err == nil {
+						connDiags.Info = &connInfo
+					}
+					cliui.ConnDiagnostics(inv.Stdout, connDiags)
 					return nil
 				}
 			}
