Fix race

ammario · ammario · commit 82ce7a21410c · 2023-06-06T01:03:27.000Z
diff --git a/cli/ssh.go b/cli/ssh.go
@@ -77,8 +77,18 @@ func (r *RootCmd) ssh() *clibase.Cmd {
 				if err != nil {
 					return xerrors.Errorf("error opening %s for logging: %w", logFilePath, err)
 				}
-				logger = slog.Make(sloghuman.Sink(logFile))
-				defer logFile.Close()
+				// HACK: Something was keeping a reference to this file
+				// after the goroutine ends, leading to the race observed
+				// here: https://github.com/coder/coder/actions/runs/5178818818/jobs/9331016395.
+				rd, wr := io.Pipe()
+				go func() {
+					_, _ = io.Copy(logFile, rd)
+				}()
+				defer func() {
+					_ = wr.Close()
+					_ = logFile.Close()
+				}()
+				logger = slog.Make(sloghuman.Sink(wr))
 				if r.verbose {
 					logger = logger.Leveled(slog.LevelDebug)
 				}
diff --git a/cli/ssh_test.go b/cli/ssh_test.go
@@ -441,10 +441,12 @@ func TestSSH(t *testing.T) {
 		pty.WriteLine("exit")
 		<-cmdDone
 
-		_, err := os.Stat(logFile)
+		info, err := os.Stat(logFile)
 		if err != nil {
 			t.Fatalf("failed to find ssh logfile: %v", err)
 		}
+
+		require.Greater(t, info.Size(), int64(0), "ssh logfile is empty")
 	})
 }
 
diff --git a/docs/cli/ssh.md b/docs/cli/ssh.md
@@ -39,24 +39,14 @@ Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, b
 
 Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent must also be enabled.
 
-### --log-dir
+### -l, --log-file
 
-|             |                                 |
-| ----------- | ------------------------------- |
-| Type        | <code>string</code>             |
-| Environment | <code>$CODER_SSH_LOG_DIR</code> |
-| Default     | <code>/tmp</code>               |
-
-Specify the location for the log files.
-
-### -l, --log-to-file
-
-|             |                                     |
-| ----------- | ----------------------------------- |
-| Type        | <code>bool</code>                   |
-| Environment | <code>$CODER_SSH_LOG_TO_FILE</code> |
+|             |                                  |
+| ----------- | -------------------------------- |
+| Type        | <code>string</code>              |
+| Environment | <code>$CODER_SSH_LOG_FILE</code> |
 
-Enable diagnostic logging to file.
+Specify the location of an SSH diagnostic log file.
 
 ### --no-wait
 

Original file line number	Diff line number	Diff line change
`@@ -441,10 +441,12 @@ func TestSSH(t *testing.T) {`
`441`	`441`	`pty.WriteLine("exit")`
`442`	`442`	`<-cmdDone`
`443`	`443`
`444`		`- _, err := os.Stat(logFile)`
	`444`	`+ info, err := os.Stat(logFile)`
`445`	`445`	`if err != nil {`
`446`	`446`	`t.Fatalf("failed to find ssh logfile: %v", err)`
`447`	`447`	`}`
	`448`	`+`
	`449`	`+ require.Greater(t, info.Size(), int64(0), "ssh logfile is empty")`
`448`	`450`	`})`
`449`	`451`	`}`
`450`	`452`