Florian Scholz (Open Web Docs) Assignee
	Description • 9 years ago

The web console emits thousands of error messages to web developers everyday. While seasoned web developers understand what is going on, especially beginners need help to understand them. Often the message gets copied, put into google, and answered on Stackoverflow.

What we could do is adding a [Learn More] link to error messages (like we already do for warnings, see CORS), so that we offer developers a direct way to get to know more about what just happened.

This could also be an icon to reduce the text noise (say a question mark in a circle).

More information is available in this etherpad: https://etherpad.mozilla.org/webconsole-mdn-error-msg and the discussion is happening here: https://groups.google.com/forum/#!topic/mozilla.dev.developer-tools/zUiTSyjIvOs

This bug is about the devtools implementation in the console.

The current [Learn More] function lives here: https://dxr.mozilla.org/mozilla-central/source/browser/devtools/webconsole/webconsole.js#1693

A link to the error docs could look like his:
https://developer.mozilla.org/docs/Web/JavaScript/Errors/JSMSG_BAD_RADIX

where "JSMSG_BAD_RADIX" is an "errorNumber" from https://dxr.mozilla.org/mozilla-central/source/js/src/js.msg

I will file a depended bug to get "errorNumber" added to nsIScriptError.

	Sylvestre Ledru [:Sylvestre]
	Comment 2 • 8 years ago

Release Note Request (optional, but appreciated)
[Why is this notable]: Great new features for developers - http://imgur.com/EOztwbI
[Suggested wording]: Console errors provide links to an "MDN error reference"
[Links (documentation, blog post, etc)]: having a doc would help

	Morgan Phillips [:mrrrgn]
	Comment 4 • 8 years ago

Comment on attachment 8758019 [details] [diff] [review]
Add more doc links to console errors

Review of attachment 8758019 [details] [diff] [review]:
-----------------------------------------------------------------

So much \m/! :)

	Florian Scholz (Open Web Docs) Assignee
	Comment 5 • 8 years ago

Okay, some more docs written. Let's land these :)

	Florian Scholz (Open Web Docs) Assignee
	Comment 6 • 8 years ago

Morgan, I updated the patch to include some more docs. Can you land this? I have no clue how to do that properly and might not have required permissions etc.

	Morgan Phillips [:mrrrgn]
	Comment 7 • 8 years ago

(In reply to Florian Scholz [:fscholz] (MDN) from comment #6)
> Morgan, I updated the patch to include some more docs. Can you land this? I
> have no clue how to do that properly and might not have required permissions
> etc.

No problem, will land the patch tonight.

	Pulsebot
	Comment 8 • 8 years ago

Pushed by mphillips@mozilla.com:
https://hg.mozilla.org/integration/mozilla-inbound/rev/8203279f09e3
Permafails browser_webconsole_bug_653531_highlighter_console_helper.js; r=backout

	Morgan Phillips [:mrrrgn]
	Comment 9 • 8 years ago

Comment on attachment 8758916 [details] [diff] [review]
errordocs.patch

Review of attachment 8758916 [details] [diff] [review]:
-----------------------------------------------------------------

I did a poor job reviewing this my first pass through. There is a bug here that needs fixin' also the bug number in the commit message is wrong.

::: devtools/server/actors/errordocs.js
@@ +51,3 @@
>  };
>  
> +exports.GetURL = (errorName) => baseURL + ErrorDocs[errorName];

This should be something like:

exports.GetURL = (errorName) => {
    let doc = ErrorDocs[errorName];
    if (doc)
        return baseURL + doc;
    return undefined;
}

Otherwise every possible error will return a learn more link to baseURL/undefined.

	Morgan Phillips [:mrrrgn]
	Comment 10 • 8 years ago

s/possible error/error that doesn't have a doc url/

	Carsten Book [:Tomcat]
	Comment 12 • 8 years ago
bugherder

https://hg.mozilla.org/mozilla-central/rev/8203279f09e3

	Carsten Book [:Tomcat]
	Comment 13 • 8 years ago
bugherder

https://hg.mozilla.org/mozilla-central/rev/8203279f09e3

	Florian Scholz (Open Web Docs) Assignee
	Comment 14 • 8 years ago

Yup, this was backed out. Revised patch is attached. Sorry for the trouble.

	Morgan Phillips [:mrrrgn]
	Comment 15 • 8 years ago

Landing after this try run looks green enough: https://treeherder.mozilla.org/#/jobs?repo=try&revision=67615de240c4

	Marcia Knous [:marcia]
	Comment 16 • 8 years ago

Relnote 49+ with the suggested wording "Console errors provide links to an "MDN error reference"

	Marcia Knous [:marcia]
	Comment 17 • 8 years ago

(In reply to Marcia Knous [:marcia - use ni] from comment #16)
> Relnote 49+ with the suggested wording "Console errors provide links to an
> "MDN error reference"

I assume this will eventually be in https://developer.mozilla.org/en-US/Firefox/Releases/49#Changes_for_Web_developers, so when it lands there I can just point to it in the release notes if necessary.

	Pulsebot
	Comment 18 • 8 years ago

Pushed by mphillips@mozilla.com:
https://hg.mozilla.org/integration/mozilla-inbound/rev/b9e7c2e445f4
Add more doc links to console errors; r=mrrrgn

	Carsten Book [:Tomcat]
	Comment 19 • 8 years ago
bugherder

https://hg.mozilla.org/mozilla-central/rev/b9e7c2e445f4

	Sebastian Zartner [:sebo]
	Comment 20 • 8 years ago

Florian, is https://developer.mozilla.org/en-US/Firefox/Releases/49#Developer_Tools enough, or should it also be mentioned somewhere else?

Sebastian

	Sebastian Zartner [:sebo]
	Comment 21 • 8 years ago

Well, I've also added a note here now:
https://developer.mozilla.org/en-US/docs/Tools/Web_Console/Console_messages#JS

Sebastian

	Florian Scholz (Open Web Docs) Assignee
	Comment 22 • 8 years ago

Thanks Sebastian! I've updated the docs with a link to the Hacks blog post and added the gif showing the feature to the console page.

(In reply to Marcia Knous [:marcia - use ni] from comment #17)
> (In reply to Marcia Knous [:marcia - use ni] from comment #16)
> > Relnote 49+ with the suggested wording "Console errors provide links to an
> > "MDN error reference"
> 
> I assume this will eventually be in
> https://developer.mozilla.org/en-US/Firefox/Releases/
> 49#Changes_for_Web_developers, so when it lands there I can just point to it
> in the release notes if necessary.

https://hacks.mozilla.org/2016/06/helping-web-developers-with-javascript-errors/ has the best summary of this feature. I would link to this blog post from the release notes.

	Sylvestre Ledru [:Sylvestre]
	Comment 23 • 8 years ago

49 release notes updated with a link to the blog post, thanks!

	Mohammad Maruf Rahman
	Comment 24 • 8 years ago

This bug as about to implement "links to an 'MDN error reference' from console errors" as mentioned as #comment0 . I have seen the features being implemented with Beta 49.0 on Windows 7, 64 Bit !

This bug's fix is verified with latest Beta 49.0

Build   ID  20160912134115
User Agent  Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:49.0) Gecko/20100101 Firefox/49.0

[bugday-20160914]