[Profiler] Utilize symfony/var-dumper for dumping response body (#397)

* [Profiler] Utilize symfony/var-dumper for dumping response body
* Fix tests with newer symfony version

Author: ostrolucky

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
 
+# 1.23.0 - ?
+
+- Changed the way request/response body is displayed in profiler. symfony/var-dumper is used now.
+
 # 1.22.1 - 2021-07-26
 
 - Do not deprecate the service alias for the old Http\Client\HttpClient interface because different Symfony

src/Collector/Twig/HttpMessageMarkupExtension.php

@@ -4,6 +4,10 @@
 
 namespace Http\HttplugBundle\Collector\Twig;
 
+use Symfony\Component\VarDumper\Cloner\ClonerInterface;
+use Symfony\Component\VarDumper\Cloner\VarCloner;
+use Symfony\Component\VarDumper\Dumper\DataDumperInterface;
+use Symfony\Component\VarDumper\Dumper\HtmlDumper;
 use Twig\Extension\AbstractExtension;
 use Twig\TwigFilter;
 
@@ -12,6 +16,22 @@
  */
 class HttpMessageMarkupExtension extends AbstractExtension
 {
+    /**
+     * @var ClonerInterface
+     */
+    private $cloner;
+
+    /**
+     * @var HtmlDumper
+     */
+    private $dumper;
+
+    public function __construct(?ClonerInterface $cloner = null, ?DataDumperInterface $dumper)
+    {
+        $this->cloner = $cloner ?: new VarCloner();
+        $this->dumper = $dumper ?: new HtmlDumper();
+    }
+
     /**
      * {@inheritdoc}
      *
@@ -21,6 +41,7 @@ public function getFilters()
     {
         return [
             new TwigFilter('httplug_markup', [$this, 'markup'], ['is_safe' => ['html']]),
+            new TwigFilter('httplug_markup_body', [$this, 'markupBody'], ['is_safe' => ['html']]),
         ];
     }
 
@@ -49,6 +70,18 @@ public function markup($message)
         return sprintf("%s\n\n<div class='httplug-http-body httplug-hidden'>%s</div>", $headers, $parts[1]);
     }
 
+    public function markupBody(string $body): ?string
+    {
+        if (in_array(substr($body, 0, 1), ['{','['], true)) {
+            $json = json_decode($body, true);
+            if (json_last_error() === JSON_ERROR_NONE) {
+                $body = $json;
+            }
+        }
+
+        return $this->dumper->dump($this->cloner->cloneVar($body));
+    }
+
     public function getName()
     {
         return 'httplug.message_markup';

src/Resources/config/data-collector.xml

@@ -24,6 +24,8 @@
         </service>
 
         <service id="httplug.collector.twig.http_message" class="Http\HttplugBundle\Collector\Twig\HttpMessageMarkupExtension" public="false">
+            <argument type="service" id="var_dumper.cloner" on-invalid="null" />
+            <argument type="service" id="var_dumper.html_dumper" on-invalid="null" />
             <tag name="twig.extension" />
         </service>
 

src/Resources/views/http_message.html.twig

@@ -14,7 +14,7 @@
         {% if row is empty %}
             {% set hasReachedBody = true %}
         {% elseif hasReachedBody %}
-            {% set content = content ~ "\n" ~ row %}
+            {% set content = content ~ row %}
         {% else %}
             {% set row = row|split(':') %}
             {% set value = row|slice(1)|join(':')|trim %}
@@ -33,4 +33,4 @@
     </tbody>
 </table>
 
-<div class='httplug-http-body httplug-hidden'>{{ content|nl2br ?: '(This message has no captured body)' }}</div>
+<div class='httplug-http-body httplug-hidden'>{{ content ? content|httplug_markup_body : '(This message has no captured body)' }}</div>

tests/Functional/DiscoveredClientsTest.php

@@ -19,7 +19,7 @@ class DiscoveredClientsTest extends WebTestCase
 {
     public function testDiscoveredClient(): void
     {
-        $container = $this->getContainer(false);
+        $container = $this->getCustomContainer(false);
 
         $this->assertTrue($container->has('httplug.auto_discovery.auto_discovered_client'));
 
@@ -30,7 +30,7 @@ public function testDiscoveredClient(): void
 
     public function testDiscoveredAsyncClient(): void
     {
-        $container = $this->getContainer(false);
+        $container = $this->getCustomContainer(false);
 
         $this->assertTrue($container->has('httplug.auto_discovery.auto_discovered_async'));
 
@@ -41,7 +41,7 @@ public function testDiscoveredAsyncClient(): void
 
     public function testDiscoveredClientWithProfilingEnabled(): void
     {
-        $container = $this->getContainer(true);
+        $container = $this->getCustomContainer(true);
 
         $this->assertTrue($container->has('httplug.auto_discovery.auto_discovered_client'));
 
@@ -53,7 +53,7 @@ public function testDiscoveredClientWithProfilingEnabled(): void
 
     public function testDiscoveredAsyncClientWithProfilingEnabled(): void
     {
-        $container = $this->getContainer(true);
+        $container = $this->getCustomContainer(true);
 
         $this->assertTrue($container->has('httplug.auto_discovery.auto_discovered_async'));
 
@@ -68,7 +68,7 @@ public function testDiscoveredAsyncClientWithProfilingEnabled(): void
      */
     public function testDiscovery(): void
     {
-        $container = $this->getContainer(true);
+        $container = $this->getCustomContainer(true);
 
         $this->assertTrue($container->has('httplug.auto_discovery.auto_discovered_client'));
         $this->assertTrue($container->has('httplug.auto_discovery.auto_discovered_async'));
@@ -90,7 +90,7 @@ public function testDiscovery(): void
      */
     public function testDisabledDiscovery(): void
     {
-        $container = $this->getContainer(true, 'discovery_disabled');
+        $container = $this->getCustomContainer(true, 'discovery_disabled');
 
         $this->assertFalse($container->has('httplug.auto_discovery.auto_discovered_client'));
         $this->assertFalse($container->has('httplug.auto_discovery.auto_discovered_async'));
@@ -106,7 +106,7 @@ public function testForcedDiscovery(): void
             $this->markTestSkipped('Guzzle7 adapter is not installed');
         }
 
-        $container = $this->getContainer(true, 'discovery_forced');
+        $container = $this->getCustomContainer(true, 'discovery_forced');
 
         $this->assertFalse($container->has('httplug.auto_discovery.auto_discovered_client'));
         $this->assertFalse($container->has('httplug.auto_discovery.auto_discovered_async'));
@@ -118,7 +118,7 @@ public function testForcedDiscovery(): void
         $this->assertEquals($container->get('httplug.client.acme'), HttpAsyncClientDiscovery::find());
     }
 
-    private function getContainer($debug, $environment = 'test')
+    private function getCustomContainer($debug, $environment = 'test')
     {
         static::bootKernel(['debug' => $debug, 'environment' => $environment]);