Display errors better

Nyholm · Nyholm · commit 8e22d09be3f1 · 2016-07-13T21:41:44.000+02:00
diff --git a/Collector/ClientDataProvider.php b/Collector/ClientDataProvider.php
@@ -3,15 +3,21 @@
 namespace Http\HttplugBundle\Collector;
 
 /**
- * An object to handle the collected data for a client.
+ * An object to handle the collected data for a client. This is used to display data.
  *
  * The Request object at $requests[0][2] is the state of the object between the third
  * and the fourth plugin. The response after that plugin is found in $responses[0][2].
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-class ClientDataCollector
+class ClientDataProvider
 {
+    /**
+     * Array that tell if a request errored or not. true = success, false = failure.
+     * @var array
+     */
+    private $failure;
+
     /**
      * A multidimensional array with requests.
      * $requests[0][0] is the first request before all plugins.
@@ -31,11 +37,13 @@ class ClientDataCollector
     private $responses;
 
     /**
+     * @param array $failure if the response was successful or not
      * @param array $requests
      * @param array $responses
      */
-    public function __construct(array $requests, array $responses)
+    public function __construct(array $failure, array $requests, array $responses)
     {
+        $this->failure = $failure;
         $this->requests = $requests;
         $this->responses = $responses;
     }
@@ -45,7 +53,7 @@ public function __construct(array $requests, array $responses)
      *
      * @param array $data
      *
