Add exception as HTML comment to beginning and end of `exception_full.html.twig` #31514

ruudk · 2019-05-16T14:24:38Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Tests pass?	yes
License	MIT

Description

Every now and then you are confronted with an exception in Symfony's debug mode. Sometimes, you will see this in your browser console or terminal. To make it easier to easily see what's going on, this change adds a HTML comment on 2 locations:

between the <html> and <head> tag;
between the </body> and </html> tag.

This way, you don't have to scan the very verbose HTML that Symfony generates. You can quickly glance at the end or the beginning.

How does it look?

<!-- Notice: Undefined index: payouts in /Volumes/CS/www/src/Generated/GraphQL/Query/TransactionList/Data.php line 33 (500 Internal Server Error) -->
<html>
    <head>
        <meta charset="UTF-8">
        <meta name="robots" content="noindex,nofollow">
        <meta name="viewport" content="width=device-width,initial-scale=1">
        <title>    Notice: Undefined index: payouts in /Volumes/CS/www/src/Generated/GraphQL/Query/TransactionList/Data.php line 33 (500 Internal Server Error)
</title>
        <link rel="icon" type="image/png" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABwAAAAgCAYAAAABtRhCAAADVUlEQVRIx82XX0jTURTHLYPyqZdefQx66CEo80+aYpoIkqzUikz6Z5klQoWUWYRIJYEUGpQ+lIr9U5dOTLdCtkmWZis3rbnC5fw/neYW002307mX/cZvP3/7o1PwwOdh95x7vnf39zvnd29AgBer2xO6DclAXiMqZAqxIiNIN/IYSUS2BPhjmGATchUxI+ADWiRhpWK7HKuHFVBFdmU5YvnI4grFGCaReF/EBH4KsZlGgj2JBTuCYBWRIYF8YoEOJ6wBt/gEs7mBbyOjQXruPLSdOgPCiEiPSUUHDoL8Ug5IUo9B/d5wrt+G7OAKNrODPuVdB6vRCIzN6SdBlpW9RIgk/1FeAXabzRlrUPVCS/JhbmwudztnGeeH9AyXBIwtmM3wLinZJZHifjHw2V+NBoRh+9ixQrbgbnaSIcl7cGea6hoXQbNe7za241oeO5Z0p42M4BV2EqP2D50wo+6HzvwC6C4sApNOR8cmOrtcnhtj2kYRyC9eBvXzKrBZrXSs72kFd1t3MoKVbMekQkEnSNKOO8fac3LpmK6l1TlGtsxmsdKFsecPYgwxst0cwROMYDXboSotg0WLBRqjY51jLYcENElXwW2XJKPydvoI2GN9T8rBtrAArYIUruBJXkFheCQYlCpQP6uk5dAQFQNaUROMSGVQFxLmkoQsxDJrhLbTZ+nvVsERME9MgPJRKV/58AsyomTSzE813WLFvWK++qI0xSfQl8k8Pg46sYRuv5t6dS+4RqxDwaa4BGjYH+NTQvKScIp9+YL/hoZh3jDtLRHtt2C3g6bmhX+CpsFBWg7ilDSPgj0lD2ncr5ev/BP8VvyAJhqVyZeUhPOrEhEFxgEtjft846Z/guQTNT89Q5P9flMLoth4F7808wKtWWKzAwNQHxrh/1vaid2F+XpYTSbQf1XA2McOmOpROnvpvMEA4tSjq1cW0sws2gCYxswY6TKkvzYnJq1NHZLnRU4BX+4U0uburvusu8Kv8iHY7qefkM4IFngJHEOUXmLEPgiGsI8YnlZILit3vSSLRTQe/MPIZva5pshNIEmyFQlCvruJKXPkCEfmePzkphXHdzZNQdoRI9KPlBAxlj/I8U97ERPS5bjGbWDFbEdqHVe5caTBeZZx2H/IMvzeN15yoQAAAABJRU5ErkJggg==%0A">
       
       <!-- ... clip ... -->

    Sfjs.addEventListener(document, 'DOMContentLoaded', function() {
        Sfjs.createTabs();
        Sfjs.createToggles();
        Sfjs.createFilters();
    });

