Skip to content

driver: pass an empty window title to start on Windows - #1023

Merged
aalexand merged 2 commits into
google:mainfrom
HuzaifaAbdulRehman:fix-windows-start-title
Aug 30, 2026
Merged

driver: pass an empty window title to start on Windows#1023
aalexand merged 2 commits into
google:mainfrom
HuzaifaAbdulRehman:fix-windows-start-title

Conversation

@HuzaifaAbdulRehman

@HuzaifaAbdulRehman HuzaifaAbdulRehman commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

What is broken

On Windows, pprof -web and weblist never open the graph when the temp file
path contains a space, which is every account like C:\Users\Ada Lovelace\....
A blank console window appears instead, titled with that path, and pprof exits 0
without printing anything. The Go toolchain vendors this code at
src/cmd/vendor/github.com/google/pprof/internal/driver/commands.go:350, so
go tool pprof -web behaves the same way.

Root cause

commands.go:350 returns the Windows browser command as cmd /c start. The
call sites in invokeVisualizer and openBrowser split it on spaces and append
the target, and os/exec quotes any argument containing a space, so cmd
receives:

cmd /c start "C:\Users\Ada Lovelace\AppData\Local\Temp\pprof001.svg"

start reads its first quoted argument as the window title. The path is
consumed as a title, a console opens, and the file never reaches a handler.
Start() returns nil, so pprof records a success.

What changed

The Windows command carries a trailing space, so splitting it yields the empty
title argument ahead of the target. browsers() delegates to browsersForOS
so the expansion can be tested from any platform.

Nothing exported changes. Non-Windows commands are unchanged, which the test
pins for darwin.

Test plan

TestBrowsersForOS pins what each command expands to, and fails without the
trailing space:

$ go test ./internal/driver/ -run TestBrowsersForOS -count=1
--- FAIL: TestBrowsersForOS (0.00s)
    commands_test.go:31: browsersForOS("windows") expands to ["cmd" "/c" "start" "C:\Users\Ada Lovelace\...\pprof001.svg"]; want ["cmd" "/c" "start" "" "C:\Users\Ada Lovelace\...\pprof001.svg"]

End to end on Windows 10, Go 1.26.5: driving invokeVisualizer with %TMP% set
to a directory containing a space, the target is never opened before the change
and opens after. gofmt -d -s ., go vet -all ./..., staticcheck ./...,
golangci-lint run -D errcheck and go test -race ./internal/driver/ are
clean, and the full suite matches the pre-change baseline.

@aalexand

Copy link
Copy Markdown
Collaborator

The fix is pretty invasive so I'd love to find a simpler option.

Can you try this one line change:

	case "windows":
		// Trailing space causes strings.Split(v, " ") to produce an empty argument (""),
		// which 'start' requires as the window title so paths with spaces are not consumed as the title.
		cmds = append(cmds, "cmd /c start ")

?

@aalexand

Copy link
Copy Markdown
Collaborator

Or alternatively a local hack like

args := strings.Split(v, " ")
if len(args) == 0 {
    continue
}
if runtime.GOOS == "windows" && v == "cmd /c start" {
    args = append(args, "")
}
viewer := exec.Command(args[0], append(args[1:], target)...)

start reads its first quoted argument as the window title, and os/exec quotes
any argument containing a space, so a temp file path such as

	C:\Users\Ada Lovelace\AppData\Local\Temp\pprof001.svg

was consumed as the title. start opened an empty console window, the file was
never handed to a handler, and Start() returned nil so pprof recorded a success.
In non-interactive mode pprof then blocked in viewer.Wait() until that window
was closed.

The Windows browser command now carries a trailing space, so splitting it on
spaces yields the empty title argument ahead of the target. browsers() delegates
to browsersForOS so that the expansion can be tested from any platform.
@HuzaifaAbdulRehman

Copy link
Copy Markdown
Contributor Author

Switched to your one line version, trailing space and comment. webui.go is
untouched again, so the change is 10 lines plus a test.

One deviation worth flagging: browsers() now calls browsersForOS(goos), four
lines, so the test can check the Windows expansion while running on Linux. Gated
on runtime.GOOS it would never run in this CI. The test fails if the trailing
space is ever deleted, which seemed worth guarding. Happy to drop the seam if
you would rather keep the literal one liner.

Verified on Windows 10 by opening a file under a %TMP% path containing a
space. vet, staticcheck, golangci-lint and the race tests are clean.

@HuzaifaAbdulRehman

Copy link
Copy Markdown
Contributor Author

Correction to the description, which I have edited: I wrote that pprof blocks in
viewer.Wait() until the stray console window is closed. That is wrong. Running
the unpatched binary with %TMP% under a path with a space, weblist exits 0
after about three seconds and leaves the console window behind. The hang I saw
came from go test holding the inherited pipe, not from pprof.

The rest stands: the target is never opened, nothing is printed, and the window
title is the path that should have been opened.

@aalexand
aalexand enabled auto-merge (squash) August 30, 2026 19:05
@codecov-commenter

codecov-commenter commented Aug 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.38%. Comparing base (67a7179) to head (5ce5b44).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1023      +/-   ##
==========================================
+ Coverage   67.35%   67.38%   +0.03%     
==========================================
  Files          45       45              
  Lines        7847     7849       +2     
==========================================
+ Hits         5285     5289       +4     
+ Misses       2117     2115       -2     
  Partials      445      445              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@aalexand
aalexand merged commit 9b110cc into google:main Aug 30, 2026
40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants