Escape Nodelet/tag names for Dot as well #568
Open
+89
−14
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In some programming languages, e.g. JuliaLang, function names can contain arbitrary characters. These are represented via the string macro `var"..."`, which allows constructing identifiers that wouldn't otherwise parse. These names are handled correctly by `pprof` in the FlameGraph view, but before this commit, they would produce an invalid dot file. This fixes the dot graph export for names that contain `"`.
…otentially harmful string labels. Remove mistaken `escapeStringForDot()` around tag names
This escaping requirement was previously leaking into the implementation of `graph.go`, by writing `\n` directly instead of "\n". This meant that if it was displayed in a different program besides `dot`, it would have been potentially incorrectly escaped. Now, this commit moves all the escaping directly into dotgraph, which is more encapsulated, and also allows us to escape other characters in the name which need escaping.
This allows tag newlines to stay center justified, and legend label newlines to stay left justified, as they were before we started escaping them for Dot. Also ran gofmt
|
i've just realized that i left this PR unmerged and forgot about it after merging #564... I'm reopening it as a reminder to myself to look into it, and see whether there's still anything here we need to do.. thanks |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This escaping requirement was previously leaking into the implementation
of
graph.go, by writing\ndirectly instead of "\n". This meant thatif it was displayed in a different program besides
dot, it would havebeen potentially incorrectly escaped.
Now, this commit moves all the escaping directly into dotgraph, which is
more encapsulated, and also allows us to escape other characters in the
name which need escaping.
This required adding a justify option to escapeForDot to preserve old behavior.
This allows tag newlines to stay center justified, and legend label
newlines to stay left justified, as they were before we started escaping
them for Dot.
--
This was meant to be opened as a follow-up PR to #564, but apparently I can't adjust it to use a fork's branch as a diffbase. that's disappointing. I will close this in favor of NHDaly#1 for now.