[Messenger] Clone messages to show in profiler #26650

Nyholm · 2018-03-23T10:06:42Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	na
License	MIT
Doc PR	na

We should make the profiler page more pretty by using the cloner.

Nyholm · 2018-03-23T10:06:59Z

src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/messages.html.twig

@@ -50,10 +60,9 @@

 {% block toolbar %}
    {% set color_code = 'normal' %}
-    {% set message_count = 0 %}


@sroze Any reason why this was zero?

Nop, very likely a mistake 🙊

sroze · 2018-03-23T10:23:58Z

src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/messages.html.twig

@@ -31,7 +31,13 @@
        <tbody>
        {% for message in collector.messages %}
        <tr>
-            <td>{{ message.message.type }}</td>
+            <td>
+                {{ message.message.type }}


I don't believe we still need to display the type anymore if we use the dumper, as the FQCN is available as overlay :)

sroze · 2018-03-23T10:24:41Z

src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/messages.html.twig

@@ -40,6 +46,10 @@
                {% if message.exception.type is defined %}
                    {{ message.exception.type }}
                {% endif %}
+
+                {% if message.result.object is defined %}


Same idea. If defined, I'd display this instead of the message.result.type.

sroze · 2018-03-23T10:25:09Z

src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/messages.html.twig

@@ -50,10 +60,9 @@

 {% block toolbar %}
    {% set color_code = 'normal' %}
-    {% set message_count = 0 %}


Nop, very likely a mistake 🙊

Nyholm · 2018-03-23T10:28:18Z

Thank you for the review

stof · 2018-03-23T10:44:22Z

src/Symfony/Bundle/FrameworkBundle/DataCollector/MessengerDataCollector.php

@@ -63,6 +64,7 @@ public function handle($message, callable $next)
            if (is_object($result)) {
                $debugRepresentation['result'] = array(
                    'type' => get_class($result),
+                    'object' => $this->cloneVar($result),
                );
            } else {


should be cloned as well in case it is an array, as it might contain objects inside the array

btw, the template does not seem to use the value in this case when rendering the info, so why storing it ?

stof · 2018-03-23T10:47:05Z

IMO, messages should not be stored directly in $this->data in the collector, as this forbids us to store anything else in the future in this collector in case we need to collect more things. You should probably move this to $this->data['messages'] instead.

Nyholm · 2018-03-23T11:26:57Z

Thank you for the review

sroze

Looks good to me 👍 (after squashing the commits, obsly)

sroze · 2018-03-26T09:51:38Z

@Nyholm could you squash your commits?
@stof can you have another look please?

Nyholm · 2018-03-26T10:41:10Z

Done

sroze

Failure in un-related 👍

stof · 2018-03-26T17:24:41Z

src/Symfony/Bundle/FrameworkBundle/DataCollector/MessengerDataCollector.php

@@ -77,7 +84,7 @@ public function handle($message, callable $next)
            );
        }

-        $this->data[] = $debugRepresentation;
+        $this->data['messages'][] = $debugRepresentation;


collect must ensure that $this->data['messages'] is always an array, even when no message was handled there, to make getMessages work without notice after collect has been called.

@Nyholm your changes did not fix this btw 😉

Doesn't it?
Cant I trust that $this->data always to be null or an array?

https://3v4l.org/tubTL

Actually, you're right, it won't "throw" a PHP notice.

sroze · 2018-03-26T18:57:26Z

src/Symfony/Bundle/FrameworkBundle/DataCollector/MessengerDataCollector.php

@@ -77,7 +84,7 @@ public function handle($message, callable $next)
            );
        }

-        $this->data[] = $debugRepresentation;
+        $this->data['messages'][] = $debugRepresentation;


@Nyholm your changes did not fix this btw 😉

sroze · 2018-03-26T19:42:54Z

src/Symfony/Bundle/FrameworkBundle/DataCollector/MessengerDataCollector.php

@@ -77,7 +84,7 @@ public function handle($message, callable $next)
            );
        }

-        $this->data[] = $debugRepresentation;
+        $this->data['messages'][] = $debugRepresentation;


Actually, you're right, it won't "throw" a PHP notice.

sroze · 2018-03-26T19:43:42Z

src/Symfony/Bundle/FrameworkBundle/DataCollector/MessengerDataCollector.php

