Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[HttpClient] Add a ScopingHttpClient
- Loading branch information
1 parent
522594a
commit 1ee0a11
Showing
2 changed files
with
176 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\HttpClient; | ||
|
||
use Symfony\Component\HttpClient\Exception\InvalidArgumentException; | ||
use Symfony\Contracts\HttpClient\HttpClientInterface; | ||
use Symfony\Contracts\HttpClient\ResponseInterface; | ||
use Symfony\Contracts\HttpClient\ResponseStreamInterface; | ||
|
||
/** | ||
* Auto-configure the default options based on the requested URL. | ||
* | ||
* @author Anthony Martin <anthony.martin@sensiolabs.com> | ||
* | ||
* @experimental in 4.3 | ||
*/ | ||
class ScopingHttpClient implements HttpClientInterface | ||
{ | ||
use HttpClientTrait; | ||
|
||
private $client; | ||
private $defaultOptionsByRegexp; | ||
private $defaultRegexp; | ||
|
||
public function __construct(HttpClientInterface $client, array $defaultOptionsByRegexp, string $defaultRegexp = null) | ||
{ | ||
$this->client = $client; | ||
$this->defaultOptionsByRegexp = $defaultOptionsByRegexp; | ||
$this->defaultRegexp = $defaultRegexp; | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function request(string $method, string $url, array $options = []): ResponseInterface | ||
{ | ||
$url = self::parseUrl($url, $options['query'] ?? []); | ||
|
||
if (\is_string($options['base_uri'] ?? null)) { | ||
$options['base_uri'] = self::parseUrl($options['base_uri']); | ||
} | ||
|
||
try { | ||
$url = implode('', self::resolveUrl($url, $options['base_uri'] ?? null)); | ||
} catch (InvalidArgumentException $e) { | ||
if (null === $this->defaultRegexp) { | ||
throw $e; | ||
} | ||
|
||
[$url, $options] = self::prepareRequest($method, implode('', $url), $options, $this->defaultOptionsByRegexp[$this->defaultRegexp], true); | ||
$url = implode('', $url); | ||
} | ||
|
||
foreach ($this->defaultOptionsByRegexp as $regexp => $defaultOptions) { | ||
if (preg_match("{{$regexp}}A", $url)) { | ||
$options = self::mergeDefaultOptions($options, $defaultOptions, true); | ||
break; | ||
} | ||
} | ||
|
||
return $this->client->request($method, $url, $options); | ||
} | ||
|
||
/** | ||
* {@inheritdoc} | ||
*/ | ||
public function stream($responses, float $timeout = null): ResponseStreamInterface | ||
{ | ||
return $this->client->stream($responses, $timeout); | ||
} | ||
} |
96 changes: 96 additions & 0 deletions
96
src/Symfony/Component/HttpClient/Tests/ScopingHttpClientTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\HttpClient\Tests; | ||
|
||
use PHPUnit\Framework\TestCase; | ||
use Symfony\Component\HttpClient\Exception\InvalidArgumentException; | ||
use Symfony\Component\HttpClient\MockHttpClient; | ||
use Symfony\Component\HttpClient\Response\MockResponse; | ||
use Symfony\Component\HttpClient\ScopingHttpClient; | ||
|
||
class ScopingHttpClientTest extends TestCase | ||
{ | ||
public function testRelativeUrl() | ||
{ | ||
$mockClient = new MockHttpClient([]); | ||
$client = new ScopingHttpClient($mockClient, []); | ||
|
||
$this->expectException(InvalidArgumentException::class); | ||
$client->request('GET', '/foo'); | ||
} | ||
|
||
public function testRelativeUrlWithDefaultRegexp() | ||
{ | ||
$mockClient = new MockHttpClient(new MockResponse()); | ||
$client = new ScopingHttpClient($mockClient, ['.*' => ['base_uri' => 'http://example.com']], '.*'); | ||
|
||
$this->assertSame('http://example.com/foo', $client->request('GET', '/foo')->getInfo('url')); | ||
} | ||
|
||
/** | ||
* @dataProvider provideMatchingUrls | ||
*/ | ||
public function testMatchingUrls(string $regexp, string $url, array $options) | ||
{ | ||
$mockClient = new MockHttpClient(new MockResponse()); | ||
$client = new ScopingHttpClient($mockClient, $options); | ||
|
||
$response = $client->request('GET', $url); | ||
$reuestedOptions = $response->getRequestOptions(); | ||
|
||
$this->assertEquals($reuestedOptions['case'], $options[$regexp]['case']); | ||
} | ||
|
||
public function provideMatchingUrls() | ||
{ | ||
$defaultOptions = [ | ||
'.*/foo-bar' => ['case' => 1], | ||
'.*' => ['case' => 2], | ||
]; | ||
|
||
yield ['regexp' => '.*/foo-bar', 'url' => 'http://example.com/foo-bar', 'default_options' => $defaultOptions]; | ||
yield ['regexp' => '.*', 'url' => 'http://example.com/bar-foo', 'default_options' => $defaultOptions]; | ||
yield ['regexp' => '.*', 'url' => 'http://example.com/foobar', 'default_options' => $defaultOptions]; | ||
} | ||
|
||
public function testMatchingUrlsAndOptions() | ||
{ | ||
$defaultOptions = [ | ||
'.*/foo-bar' => ['headers' => ['x-app' => 'unit-test-foo-bar']], | ||
'.*' => ['headers' => ['content-type' => 'text/html']], | ||
]; | ||
|
||
$mockResponses = [ | ||
new MockResponse(), | ||
new MockResponse(), | ||
new MockResponse(), | ||
]; | ||
|
||
$mockClient = new MockHttpClient($mockResponses); | ||
$client = new ScopingHttpClient($mockClient, $defaultOptions); | ||
|
||
$response = $client->request('GET', 'http://example.com/foo-bar', ['json' => ['url' => 'http://example.com']]); | ||
$requestOptions = $response->getRequestOptions(); | ||
$this->assertEquals($requestOptions['json']['url'], 'http://example.com'); | ||
$this->assertEquals($requestOptions['headers']['x-app'][0], $defaultOptions['.*/foo-bar']['headers']['x-app']); | ||
|
||
$response = $client->request('GET', 'http://example.com/bar-foo', ['headers' => ['x-app' => 'unit-test']]); | ||
$requestOptions = $response->getRequestOptions(); | ||
$this->assertEquals($requestOptions['headers']['x-app'][0], 'unit-test'); | ||
$this->assertEquals($requestOptions['headers']['content-type'][0], 'text/html'); | ||
|
||
$response = $client->request('GET', 'http://example.com/foobar-foo', ['headers' => ['x-app' => 'unit-test']]); | ||
$requestOptions = $response->getRequestOptions(); | ||
$this->assertEquals($requestOptions['headers']['x-app'][0], 'unit-test'); | ||
$this->assertEquals($requestOptions['headers']['content-type'][0], 'text/html'); | ||
} | ||
} |