fix(cli): properly handle build log streaming during coder ping (#15600)

ethanndickson · web-flow · commit 6e7f65bc599e · 2024-11-20T15:50:12.000+11:00
Closes #15584. - The `Collecting Diagnostics` spinner now starts after the workspace build logs (if any) have finished streaming. - Removes network interfaces with negative MTUs from `healthsdk` diagnostics. - Improves the wording on diagnostics for MTUs below the 'safe' value to indicate that direct connections may be degraded, or rendered unusable (i.e. if every packet is dropped).
diff --git a/cli/ping.go b/cli/ping.go
@@ -103,11 +103,6 @@ func (r *RootCmd) ping() *serpent.Command {
 			ctx, cancel := context.WithCancel(inv.Context())
 			defer cancel()
 
-			spin := spinner.New(spinner.CharSets[5], 100*time.Millisecond)
-			spin.Writer = inv.Stderr
-			spin.Suffix = pretty.Sprint(cliui.DefaultStyles.Keyword, " Collecting diagnostics...")
-			spin.Start()
-
 			notifyCtx, notifyCancel := inv.SignalNotifyContext(ctx, StopSignals...)
 			defer notifyCancel()
 
@@ -118,10 +113,15 @@ func (r *RootCmd) ping() *serpent.Command {
 				workspaceName,
 			)
 			if err != nil {
-				spin.Stop()
 				return err
 			}
 
+			// Start spinner after any build logs have finished streaming
+			spin := spinner.New(spinner.CharSets[5], 100*time.Millisecond)
+			spin.Writer = inv.Stderr
+			spin.Suffix = pretty.Sprint(cliui.DefaultStyles.Keyword, " Collecting diagnostics...")
+			spin.Start()
+
 			opts := &workspacesdk.DialAgentOptions{}
 
 			if r.verbose {
diff --git a/codersdk/healthsdk/interfaces.go b/codersdk/healthsdk/interfaces.go
@@ -68,11 +68,14 @@ func generateInterfacesReport(st *interfaces.State) (report InterfacesReport) {
 			continue
 		}
 		report.Interfaces = append(report.Interfaces, healthIface)
-		if iface.MTU < safeMTU {
+		// Some loopback interfaces on Windows have a negative MTU, which we can
+		// safely ignore in diagnostics.
+		if iface.MTU > 0 && iface.MTU < safeMTU {
 			report.Severity = health.SeverityWarning
 			report.Warnings = append(report.Warnings,
 				health.Messagef(health.CodeInterfaceSmallMTU,
-					"Network interface %s has MTU %d (less than %d), which may degrade the quality of direct connections", iface.Name, iface.MTU, safeMTU),
+					"Network interface %s has MTU %d (less than %d), which may degrade the quality of direct "+
+						"connections or render them unusable.", iface.Name, iface.MTU, safeMTU),
 			)
 		}
 	}

Original file line number	Diff line number	Diff line change
`@@ -68,11 +68,14 @@ func generateInterfacesReport(st *interfaces.State) (report InterfacesReport) {`
`68`	`68`	`continue`
`69`	`69`	`}`
`70`	`70`	`report.Interfaces = append(report.Interfaces, healthIface)`
`71`		`- if iface.MTU < safeMTU {`
	`71`	`+ // Some loopback interfaces on Windows have a negative MTU, which we can`
	`72`	`+ // safely ignore in diagnostics.`
	`73`	`+ if iface.MTU > 0 && iface.MTU < safeMTU {`
`72`	`74`	`report.Severity = health.SeverityWarning`
`73`	`75`	`report.Warnings = append(report.Warnings,`
`74`	`76`	`health.Messagef(health.CodeInterfaceSmallMTU,`
`75`		`- "Network interface %s has MTU %d (less than %d), which may degrade the quality of direct connections", iface.Name, iface.MTU, safeMTU),`
	`77`	`+ "Network interface %s has MTU %d (less than %d), which may degrade the quality of direct "+`
	`78`	`+ "connections or render them unusable.", iface.Name, iface.MTU, safeMTU),`
`76`	`79`	`)`
`77`	`80`	`}`
`78`	`81`	`}`