Merge pull request #212 from php-enqueue/bundle-profiler-array-to-string-conversion-fix

[bundle][profiler] Fix array to string conversion notice.

Author: makasim

pkg/enqueue-bundle/Profiler/MessageQueueCollector.php

@@ -5,6 +5,7 @@
 use Enqueue\Client\MessagePriority;
 use Enqueue\Client\ProducerInterface;
 use Enqueue\Client\TraceableProducer;
+use Enqueue\Util\JSON;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\DataCollector\DataCollector;
@@ -65,19 +66,13 @@ public function prettyPrintPriority($priority)
     }
 
     /**
-     * @param string $message
+     * @param mixed $body
      *
      * @return string
      */
-    public function prettyPrintMessage($message)
+    public function ensureString($body)
     {
-        if (is_scalar($message)) {
-            return htmlspecialchars($message);
-        }
-
-        return htmlspecialchars(
-            json_encode($message, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE)
-        );
+        return is_string($body) ? $body : JSON::encode($body);
     }
 
     /**

pkg/enqueue-bundle/Resources/views/Profiler/panel.html.twig

@@ -44,7 +44,10 @@
                 <td>{{ sentMessage.topic }}</td>
                 <td style="width: 70%">
                         <span class="metadata">
-                            <span>{{ sentMessage.body[0:40] }}... </span><a class="btn btn-link text-small sf-toggle" data-toggle-selector="#message-body-{{ loop.index }}" data-toggle-alt-content="Hide trace">Show trace</a>
+                            <span>
+                                {{ collector.ensureString(sentMessage.body)[0:40] }}{% if collector.ensureString(sentMessage.body)[0:40] != collector.ensureString(sentMessage.body) %}...{% endif %}
+                            </span>
+                            <a class="btn btn-link text-small sf-toggle" data-toggle-selector="#message-body-{{ loop.index }}" data-toggle-alt-content="Hide trace">Show trace</a>
 
                             <div id="message-body-{{ loop.index }}" class="context sf-toggle-content sf-toggle-hidden">
                                 {{ profiler_dump(sentMessage.body) }}

pkg/enqueue-bundle/Tests/Unit/Profiler/MessageQueueCollectorTest.php

@@ -71,21 +71,19 @@ public function testShouldPrettyPrintUnknownPriority()
         $this->assertEquals('unknownPriority', $collector->prettyPrintPriority('unknownPriority'));
     }
 
-    public function testShouldPrettyPrintScalarMessage()
+    public function testShouldEnsureStringKeepStringSame()
     {
         $collector = new MessageQueueCollector($this->createProducerMock());
 
-        $this->assertEquals('foo', $collector->prettyPrintMessage('foo'));
-        $this->assertEquals('&lt;p&gt;', $collector->prettyPrintMessage('<p>'));
+        $this->assertEquals('foo', $collector->ensureString('foo'));
+        $this->assertEquals('bar baz', $collector->ensureString('bar baz'));
     }
 
-    public function testShouldPrettyPrintArrayMessage()
+    public function testShouldEnsureStringEncodeArrayToJson()
     {
         $collector = new MessageQueueCollector($this->createProducerMock());
 
-        $expected = "[\n    &quot;foo&quot;,\n    &quot;bar&quot;\n]";
-
-        $this->assertEquals($expected, $collector->prettyPrintMessage(['foo', 'bar']));
+        $this->assertEquals('["foo","bar"]', $collector->ensureString(['foo', 'bar']));
     }
 
     /**