Merge pull request #272 from FriendsOfSymfony/make-discovery-optional

make php-http/discovery optional

Author: dbu

composer.json

@@ -27,18 +27,19 @@
         "symfony/event-dispatcher": "^2.3||^3.0",
         "symfony/options-resolver": "^2.3||^3.0",
         "php-http/client-implementation": "^1.0.0",
-        "php-http/discovery": "~0.8",
         "php-http/message": "~0.3"
     },
     "require-dev": {
         "mockery/mockery": "~0.9.1",
         "monolog/monolog": "^1.0",
+        "php-http/discovery": "~0.8",
         "php-http/guzzle6-adapter": "^0.3.1",
         "php-http/mock-client": "~0.1",
         "symfony/process": "^2.3||^3.0",
         "symfony/http-kernel": "^2.3||^3.0"
     },
     "suggest": {
+        "php-http/discovery": "When not explicitly instantiating the php-http client for the proxy client",
         "monolog/monolog": "For logging issues while invalidating"
     },
     "autoload": {

src/ProxyClient/AbstractProxyClient.php

@@ -15,7 +15,9 @@
 use Http\Client\HttpAsyncClient;
 use Http\Discovery\HttpAsyncClientDiscovery;
 use Http\Discovery\MessageFactoryDiscovery;
+use Http\Discovery\UriFactoryDiscovery;
 use Http\Message\MessageFactory;
+use Http\Message\UriFactory;
 use Psr\Http\Message\UriInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -62,18 +64,29 @@ abstract class AbstractProxyClient implements ProxyClientInterface
      *                                             client is supplied, a default one is created.
      * @param MessageFactory|null  $messageFactory Factory for PSR-7 messages. If none supplied,
      *                                             a default one is created.
+     * @param UriFactory|null      $uriFactory     Factory for PSR-7 URIs. If not specified, a
+     *                                             default one is created.
      */
     public function __construct(
         array $servers,
         array $options = [],
         HttpAsyncClient $httpClient = null,
-        MessageFactory $messageFactory = null
+        MessageFactory $messageFactory = null,
+        UriFactory $uriFactory = null
     ) {
+        if ((!$httpClient || !$messageFactory || !$uriFactory) && !class_exists('Http\Discovery\HttpAsyncClientDiscovery')) {
+            throw new \LogicException('Either specify the client and the message and uri factories or include php-http/discovery in your project');
+        }
+
         if (!$httpClient) {
             $httpClient = HttpAsyncClientDiscovery::find();
         }
+        if (!$uriFactory) {
+            $uriFactory = UriFactoryDiscovery::find();
+        }
+
         $this->options = $this->getDefaultOptions()->resolve($options);
-        $this->httpAdapter = new HttpAdapter($servers, $this->options['base_uri'], $httpClient);
+        $this->httpAdapter = new HttpAdapter($servers, $this->options['base_uri'], $httpClient, $uriFactory);
         $this->messageFactory = $messageFactory ?: MessageFactoryDiscovery::find();
     }
 

src/ProxyClient/Http/HttpAdapter.php

@@ -11,8 +11,8 @@
 use Http\Client\Exception\HttpException;
 use Http\Client\Exception\RequestException;
 use Http\Client\HttpAsyncClient;
+use Http\Message\UriFactory;
 use Http\Promise\Promise;
-use Http\Discovery\UriFactoryDiscovery;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\UriInterface;
 
@@ -28,6 +28,11 @@ class HttpAdapter
      */
     private $httpClient;
 
+    /**
+     * @var UriFactory
+     */
+    private $uriFactory;
+
     /**
      * Queued requests
      *
@@ -59,12 +64,15 @@ class HttpAdapter
      *                          you purge and refresh paths instead of
      *                          absolute URLs.
      * @param HttpAsyncClient $httpClient
+     * @param UriFactory      $uriFactory
      */
-    public function __construct(array $servers, $baseUri, HttpAsyncClient $httpClient)
+    public function __construct(array $servers, $baseUri, HttpAsyncClient $httpClient, UriFactory $uriFactory)
     {
+        $this->httpClient = $httpClient;
+        $this->uriFactory = $uriFactory;
+
         $this->setServers($servers);
         $this->setBaseUri($baseUri);
-        $this->httpClient = $httpClient;
     }
 
     /**
@@ -247,7 +255,7 @@ private function filterUri($uriString, array $allowedParts = [])
         }
 
         try {
-            $uri = UriFactoryDiscovery::find()->createUri($uriString);
+            $uri = $this->uriFactory->createUri($uriString);
         } catch (\InvalidArgumentException $e) {
             throw InvalidUrlException::invalidUrl($uriString);
         }

src/ProxyClient/Symfony.php

@@ -14,38 +14,21 @@
 use FOS\HttpCache\ProxyClient\Invalidation\PurgeInterface;
 use FOS\HttpCache\ProxyClient\Invalidation\RefreshInterface;
 use FOS\HttpCache\SymfonyCache\PurgeSubscriber;
-use Http\Client\HttpAsyncClient;
 use Http\Message\MessageFactory;
-use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
  * Symfony HttpCache invalidator.
  *
+ * Additional constructor options:
+ * - purge_method:         HTTP method that identifies purge requests.
+ *
  * @author David de Boer <david@driebit.nl>
  * @author David Buchmann <mail@davidbu.ch>
  */
 class Symfony extends AbstractProxyClient implements PurgeInterface, RefreshInterface
 {
     const HTTP_METHOD_REFRESH = 'GET';
 
-    /**
-     * {@inheritDoc}
-     *
-     * When creating the client, you can configure options:
-     *
-     * - purge_method:         HTTP method that identifies purge requests.
-     *
-     * @param array $options The purge_method that should be used.
-     */
-    public function __construct(
-        array $servers,
-        array $options,
-        HttpAsyncClient $httpClient = null,
-        MessageFactory $messageFactory = null
-    ) {
-        parent::__construct($servers, $options, $httpClient, $messageFactory);
-    }
-
     /**
      * {@inheritdoc}
      */

src/ProxyClient/Varnish.php

@@ -17,13 +17,14 @@
 use FOS\HttpCache\ProxyClient\Invalidation\PurgeInterface;
 use FOS\HttpCache\ProxyClient\Invalidation\RefreshInterface;
 use FOS\HttpCache\ProxyClient\Invalidation\TagsInterface;
-use Http\Client\HttpAsyncClient;
 use Http\Message\MessageFactory;
-use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
  * Varnish HTTP cache invalidator.
  *
+ * Additional constructor options:
+ * - tags_header Header for tagging responses, defaults to X-Cache-Tags
+ *
  * @author David de Boer <david@driebit.nl>
  */
 class Varnish extends AbstractProxyClient implements BanInterface, PurgeInterface, RefreshInterface, TagsInterface
@@ -46,38 +47,6 @@ class Varnish extends AbstractProxyClient implements BanInterface, PurgeInterfac
         self::HTTP_HEADER_CONTENT_TYPE => self::REGEX_MATCH_ALL
     ];
 
-    /**
-     * Has a base URI been set?
-     *
-     * @var bool
-     */
-    private $baseUriSet;
-
-    /**
-     * @var string
-     */
-    private $tagsHeader;
-
-    /**
-     * {@inheritdoc}
-     *
-     * Additional options:
-     *
-     * - tags_header Header for tagging responses, defaults to X-Cache-Tags
-     *
-     * @param string $tagsHeader
-     */
-    public function __construct(
-        array $servers,
-        array $options = [],
-        HttpAsyncClient $httpClient = null,
-        MessageFactory $messageFactory = null
-    ) {
-        parent::__construct($servers, $options, $httpClient, $messageFactory);
-        $this->baseUriSet = $this->options['base_uri'] !== null;
-        $this->tagsHeader = $this->options['tags_header'];
-    }
-
     /**
      * Set the default headers that get merged with the provided headers in self::ban().
      *
@@ -107,7 +76,7 @@ public function invalidateTags(array $tags)
     {
         $tagExpression = sprintf('(%s)(,.+)?$', implode('|', array_map('preg_quote', $this->escapeTags($tags))));
 
-        return $this->ban([$this->tagsHeader => $tagExpression]);
+        return $this->ban([$this->options['tags_header'] => $tagExpression]);
     }
 
     /**
@@ -125,7 +94,7 @@ public function getTagsHeaderValue(array $tags)
      */
     public function getTagsHeaderName()
     {
-        return $this->tagsHeader;
+        return $this->options['tags_header'];
     }
 
     /**
@@ -215,7 +184,7 @@ protected function queueRequest($method, $url, array $headers = [])
         $request = $this->messageFactory->createRequest($method, $url, $headers);
 
         if (self::HTTP_METHOD_BAN !== $method
-            && !$this->baseUriSet
+            && null === $this->options['base_uri']
             && !$request->getHeaderLine('Host')
         ) {
             throw MissingHostException::missingHost($url);