Display the log context in the debug pages #24151

javiereguiluz · 2017-09-11T10:13:05Z

Q	A
Branch?	3.4
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#23589
License	MIT
Doc PR	-

Before

After

I'd like to exclude the event channel context because it only adds noise:

This change would require to add a hard dependency to the VarDumper component. Do we want to do that? Thanks!

fabpot · 2017-09-11T17:30:16Z

Removing the event channel should probably not be harcoded, but moved to the default configuration in Flex/Symfony SE.

ro0NL · 2017-09-11T19:52:38Z

@fabpot is there a (hacky) way in twig to check if profiler_dump exists? Can we think of one? :)

edit: a wrapper in CodeExtension could do

javiereguiluz · 2017-09-22T18:01:50Z

Instead of complicating things with a new config option to make the list of excluded channels configurable, could we hardcode it? For our own log channels this is correct (event is annoying but the rest are useful). The only problem could be if users want to exclude some custom channels that are also annoying. I'd say: let's not implement that unless a significant number of people ask for it.

jvasseur · 2017-09-24T17:37:54Z

Maybe we could detect if all the informations from the context are used in the message an hide the context in those cases ?

This PR was squashed before being merged into the 3.3 branch (closes #24244). Discussion ---------- TwigBundle exception/deprecation tweaks | Q | A | ------------- | --- | Branch? | 3.3 | Bug fix? | yes | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes/no | Fixed tickets | #...  | License | MIT | Doc PR | symfony/symfony-docs#...  - 1st commit) if you view a exception in the profiler, there is no logger available. Making the tab useless, disabled state is now triggered at zero log messages. There's a specialized panel here. - 2nd commit) when an exception occurs this highlights deprecations in the log table outside the profiler with a warning status. This follows the same signal colors in the profiler. - 3rd commit) hide the default inactive tabs from CSS to avoid scrollbar flickering. - 4th commit) favors document.DOMContentLoaded over window.load, we dont want to wait for images to be loaded Further out-of-scope improvements could be; - From #24191; i think the logs table should show a direct `View file` link for every error/deprecation/red or yellow line in here. Traversing with `Show context` is tedious. - links to file.php for your trigger_error() calls - links to config.yml for trigger_error() calls by SF - From #24151; having the same tooling on both sides is nice - Events/Translations logs is noise, we have specialized panels for those. To further reduce the overall page size container logs can be moved away too, linked from Configuration and/or Logs. Also see #23247 Commits ------- 1c595fc [TwigBundle][WebProfilerBundle] Switch to DOMContentLoaded event ea4b096 [WebProfilerBundle] Hide inactive tabs from CSS 0c10f97 [TwigBundle] Make deprecations scream in logs 03cd9e5 [TwigBundle] Hide logs if unavailable, i.e. webprofiler

stof · 2017-09-27T19:21:35Z

src/Symfony/Bundle/TwigBundle/Resources/views/Exception/logs.html.twig

@@ -22,6 +22,12 @@
                </td>
            {% endif %}
            <td>{{ log.message|format_log_message(log.context) }}</td>
+            {# hide the context of the 'event' channel because it only displays duplicated information #}
+            {% if log.context ?? false and log.channel != 'event' %}
+                <div class="text-muted">


invalid markup. A div cannot be a child of a <tr>

I've checked the HTML spec and a <tr> can have <td> children and <td> can have children of any type included in "flow content": https://www.w3.org/TR/html51/tabular-data.html#the-td-element. And <div> is one of those "flow content" types: https://www.w3.org/TR/html51/dom.html#flow-content. So, are we good?

but this is not inside the <td>. It is after it

ro0NL · 2017-09-27T19:28:44Z

Why do we care about event channel, to be excluded here, actually? What we need are filters right?

Profiler doesnt do this AFAIK.

fabpot · 2017-10-01T18:13:40Z

@javiereguiluz Can you fix @stof comment here?

nicolas-grekas · 2017-10-08T16:33:21Z

ping @javiereguiluz should we move this to 4.1?

nicolas-grekas · 2017-10-12T16:16:23Z

Moving to 4.1.

stof · 2018-02-21T11:50:09Z

src/Symfony/Bundle/TwigBundle/Resources/views/Exception/logs.html.twig

+            {# hide the context of the 'event' channel because it only displays duplicated information #}
+            {% if log.context ?? false and log.channel != 'event' %}
+                <div class="text-muted">
+                    {{ profiler_dump(log.context) }}


this will indeed create a hard dependency on WebProfilerBundle in TwigBundle (which will break things in environments where WebProfilerBundle is not available)

How can we solve this? Maybe we can replace profiler_dump by yaml_dump? https://symfony.com/doc/current/reference/twig_reference.html#yaml-dump

This PR was squashed before being merged into the 3.3 branch (closes symfony#24244). Discussion ---------- TwigBundle exception/deprecation tweaks | Q | A | ------------- | --- | Branch? | 3.3 | Bug fix? | yes | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes/no | Fixed tickets | #...  | License | MIT | Doc PR | symfony/symfony-docs#...  - 1st commit) if you view a exception in the profiler, there is no logger available. Making the tab useless, disabled state is now triggered at zero log messages. There's a specialized panel here. - 2nd commit) when an exception occurs this highlights deprecations in the log table outside the profiler with a warning status. This follows the same signal colors in the profiler. - 3rd commit) hide the default inactive tabs from CSS to avoid scrollbar flickering. - 4th commit) favors document.DOMContentLoaded over window.load, we dont want to wait for images to be loaded Further out-of-scope improvements could be; - From symfony#24191; i think the logs table should show a direct `View file` link for every error/deprecation/red or yellow line in here. Traversing with `Show context` is tedious. - links to file.php for your trigger_error() calls - links to config.yml for trigger_error() calls by SF - From symfony#24151; having the same tooling on both sides is nice - Events/Translations logs is noise, we have specialized panels for those. To further reduce the overall page size container logs can be moved away too, linked from Configuration and/or Logs. Also see symfony#23247 Commits ------- 1c595fc [TwigBundle][WebProfilerBundle] Switch to DOMContentLoaded event ea4b096 [WebProfilerBundle] Hide inactive tabs from CSS 0c10f97 [TwigBundle] Make deprecations scream in logs 03cd9e5 [TwigBundle] Hide logs if unavailable, i.e. webprofiler

javiereguiluz · 2018-03-27T14:57:35Z

To not add a hard dependency on VarDumper, I propose a different implementation: the log context is dumped according to what you have installed.

If your app has VarDumper, you see this:

If your app has Yaml, you see this:

Otherwise, you see this:

ogizanagi · 2018-03-27T14:59:25Z

src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php

+    {
+        $logs = array();
+        foreach ($logger->getLogs() as $log) {
+            if (class_exists('Symfony\Component\VarDumper\Dumper\HtmlDumper')) {


You could use ::class consts.

ogizanagi · 2018-03-27T14:59:31Z

src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php

+                $dumper = new HtmlDumper();
+                $dumper->dump($cloner->cloneVar($log['context']), $output = fopen('php://memory', 'r+b'));
+                $contextAsString = stream_get_contents($output, -1, 0);
+            } elseif (class_exists('Symfony\Component\Yaml\Yaml')) {


ogizanagi · 2018-03-27T15:03:27Z

src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php

+            if (class_exists('Symfony\Component\VarDumper\Dumper\HtmlDumper')) {
+                $cloner = new VarCloner();
+                $dumper = new HtmlDumper();
+                $dumper->dump($cloner->cloneVar($log['context']), $output = fopen('php://memory', 'r+b'));


You can just pass true as the second argument since 3.2 (4be9776) to get the string as returned value.

javiereguiluz · 2018-03-27T15:07:18Z

My question ... should we complicate this so much ... or should we just always use json_encode() which works reasonable well in all cases?

stof · 2018-03-27T15:10:42Z

src/Symfony/Bundle/TwigBundle/Resources/views/Exception/logs.html.twig

@@ -22,6 +22,9 @@
                </td>
            {% endif %}
            <td>{{ log.message|format_log_message(log.context) }}</td>
+            {% if log.context ?? false %}
+                <div class="text-muted prewrap log-context">{{ log.context_as_string|raw }}</div>


currently, you have a XSS issue here: you apply the raw filter, but only the rendering using VarDumper is producing HTML properly. Other case are not escaping anything to produce HTML

stof · 2018-03-27T15:15:10Z

src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php

+            } elseif (class_exists('Symfony\Component\Yaml\Yaml')) {
+                $contextAsString = Yaml::dump((array) $log['context'], 1024);
+            } else {
+                $contextAsString = json_encode($log['context'], JSON_PRETTY_PRINT);


I suggest also adding the JSON_UNESCAPED_UNICODE and JSON_UNESCAPED_SLASHES flags to make the output more human-readable (having \u... codes for non-ASCII chars makes things harder to read)

stof · 2018-03-27T15:29:07Z

src/Symfony/Bundle/TwigBundle/Resources/views/Exception/logs.html.twig

+            <td>
+                {{ log.message|format_log_message(log.context) }}
+                {% if log.context ?? false %}
+                    <span class="block text-muted prewrap m-t-5">{{ log.context|json_encode(constant('JSON_PRETTY_PRINT') b-or constant('JSON_UNESCAPED_UNICODE') b-or constant('JSON_UNESCAPED_SLASHES')) }}</span>


it is is a block display with prewrap, why not using <pre> ? It would be the dedicated markup rather than a span

stof · 2018-03-28T14:46:27Z

src/Symfony/Bundle/TwigBundle/Resources/views/Exception/logs.html.twig

@@ -24,7 +24,7 @@
            <td>
                {{ log.message|format_log_message(log.context) }}
                {% if log.context ?? false %}
-                    <span class="block text-muted prewrap m-t-5">{{ log.context|json_encode(constant('JSON_PRETTY_PRINT') b-or constant('JSON_UNESCAPED_UNICODE') b-or constant('JSON_UNESCAPED_SLASHES')) }}</span>
+                    <pre class="text-muted prewrap m-t-5">{{ log.context|json_encode(constant('JSON_PRETTY_PRINT') b-or constant('JSON_UNESCAPED_UNICODE') b-or constant('JSON_UNESCAPED_SLASHES')) }}</pre>


do you still need prewrap here ? If no, this could be removed (and removing the class from the cSS as your PR is adding it)

Yes, I think it's needed because when outputting long lines (e.g. long class namespaces) the <pre> doesn't break lines and makes the debug page hugely wide.

fabpot · 2018-10-10T12:31:39Z

Thank you @javiereguiluz.

…luz) This PR was squashed before being merged into the 4.2-dev branch (closes #24151). Discussion ---------- Display the log context in the debug pages | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #23589 | License | MIT | Doc PR | - ### Before ![before](https://user-images.githubusercontent.com/73419/30269760-564ff2e8-96ea-11e7-98fa-0610d6a0322f.png) ### After ![after](https://user-images.githubusercontent.com/73419/30269764-5830482e-96ea-11e7-946a-a6805c28741a.png) I'd like to exclude the `event` channel context because it only adds noise: ![event-noise](https://user-images.githubusercontent.com/73419/30269774-67036f52-96ea-11e7-87c0-5ef8328f315a.png) ----- This change would require to add a hard dependency to the VarDumper component. Do we want to do that? Thanks! Commits ------- c59fbde Display the log context in the debug pages

javiereguiluz added Feature WebProfilerBundle labels Sep 11, 2017

carsonbot added the Status: Needs Review label Sep 11, 2017

nicolas-grekas added this to the 3.4 milestone Sep 11, 2017

This was referenced Sep 17, 2017

TwigBundle exception/deprecation tweaks #24244

Merged

Filter logs by level #24263

Merged

stof requested changes Sep 27, 2017

View reviewed changes

nicolas-grekas modified the milestones: 3.4, 4.1 Oct 12, 2017

stof reviewed Feb 21, 2018

View reviewed changes

stof changed the base branch from 3.4 to master February 21, 2018 11:50

ogizanagi reviewed Mar 27, 2018

View reviewed changes

stof requested changes Mar 27, 2018

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Mar 27, 2018

stof reviewed Mar 27, 2018

View reviewed changes

javiereguiluz added Status: Reviewed and removed Status: Needs Work labels Mar 27, 2018

javiereguiluz added Status: Needs Review and removed Status: Reviewed labels Mar 27, 2018

stof reviewed Mar 27, 2018

View reviewed changes

stof reviewed Mar 28, 2018

View reviewed changes

nicolas-grekas modified the milestones: 4.1, next Apr 20, 2018

fabpot approved these changes Oct 10, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Oct 10, 2018

Display the log context in the debug pages

c59fbde

fabpot force-pushed the fix_23589 branch from e33d05f to c59fbde Compare October 10, 2018 12:31

fabpot merged commit c59fbde into symfony:master Oct 10, 2018

nicolas-grekas modified the milestones: next, 4.2 Nov 1, 2018

This was referenced Nov 3, 2018

Release v4.2.0-BETA1 #29072

Closed

Release v4.2.0-BETA1 #29073

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Display the log context in the debug pages #24151

Display the log context in the debug pages #24151

javiereguiluz commented Sep 11, 2017

fabpot commented Sep 11, 2017

ro0NL commented Sep 11, 2017 •

edited

Loading

javiereguiluz commented Sep 22, 2017

jvasseur commented Sep 24, 2017 •

edited

Loading

stof Sep 27, 2017

javiereguiluz Mar 12, 2018

stof Mar 27, 2018

ro0NL commented Sep 27, 2017 •

edited

Loading

fabpot commented Oct 1, 2017

nicolas-grekas commented Oct 8, 2017

nicolas-grekas commented Oct 12, 2017

stof Feb 21, 2018

javiereguiluz Mar 12, 2018

javiereguiluz commented Mar 27, 2018

ogizanagi Mar 27, 2018

ogizanagi Mar 27, 2018

ogizanagi Mar 27, 2018

javiereguiluz commented Mar 27, 2018

stof Mar 27, 2018

stof Mar 27, 2018 •

edited

Loading

stof Mar 27, 2018

stof Mar 28, 2018

javiereguiluz Mar 28, 2018

fabpot commented Oct 10, 2018

Display the log context in the debug pages #24151

Display the log context in the debug pages #24151

Conversation

javiereguiluz commented Sep 11, 2017

Before

After

fabpot commented Sep 11, 2017

ro0NL commented Sep 11, 2017 • edited Loading

javiereguiluz commented Sep 22, 2017

jvasseur commented Sep 24, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ro0NL commented Sep 27, 2017 • edited Loading

fabpot commented Oct 1, 2017

nicolas-grekas commented Oct 8, 2017

nicolas-grekas commented Oct 12, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

javiereguiluz commented Mar 27, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

javiereguiluz commented Mar 27, 2018

Choose a reason for hiding this comment

stof Mar 27, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Oct 10, 2018

ro0NL commented Sep 11, 2017 •

edited

Loading

jvasseur commented Sep 24, 2017 •

edited

Loading

ro0NL commented Sep 27, 2017 •

edited

Loading

stof Mar 27, 2018 •

edited

Loading