1385337 - Write MDN page describing source map failures and how to fix them

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: Developer Tools, enhancement, P2)

Description

[Tom Tromey :tromey]

In bug 1345533, I'm going to change the devtools to report source map errors
to the web console.  In bug 1385032, :bgrins made the excellent suggestion to
have an MDN page describing the different errors and what might be done to
fix them.

I think it would make sense to write this page after landing bug 1345533,
so we can make screen shots.  Meanwhile, I'm filing the bug to be sure it is
on the source-map to-do list.

Comment 1

[Tom Tromey :tromey]

Specifically see the suggestions at the end of https://bugzilla.mozilla.org/show_bug.cgi?id=1385032#c2
This bug may also require landing a change to errordocs.js in devtools.

Comment 2

[Tom Tromey :tromey]

I've been talking with Chris Mills and Sole about this.
Chris is going to make a stub page and I will fill it in.

Comment 3

[Tom Tromey :tromey]

I've got a URL now, so I wrote the patch.
Unsure if we should land this before I write the text.

Comment 4

[Tom Tromey :tromey]

Attachment: Bug 1385337 - add MDN learn more link to source map errors;

Review commit: https://reviewboard.mozilla.org/r/180386/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/180386/

Comment 5

[Brian Grinstead [:bgrins]]

Comment on attachment 8908774 [details]
Bug 1385337 - add MDN learn more link to source map errors;

https://reviewboard.mozilla.org/r/180386/#review186058

Looks good to me with the selector updated. I think it'd be OK to land without the text on the page as long as it's coming relatively soon.

::: devtools/client/webconsole/new-console-output/test/mochitest/browser_webconsole_sourcemap_nosource.js:55
(Diff revision 1)
>    yield toolbox.selectTool("webconsole");
>  
>    const node = yield waitFor(() => findMessage(hud, "original source"));
>    ok(node, "source map error is displayed in web console");
> +
> +  ok(!!node.querySelector(".message-body"), "source map error has learn more link");

This selector could be `.learn-more-link` instead.  For example, something like this:

is(node.querySelectorAll(".learn-more-link").length, 1, "source map error has learn more link");

Comment 6

[Tom Tromey :tromey]

Comment on attachment 8908774 [details]
Bug 1385337 - add MDN learn more link to source map errors;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/180386/diff/1-2/

Comment 7

[Tom Tromey :tromey]

Comment on attachment 8908774 [details]
Bug 1385337 - add MDN learn more link to source map errors;

https://reviewboard.mozilla.org/r/180386/#review186058

> This selector could be `.learn-more-link` instead.  For example, something like this:
> 
> is(node.querySelectorAll(".learn-more-link").length, 1, "source map error has learn more link");

Oops, sorry about that.

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/5430d402cfd5
add MDN learn more link to source map errors; r=bgrins

Comment 9

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

https://hg.mozilla.org/mozilla-central/rev/5430d402cfd5