/*]]>*/</script>

    </body>
</html>
<!-- Notice: Undefined index: payouts in /Volumes/CS/www/src/Generated/GraphQL/Query/TransactionList/Data.php line 33 (500 Internal Server Error) -->

ruudk · 2019-05-16T14:36:39Z

Not sure why Appveyor fails. Not related to this change.

ruudk · 2019-05-16T15:09:20Z

I accidentally said it contained deprecations but it doesn't. Carson doesn't remove the label now.

src/Symfony/Bundle/TwigBundle/Resources/views/layout.html.twig

fabpot · 2019-05-18T16:08:26Z

I like this idea a lot!

ruudk · 2019-05-20T07:19:51Z

I like this idea a lot!

@fabpot Great, Anything I need to change to accept this?

src/Symfony/Bundle/TwigBundle/CHANGELOG.md

ogizanagi · 2019-05-23T15:01:13Z

Great idea!
I wonder, does it even need to be within the <html> tag, or can't it simply be first and last lines?

ruudk · 2019-05-23T15:53:04Z

I wonder, does it even need to be within the <html> tag, or can't it simply be first and last lines?

I think that would be a lot nicer indeed, first and last line. What do others think?

ruudk · 2019-05-23T15:56:32Z

Another idea:

<html><head><meta charset="UTF-8">
<!-- Notice: Undefined index: payouts in /Volumes/CS/www/src/Generated/GraphQL/Query/TransactionList/Data.php line 33 (500 Internal Server Error) -->

put the first 3 tags on 1 line, so that the comment is on line 2.

ro0NL · 2019-05-23T19:07:02Z

the issue raised by @mpdude in #31514 (comment) relates to possible Codepage Sniffing

AFAIK it's safe to put it on first line, as we set the charset already

symfony/src/Symfony/Component/HttpFoundation/Response.php

Line 280 in 63d7309

$charset = $this->charset ?: 'UTF-8';

moreover, it's always a comment, so no encoding-rendering issues involved.

ruudk · 2019-05-24T08:19:36Z

Changed it to this now:

<!-- Notice: Undefined index: payouts in /Volumes/CS/www/src/Generated/GraphQL/Query/TransactionList/Data.php line 33 (500 Internal Server Error) -->
<html>
    <head>
        <meta charset="UTF-8">
        <meta name="robots" content="noindex,nofollow">
        <meta name="viewport" content="width=device-width,initial-scale=1">
        <title>    Notice: Undefined index: payouts in /Volumes/CS/www/src/Generated/GraphQL/Query/TransactionList/Data.php line 33 (500 Internal Server Error)
