feature #33973 [HttpClient] add HttpClient::createForBaseUri() (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit 46e94d94255e · 2019-10-14T16:15:04.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [HttpClient] add HttpClient::createForBaseUri() | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - I've seen ppl use `HttpClient::create()` with default `base_uri` & `auth_bearer`. That's a security risk as the bearer would be sent to any hosts that the client requests. Instead, ppl should use `ScopingHttpClient`. The new method should help to discover and use it. Commits ------- 1aa9a11 [HttpClient] add HttpClient::createForBaseUri()
diff --git a/src/Symfony/Component/HttpClient/CHANGELOG.md b/src/Symfony/Component/HttpClient/CHANGELOG.md
@@ -4,10 +4,11 @@ CHANGELOG
 4.4.0
 -----
 
- * added `StreamWrapper`
+ * added `HttpClient::createForBaseUri()`
  * added `HttplugClient` with support for sync and async requests
  * added `max_duration` option
  * added support for NTLM authentication
+ * added `StreamWrapper` to cast any `ResponseInterface` instances to PHP streams.
  * added `$response->toStream()` to cast responses to regular PHP streams
  * made `Psr18Client` implement relevant PSR-17 factories and have streaming responses
  * added `TraceableHttpClient`, `HttpClientDataCollector` and `HttpClientPass` to integrate with the web profiler
diff --git a/src/Symfony/Component/HttpClient/HttpClient.php b/src/Symfony/Component/HttpClient/HttpClient.php
@@ -39,4 +39,14 @@ public static function create(array $defaultOptions = [], int $maxHostConnection
 
         return new NativeHttpClient($defaultOptions, $maxHostConnections);
     }
+
+    /**
+     * Creates a client that adds options (e.g. authentication headers) only when the request URL matches the provided base URI.
+     */
+    public static function createForBaseUri(string $baseUri, array $defaultOptions = [], int $maxHostConnections = 6, int $maxPendingPushes = 50): HttpClientInterface
+    {
+        $client = self::create([], $maxHostConnections, $maxPendingPushes);
+
+        return ScopingHttpClient::forBaseUri($client, $baseUri, $defaultOptions);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -39,4 +39,14 @@ public static function create(array $defaultOptions = [], int $maxHostConnection`
`39`	`39`
`40`	`40`	`return new NativeHttpClient($defaultOptions, $maxHostConnections);`
`41`	`41`	`}`
	`42`	`+`
	`43`	`+ /**`
	`44`	`+ * Creates a client that adds options (e.g. authentication headers) only when the request URL matches the provided base URI.`
	`45`	`+ */`
	`46`	`+ public static function createForBaseUri(string $baseUri, array $defaultOptions = [], int $maxHostConnections = 6, int $maxPendingPushes = 50): HttpClientInterface`
	`47`	`+ {`
	`48`	`+ $client = self::create([], $maxHostConnections, $maxPendingPushes);`
	`49`	`+`
	`50`	`+ return ScopingHttpClient::forBaseUri($client, $baseUri, $defaultOptions);`
	`51`	`+ }`
`42`	`52`	`}`