tree 3b5aa2ea5472f6ce104106a747f25b135aa650aa
parent 0368bd9e19a701277ef7ee067e44c2ac85f349b1
author Evan Jones <ej@evanjones.ca> 1647224305 -0400
committer GitHub <noreply@github.com> 1647224305 -0700
gpgsig -----BEGIN PGP SIGNATURE-----
 
 wsBcBAABCAAQBQJiLqXxCRBK7hj4Ov3rIwAAIOEIACQi6JLPXdXBsiujz/GKTNCC
 hghjJKJIjnXhGTOILo1r1E+S3+jasRjZzTHajopb8P5WN+GyI61XH5OwbqCmPXEC
 GLxR8QAXTwRVAxmg+jnMUnKyNVxZXXM3EoHMxujAEvBnyQkl4mhExpB/Y5oZd7eO
 PAu81cOQYNIWoF083XanBKyjNDU18VSyyoci53R4ISeXgkaDoaE4wp7LcWv8fKBr
 oa/gE+KeIE4si5u8hlXiCU1XoTpkENZNEEa90p49F4d/Pw5iGoTuLggC21LgaXQp
 SU7b9mHsLlRldQLNxqgGlgdwIOe3r5ezzAT51caNjPWe6CkJIpMDEt+/dUqwkhs=
 =5iUe
 -----END PGP SIGNATURE-----
 

internal/graph: Support comments with double quotes (#688)

The first comment in a pprof file is used as the subgraph ID for the
legend, but was not escaped. If the comment contained double quotes,
it could cause graphviz to fail to parse the output, or to render
incorrect graphs. To reproduce, run the following commands:

$ pprof -add_comment "unterminated \"double quote" -proto -output=bug.pprof in.pprof
Generating report in labels-no-specials-unterminated-double-quote.pprof
$ pprof -comments bug.pprof
unterminated "double quote
$ pprof -web bug.pprof
Error: <stdin>: syntax error in line 3 near '\'
pprof: failed to execute dot. Is Graphviz installed? Error: exit status 1

Add a test for this case. Without the change to dotgraph.go, the test
produced the following dot output:

digraph "testtitle" {
node [style=filled fillcolor="#f8f8f8"]
subgraph cluster_L { "comment line 1
comment line 2 "unterminated double quote" [shape=box fontsize=16 label="comment line 1\lcomment line 2 \"unterminated double quote\lsecond comment \"double quote\"\l" tooltip="testtitle"] }
N1 [label="src\n10 (10.00%)\nof 25 (25.00%)" id="node1" fontsize=22 shape=box tooltip="src (25)" color="#b23c00" fillcolor="#edddd5"]
N2 [label="dest\n15 (15.00%)\nof 25 (25.00%)" id="node2" fontsize=24 shape=box tooltip="dest (25)" color="#b23c00" fillcolor="#edddd5"]
N1 -> N2 [label=" 10" weight=11 color="#b28559" tooltip="src -> dest (10)" labeltooltip="src -> dest (10)"]
}

This failed to parse with dot:

$ dot ./internal/graph/testdata/compose9.dot
Error: ./internal/graph/testdata/compose9.dot: syntax error in line 4 near '\'

After adding the escaping, the test case now parses with dot, and the
new test case works as expected.