</title>
        <link rel="icon" type="image/png" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABwAAAAgCAYAAAABtRhCAAADVUlEQVRIx82XX0jTURTHLYPyqZdefQx66CEo80+aYpoIkqzUikz6Z5klQoWUWYRIJYEUGpQ+lIr9U5dOTLdCtkmWZis3rbnC5fw/neYW002307mX/cZvP3/7o1PwwOdh95x7vnf39zvnd29AgBer2xO6DclAXiMqZAqxIiNIN/IYSUS2BPhjmGATchUxI+ADWiRhpWK7HKuHFVBFdmU5YvnI4grFGCaReF/EBH4KsZlGgj2JBTuCYBWRIYF8YoEOJ6wBt/gEs7mBbyOjQXruPLSdOgPCiEiPSUUHDoL8Ug5IUo9B/d5wrt+G7OAKNrODPuVdB6vRCIzN6SdBlpW9RIgk/1FeAXabzRlrUPVCS/JhbmwudztnGeeH9AyXBIwtmM3wLinZJZHifjHw2V+NBoRh+9ixQrbgbnaSIcl7cGea6hoXQbNe7za241oeO5Z0p42M4BV2EqP2D50wo+6HzvwC6C4sApNOR8cmOrtcnhtj2kYRyC9eBvXzKrBZrXSs72kFd1t3MoKVbMekQkEnSNKOO8fac3LpmK6l1TlGtsxmsdKFsecPYgwxst0cwROMYDXboSotg0WLBRqjY51jLYcENElXwW2XJKPydvoI2GN9T8rBtrAArYIUruBJXkFheCQYlCpQP6uk5dAQFQNaUROMSGVQFxLmkoQsxDJrhLbTZ+nvVsERME9MgPJRKV/58AsyomTSzE813WLFvWK++qI0xSfQl8k8Pg46sYRuv5t6dS+4RqxDwaa4BGjYH+NTQvKScIp9+YL/hoZh3jDtLRHtt2C3g6bmhX+CpsFBWg7ilDSPgj0lD2ncr5ev/BP8VvyAJhqVyZeUhPOrEhEFxgEtjft846Z/guQTNT89Q5P9flMLoth4F7808wKtWWKzAwNQHxrh/1vaid2F+XpYTSbQf1XA2McOmOpROnvpvMEA4tSjq1cW0sws2gCYxswY6TKkvzYnJq1NHZLnRU4BX+4U0uburvusu8Kv8iHY7qefkM4IFngJHEOUXmLEPgiGsI8YnlZILit3vSSLRTQe/MPIZva5pshNIEmyFQlCvruJKXPkCEfmePzkphXHdzZNQdoRI9KPlBAxlj/I8U97ERPS5bjGbWDFbEdqHVe5caTBeZZx2H/IMvzeN15yoQAAAABJRU5ErkJggg==%0A">
       
       <!-- ... clip ... -->

    Sfjs.addEventListener(document, 'DOMContentLoaded', function() {
        Sfjs.createTabs();
        Sfjs.createToggles();
        Sfjs.createFilters();
    });

/*]]>*/</script>

    </body>
</html>
<!-- Notice: Undefined index: payouts in /Volumes/CS/www/src/Generated/GraphQL/Query/TransactionList/Data.php line 33 (500 Internal Server Error) -->

