Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit c8a7222

Browse files
ethanndicksonethanndickson
committed
feat(cli): add p2p diagnostics to ping
1 parent c8eacc6 commit c8a7222

File tree

8 files changed

+286
-5
lines changed

8 files changed

+286
-5
lines changed

‎agent/api.go

+1
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ func (a *agent) apiHandler() http.Handler {
3737
}
3838
promHandler := PrometheusMetricsHandler(a.prometheusRegistry, a.logger)
3939
r.Get("/api/v0/listening-ports", lp.handler)
40+
r.Get("/api/v0/netcheck", a.HandleNetcheck)
4041
r.Get("/debug/logs", a.HandleHTTPDebugLogs)
4142
r.Get("/debug/magicsock", a.HandleHTTPDebugMagicsock)
4243
r.Get("/debug/magicsock/debug-logging/{state}", a.HandleHTTPMagicsockDebugLoggingState)

‎agent/health.go

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
package agent
2+
3+
import (
4+
"net/http"
5+
6+
"github.com/coder/coder/v2/coderd/healthcheck/health"
7+
"github.com/coder/coder/v2/coderd/httpapi"
8+
"github.com/coder/coder/v2/codersdk"
9+
"github.com/coder/coder/v2/codersdk/healthsdk"
10+
)
11+
12+
func (a *agent) HandleNetcheck(rw http.ResponseWriter, r *http.Request) {
13+
ni := a.TailnetConn().GetNetInfo()
14+
15+
ifReport, err := healthsdk.RunInterfacesReport()
16+
if err != nil {
17+
httpapi.Write(r.Context(), rw, http.StatusInternalServerError, codersdk.Response{
18+
Message: "Failed to run interfaces report",
19+
Detail: err.Error(),
20+
})
21+
}
22+
23+
httpapi.Write(r.Context(), rw, http.StatusOK, healthsdk.AgentNetcheckReport{
24+
BaseReport: healthsdk.BaseReport{
25+
Severity: health.SeverityOK,
26+
},
27+
NetInfo: ni,
28+
Interfaces: ifReport,
29+
})
30+
}

‎cli/cliui/agent.go

+49
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,11 @@ import (
1010

1111
"github.com/google/uuid"
1212
"golang.org/x/xerrors"
13+
"tailscale.com/tailcfg"
1314

1415
"github.com/coder/coder/v2/codersdk"
16+
"github.com/coder/coder/v2/codersdk/healthsdk"
17+
"github.com/coder/coder/v2/codersdk/workspacesdk"
1518
"github.com/coder/coder/v2/tailnet"
1619
)
1720

@@ -346,3 +349,49 @@ func PeerDiagnostics(w io.Writer, d tailnet.PeerDiagnostics) {
346349
_, _ = fmt.Fprint(w, "✘ Wireguard is not connected\n")
347350
}
348351
}
352+
353+
type ConnDiags struct {
354+
ConnInfo *workspacesdk.AgentConnectionInfo
355+
PingP2P bool
356+
LocalNetInfo *tailcfg.NetInfo
357+
LocalInterfaces *healthsdk.InterfacesReport
358+
AgentNetcheck *healthsdk.AgentNetcheckReport
359+
// TODO: More diagnostics
360+
}
361+
362+
func ConnDiagnostics(w io.Writer, d ConnDiags) {
363+
if d.AgentNetcheck != nil {
364+
for _, msg := range d.AgentNetcheck.Interfaces.Warnings {
365+
_, _ = fmt.Fprintf(w, "❗ Agent: %s\n", msg.Message)
366+
}
367+
}
368+
369+
if d.LocalInterfaces != nil {
370+
for _, msg := range d.LocalInterfaces.Warnings {
371+
_, _ = fmt.Fprintf(w, "❗ Client: %s\n", msg.Message)
372+
}
373+
}
374+
375+
if d.PingP2P {
376+
_, _ = fmt.Fprint(w, "✔ You are connected directly, peer-to-peer (p2p)\n")
377+
return
378+
}
379+
_, _ = fmt.Fprint(w, "❗ You are connected via a DERP relay, not directly, peer-to-peer (p2p)\n")
380+
381+
if d.ConnInfo != nil && d.ConnInfo.DisableDirectConnections {
382+
_, _ = fmt.Fprint(w, "❗ Your Coder administrator has blocked direct connections\n")
383+
return
384+
}
385+
386+
if d.ConnInfo != nil && d.ConnInfo.DERPMap != nil && !d.ConnInfo.DERPMap.HasSTUN() {
387+
_, _ = fmt.Fprint(w, "✘ The DERP map is not configured to use STUN, which will prevent direct connections from starting outside of local networks\n")
388+
}
389+
390+
if d.LocalNetInfo != nil && d.LocalNetInfo.MappingVariesByDestIP.EqualBool(true) {
391+
_, _ = fmt.Fprint(w, "❗ Client is potentially behind a hard NAT, as multiple endpoints were retrieved from different STUN servers\n")
392+
}
393+
394+
if d.AgentNetcheck != nil && d.AgentNetcheck.NetInfo != nil && d.AgentNetcheck.NetInfo.MappingVariesByDestIP.EqualBool(true) {
395+
_, _ = fmt.Fprint(w, "❗ Agent is potentially behind a hard NAT, as multiple endpoints were retrieved from different STUN servers\n")
396+
}
397+
}

