Support Both HTTPlug's RequestFactory and PSR's RequestFactoryInterface

Author: zanbaldwin

composer.json

@@ -13,12 +13,13 @@
     "require": {
         "php": "^7.2 || ^8.0",
         "ext-json": "*",
+        "composer-runtime-api": "^2.0",
         "php-http/client-common": "^1.9 || ^2.0",
         "php-http/discovery": "^1.0",
         "psr/http-client-implementation": "^1.0",
         "php-http/message-factory": "^1.0",
         "psr/http-message-implementation": "^1.0",
-        "composer-runtime-api": "^2.0"
+        "symfony/deprecation-contracts": "^2.5 || ^3.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.0",

src/HttpClient/HttpPluginClientBuilder.php

@@ -14,6 +14,7 @@
 use Http\Client\Common\PluginClient;
 use Http\Discovery\Psr17FactoryDiscovery;
 use Http\Discovery\Psr18ClientDiscovery;
+use Http\Message\RequestFactory;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestFactoryInterface;
 
@@ -28,10 +29,33 @@ class HttpPluginClientBuilder
     /** @var Plugin[] */
     private $plugins = [];
 
-    public function __construct(ClientInterface $httpClient = null, RequestFactoryInterface $requestFactory = null)
+    /**
+     * @param ClientInterface|null $httpClient
+     * @param RequestFactory|RequestFactoryInterface|null $requestFactory
+     */
+    public function __construct(ClientInterface $httpClient = null, $requestFactory = null)
     {
+        $requestFactory = $requestFactory ?: Psr17FactoryDiscovery::findRequestFactory();
+        if ($requestFactory instanceof RequestFactory) {
+            trigger_deprecation(
+                'private-packagist/api-client',
+                '1.35.0',
+                '',
+                RequestFactory::class,
+                RequestFactoryInterface::class
+            );
+        } elseif (!$requestFactory instanceof RequestFactoryInterface) {
+            throw new \TypeError(sprintf(
+                '%s::__construct(): Argument #2 ($requestFactory) must be of type %s|%s, %s given',
+                self::class,
+                RequestFactory::class,
+                RequestFactoryInterface::class,
+                is_object($requestFactory) ? get_class($requestFactory) : gettype($requestFactory)
+            ));
+        }
+
         $this->httpClient = $httpClient ?: Psr18ClientDiscovery::find();
-        $this->requestFactory = $requestFactory ?: Psr17FactoryDiscovery::findRequestFactory();
+        $this->requestFactory = $requestFactory;
     }
 
     public function addPlugin(Plugin $plugin)

tests/HttpClient/HttpPluginClientBuilderTest.php

@@ -0,0 +1,80 @@
+<?php
+
+/*
+ * (c) Packagist Conductors GmbH <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace PrivatePackagist\ApiClient\HttpClient\Plugin;
+
+use GuzzleHttp\Psr7\HttpFactory;
+use GuzzleHttp\Psr7\Response;
+use Http\Client\Common\HttpMethodsClientInterface;
+use Http\Message\MessageFactory\GuzzleMessageFactory;
+use Http\Message\RequestMatcher as RequestMatcherInterface;
+use Http\Mock\Client as MockClient;
+use PHPUnit\Framework\TestCase;
+use PrivatePackagist\ApiClient\HttpClient\HttpPluginClientBuilder;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+class HttpPluginClientBuilderTest extends TestCase
+{
+    /** @dataProvider provideRequestFactories */
+    public function testRequestFactory(?object $factory, ?string $expectedException): void
+    {
+        if ($expectedException !== null) {
+            $this->expectException($expectedException);
+        }
+
+        $mockHttp = new MockClient;
+        $mockHttp->setDefaultException(new \Exception('Mock HTTP client did not match request.'));
+        $mockHttp->on($this->matchRequestIncludingHeaders(), new Response(307, ['Location' => '/kittens.jpg']));
+
+        $builder = new HttpPluginClientBuilder($mockHttp, $factory);
+        // Make sure that the RequestFactory passed is acceptable for the client.
+        $client = $builder->getHttpClient();
+        $this->assertInstanceOf(HttpMethodsClientInterface::class, $client);
+
+        // Ensure that the Request Factory correctly generates a request object (including headers
+        // as RequestFactory and RequestFactoryInterface set headers differently).
+        $response = $client->get('https://example.com/puppies.jpg', ['Accept' => 'image/vnd.cute+jpeg']);
+        $this->assertInstanceOf(ResponseInterface::class, $response);
+        $this->assertSame(307, $response->getStatusCode());
+        $locationHeaders = $response->getHeader('Location');
+        $this->assertCount(1, $locationHeaders);
+        $this->assertSame('/kittens.jpg', reset($locationHeaders));
+    }
+
+    /**
+     * The concrete implementation of the RequestMatcher interface does not allow matching on
+     * headers, which we need to test to ensure both legacy and PSR17 implementations work.
+     */
+    protected function matchRequestIncludingHeaders(): RequestMatcherInterface
+    {
+        return new class implements RequestMatcherInterface {
+            public function matches(RequestInterface $request): bool
+            {
+                $acceptHeaders = $request->getHeader('Accept');
+                return $request->getUri()->getPath() === '/puppies.jpg'
+                    && count($acceptHeaders) === 1
+                    && reset($acceptHeaders) === 'image/vnd.cute+jpeg';
+            }
+        };
+    }
+
+    /** @return iterable{object|null, class-string|null} */
+    private static function provideRequestFactories(): iterable
+    {
+        // Fallback
+        yield [null, null];
+        // Legacy
+        yield [new GuzzleMessageFactory, null];
+        // PSR17
+        yield [new HttpFactory, null];
+        // Invalid
+        yield [new \stdClass, \TypeError::class];
+    }
+}