….html.twig` Every now and then you are confronted with an exception in Symfony's debug mode. Sometimes, you will see this in your browser console or terminal. To make it easier to easily see what's going on, this change adds a HTML comment on 2 locations: - before the `<html>` tag; - after the `</html>` tag. This way, you don't have to scan the very verbose HTML that Symfony generates. You can quickly glance at the end or the beginning.

mpdude · 2019-05-30T15:28:14Z

Is it really that important to have the comments at the very first and last line to risk any quirks with having comments outside the tags?

If I got this right, it’s about getting developer-readable error messages also when you look at the html source of the error page or got it with curl.

ruudk · 2019-05-30T18:08:53Z

It makes it a lot easier to quickly read, yes.

I don't think there are rendering issues. Plus, these pages are only shown for developers.

fabpot · 2019-06-04T06:31:56Z

Let's merge as is. We can tweak later on if some report issues with that.

fabpot · 2019-06-04T06:32:51Z

Thank you @ruudk.

…`exception_full.html.twig` (ruudk) This PR was merged into the 4.4 branch. Discussion ---------- Add exception as HTML comment to beginning and end of `exception_full.html.twig` | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Tests pass? | yes | License | MIT ## Description Every now and then you are confronted with an exception in Symfony's debug mode. Sometimes, you will see this in your browser console or terminal. To make it easier to easily see what's going on, this change adds a HTML comment on 2 locations: - between the `<html>` and `<head>` tag; - between the `</body>` and `</html>` tag. This way, you don't have to scan the very verbose HTML that Symfony generates. You can quickly glance at the end or the beginning. ## How does it look? ```html  <html> <head> <meta charset="UTF-8"> <meta name="robots" content="noindex,nofollow"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title> Notice: Undefined index: payouts in /Volumes/CS/www/src/Generated/GraphQL/Query/TransactionList/Data.php line 33 (500 Internal Server Error) </title> <link rel="icon" type="image/png" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABwAAAAgCAYAAAABtRhCAAADVUlEQVRIx82XX0jTURTHLYPyqZdefQx66CEo80+aYpoIkqzUikz6Z5klQoWUWYRIJYEUGpQ+lIr9U5dOTLdCtkmWZis3rbnC5fw/neYW002307mX/cZvP3/7o1PwwOdh95x7vnf39zvnd29AgBer2xO6DclAXiMqZAqxIiNIN/IYSUS2BPhjmGATchUxI+ADWiRhpWK7HKuHFVBFdmU5YvnI4grFGCaReF/EBH4KsZlGgj2JBTuCYBWRIYF8YoEOJ6wBt/gEs7mBbyOjQXruPLSdOgPCiEiPSUUHDoL8Ug5IUo9B/d5wrt+G7OAKNrODPuVdB6vRCIzN6SdBlpW9RIgk/1FeAXabzRlrUPVCS/JhbmwudztnGeeH9AyXBIwtmM3wLinZJZHifjHw2V+NBoRh+9ixQrbgbnaSIcl7cGea6hoXQbNe7za241oeO5Z0p42M4BV2EqP2D50wo+6HzvwC6C4sApNOR8cmOrtcnhtj2kYRyC9eBvXzKrBZrXSs72kFd1t3MoKVbMekQkEnSNKOO8fac3LpmK6l1TlGtsxmsdKFsecPYgwxst0cwROMYDXboSotg0WLBRqjY51jLYcENElXwW2XJKPydvoI2GN9T8rBtrAArYIUruBJXkFheCQYlCpQP6uk5dAQFQNaUROMSGVQFxLmkoQsxDJrhLbTZ+nvVsERME9MgPJRKV/58AsyomTSzE813WLFvWK++qI0xSfQl8k8Pg46sYRuv5t6dS+4RqxDwaa4BGjYH+NTQvKScIp9+YL/hoZh3jDtLRHtt2C3g6bmhX+CpsFBWg7ilDSPgj0lD2ncr5ev/BP8VvyAJhqVyZeUhPOrEhEFxgEtjft846Z/guQTNT89Q5P9flMLoth4F7808wKtWWKzAwNQHxrh/1vaid2F+XpYTSbQf1XA2McOmOpROnvpvMEA4tSjq1cW0sws2gCYxswY6TKkvzYnJq1NHZLnRU4BX+4U0uburvusu8Kv8iHY7qefkM4IFngJHEOUXmLEPgiGsI8YnlZILit3vSSLRTQe/MPIZva5pshNIEmyFQlCvruJKXPkCEfmePzkphXHdzZNQdoRI9KPlBAxlj/I8U97ERPS5bjGbWDFbEdqHVe5caTBeZZx2H/IMvzeN15yoQAAAABJRU5ErkJggg==%0A">  Sfjs.addEventListener(document, 'DOMContentLoaded', function() { Sfjs.createTabs(); Sfjs.createToggles(); Sfjs.createFilters(); }); /*]]>*/</script> </body> </html>  ``` Commits ------- 11c8b45 Add exception as HTML comment to beginning and end of `exception_full.html.twig`

kevinpapst · 2019-06-09T10:35:30Z

https://developer.mozilla.org/en-US/docs/Web/HTML/Quirks_Mode_and_Standards_Mode

Make sure you put the DOCTYPE right at the beginning of your HTML document. Anything before the DOCTYPE, like a comment or an XML declaration will trigger quirks mode in Internet Explorer 9 and older.

tehplague · 2019-07-29T13:43:28Z

Make sure you put the DOCTYPE right at the beginning of your HTML document. Anything before the DOCTYPE, like a comment or an XML declaration will trigger quirks mode in Internet Explorer 9 and older.

Too bad for those developers who are still using IE9 ;)

carsonbot added Status: Needs Review Feature Deprecation labels May 16, 2019

