Cache and methods client improvements

Author: GrahamCampbell

composer.json

@@ -28,6 +28,7 @@
         "php-http/discovery": "^1.9",
         "php-http/httplug": "^2.1",
         "php-http/multipart-stream-builder": "^1.1",
+        "psr/cache": "^1.0",
         "psr/http-client-implementation": "^1.0",
         "psr/http-factory-implementation": "^1.0",
         "psr/http-message": "^1.0",
@@ -37,10 +38,10 @@
         "guzzlehttp/psr7": "^1.5.2",
         "php-http/guzzle6-adapter": "^2.0.1",
         "http-interop/http-factory-guzzle": "^1.0",
-        "phpunit/phpunit": "^7.5.15",
         "phpstan/phpstan": "^0.12.32",
         "phpstan/extension-installer": "^1.0.4",
-        "phpstan/phpstan-deprecation-rules": "^0.12.4"
+        "phpstan/phpstan-deprecation-rules": "^0.12.4",
+        "phpunit/phpunit": "^7.5.15"
     },
     "autoload": {
         "psr-4": { "Gitlab\\": "lib/Gitlab/" }

lib/Gitlab/Api/AbstractApi.php

@@ -39,7 +39,7 @@ abstract class AbstractApi implements ApiInterface
     public function __construct(Client $client, StreamFactoryInterface $streamFactory = null)
     {
         $this->client = $client;
-        $this->streamFactory = $streamFactory ?: Psr17FactoryDiscovery::findStreamFactory();
+        $this->streamFactory = $streamFactory ?? Psr17FactoryDiscovery::findStreamFactory();
     }
 
     /**

lib/Gitlab/Client.php

@@ -7,7 +7,7 @@
 use Gitlab\HttpClient\Plugin\History;
 use Gitlab\HttpClient\Plugin\Authentication;
 use Gitlab\HttpClient\Plugin\GitlabExceptionThrower;
-use Http\Client\Common\HttpMethodsClient;
+use Http\Client\Common\HttpMethodsClientInterface;
 use Http\Client\Common\Plugin\AddHostPlugin;
 use Http\Client\Common\Plugin\HeaderDefaultsPlugin;
 use Http\Client\Common\Plugin\HistoryPlugin;
@@ -78,7 +78,7 @@ class Client
     public function __construct(Builder $httpClientBuilder = null)
     {
         $this->responseHistory = new History();
-        $this->httpClientBuilder = $httpClientBuilder ?: new Builder();
+        $this->httpClientBuilder = $httpClientBuilder ?? new Builder();
 
         $this->httpClientBuilder->addPlugin(new GitlabExceptionThrower());
         $this->httpClientBuilder->addPlugin(new HistoryPlugin($this->responseHistory));
@@ -456,7 +456,7 @@ public function __get($api)
     }
 
     /**
-     * @return HttpMethodsClient
+     * @return HttpMethodsClientInterface
      */
     public function getHttpClient()
     {

lib/Gitlab/HttpClient/Builder.php

@@ -3,20 +3,26 @@
 namespace Gitlab\HttpClient;
 
 use Http\Client\Common\HttpMethodsClient;
+use Http\Client\Common\HttpMethodsClientInterface;
 use Http\Client\Common\Plugin;
 use Http\Client\Common\PluginClient;
+use Http\Client\Common\Plugin\Cache\Generator\HeaderCacheKeyGenerator;
+use Http\Client\Common\Plugin\CachePlugin;
 use Http\Client\Common\PluginClientFactory;
 use Http\Discovery\Psr17FactoryDiscovery;
 use Http\Discovery\Psr18ClientDiscovery;
+use Psr\Cache\CacheItemPoolInterface;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestFactoryInterface;
 use Psr\Http\Message\StreamFactoryInterface;
 
 /**
  * A builder that builds the API client.
+ *
  * This will allow you to fluently add and remove plugins.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ * @author Graham Campbell <graham@alt-three.com>
  */
 class Builder
 {
@@ -30,16 +36,20 @@ class Builder
     /**
      * A HTTP client with all our plugins.
      *
-     * @var HttpMethodsClient
+     * @var HttpMethodsClientInterface
      */
     private $pluginClient;
 
     /**
+     * The HTTP request factory.
+     *
      * @var RequestFactoryInterface
      */
     private $requestFactory;
 
     /**
+     * The HTTP stream factory.
+     *
      * @var StreamFactoryInterface
      */
     private $streamFactory;
@@ -52,11 +62,24 @@ class Builder
     private $httpClientModified = true;
 
     /**
+     * The currently registered plugins.
+     *
      * @var Plugin[]
      */
     private $plugins = [];
 
     /**
+     * The cache plugin to use.
+     *
+     * This plugin is specially treated because it has to be the very last plugin.
+     *
+     * @var CachePlugin|null
+     */
+    private $cachePlugin;
+
+    /**
+     * Create a new http client builder instance.
+     *
      * @param ClientInterface|null         $httpClient
      * @param RequestFactoryInterface|null $requestFactory
      * @param StreamFactoryInterface|null  $streamFactory
@@ -66,21 +89,26 @@ public function __construct(
         RequestFactoryInterface $requestFactory = null,
         StreamFactoryInterface $streamFactory = null
     ) {
-        $this->httpClient = $httpClient ?: Psr18ClientDiscovery::find();
-        $this->requestFactory = $requestFactory ?: Psr17FactoryDiscovery::findRequestFactory();
-        $this->streamFactory = $streamFactory ?: Psr17FactoryDiscovery::findStreamFactory();
+        $this->httpClient = $httpClient ?? Psr18ClientDiscovery::find();
+        $this->requestFactory = $requestFactory ?? Psr17FactoryDiscovery::findRequestFactory();
+        $this->streamFactory = $streamFactory ?? Psr17FactoryDiscovery::findStreamFactory();
     }
 
     /**
-     * @return HttpMethodsClient
+     * @return HttpMethodsClientInterface
      */
     public function getHttpClient()
     {
         if ($this->httpClientModified) {
             $this->httpClientModified = false;
 
+            $plugins = $this->plugins;
+            if ($this->cachePlugin !== null) {
+                $plugins[] = $this->cachePlugin;
+            }
+
             $this->pluginClient = new HttpMethodsClient(
-                (new PluginClientFactory())->createClient($this->httpClient, $this->plugins),
+                (new PluginClientFactory())->createClient($this->httpClient, $plugins),
                 $this->requestFactory
             );
         }
@@ -92,6 +120,8 @@ public function getHttpClient()
      * Add a new plugin to the end of the plugin chain.
      *
      * @param Plugin $plugin
+     *
+     * @return void
      */
     public function addPlugin(Plugin $plugin)
     {
@@ -103,6 +133,8 @@ public function addPlugin(Plugin $plugin)
      * Remove a plugin by its fully qualified class name (FQCN).
      *
      * @param string $fqcn
+     *
+     * @return void
      */
     public function removePlugin($fqcn)
     {
@@ -113,4 +145,33 @@ public function removePlugin($fqcn)
             }
         }
     }
+
+    /**
+     * Add a cache plugin to cache responses locally.
+     *
+     * @param CacheItemPoolInterface $cachePool
+     * @param array                  $config
+     *
+     * @return void
+     */
+    public function addCache(CacheItemPoolInterface $cachePool, array $config = [])
+    {
+        if (!isset($config['cache_key_generator'])) {
+            $config['cache_key_generator'] = new HeaderCacheKeyGenerator(['Authorization', 'Cookie', 'Accept', 'Content-type']);
+        }
+
+        $this->cachePlugin = CachePlugin::clientCache($cachePool, $this->streamFactory, $config);
+        $this->httpClientModified = true;
+    }
+
+    /**
+     * Remove the cache plugin.
+     *
+     * @return void
+     */
+    public function removeCache()
+    {
+        $this->cachePlugin = null;
+        $this->httpClientModified = true;
+    }
 }

test/Gitlab/Tests/HttpClient/BuilderTest.php

@@ -3,7 +3,7 @@
 namespace Gitlab\Tests\HttpClient;
 
 use Gitlab\HttpClient\Builder;
-use Http\Client\Common\HttpMethodsClient;
+use Http\Client\Common\HttpMethodsClientInterface;
 use Http\Client\Common\Plugin;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Client\ClientInterface;
@@ -20,7 +20,10 @@ class BuilderTest extends TestCase
      */
     private $subject;
 
-    public function setUp()
+    /**
+     * @before
+     */
+    public function initBuilder()
     {
         $this->subject = new Builder(
             $this->getMockBuilder(ClientInterface::class)->getMock(),
@@ -51,6 +54,6 @@ public function testRemovePluginShouldInvalidateHttpClient()
 
     public function testHttpClientShouldBeAnHttpMethodsClient()
     {
-        $this->assertInstanceOf(HttpMethodsClient::class, $this->subject->getHttpClient());
+        $this->assertInstanceOf(HttpMethodsClientInterface::class, $this->subject->getHttpClient());
     }
 }

test/Gitlab/Tests/ResultPagerTest.php

@@ -8,7 +8,6 @@
 use Gitlab\ResultPager;
 use GuzzleHttp\Psr7\Response;
 use function GuzzleHttp\Psr7\stream_for;
-use Http\Client\Common\HttpMethodsClient;
 use Http\Client\Common\HttpMethodsClientInterface;
 use PHPUnit\Framework\TestCase;
 
@@ -72,14 +71,7 @@ public function testFetchAll()
             ))
         ;
 
-        if (interface_exists(HttpMethodsClientInterface::class)) {
-            $httpClient = $this->createMock(HttpMethodsClientInterface::class);
-        } else {
-            $httpClient = $this->getMockBuilder(HttpMethodsClient::class)
-                ->disableOriginalConstructor()
-                ->getMock()
-            ;
-        }
+        $httpClient = $this->createMock(HttpMethodsClientInterface::class);
 
         $httpClient->expects($this->exactly(2))
             ->method('get')