Take advantage of php-vcr 1.2.0 to display which requests where replayed

K-Phoen · K-Phoen · commit de9ea4b823ed · 2015-01-24T14:30:16.000Z
diff --git a/DataCollector/VCRDataCollector.php b/DataCollector/VCRDataCollector.php
@@ -6,31 +6,50 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\DataCollector\DataCollector;
 
-use VCR\VCRBundle\VCR\LoggedVideoRecorder;
+use VCR\VCRBundle\VCR\Logger;
 
 class VCRDataCollector extends DataCollector
 {
-    private $recorder;
+    private $logger;
 
-    public function __construct(LoggedVideoRecorder $recorder)
+    public function __construct(Logger $logger)
     {
-        $this->recorder = $recorder;
+        $this->logger = $logger;
     }
 
     public function collect(Request $request, Response $response, \Exception $exception = null)
     {
+        $requests  = $this->logger->getHttpRequests();
+        $playbacks = $this->logger->getPlaybacks();
+
         $this->data = array(
-            'logs'  => $logs = $this->recorder->getLog(),
-            'count' => count($logs),
+            'requests'   => $requests,
+            'playbacks'  => $playbacks,
+            'count'      => count($requests) + count($playbacks),
         );
     }
 
     public function getRequestsLogs()
     {
-        return $this->data['logs'];
+        return $this->data['requests'];
+    }
+
+    public function getPlaybacks()
+    {
+        return $this->data['playbacks'];
+    }
+
+    public function getPlaybacksCount()
+    {
+        return count($this->data['playbacks']);
     }
 
     public function getRequestsCount()
+    {
+        return count($this->data['requests']);
+    }
+
+    public function getCount()
     {
         return $this->data['count'];
     }
diff --git a/DependencyInjection/VCRVCRExtension.php b/DependencyInjection/VCRVCRExtension.php
@@ -12,6 +12,7 @@ class VCRVCRExtension extends Extension
     public function load(array $configs, ContainerBuilder $container)
     {
         $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader->load('listeners.yml');
         $loader->load('services.yml');
 
         $config = $this->processConfiguration($this->getConfiguration($configs, $container), $configs);
@@ -27,7 +28,6 @@ public function load(array $configs, ContainerBuilder $container)
     public function getConfiguration(array $config, ContainerBuilder $container)
     {
         return new Configuration();
-
     }
 
     public function getAlias()
diff --git a/EventListener/HttpRequestListener.php b/EventListener/HttpRequestListener.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace VCR\VCRBundle\EventListener;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use VCR\VCREvents;
+use VCR\Event\AfterHttpRequestEvent;
+
+use VCR\VCRBundle\VCR\Logger;
+
+class HttpRequestListener implements EventSubscriberInterface
+{
+    private $logger;
+
+    public function __construct(Logger $logger)
+    {
+        $this->logger = $logger;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public static function getSubscribedEvents()
+    {
+        return array(
+            VCREvents::VCR_AFTER_HTTP_REQUEST => 'onHttpRequest',
+        );
+    }
+
+    public function onHttpRequest(AfterHttpRequestEvent $event)
+    {
+        $this->logger->logHttpRequest(
+            $event->getRequest(),
+            $event->getResponse()
+        );
+    }
+}
diff --git a/EventListener/PlaybackListener.php b/EventListener/PlaybackListener.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace VCR\VCRBundle\EventListener;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use VCR\VCREvents;
+use VCR\Event\AfterPlaybackEvent;
+
+use VCR\VCRBundle\VCR\Logger;
+
+class PlaybackListener implements EventSubscriberInterface
+{
+    private $logger;
+
+    public function __construct(Logger $logger)
+    {
+        $this->logger = $logger;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public static function getSubscribedEvents()
+    {
+        return array(
+            VCREvents::VCR_AFTER_PLAYBACK => 'onPlayback',
+        );
+    }
+
+    public function onPlayback(AfterPlaybackEvent $event)
+    {
+        $this->logger->logPlayback(
+            $event->getRequest(),
+            $event->getResponse(),
+            $event->getCassette()
+        );
+    }
+}
diff --git a/Resources/config/listeners.yml b/Resources/config/listeners.yml
@@ -0,0 +1,12 @@
+services:
+    vcr.listener.http_request:
+        class:     VCR\VCRBundle\EventListener\HttpRequestListener
+        arguments: [ @vcr.logger ]
+        tags:
+            - { name: kernel.event_subscriber }
+
+    vcr.listener.playback:
+        class:     VCR\VCRBundle\EventListener\PlaybackListener
+        arguments: [ @vcr.logger ]
+        tags:
+            - { name: kernel.event_subscriber }
diff --git a/Resources/config/services.yml b/Resources/config/services.yml
@@ -1,10 +1,13 @@
 services:
     data_collector.vcr:
         class:      VCR\VCRBundle\DataCollector\VCRDataCollector
-        arguments:  [ @vcr.recorder ]
+        arguments:  [ @vcr.logger ]
         tags:
             - { name: data_collector, template: "VCRVCRBundle:Profiler:collector", id: "vcr_collector" }
 
+    vcr.logger:
+        class:  VCR\VCRBundle\VCR\Logger
+
     vcr.config:
         class: VCR\Configuration
         calls:
@@ -21,8 +24,9 @@ services:
         arguments:      [ @vcr.config ]
 
     vcr.recorder:
-        class:      VCR\VCRBundle\VCR\LoggedVideoRecorder
+        class:      VCR\Videorecorder
         arguments:  [ @vcr.config, @vcr.http_client, @vcr.factory ]
         calls:
+            - [ setEventDispatcher, [ @event_dispatcher ] ]
             - [ turnOn, [ ] ]
             - [ insertCassette, [ %vcr.cassette.name% ] ]
diff --git a/Resources/views/Profiler/call.html.twig b/Resources/views/Profiler/call.html.twig
@@ -1,13 +1,13 @@
 <div id="log_{{ index }}" class="request {{ log.request.method|lower }}">
-    <div class="status icon {% if log.response.status != 200 %}error{% else %}success{% endif %}"></div>
+    <div class="status icon {% if log.response.status.code != 200 %}error{% else %}success{% endif %}"></div>
 
     <div class="summary">
         <h3>
             <span class="method">{{ log.request.method }}</span>
             <span class="path">&nbsp{{ log.request.url }}</span>
         </h3>
         <div class="code">
-            <abbr title="{{ log.response.status_text }}">{{ log.response.status }}</abbr>
+            <abbr title="{{ log.response.status.message }}">{{ log.response.status.code }}</abbr>
         </div>
     </div>
 
diff --git a/Resources/views/Profiler/collector.html.twig b/Resources/views/Profiler/collector.html.twig
@@ -5,12 +5,16 @@
     {# the web debug toolbar content #}
     {% set icon %}
         <img alt="VCR" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABoAAAAaCAYAAACpSkzOAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDo5QUVGQjczQ0Q0ODIxMUUxQjBDOENFNTg5Q0ZFQTZENSIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDo5QUVGQjczREQ0ODIxMUUxQjBDOENFNTg5Q0ZFQTZENSI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjlBRUZCNzNBRDQ4MjExRTFCMEM4Q0U1ODlDRkVBNkQ1IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjlBRUZCNzNCRDQ4MjExRTFCMEM4Q0U1ODlDRkVBNkQ1Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+TS3nKAAAAUVJREFUeNpi/P//PwM9ABMDncDws4jFxMSEC0hPAeIYIGalsvm/gXgJEOewQC1JpJFHWGFmM0F9QmsQw0SD4MLqMxY0gU9ATM2MxQ9PDGgS8mfPnv1gbGwsAGSXArELVHwPEHeD5JAVY1G3C4i7gOo+Q+XhjmZE5gCBIJQ+BsSaaI64DsRWMMuglmBTdxmIrUGWIZuNLR+VImneBcUMULFSItTpAnEJMRnWFUrvBrrKHYRBbDQ5QurcqVkyMOIrCAgKQF1lCnIxMIx3orseSd1eIDbBoW4/MT7qhkY8CLhBMSwxdCOp6wTiO1jU3YPK4bcImqqsgLgNiE9DcRtyioOqew+kLIB4MhDfhGJQcWYJlHuDEc5oyfsxEP+jYoaVxxVHsrSsj37Toaz7zQStL2gNloCCLgdWlNOy4mMcbQUNeosAAgwA9nZtAXhMJ/oAAAAASUVORK5CYII="/>
-        <span class="sf-toolbar-status">{{ collector.requestsCount }}</span>
+        <span class="sf-toolbar-status">{{ collector.count }}</span>
     {% endset %}
     {% set text %}
         <div class="sf-toolbar-info-piece">
-            <b>Requests sent</b>
-            <span>{{ collector.requestsCount }}</span>
+            <b>Interceptions</b>
+            <span class="sf-toolbar-status sf-toolbar-status-yellow">{{ collector.requestsCount }}</span>
+        </div>
+        <div class="sf-toolbar-info-piece">
+            <b>Replays</b>
+            <span class="sf-toolbar-status sf-toolbar-status-green">{{ collector.playbacksCount }}</span>
         </div>
     {% endset %}
 
@@ -29,9 +33,21 @@
 {% endblock %}
 
 {% block panel %}
-    <h2>Sent Requests</h2>
+    <h2>Intercepted Requests</h2>
+
+    {% if collector.requestsLogs %}
+        {% include 'VCRVCRBundle:Profiler:calls.html.twig' with {'logs': collector.requestsLogs } %}
+    {% else %}
+        <p>No request intercepted.</p>
+    {% endif %}
+
+    <h2>Replays</h2>
 
-    {% include 'VCRVCRBundle:Profiler:calls.html.twig' with {'logs': collector.requestsLogs } %}
+    {% if collector.playbacks %}
+        {% include 'VCRVCRBundle:Profiler:calls.html.twig' with {'logs': collector.playbacks } %}
+    {% else %}
+        <p>No request replayed.</p>
+    {% endif %}
 {% endblock %}
 
 {% block head %}
diff --git a/Resources/views/Profiler/request.html.twig b/Resources/views/Profiler/request.html.twig
@@ -50,7 +50,7 @@
     <h5>Query Parameters</h5>
     <table>
         <tbody>
-        {% for name,parameter in request.query %}
+        {% for name, parameter in request.query %}
             <tr>
                 <th style="width: 25%">{{ name }}</th>
                 <td>
diff --git a/Resources/views/Profiler/response.html.twig b/Resources/views/Profiler/response.html.twig
@@ -4,11 +4,11 @@
         <tbody>
             <tr>
                 <th style="width: 25%">Code</th>
-                <td>{{ response.status }}</td>
+                <td>{{ response.status.code }}</td>
             </tr>
             <tr>
                 <th style="width: 25%">Status</th>
-                <td>{{ response.status_text }}</td>
+                <td>{{ response.status.message }}</td>
             </tr>
         </tbody>
     </table>
@@ -27,7 +27,7 @@
         </tbody>
     </table>
 
-    {% if response.body is defined %}
+    {% if request.body is defined %}
         <h5>Content</h5>
         <pre>{{ response.body|replace({"\t\t\n": "", "\t": "  "}) }}</pre>
     {% endif %}
diff --git a/VCR/LoggedVideoRecorder.php b/VCR/LoggedVideoRecorder.php
diff --git a/VCR/Logger.php b/VCR/Logger.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace VCR\VCRBundle\VCR;
+
+use VCR\Cassette;
+use VCR\Request;
+use VCR\Response;
+
+class Logger
+{
+    private $http_requests = array();
+    private $playbacks     = array();
+
+    public function logHttpRequest(Request $request, Response $response)
+    {
+        $this->http_requests[] = array(
+            'request'  => $this->augmentRequest($request->toArray()),
+            'response' => $response->toArray(),
+        );
+    }
+
+    public function logPlayback(Request $request, Response $response, Cassette $cassette)
+    {
+        $this->playbacks[] = array(
+            'request'  => $this->augmentRequest($request->toArray()),
+            'response' => $response->toArray(),
+            'cassette' => $cassette,
+        );
+    }
+
+    public function getHttpRequests()
+    {
+        return $this->http_requests;
+    }
+
+    public function getPlaybacks()
+    {
+        return $this->playbacks;
+    }
+
+    private function augmentRequest(array $request)
+    {
+        $url_info = parse_url($request['url']);
+        $query_string = array();
+        parse_str(!empty($url_info['query']) ? $url_info['query'] : '', $query_string);
+
+        return array_merge(
+            $url_info,
+            array('query' => $query_string),
+            $request
+        );
+    }
+}
diff --git a/VCRVCRBundle.php b/VCRVCRBundle.php
@@ -17,5 +17,7 @@ public function boot()
             $fs = new Filesystem();
             $fs->mkdir($cassettePath);
         }
+
+        $this->container->get('vcr.recorder');
     }
 }
diff --git a/composer.json b/composer.json

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ class VCRVCRExtension extends Extension`
`12`	`12`	`public function load(array $configs, ContainerBuilder $container)`
`13`	`13`	`{`
`14`	`14`	`$loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));`
	`15`	`+ $loader->load('listeners.yml');`
`15`	`16`	`$loader->load('services.yml');`
`16`	`17`
`17`	`18`	`$config = $this->processConfiguration($this->getConfiguration($configs, $container), $configs);`
`@@ -27,7 +28,6 @@ public function load(array $configs, ContainerBuilder $container)`
`27`	`28`	`public function getConfiguration(array $config, ContainerBuilder $container)`
`28`	`29`	`{`
`29`	`30`	`return new Configuration();`
`30`		`-`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`public function getAlias()`