From ee68b1dfa7c52ca00923ef8afef43cab5e765caf Mon Sep 17 00:00:00 2001
From: Maxime Steinhausser <maxime.steinhausser@elao.com>
Date: Tue, 23 Jul 2019 15:40:37 +0200
Subject: [PATCH] [Messenger][Profiler] Collect the stamps at the end of
 dispatch

---
 .../Bundle/WebProfilerBundle/CHANGELOG.md     | 11 ++++---
 .../views/Collector/messenger.html.twig       | 16 ++++++++--
 .../DataCollector/MessengerDataCollector.php  |  1 +
 .../MessengerDataCollectorTest.php            |  6 ++--
 .../Tests/TraceableMessageBusTest.php         | 31 ++++++++++++++++++-
 .../Messenger/TraceableMessageBus.php         |  4 +--
 src/Symfony/Component/VarDumper/CHANGELOG.md  |  1 +
 7 files changed, 58 insertions(+), 12 deletions(-)

diff --git a/src/Symfony/Bundle/WebProfilerBundle/CHANGELOG.md b/src/Symfony/Bundle/WebProfilerBundle/CHANGELOG.md
index 253c125e12655..d785a0fcd7912 100644
--- a/src/Symfony/Bundle/WebProfilerBundle/CHANGELOG.md
+++ b/src/Symfony/Bundle/WebProfilerBundle/CHANGELOG.md
@@ -4,11 +4,12 @@ CHANGELOG
 4.4.0
 -----
 
- * Added button to clear the ajax request tab
- * Deprecated the `ExceptionController::templateExists()` method
- * Deprecated the `TemplateManager::templateExists()` method
- * Deprecated the `ExceptionController` in favor of `ExceptionPanelController`
- * Marked all classes of the WebProfilerBundle as internal
+ * added button to clear the ajax request tab
+ * deprecated the `ExceptionController::templateExists()` method
+ * deprecated the `TemplateManager::templateExists()` method
+ * deprecated the `ExceptionController` in favor of `ExceptionPanelController`
+ * marked all classes of the WebProfilerBundle as internal
+ * added a section with the stamps of a message after it is dispatched in the Messenger panel
 
 4.3.0
 -----
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/messenger.html.twig b/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/messenger.html.twig
index 6f2af8dd452d1..b48aaa82e5787 100644
--- a/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/messenger.html.twig
+++ b/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/messenger.html.twig
@@ -45,7 +45,7 @@
     {{ parent() }}
     <style>
         .message-item thead th { position: relative; cursor: pointer; user-select: none; padding-right: 35px; }
-        .message-item tbody tr td:first-child { width: 115px; }
+        .message-item tbody tr td:first-child { width: 170px; }
 
         .message-item .label { float: right; padding: 1px 5px; opacity: .75; margin-left: 5px; }
         .message-item .toggle-button { position: absolute; right: 6px; top: 6px; opacity: .5; pointer-events: none }
@@ -166,7 +166,7 @@
                 <td>{{ profiler_dump(dispatchCall.message.value, maxDepth=2) }}</td>
             </tr>
             <tr>
-                <td class="text-bold">Envelope stamps</td>
+                <td class="text-bold">Envelope stamps <span class="text-muted">when dispatching</span></td>
                 <td>
                     {% for item in dispatchCall.stamps %}
                         {{ profiler_dump(item) }}
@@ -175,6 +175,18 @@
                     {% endfor %}
                 </td>
             </tr>
+            {% if dispatchCall.stamps_after_dispatch is defined %}
+                <tr>
+                    <td class="text-bold">Envelope stamps <span class="text-muted">after dispatch</span></td>
+                    <td>
+                        {% for item in dispatchCall.stamps_after_dispatch %}
+                            {{ profiler_dump(item) }}
+                        {% else %}
+                            <span class="text-muted">No items</span>
+                        {% endfor %}
+                    </td>
+                </tr>
+            {% endif %}
             {% if dispatchCall.exception is defined %}
                 <tr>
                     <td class="text-bold">Exception</td>
