Closed Bug 1258584 Opened 9 years ago Closed 7 years ago

Newlines don't show up in variables view sidebar

Categories

(DevTools :: Debugger, defect, P1)

defect

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: fitzgen, Assigned: tromey)

References

Details

Attachments

(2 files)

Yikes... https://twitter.com/jonathansampson/status/711988345358802948 STR: Open this in the debugger: """ <script> var s = "\nfoo\nbar\nbaz\n"; debugger; </script> """
So here's an interesting question: how should we output symbols with a newline? You can do `Symbol("foo\nbar")`. Should we run that name through the same process that we do strings? Seems like we should, but right now symbols are shown as `Symbol(foo)`, meaning it's not obvious that we're stringifying the name. Does `Symbol(foo\nbar)` have a name of "foo\\nbar" or "foo\nbar"? We could solve this by adding quotes around the name.
Attached patch 1258584.patch (deleted) — Splinter Review
This patch calls `JSON.stringify` on strings. This takes care of all values that need to be escaped. There are all kind of other characters that aren't showing up: `\r` \t` etc. Basically, we are just putting the raw string straight into the DOM. Need to solve `Symbol` as well, see comment above. Will fix/add tests if you think this approach is right.
Attachment #8733521 - Flags: feedback?(nfitzgerald)
Assignee: nobody → jlong
Priority: -- → P1
Attachment #8733521 - Flags: feedback?(nfitzgerald) → feedback+
I spent an unusual amount of time rediscovering this bug yesterday. It happens with the console as well. STR: x = {a:"string with\nnewline", b:73, c:92} then inspect the resulting object. The variable display shows a: "string withnewline" I think it should show: a: "string with\nnewline"
Assignee: jlong → nobody
It's worth considering many cases when displaying strings. Enumerating the ones I know of: * control characters - https://en.wikipedia.org/wiki/Unicode_control_characters I think it would be fine to use \uNNNN for these, Unicode provides "control character pictures", but I had never heard of these until reading that article, so it's not clear to me that displaying these would help much. Perhaps the bidi text control characters could be left alone. * zero-width characters - I know of ZWJ, ZWNJ, and ZWSP. It may make sense to display these specially as \uNNNN. * A BOM should probably be displayed explicitly. * Unpair surrogate characters should be escaped. For other unusual cases, say zalgo text, I think it's fine to just display it. The main principle is to make sure that what is there is viewable somehow -- so otherwise-invisible characters ought to be made visible. (Perhaps this argues for escaping bidi controls, I'm not sure what is best).
Let's not forget that backslash and double quote have to be escaped. Also maybe it would be nice to have some kind of "show as ascii" button for strings that aren't entirely ascii already. This would quote everything outside [32,127].
Fixed in devtools-reps.
Assignee: nobody → ttromey
Depends on: 1341635
... except not truly fixed, because it also affects the variables view, which I didn't touch.
Depends on: 1308566
Fixing VariablesView is relatively straightforward: * Export escapeString from devtools-reps * Use that in VariablesView.jsm (see VariablesView.stringifiers.byType) to quote the strings However this isn't worth doing if the object inspector change is happening imminently.
This is fixed in nightly when using the new debugger.
Status: NEW → RESOLVED
Closed: 7 years ago
Resolution: --- → FIXED
Product: Firefox → DevTools
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: