Better logger

Author: Nyholm

ClientFactory/PluginClientFactory.php

@@ -16,11 +16,12 @@ final class PluginClientFactory
      * @param Plugin[]      $plugins
      * @param ClientFactory $factory
      * @param array         $config
+     * @param array         $pluginClientOptions
      *
      * @return PluginClient
      */
-    public static function createPluginClient(array $plugins, ClientFactory $factory, array $config)
+    public static function createPluginClient(array $plugins, ClientFactory $factory, array $config, array $pluginClientOptions = [])
     {
-        return new PluginClient($factory->createClient($config), $plugins);
+        return new PluginClient($factory->createClient($config), $plugins, $pluginClientOptions);
     }
 }

Collector/DebugPlugin.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Http\HttplugBundle\Collector;
+
+use Http\Client\Common\Plugin;
+use Http\Client\Exception;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * A plugin used for log requests and responses passing through each plugin.
+ *
+ * @author Tobias Nyholm <[email protected]>
+ */
+class DebugPlugin implements Plugin
+{
+    /**
+     * @var DebugPluginCollector
+     */
+    private $collector;
+
+    /**
+     * @var string
+     */
+    private $clientName;
+
+    /**
+     * @var int
+     */
+    private $depth = -1;
+
+    /**
+     *
+     * @param DebugPluginCollector $collector
+     * @param string $clientName
+     */
+    public function __construct(DebugPluginCollector $collector, $clientName)
+    {
+        $this->collector = $collector;
+        $this->clientName = $clientName;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handleRequest(RequestInterface $request, callable $next, callable $first)
+    {
+        $collector = $this->collector;
+        $clientName = $this->clientName;
+        $depth = &$this->depth;
+
+        $collector->addRequest($request, $clientName, ++$depth);
+
+        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);
+
+            throw $exception;
+        });
+    }
+}

Collector/DebugPluginCollector.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace Http\HttplugBundle\Collector;
+
+use Http\Client\Exception;
+use Http\Message\Formatter;
+use Http\Message\Formatter\SimpleFormatter;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\DataCollector\DataCollector;
+
+/**
+ * @author Tobias Nyholm <[email protected]>
+ */
+class DebugPluginCollector extends DataCollector
+{
+    /**
+     * @var Formatter
+     */
+    private $formatter;
+
+    /**
+     * @param Formatter $formatter
+     */
+    public function __construct(Formatter $formatter = null)
+    {
+        $this->formatter = $formatter ?: new SimpleFormatter();
+    }
+
+    /**
+     * @param RequestInterface $request
+     */
+    public function addRequest(RequestInterface $request, $clientName, $depth)
+    {
+        $this->data[$clientName]['requests'][$depth][] = $this->formatter->formatRequest($request);
+    }
+
+    /**
+     * @param ResponseInterface $response
+     */
+    public function addResponse(ResponseInterface $response, $clientName, $depth)
+    {
+        $this->data[$clientName]['response'][$depth][] = $this->formatter->formatResponse($response);
+    }
+
+    /**
+     * @param Exception $exception
+     */
+    public function addFailure(Exception $exception, $clientName, $depth)
+    {
+        if ($exception instanceof Exception\HttpException) {
+            $formattedResponse = $this->formatter->formatResponse($exception->getResponse());
+        } elseif ($exception instanceof Exception\TransferException) {
+            $formattedResponse = $exception->getMessage();
+        } else {
+            $formattedResponse = sprintf('Unexpected exception of type "%s"', get_class($exception));
+        }
+
+        $this->data[$clientName]['failure'][$depth][] = $formattedResponse;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function collect(Request $request, Response $response, \Exception $exception = null)
+    {
+        // We do not need to collect any data from the Symfony Request and Response
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return 'httplug_debug';
+    }
+}

DependencyInjection/HttplugExtension.php

@@ -7,6 +7,7 @@
 use Http\Client\Common\Plugin\AuthenticationPlugin;
 use Http\Client\Common\PluginClient;
 use Http\HttplugBundle\ClientFactory\DummyClient;
+use Http\HttplugBundle\Collector\DebugPlugin;
 use Http\Message\Authentication\BasicAuth;
 use Http\Message\Authentication\Bearer;
 use Http\Message\Authentication\Wsse;
@@ -211,6 +212,13 @@ private function configureClient(ContainerBuilder $container, $name, array $argu
             $def->setFactory([new Reference($arguments['factory']), 'createClient'])
                 ->addArgument($arguments['config']);
         } else {
+            // Create a new plugin service for this client
+            $serviceIdDebugPlugin = $serviceId.'.debug_plugin';
+            $container->register($serviceIdDebugPlugin, DebugPlugin::class)
+                ->addArgument(new Reference('httplug.collector.debug_collector'))
+                ->addArgument($name)
+                ->setPublic(false);
+            
             $def->setFactory('Http\HttplugBundle\ClientFactory\PluginClientFactory::createPluginClient')
                 ->addArgument(
                     array_map(
@@ -221,7 +229,8 @@ function ($id) {
                     )
                 )
                 ->addArgument(new Reference($arguments['factory']))
-                ->addArgument($arguments['config']);
+                ->addArgument($arguments['config'])
+                ->addArgument(['debug_plugins'=>[new Reference($serviceIdDebugPlugin)]]);
         }
 
 

Resources/config/data-collector.xml

@@ -13,5 +13,11 @@
         <service id="httplug.collector.history_plugin" class="Http\Client\Common\Plugin\HistoryPlugin" public="false">
             <argument type="service" id="httplug.collector.message_journal"/>
         </service>
+
+
+        <service id="httplug.collector.debug_collector" class="Http\HttplugBundle\Collector\DebugPluginCollector" public="false">
+        </service>
+
+
     </services>
 </container>