-     * @return ClientDataCollector[]
+     * @return ClientDataProvider[]
      */
     public static function createFromCollectedData(array $data)
     {
@@ -58,16 +66,23 @@ public static function createFromCollectedData(array $data)
     }
 
     /**
-     * @param array $messages is an array with keys 'request' and 'response' which hold requests for each call to
+     * @param array $messages is an array with keys 'failure', 'request' and 'response' which hold requests for each call to
      *                        sendRequest and for each depth.
      *
-     * @return ClientDataCollector
+     * @return ClientDataProvider
      */
     private static function createOne($messages)
     {
+        $orderedFaulure = [];
         $orderedRequests = [];
         $orderedResponses = [];
 
+        foreach ($messages['failure'] as $depth => $failures) {
+            foreach ($failures as $idx => $failure) {
+                $orderedFaulure[$idx][$depth] = $failure;
+            }
+        }
+
         foreach ($messages['request'] as $depth => $requests) {
             foreach ($requests as $idx => $request) {
                 $orderedRequests[$idx][$depth] = $request;
@@ -80,7 +95,7 @@ private static function createOne($messages)
             }
         }
 
-        return new self($orderedRequests, $orderedResponses);
+        return new self($orderedFaulure, $orderedRequests, $orderedResponses);
     }
 
     /**
@@ -94,7 +109,7 @@ public function getRequests()
     /**
      * @param array $requests
      *
-     * @return ClientDataCollector
+     * @return ClientDataProvider
      */
     public function setRequests($requests)
     {
@@ -114,7 +129,7 @@ public function getResponses()
     /**
      * @param array $responses
      *
-     * @return ClientDataCollector
+     * @return ClientDataProvider
      */
     public function setResponses($responses)
     {
@@ -152,4 +167,14 @@ public function getResponseStack($idx)
     {
         return $this->responses[$idx];
     }
+
+    /**
+     * @param int $idx
+     *
+     * @return array failures
+     */
+    public function getFailureStack($idx)
+    {
+        return $this->failure[$idx];
+    }
 }
diff --git a/Collector/DebugPlugin.php b/Collector/DebugPlugin.php
@@ -52,8 +52,7 @@ public function handleRequest(RequestInterface $request, callable $next, callabl
 
         return $next($request)->then(function (ResponseInterface $response) use ($collector, $clientName, &$depth) {
             $collector->addResponse($response, $clientName, $depth--);
-
-
+            
             return $response;
         }, function (Exception $exception) use ($collector, $clientName, &$depth) {
             $collector->addFailure($exception, $clientName, $depth--);
diff --git a/Collector/DebugPluginCollector.php b/Collector/DebugPluginCollector.php
@@ -48,6 +48,7 @@ public function addRequest(RequestInterface $request, $clientName, $depth)
     public function addResponse(ResponseInterface $response, $clientName, $depth)
     {
         $this->data[$clientName]['response'][$depth][] = $this->formatter->formatResponse($response);
+        $this->data[$clientName]['failure'][$depth][] = false;
     }
 
     /**
@@ -76,8 +77,12 @@ public function getSucessfulRequests()
     {
         $count = 0;
         foreach ($this->data as $client) {
-            if (isset($client['request'])) {
-                $count += count($client['request'][0]);
+            if (isset($client['failure'])) {
+                foreach ($client['failure'][0] as $failure) {
+                    if (!$failure) {
+                        $count++;
+                    }
+                }
             }
         }
 
@@ -94,7 +99,11 @@ public function getFailedRequests()
         $count = 0;
         foreach ($this->data as $client) {
             if (isset($client['failure'])) {
-                $count += count($client['failure'][0]);
+                foreach ($client['failure'][0] as $failure) {
+                    if ($failure) {
+                        $count++;
+                    }
+                }
             }
         }
 
@@ -112,11 +121,11 @@ public function getTotalRequests()
     }
 
     /**
-     * @return ClientDataCollector[]
+     * @return ClientDataProvider[]
      */
     public function getClients()
     {
-        return ClientDataCollector::createFromCollectedData($this->data);
+        return ClientDataProvider::createFromCollectedData($this->data);
     }
 
     /**
diff --git a/Collector/Twig/HttpMessageMarkupExtension.php b/Collector/Twig/HttpMessageMarkupExtension.php
@@ -25,12 +25,17 @@ public function getFilters()
     public function markup($message)
     {
         $safeMessage = htmlentities($message);
-        list($headers, $body) = preg_split('|\\r?\\n\\r?\\n|', $safeMessage, 2);
+        $parts = preg_split('|\\r?\\n\\r?\\n|', $safeMessage, 2);
+
+        if (!isset($parts[1])) {
+            // This is not a HTTP message
+            return $safeMessage;
+        }
 
         // make header names bold
-        $headers = preg_replace("|\n(.*?): |si", "\n<b>$1</b>: ", $headers);
+        $headers = preg_replace("|\n(.*?): |si", "\n<b>$1</b>: ", $parts[0]);
 
-        return sprintf("%s\n\n<div class='httplug-http-body'>%s</div>", $headers, $body);
+        return sprintf("%s\n\n<div class='httplug-http-body'>%s</div>", $headers, $parts[1]);
     }
 
     public function getName()
diff --git a/Resources/public/style/httplug.css b/Resources/public/style/httplug.css
@@ -18,4 +18,7 @@
 .httplug-request-stack {
 
     display: none;
+}
+.httplug-error {
+    color: red;
 }
diff --git a/Resources/views/webprofiler.html.twig b/Resources/views/webprofiler.html.twig
@@ -64,8 +64,14 @@
                 </p>
 
                 {% for stackIndex in client.stackIndexKeys %}
-                    <h3>Request {{ stackIndex }}</h3>
-                    {{ macro.printMessages(client.requstStack(stackIndex), client.responseStack(stackIndex), collector.journal.plugins(name)) }}
+                    {% set failureStack = client.failureStack(stackIndex) %}
+                    <h3>
+                        Request {{ stackIndex }}
+                        {% if failureStack[0] %}
+                            - <span class="httplug-error">Errored</span>
+                        {% endif %}
+                    </h3>
+                    {{ macro.printMessages(client.requstStack(stackIndex), client.responseStack(stackIndex), failureStack, collector.journal.plugins(name)) }}
                 {% endfor %}
             </div>
         </div>
@@ -79,7 +85,7 @@
 
 {% endblock %}
 
-{% macro printMessages(requestStack, responseStack, pluginNames) %}
+{% macro printMessages(requestStack, responseStack, failureStack, pluginNames) %}
     <table class="httplug-request-table">
         <tr>
             <th width="50%">Request</th>
@@ -101,12 +107,20 @@
                     {# We do not have a plugin at the first entry in the stack #}
                     <tr class="httplug-request-stack">
                         <td class="httplug-plugin-name">&darr; Start </td>
-                        <td class="httplug-plugin-name">- End</td>
+                        <td class="httplug-plugin-name">- End
+                            {% if failureStack[idx] %}
+                                <span class="httplug-error">&#9747;</span>
+                            {% endif %}
+                        </td>
                     </tr>
                 {% else %}
                     <tr class="httplug-request-stack">
                         <td class="httplug-plugin-name">&darr; {{ pluginNames[idx-1] }} </td>
-                        <td class="httplug-plugin-name">&uarr;</td>
+                        <td class="httplug-plugin-name">&uarr;
+                            {% if failureStack[idx] %}
+                                <span class="httplug-error">&#9747;</span>
+                            {% endif %}
+                        </td>
                     </tr>
                 {% endif %}
                 <tr class="httplug-request-stack">
@@ -115,7 +129,7 @@
                 </tr>
                 {% if loop.last %}
                     <tr class="httplug-request-stack">
-                        <td class="httplug-plugin-name">&#10230; <span class="push-right">Internet</span></td>
+                        <td class="httplug-plugin-name">&#10230; <span class="push-right">HTTP client</span></td>
                         <td class="httplug-plugin-name">&uarr;</td>
                     </tr>
                 {% endif %}

Original file line number	Diff line number	Diff line change
`@@ -3,15 +3,21 @@`
`3`	`3`	`namespace Http\HttplugBundle\Collector;`
`4`	`4`
`5`	`5`	`/**`
`6`		`- * An object to handle the collected data for a client.`
	`6`	`+ * An object to handle the collected data for a client. This is used to display data.`
`7`	`7`	`*`
`8`	`8`	`* The Request object at $requests[0][2] is the state of the object between the third`
`9`	`9`	`* and the fourth plugin. The response after that plugin is found in $responses[0][2].`
`10`	`10`	`*`
`11`	`11`	`* @author Tobias Nyholm <[email protected]>`
`12`	`12`	`*/`
`13`		`-class ClientDataCollector`
	`13`	`+class ClientDataProvider`
`14`	`14`	`{`
	`15`	`+ /**`
	`16`	`+ * Array that tell if a request errored or not. true = success, false = failure.`
	`17`	`+ * @var array`
	`18`	`+ */`
	`19`	`+ private $failure;`
	`20`	`+`
`15`	`21`	`/**`
`16`	`22`	`* A multidimensional array with requests.`
`17`	`23`	`* $requests[0][0] is the first request before all plugins.`
`@@ -31,11 +37,13 @@ class ClientDataCollector`
`31`	`37`	`private $responses;`
`32`	`38`
`33`	`39`	`/**`
	`40`	`+ * @param array $failure if the response was successful or not`
`34`	`41`	`* @param array $requests`
`35`	`42`	`* @param array $responses`
`36`	`43`	`*/`
`37`		`- public function __construct(array $requests, array $responses)`
	`44`	`+ public function __construct(array $failure, array $requests, array $responses)`
`38`	`45`	`{`
	`46`	`+ $this->failure = $failure;`
`39`	`47`	`$this->requests = $requests;`
`40`	`48`	`$this->responses = $responses;`
`41`	`49`	`}`
`@@ -45,7 +53,7 @@ public function __construct(array $requests, array $responses)`
`45`	`53`	`*`
`46`	`54`	`* @param array $data`
`47`	`55`	`*`
`48`		`- * @return ClientDataCollector[]`
	`56`	`+ * @return ClientDataProvider[]`
`49`	`57`	`*/`
`50`	`58`	`public static function createFromCollectedData(array $data)`
`51`	`59`	`{`
`@@ -58,16 +66,23 @@ public static function createFromCollectedData(array $data)`
`58`	`66`	`}`
`59`	`67`
`60`	`68`	`/**`
`61`		`- * @param array $messages is an array with keys 'request' and 'response' which hold requests for each call to`
	`69`	`+ * @param array $messages is an array with keys 'failure', 'request' and 'response' which hold requests for each call to`
`62`	`70`	`* sendRequest and for each depth.`
`63`	`71`	`*`
`64`		`- * @return ClientDataCollector`
	`72`	`+ * @return ClientDataProvider`
`65`	`73`	`*/`
`66`	`74`	`private static function createOne($messages)`
`67`	`75`	`{`
	`76`	`+ $orderedFaulure = [];`
`68`	`77`	`$orderedRequests = [];`
`69`	`78`	`$orderedResponses = [];`
`70`	`79`
	`80`	`+ foreach ($messages['failure'] as $depth => $failures) {`
	`81`	`+ foreach ($failures as $idx => $failure) {`
	`82`	`+ $orderedFaulure[$idx][$depth] = $failure;`
	`83`	`+ }`
	`84`	`+ }`
	`85`	`+`
`71`	`86`	`foreach ($messages['request'] as $depth => $requests) {`
`72`	`87`	`foreach ($requests as $idx => $request) {`
`73`	`88`	`$orderedRequests[$idx][$depth] = $request;`
`@@ -80,7 +95,7 @@ private static function createOne($messages)`
`80`	`95`	`}`
`81`	`96`	`}`
`82`	`97`
`83`		`- return new self($orderedRequests, $orderedResponses);`
	`98`	`+ return new self($orderedFaulure, $orderedRequests, $orderedResponses);`
`84`	`99`	`}`
`85`	`100`
`86`	`101`	`/**`
`@@ -94,7 +109,7 @@ public function getRequests()`
`94`	`109`	`/**`
`95`	`110`	`* @param array $requests`
`96`	`111`	`*`
`97`		`- * @return ClientDataCollector`
	`112`	`+ * @return ClientDataProvider`
`98`	`113`	`*/`
`99`	`114`	`public function setRequests($requests)`
`100`	`115`	`{`
`@@ -114,7 +129,7 @@ public function getResponses()`
`114`	`129`	`/**`
`115`	`130`	`* @param array $responses`
`116`	`131`	`*`
`117`		`- * @return ClientDataCollector`
	`132`	`+ * @return ClientDataProvider`
`118`	`133`	`*/`
`119`	`134`	`public function setResponses($responses)`
`120`	`135`	`{`
`@@ -152,4 +167,14 @@ public function getResponseStack($idx)`
`152`	`167`	`{`
`153`	`168`	`return $this->responses[$idx];`
`154`	`169`	`}`
	`170`	`+`
	`171`	`+ /**`
	`172`	`+ * @param int $idx`
	`173`	`+ *`
	`174`	`+ * @return array failures`
	`175`	`+ */`
	`176`	`+ public function getFailureStack($idx)`
	`177`	`+ {`
	`178`	`+ return $this->failure[$idx];`
	`179`	`+ }`
`155`	`180`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,7 @@ public function addRequest(RequestInterface $request, $clientName, $depth)`
`48`	`48`	`public function addResponse(ResponseInterface $response, $clientName, $depth)`
`49`	`49`	`{`
`50`	`50`	`$this->data[$clientName]['response'][$depth][] = $this->formatter->formatResponse($response);`
	`51`	`+ $this->data[$clientName]['failure'][$depth][] = false;`
`51`	`52`	`}`
`52`	`53`
`53`	`54`	`/**`
`@@ -76,8 +77,12 @@ public function getSucessfulRequests()`
`76`	`77`	`{`
`77`	`78`	`$count = 0;`
`78`	`79`	`foreach ($this->data as $client) {`
`79`		`- if (isset($client['request'])) {`
`80`		`- $count += count($client['request'][0]);`
	`80`	`+ if (isset($client['failure'])) {`
	`81`	`+ foreach ($client['failure'][0] as $failure) {`
	`82`	`+ if (!$failure) {`
	`83`	`+ $count++;`
	`84`	`+ }`
	`85`	`+ }`
`81`	`86`	`}`
`82`	`87`	`}`
`83`	`88`
`@@ -94,7 +99,11 @@ public function getFailedRequests()`
`94`	`99`	`$count = 0;`
`95`	`100`	`foreach ($this->data as $client) {`
`96`	`101`	`if (isset($client['failure'])) {`
`97`		`- $count += count($client['failure'][0]);`
	`102`	`+ foreach ($client['failure'][0] as $failure) {`
	`103`	`+ if ($failure) {`
	`104`	`+ $count++;`
	`105`	`+ }`
	`106`	`+ }`
`98`	`107`	`}`
`99`	`108`	`}`
`100`	`109`
`@@ -112,11 +121,11 @@ public function getTotalRequests()`
`112`	`121`	`}`
`113`	`122`
`114`	`123`	`/**`
`115`		`- * @return ClientDataCollector[]`
	`124`	`+ * @return ClientDataProvider[]`
`116`	`125`	`*/`
`117`	`126`	`public function getClients()`
`118`	`127`	`{`
`119`		`- return ClientDataCollector::createFromCollectedData($this->data);`
	`128`	`+ return ClientDataProvider::createFromCollectedData($this->data);`
`120`	`129`	`}`
`121`	`130`
`122`	`131`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,7 @@`
`18`	`18`	`.httplug-request-stack {`
`19`	`19`
`20`	`20`	`display: none;`
	`21`	`+}`
	`22`	`+.httplug-error {`
	`23`	`+ color: red;`
`21`	`24`	`}`