@@ -88,6 +95,10 @@ public function handle($message, callable $next)

    public function getMessages(): array
    {
-        return $this->data;
+        if (!isset($this->data['messages'])) {


return $this->data['messages'] ?? array();

(note the array(), this will make fabbot happy)

Nyholm · 2018-03-26T20:16:56Z

Thank you

Nyholm · 2018-03-27T07:38:10Z

I've rebased this PR now. Im ready for a final review.

fabpot · 2018-03-27T07:47:21Z

Thank you @Nyholm.

This PR was squashed before being merged into the 4.1-dev branch (closes #26650). Discussion ---------- [Messenger] Clone messages to show in profiler | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | na | License | MIT | Doc PR | na We should make the profiler page more pretty by using the cloner. ![screen shot 2018-03-23 at 11 08 02](https://user-images.githubusercontent.com/1275206/37823687-816a373a-2e8a-11e8-824e-ac7f96a51e3b.png) Commits ------- 4d1be87 [Messenger] Clone messages to show in profiler

carsonbot added Status: Needs Review Feature labels Mar 23, 2018

Nyholm commented Mar 23, 2018

View reviewed changes

sroze reviewed Mar 23, 2018

View reviewed changes

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

stof requested changes Mar 23, 2018

View reviewed changes

chalasr added this to the 4.1 milestone Mar 23, 2018

chalasr added the Messenger label Mar 23, 2018

carsonbot added Status: Reviewed and removed Status: Needs Work labels Mar 24, 2018

sroze approved these changes Mar 24, 2018

View reviewed changes

Nyholm force-pushed the message-profiler-clone branch from 5700de0 to 52f4da9 Compare March 26, 2018 10:40

sroze approved these changes Mar 26, 2018

View reviewed changes

stof requested changes Mar 26, 2018

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Reviewed labels Mar 26, 2018

sroze suggested changes Mar 26, 2018

View reviewed changes

sroze mentioned this pull request Mar 26, 2018

Updated the Messenger profiler panel #26674

Closed

sroze suggested changes Mar 26, 2018

View reviewed changes

Nyholm added 4 commits March 27, 2018 09:36

Clone messages to show in profiler

00ae3c9

Check if key exists

3fae7d0

cs

f2229f9

Fixed rebase

359a658

Nyholm force-pushed the message-profiler-clone branch from ff354df to 359a658 Compare March 27, 2018 07:37

fabpot approved these changes Mar 27, 2018

View reviewed changes

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

stof approved these changes Mar 27, 2018

View reviewed changes

fabpot closed this Mar 27, 2018

Nyholm deleted the message-profiler-clone branch March 27, 2018 07:52

fabpot mentioned this pull request May 7, 2018

Release v4.1.0-BETA1 #27181

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Messenger] Clone messages to show in profiler #26650

[Messenger] Clone messages to show in profiler #26650

Nyholm commented Mar 23, 2018 •

edited

Loading

Nyholm Mar 23, 2018

sroze Mar 23, 2018

sroze Mar 23, 2018

sroze Mar 23, 2018

sroze Mar 23, 2018

Nyholm commented Mar 23, 2018

stof Mar 23, 2018

stof Mar 23, 2018

stof commented Mar 23, 2018

Nyholm commented Mar 23, 2018

sroze left a comment

sroze commented Mar 26, 2018

Nyholm commented Mar 26, 2018

sroze left a comment

stof Mar 26, 2018

Nyholm Mar 26, 2018

sroze Mar 26, 2018

Nyholm Mar 26, 2018

sroze Mar 26, 2018

sroze Mar 26, 2018

sroze Mar 26, 2018

sroze Mar 26, 2018

Nyholm commented Mar 26, 2018

Nyholm commented Mar 27, 2018

fabpot commented Mar 27, 2018

[Messenger] Clone messages to show in profiler #26650

[Messenger] Clone messages to show in profiler #26650

Conversation

Nyholm commented Mar 23, 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

Choose a reason for hiding this comment

Nyholm commented Mar 23, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Mar 23, 2018

Nyholm commented Mar 23, 2018

sroze left a comment

Choose a reason for hiding this comment

sroze commented Mar 26, 2018

Nyholm commented Mar 26, 2018

sroze left a comment

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

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

Choose a reason for hiding this comment

Nyholm commented Mar 26, 2018

Nyholm commented Mar 27, 2018

fabpot commented Mar 27, 2018

Nyholm commented Mar 23, 2018 •

edited

Loading