fix(cli): generate correctly named file in DumpHandler (#12409)

mafredri · web-flow · commit 4ce1448bbea1 · 2024-03-04T18:35:33.000+02:00
diff --git a/cli/agent.go b/cli/agent.go
@@ -149,7 +149,7 @@ func (r *RootCmd) workspaceAgent() *clibase.Cmd {
 
 			// DumpHandler does signal handling, so we call it after the
 			// reaper.
-			go DumpHandler(ctx)
+			go DumpHandler(ctx, "agent")
 
 			logWriter := &lumberjackWriteCloseFixer{w: &lumberjack.Logger{
 				Filename: filepath.Join(logDir, "coder-agent.log"),
diff --git a/cli/root.go b/cli/root.go
@@ -937,7 +937,7 @@ func (r *RootCmd) Verbosef(inv *clibase.Invocation, fmtStr string, args ...inter
 // A SIGQUIT handler will not be registered if GOTRACEBACK=crash.
 //
 // On Windows this immediately returns.
-func DumpHandler(ctx context.Context) {
+func DumpHandler(ctx context.Context, name string) {
 	if runtime.GOOS == "windows" {
 		// free up the goroutine since it'll be permanently blocked anyways
 		return
@@ -992,7 +992,11 @@ func DumpHandler(ctx context.Context) {
 		if err != nil {
 			dir = os.TempDir()
 		}
-		fpath := filepath.Join(dir, fmt.Sprintf("coder-agent-%s.dump", time.Now().Format("2006-01-02T15:04:05.000Z")))
+		// Make the time filesystem-safe, for example ":" is not
+		// permitted on many filesystems. Note that Z here only appends
+		// Z to the string, it does not actually change the time zone.
+		filesystemSafeTime := time.Now().UTC().Format("2006-01-02T15-04-05.000Z")
+		fpath := filepath.Join(dir, fmt.Sprintf("coder-%s-%s.dump", name, filesystemSafeTime))
 		_, _ = fmt.Fprintf(os.Stderr, "writing dump to %q\n", fpath)
 
 		f, err := os.Create(fpath)
diff --git a/cli/server.go b/cli/server.go
@@ -289,7 +289,7 @@ func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd.
 				cliui.Warnf(inv.Stderr, "YAML support is experimental and offers no compatibility guarantees.")
 			}
 
-			go DumpHandler(ctx)
+			go DumpHandler(ctx, "coderd")
 
 			// Validate bind addresses.
 			if vals.Address.String() != "" {
diff --git a/enterprise/cli/proxyserver.go b/enterprise/cli/proxyserver.go
@@ -119,7 +119,7 @@ func (r *RootCmd) proxyServer() *clibase.Cmd {
 			defer topCancel()
 			closers.Add(topCancel)
 
-			go cli.DumpHandler(ctx)
+			go cli.DumpHandler(ctx, "workspace-proxy")
 
 			cli.PrintLogo(inv, "Coder Workspace Proxy")
 			logger, logCloser, err := clilog.New(clilog.FromDeploymentValues(cfg)).Build(inv)

Original file line number	Diff line number	Diff line change
`@@ -289,7 +289,7 @@ func (r RootCmd) Server(newAPI func(context.Context, coderd.Options) (*coderd.`
`289`	`289`	`cliui.Warnf(inv.Stderr, "YAML support is experimental and offers no compatibility guarantees.")`
`290`	`290`	`}`
`291`	`291`
`292`		`- go DumpHandler(ctx)`
	`292`	`+ go DumpHandler(ctx, "coderd")`
`293`	`293`
`294`	`294`	`// Validate bind addresses.`
`295`	`295`	`if vals.Address.String() != "" {`