Expose HTTP client options

Author: cicnavi

src/Factories/HttpClientDecoratorFactory.php

@@ -12,8 +12,23 @@
  */
 class HttpClientDecoratorFactory
 {
-    public function build(?Client $client = null): HttpClientDecorator
+    /**
+     * @param \GuzzleHttp\Client|null $client A pre-built client. If given, $httpClientConfig is ignored.
+     * @param array<string,mixed> $httpClientConfig Guzzle client options merged over the defaults when no
+     *        $client is supplied. See https://docs.guzzlephp.org/en/stable/request-options.html
+     */
+    public function build(?Client $client = null, array $httpClientConfig = []): HttpClientDecorator
     {
-        return is_null($client) ? new HttpClientDecorator() : new HttpClientDecorator($client);
+        if (!is_null($client)) {
+            return new HttpClientDecorator($client);
+        }
+
+        if ($httpClientConfig === []) {
+            return new HttpClientDecorator();
+        }
+
+        return new HttpClientDecorator(
+            new Client(array_merge(HttpClientDecorator::DEFAULT_HTTP_CLIENT_CONFIG, $httpClientConfig)),
+        );
     }
 }

src/Federation.php

@@ -141,6 +141,9 @@ class Federation
     protected ?EntityCollectionFactory $entityCollectionFactory = null;
 
 
+    /**
+     * @param array<string,mixed> $httpClientConfig
+     */
     public function __construct(
         protected readonly SupportedAlgorithms $supportedAlgorithms = new SupportedAlgorithms(),
         protected readonly SupportedSerializers $supportedSerializers = new SupportedSerializers(),
@@ -154,14 +157,15 @@ public function __construct(
         protected readonly TrustMarkStatusEndpointUsagePolicyEnum $defaultTrustMarkStatusEndpointUsagePolicyEnum = TrustMarkStatusEndpointUsagePolicyEnum::NotUsed,
         int $maxDiscoveryDepth = 10,
         protected ?EntityCollectionStoreInterface $entityCollectionStore = null,
+        array $httpClientConfig = [],
     ) {
         $this->maxCacheDurationDecorator = $this->dateIntervalDecoratorFactory()->build($maxCacheDuration);
         $this->timestampValidationLeewayDecorator = $this->dateIntervalDecoratorFactory()
             ->build($timestampValidationLeeway);
         $this->maxTrustChainDepth = min(20, max(1, $maxTrustChainDepth));
         $this->maxDiscoveryDepth = max(1, $maxDiscoveryDepth);
         $this->cacheDecorator = is_null($cache) ? null : $this->cacheDecoratorFactory()->build($cache);
-        $this->httpClientDecorator = $this->httpClientDecoratorFactory()->build($client);
+        $this->httpClientDecorator = $this->httpClientDecoratorFactory()->build($client, $httpClientConfig);
     }
 
 

src/Jwks.php

@@ -73,6 +73,9 @@ class Jwks
     protected ?AlgorithmManagerDecorator $algorithmManagerDecorator = null;
 
 
+    /**
+     * @param array<string,mixed> $httpClientConfig
+     */
     public function __construct(
         protected readonly SupportedAlgorithms $supportedAlgorithms = new SupportedAlgorithms(),
         protected readonly SupportedSerializers $supportedSerializers = new SupportedSerializers(),
@@ -81,12 +84,13 @@ public function __construct(
         ?CacheInterface $cache = null,
         protected readonly ?LoggerInterface $logger = null,
         ?Client $httpClient = null,
+        array $httpClientConfig = [],
     ) {
         $this->maxCacheDurationDecorator = $this->dateIntervalDecoratorFactory()->build($maxCacheDuration);
         $this->timestampValidationLeewayDecorator = $this->dateIntervalDecoratorFactory()
             ->build($timestampValidationLeeway);
         $this->cacheDecorator = is_null($cache) ? null : $this->cacheDecoratorFactory()->build($cache);
-        $this->httpClientDecorator = $this->httpClientDecoratorFactory()->build($httpClient);
+        $this->httpClientDecorator = $this->httpClientDecoratorFactory()->build($httpClient, $httpClientConfig);
     }
 
 

src/RequestObject.php

@@ -84,6 +84,9 @@ class RequestObject
     protected ?Helpers $helpers = null;
 
 
+    /**
+     * @param array<string,mixed> $httpClientConfig
+     */
     public function __construct(
         protected readonly SupportedAlgorithms $supportedAlgorithms = new SupportedAlgorithms(
             new SignatureAlgorithmBag(
@@ -98,10 +101,11 @@ public function __construct(
         protected ?RequestUriFetcher $requestUriFetcher = null,
         ?Client $client = null,
         ?CacheInterface $cache = null,
+        array $httpClientConfig = [],
     ) {
         $this->timestampValidationLeewayDecorator = $this->dateIntervalDecoratorFactory()
             ->build($timestampValidationLeeway);
-        $this->httpClientDecorator = $this->httpClientDecoratorFactory()->build($client);
+        $this->httpClientDecorator = $this->httpClientDecoratorFactory()->build($client, $httpClientConfig);
         $this->cacheDecorator = is_null($cache) ? null : $this->cacheDecoratorFactory()->build($cache);
     }
 

tests/src/Factories/HttpClientDecoratorFactoryTest.php

@@ -31,11 +31,36 @@ public function testCanCreateInstance(): void
     }
 
 
-    public function testCanBuild(): void
+    public function testBuildWithClient(): void
     {
-        $this->assertInstanceOf(
-            HttpClientDecorator::class,
-            $this->sut()->build($this->createStub(\GuzzleHttp\Client::class)),
-        );
+        $client = new \GuzzleHttp\Client();
+        $decorator = $this->sut()->build($client);
+        $this->assertSame($client, $decorator->client);
+    }
+
+
+    public function testBuildWithoutClientAndConfig(): void
+    {
+        $decorator = $this->sut()->build();
+        $this->assertInstanceOf(HttpClientDecorator::class, $decorator);
+        $this->assertNotEmpty($decorator->client->getConfig('allow_redirects'));
+    }
+
+
+    public function testBuildWithConfig(): void
+    {
+        $config = ['timeout' => 10.0, 'connect_timeout' => 5.0];
+        $decorator = $this->sut()->build(null, $config);
+
+        $this->assertEqualsWithDelta(10.0, $decorator->client->getConfig('timeout'), PHP_FLOAT_EPSILON);
+        $this->assertEqualsWithDelta(5.0, $decorator->client->getConfig('connect_timeout'), PHP_FLOAT_EPSILON);
+        $this->assertNotEmpty($decorator->client->getConfig('allow_redirects'));
+    }
+
+
+    public function testBuildWithConfigOverridingDefaults(): void
+    {
+        $decorator = $this->sut()->build(null, ['allow_redirects' => false]);
+        $this->assertFalse($decorator->client->getConfig('allow_redirects'));
     }
 }