1834725 - Report errors related to sourcemap somewhere in debugger UI

Status: RESOLVED FIXED

(DevTools :: Debugger, enhancement)

Description

[Alexandre Poirot [:ochameau]]

For now, many errors related to source maps are only logged into the browser console.
If the sourcemap is still functional enough, you may be able to see some original sources and see some error message in CodeMirror. But in various cases, you won't be able to know that something went wrong.

We should find one or many placeholder where to display such errors.
We may have a first UI element where we display early errors, which doesn't related to any specific original source. Like unable to fetch the source map file, invalid source map file,...
And then a second UI element specific to each original source where we may should errors specific to a particular source.

Comment 1

[Alexandre Poirot [:ochameau]]

Attachment: Bug 1834725 - [devtools] Show various source-map settings in the Sources Tree.

• a first toggle to enable/disable source-map entirely (you need to reload the page to see a difference)
• a second one finally displaying the implicit "should select original source" boolean,
  which is equivalent of clicking on footer's link... but at least we have a clear UI state to
  explain if pause and links will show/open original sources or not.
• a last one to hide generated sources from the sources tree.
  Not sure the other way around could be useful: only show generated? should rather disable source maps?

Comment 2

[Alexandre Poirot [:ochameau]]

Attachment: Bug 1834725 - [devtools] Tweak original CSS handling in the Style Editor.

• Accept exceptions from getOriginalURLS.
• Avoid instantiating an editor for functional original sources.
  Solely for getting their friendlyName, whereas we could lazily compute it only when we need it.

Comment 3

[Alexandre Poirot [:ochameau]]

Attachment: Bug 1834725 - [devtools] Log source map errors to the console directly from SourceMapLoader.

Also re-throw the exception so that the debugger can start displaying source map errors.

Comment 4

[Alexandre Poirot [:ochameau]]

Attachment: Bug 1834725 - [devtools] Introduce a new Menu Button dedicated to source maps.

I'm introducing a new dedicated method on SourceMapLoader so that we can:

• ensure retrieving the resolved source map URL, even in case of errors
  so that we can easily open the source map file from the frontend.
• pass all useful data in one worker call (ignore urls + sources + error + resolve source map url)

I'm also introducing a duplicate UI from the previous patches in the SourceTree to control SourceMaps
directly from the Footer. This is probably a better place to show Source Map errors?
And while displaying errors, it may be more relevant to also be able to control all source map settings?

Comment 5

[Phabricator Automation]

Comment on attachment 9351841 [details]
Bug 1834725 - [devtools] Show various source-map settings in the Sources Tree.

Revision D187574 was moved to bug 1853897. Setting attachment 9351841 [details] to obsolete.

Comment 6

[Alexandre Poirot [:ochameau]]

Attachment: Bug 1834725 - [devtools] Retrieve the resolved source map URL and source map error.

Comment 7

[Alexandre Poirot [:ochameau]]

Attachment: Bug 1834725 - [devtools] Surface source map errors in Debugger frontend.

I'm introducing a new dedicated method on SourceMapLoader so that we can:

• ensure retrieving the resolved source map URL, even in case of errors
  so that we can easily open the source map file from the frontend.
• pass all useful data in one worker call (ignore urls + sources + error + resolve source map url)

Display the source map error in a new dedicated warning footer in the bottom of the editor pane.

Comment 8

[Phabricator Automation]

Comment on attachment 9351844 [details]
Bug 1834725 - [devtools] Introduce a new Menu Button dedicated to source maps.

Revision D187577 was moved to bug 1853899. Setting attachment 9351844 [details] to obsolete.

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a920356b63eb
[devtools] Tweak original CSS handling in the Style Editor. r=devtools-reviewers,nchevobbe
https://hg.mozilla.org/integration/autoland/rev/a56f42223377
[devtools] Log source map errors to the console directly from SourceMapLoader. r=devtools-reviewers,nchevobbe
https://hg.mozilla.org/integration/autoland/rev/4a8151163607
[devtools] Retrieve the resolved source map URL and source map error. r=devtools-reviewers,nchevobbe
https://hg.mozilla.org/integration/autoland/rev/0965e956200a
[devtools] Surface source map errors in Debugger frontend. r=devtools-reviewers,nchevobbe

Comment 10