‎cli/cliui/agent_test.go

+139
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,11 @@ import (
2020

2121
"github.com/coder/coder/v2/cli/clitest"
2222
"github.com/coder/coder/v2/cli/cliui"
23+
"github.com/coder/coder/v2/coderd/healthcheck/health"
2324
"github.com/coder/coder/v2/coderd/util/ptr"
2425
"github.com/coder/coder/v2/codersdk"
26+
"github.com/coder/coder/v2/codersdk/healthsdk"
27+
"github.com/coder/coder/v2/codersdk/workspacesdk"
2528
"github.com/coder/coder/v2/tailnet"
2629
"github.com/coder/coder/v2/testutil"
2730
"github.com/coder/serpent"
@@ -672,3 +675,139 @@ func TestPeerDiagnostics(t *testing.T) {
672675
})
673676
}
674677
}
678+
679+
func TestConnDiagnostics(t *testing.T) {
680+
t.Parallel()
681+
testCases := []struct {
682+
name string
683+
diags cliui.ConnDiags
684+
want []*regexp.Regexp
685+
}{
686+
{
687+
name: "Direct",
688+
diags: cliui.ConnDiags{
689+
ConnInfo: &workspacesdk.AgentConnectionInfo{},
690+
PingP2P: true,
691+
LocalNetInfo: &tailcfg.NetInfo{},
692+
},
693+
want: []*regexp.Regexp{
694+
regexp.MustCompile(`^✔ You are connected directly, peer-to-peer \(p2p\)$`),
695+
},
696+
},
697+
{
698+
name: "DirectBlocked",
699+
diags: cliui.ConnDiags{
700+
ConnInfo: &workspacesdk.AgentConnectionInfo{
701+
DisableDirectConnections: true,
702+
},
703+
},
704+
want: []*regexp.Regexp{
705+
regexp.MustCompile(`^❗ You are connected via a DERP relay, not directly, peer-to-peer \(p2p\)$`),
706+
regexp.MustCompile(`^❗ Your Coder administrator has blocked direct connections$`),
707+
},
708+
},
709+
{
710+
name: "NoStun",
711+
diags: cliui.ConnDiags{
712+
ConnInfo: &workspacesdk.AgentConnectionInfo{
713+
DERPMap: &tailcfg.DERPMap{},
714+
},
715+
LocalNetInfo: &tailcfg.NetInfo{},
716+
},
717+
want: []*regexp.Regexp{
718+
regexp.MustCompile(`^❗ You are connected via a DERP relay, not directly, peer-to-peer \(p2p\)$`),
719+
regexp.MustCompile(`^✘ The DERP map is not configured to use STUN, which will prevent direct connections from starting outside of local networks$`),
720+
},
721+
},
722+
{
723+
name: "ClientHardNat",
724+
diags: cliui.ConnDiags{
725+
LocalNetInfo: &tailcfg.NetInfo{
726+
MappingVariesByDestIP: "true",
727+
},
728+
},
729+
want: []*regexp.Regexp{
730+
regexp.MustCompile(`^❗ You are connected via a DERP relay, not directly, peer-to-peer \(p2p\)$`),
731+
regexp.MustCompile(`^❗ Client is potentially behind a hard NAT, as multiple endpoints were retrieved from different STUN servers$`),
732+
},
733+
},
734+
{
735+
name: "AgentHardNat",
736+
diags: cliui.ConnDiags{
737+
ConnInfo: &workspacesdk.AgentConnectionInfo{},
738+
PingP2P: false,
739+
LocalNetInfo: &tailcfg.NetInfo{},
740+
AgentNetcheck: &healthsdk.AgentNetcheckReport{
741+
NetInfo: &tailcfg.NetInfo{MappingVariesByDestIP: "true"},
742+
},
743+
},
744+
want: []*regexp.Regexp{
745+
regexp.MustCompile(`^❗ You are connected via a DERP relay, not directly, peer-to-peer \(p2p\)$`),
746+
regexp.MustCompile(`^❗ Agent is potentially behind a hard NAT, as multiple endpoints were retrieved from different STUN servers$`),
747+
},
748+
},
749+
{
750+
name: "AgentInterfaceWarnings",
751+
diags: cliui.ConnDiags{
752+
PingP2P: true,
753+
AgentNetcheck: &healthsdk.AgentNetcheckReport{
754+
Interfaces: healthsdk.InterfacesReport{
755+
BaseReport: healthsdk.BaseReport{
756+
Warnings: []health.Message{
757+
health.Messagef(health.CodeInterfaceSmallMTU, "network interface eth0 has MTU 1280, (less than 1378), which may cause problems with direct connections"),
758+
},
759+
},
760+
},
761+
},
762+
},
763+
want: []*regexp.Regexp{
764+
regexp.MustCompile(`^❗ Agent: network interface eth0 has MTU 1280, \(less than 1378\), which may cause problems with direct connections$`),
765+
regexp.MustCompile(`^✔ You are connected directly, peer-to-peer \(p2p\)$`),
766+
},
767+
},
768+
{
769+
name: "LocalInterfaceWarnings",
770+
diags: cliui.ConnDiags{
771+
PingP2P: true,
772+
LocalInterfaces: &healthsdk.InterfacesReport{
773+
BaseReport: healthsdk.BaseReport{
774+
Warnings: []health.Message{
775+
health.Messagef(health.CodeInterfaceSmallMTU, "network interface eth1 has MTU 1310, (less than 1378), which may cause problems with direct connections"),
776+
},
777+
},
778+
},
779+
},
780+
want: []*regexp.Regexp{
781+
regexp.MustCompile(`^❗ Client: network interface eth1 has MTU 1310, \(less than 1378\), which may cause problems with direct connections$`),
782+
regexp.MustCompile(`^✔ You are connected directly, peer-to-peer \(p2p\)$`),
783+
},
784+
},
785+
}
786+
for _, tc := range testCases {
787+
tc := tc
788+
t.Run(tc.name, func(t *testing.T) {
789+
t.Parallel()
790+
r, w := io.Pipe()
791+
go func() {
792+
defer w.Close()
793+
cliui.ConnDiagnostics(w, tc.diags)
794+
}()
795+
s := bufio.NewScanner(r)
796+
i := 0
797+
got := make([]string, 0)
798+
for s.Scan() {
799+
got = append(got, s.Text())
800+
if i < len(tc.want) {
801+
reg := tc.want[i]
802+
if reg.Match(s.Bytes()) {
803+
i++
804+
}
805+
}
806+
}
807+
if i < len(tc.want) {
808+
t.Logf("failed to match regexp: %s\ngot:\n%s", tc.want[i].String(), strings.Join(got, "\n"))
809+
t.FailNow()
810+
}
811+
})
812+
}
813+
}

‎cli/ping.go

+26-4
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import (
1414

1515
"github.com/coder/coder/v2/cli/cliui"
1616
"github.com/coder/coder/v2/codersdk"
17+
"github.com/coder/coder/v2/codersdk/healthsdk"
1718
"github.com/coder/coder/v2/codersdk/workspacesdk"
1819
"github.com/coder/serpent"
1920
)
@@ -61,7 +62,8 @@ func (r *RootCmd) ping() *serpent.Command {
6162
if !r.disableNetworkTelemetry {
6263
opts.EnableTelemetry = true
6364
}
64-
conn, err := workspacesdk.New(client).DialAgent(ctx, workspaceAgent.ID, opts)
65+
client := workspacesdk.New(client)
66+
conn, err := client.DialAgent(ctx, workspaceAgent.ID, opts)
6567
if err != nil {
6668
return err
6769
}
@@ -138,11 +140,31 @@ func (r *RootCmd) ping() *serpent.Command {
138140
)
139141

140142
if n == int(pingNum) {
141-
diags := conn.GetPeerDiagnostics()
142-
cliui.PeerDiagnostics(inv.Stdout, diags)
143-
return nil
143+
break
144144
}
145145
}
146+
ctx, cancel = context.WithTimeout(inv.Context(), 30*time.Second)
147+
defer cancel()
148+
diags := conn.GetPeerDiagnostics()
149+
cliui.PeerDiagnostics(inv.Stdout, diags)
150+
151+
connDiags := cliui.ConnDiags{
152+
PingP2P: didP2p,
153+
}
154+
connInfo, err := client.AgentConnectionInfoGeneric(ctx)
155+
if err == nil {
156+
connDiags.ConnInfo = &connInfo
157+
}
158+
agentNetcheck, err := conn.Netcheck(ctx)
159+
if err == nil {
160+
connDiags.AgentNetcheck = &agentNetcheck
161+
}
162+
ifReport, err := healthsdk.RunInterfacesReport()
163+
if err == nil {
164+
connDiags.LocalInterfaces = &ifReport
165+
}
166+
cliui.ConnDiagnostics(inv.Stdout, connDiags)
167+
return nil
146168
},
147169
}
148170