ruudk force-pushed the exception-improvement branch from 7348d05 to 69499c2 Compare May 16, 2019 15:30

mpdude reviewed May 16, 2019

View reviewed changes

src/Symfony/Bundle/TwigBundle/Resources/views/layout.html.twig Outdated Show resolved Hide resolved

javiereguiluz removed the Deprecation label May 17, 2019

nicolas-grekas added this to the next milestone May 20, 2019

ruudk force-pushed the exception-improvement branch from 69499c2 to 9639946 Compare May 21, 2019 07:45

fabpot reviewed May 21, 2019

View reviewed changes

src/Symfony/Bundle/TwigBundle/CHANGELOG.md Outdated Show resolved Hide resolved

ruudk force-pushed the exception-improvement branch from 9639946 to 260f161 Compare May 21, 2019 10:54

ruudk force-pushed the exception-improvement branch from 260f161 to d91ea1d Compare May 24, 2019 08:18

ruudk force-pushed the exception-improvement branch from d91ea1d to 11c8b45 Compare May 24, 2019 08:25

fabpot approved these changes May 25, 2019

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels May 25, 2019

nicolas-grekas changed the base branch from master to 4.4 June 2, 2019 20:14

fabpot merged commit 11c8b45 into symfony:4.4 Jun 4, 2019

ruudk deleted the exception-improvement branch June 4, 2019 09:01

lyrixx mentioned this pull request Jul 28, 2019

Plain-text view of stack traces at the top of HTML response, in a comment #32766

Closed

nicolas-grekas modified the milestones: next, 4.4 Oct 27, 2019

This was referenced Nov 12, 2019

Release v4.4.0-BETA1 #34338

Merged

Release v5.0.0-BETA1 #34339

Merged

ro0NL mentioned this pull request Jan 17, 2020

[WebProfilerBundle] Add an HTML comment to specify the Symfony toolbar on the body tag #35372

Closed

javiereguiluz mentioned this pull request Oct 4, 2024

[TwigBridge] Improve error rendering when running tests #58456

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add exception as HTML comment to beginning and end of `exception_full.html.twig` #31514

Add exception as HTML comment to beginning and end of `exception_full.html.twig` #31514

ruudk commented May 16, 2019 •

edited

Loading

ruudk commented May 16, 2019

ruudk commented May 16, 2019

fabpot commented May 18, 2019

ruudk commented May 20, 2019

ogizanagi commented May 23, 2019

ruudk commented May 23, 2019

ruudk commented May 23, 2019

ro0NL commented May 23, 2019 •

edited

Loading

ruudk commented May 24, 2019

mpdude commented May 30, 2019

ruudk commented May 30, 2019

fabpot commented Jun 4, 2019

fabpot commented Jun 4, 2019

kevinpapst commented Jun 9, 2019

tehplague commented Jul 29, 2019

Add exception as HTML comment to beginning and end of exception_full.html.twig #31514

Add exception as HTML comment to beginning and end of exception_full.html.twig #31514

Conversation

ruudk commented May 16, 2019 • edited Loading

Description

How does it look?

ruudk commented May 16, 2019

ruudk commented May 16, 2019

fabpot commented May 18, 2019

ruudk commented May 20, 2019

ogizanagi commented May 23, 2019

ruudk commented May 23, 2019

ruudk commented May 23, 2019

ro0NL commented May 23, 2019 • edited Loading

ruudk commented May 24, 2019

mpdude commented May 30, 2019

ruudk commented May 30, 2019

fabpot commented Jun 4, 2019

fabpot commented Jun 4, 2019

kevinpapst commented Jun 9, 2019

tehplague commented Jul 29, 2019

Add exception as HTML comment to beginning and end of `exception_full.html.twig` #31514

Add exception as HTML comment to beginning and end of `exception_full.html.twig` #31514

ruudk commented May 16, 2019 •

edited

Loading

ro0NL commented May 23, 2019 •

edited

Loading