[Natalia Csoregi [:nataliaCs]]

Backed out for causing failures on browser_styleeditor_loading_with_containers.js

• backout: https://hg.mozilla.org/integration/autoland/rev/213b63af723a13b951d4379a5bd407498a7b6eea
• push: https://treeherder.mozilla.org/jobs?repo=autoland&group_state=expanded&selectedTaskRun=W9mwxSS9SpiH68xPynbBZA.0&revision=0965e956200a6a8c26fe399f18cf3ccfd9a462fd
• failure log: https://treeherder.mozilla.org/logviewer?job_id=442977552&repo=autoland&lineNumber=23245

task 2024-01-11T16:45:37.599Z] 16:45:37     INFO - TEST-PASS | devtools/client/styleeditor/test/browser_styleeditor_loading_with_containers.js | The name '<inline style sheet #1>' is correct. - 
[task 2024-01-11T16:45:37.600Z] 16:45:37     INFO - Buffered messages finished
[task 2024-01-11T16:45:37.601Z] 16:45:37     INFO - TEST-UNEXPECTED-FAIL | devtools/client/styleeditor/test/browser_styleeditor_loading_with_containers.js | the rule count is correct - Got +0, expected 3
[task 2024-01-11T16:45:37.601Z] 16:45:37     INFO - Stack trace:
[task 2024-01-11T16:45:37.601Z] 16:45:37     INFO - chrome://mochikit/content/browser-test.js:test_is:1619
[task 2024-01-11T16:45:37.601Z] 16:45:37     INFO - chrome://mochitests/content/browser/devtools/client/styleeditor/test/browser_styleeditor_loading_with_containers.js:checkSheet:63
[task 2024-01-11T16:45:37.601Z] 16:45:37     INFO - chrome://mochitests/content/browser/devtools/client/styleeditor/test/browser_styleeditor_loading_with_containers.js:null:33
[task 2024-01-11T16:45:37.602Z] 16:45:37     INFO - chrome://mochikit/content/browser-test.js:handleTask:1138
[task 2024-01-11T16:45:37.602Z] 16:45:37     INFO - chrome://mochikit/content/browser-test.js:_runTaskBasedTest:1210
[task 2024-01-11T16:45:37.602Z] 16:45:37     INFO - chrome://mochikit/content/browser-test.js:Tester_execTest:1352
[task 2024-01-11T16:45:37.602Z] 16:45:37     INFO - chrome://mochikit/content/browser-test.js:nextTest/<:1127
[task 2024-01-11T16:45:37.602Z] 16:45:37     INFO - chrome://mochikit/content/tests/SimpleTest/SimpleTest.js:SimpleTest.waitForFocus/<:1058
[task 2024-01-11T16:45:37.602Z] 16:45:37     INFO - TEST-PASS | devtools/client/styleeditor/test/browser_styleeditor_loading_with_containers.js | The active status for this sheet is correct. - 

Comment 11

[Alexandre Poirot [:ochameau]]

browser_styleeditor_loading_with_containers.js should now be fixed:
https://treeherder.mozilla.org/jobs?repo=try&test_paths=devtools%2Fclient%2Fstyleeditor%2Ftest%2F&revision=0d82ff7b887bb084905b363eb36cbed12248d714

Comment 12

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/85222078df86
[devtools] Tweak original CSS handling in the Style Editor. r=devtools-reviewers,nchevobbe
https://hg.mozilla.org/integration/autoland/rev/f7422af361da
[devtools] Log source map errors to the console directly from SourceMapLoader. r=devtools-reviewers,nchevobbe
https://hg.mozilla.org/integration/autoland/rev/fb56c6d19143
[devtools] Retrieve the resolved source map URL and source map error. r=devtools-reviewers,nchevobbe
https://hg.mozilla.org/integration/autoland/rev/2db29de32bc8
[devtools] Surface source map errors in Debugger frontend. r=devtools-reviewers,nchevobbe

Comment 13

[Cristina Horotan [:chorotan]]

https://hg.mozilla.org/mozilla-central/rev/85222078df86
https://hg.mozilla.org/mozilla-central/rev/f7422af361da
https://hg.mozilla.org/mozilla-central/rev/fb56c6d19143
https://hg.mozilla.org/mozilla-central/rev/2db29de32bc8