‎codersdk/healthsdk/healthsdk.go

+7
Original file line numberDiff line numberDiff line change
@@ -273,3 +273,10 @@ type ClientNetcheckReport struct {
273273
DERP DERPHealthReport `json:"derp"`
274274
Interfaces InterfacesReport `json:"interfaces"`
275275
}
276+
277+
// @typescript-ignore AgentNetcheckReport
278+
type AgentNetcheckReport struct {
279+
BaseReport
280+
NetInfo *tailcfg.NetInfo `json:"net_info"`
281+
Interfaces InterfacesReport `json:"interfaces"`
282+
}

‎codersdk/workspacesdk/agentconn.go

+18
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import (
2222

2323
"github.com/coder/coder/v2/coderd/tracing"
2424
"github.com/coder/coder/v2/codersdk"
25+
"github.com/coder/coder/v2/codersdk/healthsdk"
2526
"github.com/coder/coder/v2/tailnet"
2627
)
2728

@@ -241,6 +242,23 @@ func (c *AgentConn) ListeningPorts(ctx context.Context) (codersdk.WorkspaceAgent
241242
return resp, json.NewDecoder(res.Body).Decode(&resp)
242243
}
243244

245+
// Netcheck returns a network check report from the workspace agent.
246+
func (c *AgentConn) Netcheck(ctx context.Context) (healthsdk.AgentNetcheckReport, error) {
247+
ctx, span := tracing.StartSpan(ctx)
248+
defer span.End()
249+
res, err := c.apiRequest(ctx, http.MethodGet, "/api/v0/netcheck", nil)
250+
if err != nil {
251+
return healthsdk.AgentNetcheckReport{}, xerrors.Errorf("do request: %w", err)
252+
}
253+
defer res.Body.Close()
254+
if res.StatusCode != http.StatusOK {
255+
return healthsdk.AgentNetcheckReport{}, codersdk.ReadBodyAsError(res)
256+
}
257+
258+
var resp healthsdk.AgentNetcheckReport
259+
return resp, json.NewDecoder(res.Body).Decode(&resp)
260+
}
261+
244262
// DebugMagicsock makes a request to the workspace agent's magicsock debug endpoint.
245263
func (c *AgentConn) DebugMagicsock(ctx context.Context) ([]byte, error) {
246264
ctx, span := tracing.StartSpan(ctx)

‎tailnet/conn.go

+16-1
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,9 @@ func NewConn(options *Options) (conn *Conn, err error) {
294294
}()
295295
if server.telemetryStore != nil {
296296
server.wireguardEngine.SetNetInfoCallback(func(ni *tailcfg.NetInfo) {
297+
server.mutex.Lock()
298+
defer server.mutex.Unlock()
299+
server.lastNetInfo = ni.Clone()
297300
server.telemetryStore.setNetInfo(ni)
298301
nodeUp.setNetInfo(ni)
299302
server.telemetryStore.pingPeer(server)
@@ -304,7 +307,12 @@ func NewConn(options *Options) (conn *Conn, err error) {
304307
})
305308
go server.watchConnChange()
306309
} else {
307-
server.wireguardEngine.SetNetInfoCallback(nodeUp.setNetInfo)
310+
server.wireguardEngine.SetNetInfoCallback(func(ni *tailcfg.NetInfo) {
311+
server.mutex.Lock()
312+
defer server.mutex.Unlock()
313+
server.lastNetInfo = ni.Clone()
314+
nodeUp.setNetInfo(ni)
315+
})
308316
}
309317
server.wireguardEngine.SetStatusCallback(nodeUp.setStatus)
310318
server.magicConn.SetDERPForcedWebsocketCallback(nodeUp.setDERPForcedWebsocket)
@@ -373,6 +381,13 @@ type Conn struct {
373381
watchCancel func()
374382

375383
trafficStats *connstats.Statistics
384+
lastNetInfo *tailcfg.NetInfo
385+
}
386+
387+
func (c *Conn) GetNetInfo() *tailcfg.NetInfo {
388+
c.mutex.Lock()
389+
defer c.mutex.Unlock()
390+
return c.lastNetInfo.Clone()
376391
}
377392

378393
func (c *Conn) SetTunnelDestination(id uuid.UUID) {

0 commit comments

Comments
 (0)