From b163bc7f014394dc7b59d0141d2d03c76b799243 Mon Sep 17 00:00:00 2001 From: Cian Johnston Date: Fri, 12 Apr 2024 09:40:04 +0100 Subject: [PATCH] fix(support): correctly rename existing agent connection info, add real netcheck (#12946) --- cli/support.go | 23 ++++++++++++----------- cli/support_test.go | 13 +++++++------ support/support.go | 38 ++++++++++++++++++++++++++------------ support/support_test.go | 6 ++++-- 4 files changed, 49 insertions(+), 31 deletions(-) diff --git a/cli/support.go b/cli/support.go index 88372278c1..f2f962a358 100644 --- a/cli/support.go +++ b/cli/support.go @@ -232,20 +232,21 @@ func findAgent(agentName string, haystack []codersdk.WorkspaceResource) (*coders func writeBundle(src *support.Bundle, dest *zip.Writer) error { // We JSON-encode the following: for k, v := range map[string]any{ - "deployment/buildinfo.json": src.Deployment.BuildInfo, - "deployment/config.json": src.Deployment.Config, - "deployment/experiments.json": src.Deployment.Experiments, - "deployment/health.json": src.Deployment.HealthReport, - "network/netcheck.json": src.Network.Netcheck, - "workspace/workspace.json": src.Workspace.Workspace, "agent/agent.json": src.Agent.Agent, "agent/listening_ports.json": src.Agent.ListeningPorts, "agent/manifest.json": src.Agent.Manifest, "agent/peer_diagnostics.json": src.Agent.PeerDiagnostics, "agent/ping_result.json": src.Agent.PingResult, + "deployment/buildinfo.json": src.Deployment.BuildInfo, + "deployment/config.json": src.Deployment.Config, + "deployment/experiments.json": src.Deployment.Experiments, + "deployment/health.json": src.Deployment.HealthReport, + "network/connection_info.json": src.Network.ConnectionInfo, + "network/netcheck.json": src.Network.Netcheck, "workspace/template.json": src.Workspace.Template, "workspace/template_version.json": src.Workspace.TemplateVersion, "workspace/parameters.json": src.Workspace.Parameters, + "workspace/workspace.json": src.Workspace.Workspace, } { f, err := dest.Create(k) if err != nil { @@ -265,17 +266,17 @@ func writeBundle(src *support.Bundle, dest *zip.Writer) error { // The below we just write as we have them: for k, v := range map[string]string{ - "network/coordinator_debug.html": src.Network.CoordinatorDebug, - "network/tailnet_debug.html": src.Network.TailnetDebug, - "workspace/build_logs.txt": humanizeBuildLogs(src.Workspace.BuildLogs), "agent/logs.txt": string(src.Agent.Logs), "agent/agent_magicsock.html": string(src.Agent.AgentMagicsockHTML), "agent/client_magicsock.html": string(src.Agent.ClientMagicsockHTML), "agent/startup_logs.txt": humanizeAgentLogs(src.Agent.StartupLogs), "agent/prometheus.txt": string(src.Agent.Prometheus), - "workspace/template_file.zip": string(templateVersionBytes), - "logs.txt": strings.Join(src.Logs, "\n"), "cli_logs.txt": string(src.CLILogs), + "logs.txt": strings.Join(src.Logs, "\n"), + "network/coordinator_debug.html": src.Network.CoordinatorDebug, + "network/tailnet_debug.html": src.Network.TailnetDebug, + "workspace/build_logs.txt": humanizeBuildLogs(src.Workspace.BuildLogs), + "workspace/template_file.zip": string(templateVersionBytes), } { f, err := dest.Create(k) if err != nil { diff --git a/cli/support_test.go b/cli/support_test.go index c40119c474..d9bee0fb2f 100644 --- a/cli/support_test.go +++ b/cli/support_test.go @@ -23,6 +23,7 @@ import ( "github.com/coder/coder/v2/coderd/database" "github.com/coder/coder/v2/coderd/database/dbfake" "github.com/coder/coder/v2/coderd/database/dbtime" + "github.com/coder/coder/v2/coderd/healthcheck/derphealth" "github.com/coder/coder/v2/codersdk" "github.com/coder/coder/v2/codersdk/agentsdk" "github.com/coder/coder/v2/codersdk/healthsdk" @@ -182,6 +183,10 @@ func assertBundleContents(t *testing.T, path string, wantWorkspace bool, wantAge var v healthsdk.HealthcheckReport decodeJSONFromZip(t, f, &v) require.NotEmpty(t, v, "health report should not be empty") + case "network/connection_info.json": + var v workspacesdk.AgentConnectionInfo + decodeJSONFromZip(t, f, &v) + require.NotEmpty(t, v, "agent connection info should not be empty") case "network/coordinator_debug.html": bs := readBytesFromZip(t, f) require.NotEmpty(t, bs, "coordinator debug should not be empty") @@ -189,13 +194,9 @@ func assertBundleContents(t *testing.T, path string, wantWorkspace bool, wantAge bs := readBytesFromZip(t, f) require.NotEmpty(t, bs, "tailnet debug should not be empty") case "network/netcheck.json": - var v workspacesdk.AgentConnectionInfo + var v derphealth.Report decodeJSONFromZip(t, f, &v) - if !wantAgent || !wantWorkspace { - require.Empty(t, v, "expected connection info to be empty") - continue - } - require.NotEmpty(t, v, "connection info should not be empty") + require.NotEmpty(t, v, "netcheck should not be empty") case "workspace/workspace.json": var v codersdk.Workspace decodeJSONFromZip(t, f, &v) diff --git a/support/support.go b/support/support.go index 47cad76a7d..341e01e186 100644 --- a/support/support.go +++ b/support/support.go @@ -13,6 +13,9 @@ import ( "golang.org/x/sync/errgroup" "golang.org/x/xerrors" "tailscale.com/ipn/ipnstate" + "tailscale.com/net/netcheck" + + "github.com/coder/coder/v2/coderd/healthcheck/derphealth" "github.com/google/uuid" @@ -46,9 +49,16 @@ type Deployment struct { } type Network struct { - CoordinatorDebug string `json:"coordinator_debug"` - TailnetDebug string `json:"tailnet_debug"` - Netcheck *workspacesdk.AgentConnectionInfo `json:"netcheck"` + ConnectionInfo workspacesdk.AgentConnectionInfo + CoordinatorDebug string `json:"coordinator_debug"` + Netcheck *derphealth.Report `json:"netcheck"` + TailnetDebug string `json:"tailnet_debug"` +} + +type Netcheck struct { + Report *netcheck.Report `json:"report"` + Error string `json:"error"` + Logs []string `json:"logs"` } type Workspace struct { @@ -62,6 +72,7 @@ type Workspace struct { type Agent struct { Agent *codersdk.WorkspaceAgent `json:"agent"` + ConnectionInfo *workspacesdk.AgentConnectionInfo `json:"connection_info"` ListeningPorts *codersdk.WorkspaceAgentListeningPortsResponse `json:"listening_ports"` Logs []byte `json:"logs"` ClientMagicsockHTML []byte `json:"client_magicsock_html"` @@ -136,7 +147,7 @@ func DeploymentInfo(ctx context.Context, client *codersdk.Client, log slog.Logge return d } -func NetworkInfo(ctx context.Context, client *codersdk.Client, log slog.Logger, agentID uuid.UUID) Network { +func NetworkInfo(ctx context.Context, client *codersdk.Client, log slog.Logger) Network { var ( n Network eg errgroup.Group @@ -171,15 +182,18 @@ func NetworkInfo(ctx context.Context, client *codersdk.Client, log slog.Logger, }) eg.Go(func() error { - if agentID == uuid.Nil { - log.Warn(ctx, "agent id required for agent connection info") + // Need connection info to get DERP map for netcheck + connInfo, err := workspacesdk.New(client).AgentConnectionInfoGeneric(ctx) + if err != nil { + log.Warn(ctx, "unable to fetch generic agent connection info") return nil } - connInfo, err := workspacesdk.New(client).AgentConnectionInfo(ctx, agentID) - if err != nil { - return xerrors.Errorf("fetch agent conn info: %w", err) - } - n.Netcheck = &connInfo + n.ConnectionInfo = connInfo + var rpt derphealth.Report + rpt.Run(ctx, &derphealth.ReportOptions{ + DERPMap: connInfo.DERPMap, + }) + n.Netcheck = &rpt return nil }) @@ -482,7 +496,7 @@ func Run(ctx context.Context, d *Deps) (*Bundle, error) { return nil }) eg.Go(func() error { - ni := NetworkInfo(ctx, d.Client, d.Log, d.AgentID) + ni := NetworkInfo(ctx, d.Client, d.Log) b.Network = ni return nil }) diff --git a/support/support_test.go b/support/support_test.go index 58d5c9731a..55eb6a1f23 100644 --- a/support/support_test.go +++ b/support/support_test.go @@ -62,9 +62,10 @@ func TestRun(t *testing.T) { assertSanitizedDeploymentConfig(t, bun.Deployment.Config) assertNotNilNotEmpty(t, bun.Deployment.HealthReport, "deployment health report should be present") assertNotNilNotEmpty(t, bun.Deployment.Experiments, "deployment experiments should be present") + assertNotNilNotEmpty(t, bun.Network.ConnectionInfo, "agent connection info should be present") assertNotNilNotEmpty(t, bun.Network.CoordinatorDebug, "network coordinator debug should be present") - assertNotNilNotEmpty(t, bun.Network.TailnetDebug, "network tailnet debug should be present") assertNotNilNotEmpty(t, bun.Network.Netcheck, "network netcheck should be present") + assertNotNilNotEmpty(t, bun.Network.TailnetDebug, "network tailnet debug should be present") assertNotNilNotEmpty(t, bun.Workspace.Workspace, "workspace should be present") assertSanitizedWorkspace(t, bun.Workspace.Workspace) assertNotNilNotEmpty(t, bun.Workspace.BuildLogs, "workspace build logs should be present") @@ -109,9 +110,10 @@ func TestRun(t *testing.T) { assertSanitizedDeploymentConfig(t, bun.Deployment.Config) assertNotNilNotEmpty(t, bun.Deployment.HealthReport, "deployment health report should be present") assertNotNilNotEmpty(t, bun.Deployment.Experiments, "deployment experiments should be present") + assertNotNilNotEmpty(t, bun.Network.ConnectionInfo, "agent connection info should be present") assertNotNilNotEmpty(t, bun.Network.CoordinatorDebug, "network coordinator debug should be present") + assertNotNilNotEmpty(t, bun.Network.Netcheck, "network netcheck should be present") assertNotNilNotEmpty(t, bun.Network.TailnetDebug, "network tailnet debug should be present") - assert.Empty(t, bun.Network.Netcheck, "did not expect netcheck to be present") assert.Empty(t, bun.Workspace.Workspace, "did not expect workspace to be present") assert.Empty(t, bun.Agent, "did not expect agent to be present") assertNotNilNotEmpty(t, bun.Logs, "bundle logs should be present")