diff --git a/src/Symfony/Component/Messenger/DataCollector/MessengerDataCollector.php b/src/Symfony/Component/Messenger/DataCollector/MessengerDataCollector.php
index ea32e06cde23d..21b2312b9f472 100644
--- a/src/Symfony/Component/Messenger/DataCollector/MessengerDataCollector.php
+++ b/src/Symfony/Component/Messenger/DataCollector/MessengerDataCollector.php
@@ -99,6 +99,7 @@ private function collectMessage(string $busName, array $tracedMessage)
         $debugRepresentation = [
             'bus' => $busName,
             'stamps' => $tracedMessage['stamps'] ?? null,
+            'stamps_after_dispatch' => $tracedMessage['stamps_after_dispatch'] ?? null,
             'message' => [
                 'type' => new ClassStub(\get_class($message)),
                 'value' => $message,
diff --git a/src/Symfony/Component/Messenger/Tests/DataCollector/MessengerDataCollectorTest.php b/src/Symfony/Component/Messenger/Tests/DataCollector/MessengerDataCollectorTest.php
index abe1b3453ff20..9c27a6052ca07 100644
--- a/src/Symfony/Component/Messenger/Tests/DataCollector/MessengerDataCollectorTest.php
+++ b/src/Symfony/Component/Messenger/Tests/DataCollector/MessengerDataCollectorTest.php
@@ -55,9 +55,10 @@ public function testHandle()
 
         $file = __FILE__;
         $expected = <<<DUMP
-array:4 [
+array:5 [
   "bus" => "default"
   "stamps" => []
+  "stamps_after_dispatch" => []
   "message" => array:2 [
     "type" => "Symfony\Component\Messenger\Tests\Fixtures\DummyMessage"
     "value" => Symfony\Component\Messenger\Tests\Fixtures\DummyMessage %A
@@ -100,9 +101,10 @@ public function testHandleWithException()
 
         $file = __FILE__;
         $this->assertStringMatchesFormat(<<<DUMP
-array:5 [
+array:6 [
   "bus" => "default"
   "stamps" => []
+  "stamps_after_dispatch" => []
   "message" => array:2 [
     "type" => "Symfony\Component\Messenger\Tests\Fixtures\DummyMessage"
     "value" => Symfony\Component\Messenger\Tests\Fixtures\DummyMessage %A
diff --git a/src/Symfony/Component/Messenger/Tests/TraceableMessageBusTest.php b/src/Symfony/Component/Messenger/Tests/TraceableMessageBusTest.php
index b87fffa82f339..a0ff3bdb88004 100644
--- a/src/Symfony/Component/Messenger/Tests/TraceableMessageBusTest.php
+++ b/src/Symfony/Component/Messenger/Tests/TraceableMessageBusTest.php
@@ -27,7 +27,7 @@ public function testItTracesDispatch()
 
         $stamp = new DelayStamp(5);
         $bus = $this->getMockBuilder(MessageBusInterface::class)->getMock();
-        $bus->expects($this->once())->method('dispatch')->with($message, [$stamp])->willReturn(new Envelope($message));
+        $bus->expects($this->once())->method('dispatch')->with($message, [$stamp])->willReturn(new Envelope($message, [$stamp]));
 
         $traceableBus = new TraceableMessageBus($bus);
         $line = __LINE__ + 1;
@@ -38,6 +38,7 @@ public function testItTracesDispatch()
         $this->assertEquals([
             'message' => $message,
             'stamps' => [$stamp],
+            'stamps_after_dispatch' => [$stamp],
             'caller' => [
                 'name' => 'TraceableMessageBusTest.php',
                 'file' => __FILE__,
@@ -63,6 +64,33 @@ public function testItTracesDispatchWithEnvelope()
         $this->assertEquals([
             'message' => $message,
             'stamps' => [$stamp],
+            'stamps_after_dispatch' => [$stamp],
+            'caller' => [
+                'name' => 'TraceableMessageBusTest.php',
+                'file' => __FILE__,
+                'line' => $line,
+            ],
+        ], $actualTracedMessage);
+    }
+
+    public function testItCollectsStampsAddedDuringDispatch()
+    {
+        $message = new DummyMessage('Hello');
+        $envelope = (new Envelope($message))->with($stamp = new AnEnvelopeStamp());
+
+        $bus = $this->getMockBuilder(MessageBusInterface::class)->getMock();
+        $bus->expects($this->once())->method('dispatch')->with($envelope)->willReturn($envelope->with($anotherStamp = new AnEnvelopeStamp()));
+
+        $traceableBus = new TraceableMessageBus($bus);
+        $line = __LINE__ + 1;
+        $traceableBus->dispatch($envelope);
+        $this->assertCount(1, $tracedMessages = $traceableBus->getDispatchedMessages());
+        $actualTracedMessage = $tracedMessages[0];
+        unset($actualTracedMessage['callTime']); // don't check, too variable
+        $this->assertEquals([
+            'message' => $message,
+            'stamps' => [$stamp],
+            'stamps_after_dispatch' => [$stamp, $anotherStamp],
             'caller' => [
                 'name' => 'TraceableMessageBusTest.php',
                 'file' => __FILE__,
@@ -94,6 +122,7 @@ public function testItTracesExceptions()
             'message' => $message,
             'exception' => $exception,
             'stamps' => [],
+            'stamps_after_dispatch' => [],
             'caller' => [
                 'name' => 'TraceableMessageBusTest.php',
                 'file' => __FILE__,
diff --git a/src/Symfony/Component/Messenger/TraceableMessageBus.php b/src/Symfony/Component/Messenger/TraceableMessageBus.php
index 09347bcb2f7bc..022176503b89e 100644
--- a/src/Symfony/Component/Messenger/TraceableMessageBus.php
+++ b/src/Symfony/Component/Messenger/TraceableMessageBus.php
@@ -38,13 +38,13 @@ public function dispatch($message, array $stamps = []): Envelope
         ];
 
         try {
-            return $this->decoratedBus->dispatch($message, $stamps);
+            return $envelope = $this->decoratedBus->dispatch($message, $stamps);
         } catch (\Throwable $e) {
             $context['exception'] = $e;
 
             throw $e;
         } finally {
-            $this->dispatchedMessages[] = $context;
+            $this->dispatchedMessages[] = $context + ['stamps_after_dispatch' => array_merge([], ...array_values($envelope->all()))];
         }
     }
 
diff --git a/src/Symfony/Component/VarDumper/CHANGELOG.md b/src/Symfony/Component/VarDumper/CHANGELOG.md
index 8ca7979d723c6..94c68269b0666 100644
--- a/src/Symfony/Component/VarDumper/CHANGELOG.md
+++ b/src/Symfony/Component/VarDumper/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * added `VarDumperTestTrait::setUpVarDumper()` and `VarDumperTestTrait::tearDownVarDumper()` 
    to configure casters & flags to use in tests
+ * added the stamps of a message after it is dispatched in `TraceableMessageBus` and `MessengerDataCollector` collected data
 
 4.3.0
 -----

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>pFad - Phonifier reborn</title>
<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
</head>
<body>
<h1>Pfad - The Proxy pFad of &#169; 2024 Garber Painting. All rights reserved.</h1>


<!-- Disclaimer -->
<p>Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.</p>
<br>
<p>Alternative Proxies:</p><p><a href="http://rainy.clevelandohioweatherforecast.com/php-proxy/index.php?q=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/32680.patch" target="_blank">Alternative Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/32680.patch" target="_blank">pFad Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v3index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/32680.patch" target="_blank">pFad v3 Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v4index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/32680.patch" target="_blank">pFad v4 Proxy</a></p></body>
</html>