Skip to content

[FrameworkBundle] Add extra attribute for HttpClient Configuration #48797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fabpot merged 1 commit into from
Jan 5, 2023
Merged

[FrameworkBundle] Add extra attribute for HttpClient Configuration #48797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ CHANGELOG
6.3
---

* Add `extra` option for `http_client.default_options` and `http_client.scoped_client`
* Add `DomCrawlerAssertionsTrait::assertSelectorCount(int $count, string $selector)`
* Allow to avoid `limit` definition in a RateLimiter configuration when using the `no_limit` policy
* Add `--format` option to the `debug:config` command
Expand Down
10 changes: 10 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1725,6 +1725,11 @@ private function addHttpClientSection(ArrayNodeDefinition $rootNode, callable $e
->variableNode('md5')->end()
->end()
->end()
->arrayNode('extra')
->info('Extra options for specific HTTP client')
->normalizeKeys(false)
->variablePrototype()->end()
->end()
->append($this->addHttpClientRetrySection())
->end()
->end()
Expand Down Expand Up @@ -1868,6 +1873,11 @@ private function addHttpClientSection(ArrayNodeDefinition $rootNode, callable $e
->variableNode('md5')->end()
->end()
->end()
->arrayNode('extra')
->info('Extra options for specific HTTP client')
->normalizeKeys(false)
->variablePrototype()->end()
->end()
->append($this->addHttpClientRetrySection())
->end()
->end()
Expand Down
2 changes: 2 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,7 @@
<xsd:element name="header" type="http_header" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="peer-fingerprint" type="fingerprint" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="retry-failed" type="http_client_retry_failed" minOccurs="0" maxOccurs="1" />
<xsd:element name="extra" type="xsd:anyType" minOccurs="0" maxOccurs="unbounded" />
</xsd:choice>
<xsd:attribute name="max-redirects" type="xsd:integer" />
<xsd:attribute name="http-version" type="xsd:string" />
Expand All @@ -645,6 +646,7 @@
<xsd:element name="header" type="http_header" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="peer-fingerprint" type="fingerprint" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="retry-failed" type="http_client_retry_failed" minOccurs="0" maxOccurs="1" />
<xsd:element name="extra" type="xsd:anyType" minOccurs="0" maxOccurs="unbounded" />
</xsd:choice>
<xsd:attribute name="name" type="xsd:string" />
<xsd:attribute name="scope" type="xsd:string" />
Expand Down
1 change: 1 addition & 0 deletions ...ameworkBundle/Tests/DependencyInjection/Fixtures/php/http_client_full_default_options.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
'pin-sha256' => ['14s5erg62v1v8471g2revg48r7==', 'jsda84hjtyd4821bgfesd215bsfg5412='],
'md5' => 'sdhtb481248721thbr=',
],
'extra' => ['foo' => ['bar' => 'baz']],
],
],
]);
2 changes: 2 additions & 0 deletions ...orkBundle/Tests/DependencyInjection/Fixtures/php/http_client_override_default_options.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@
'max_host_connections' => 4,
'default_options' => [
'headers' => ['foo' => 'bar'],
'extra' => ['foo' => 'bar'],
],
'scoped_clients' => [
'foo' => [
'base_uri' => 'http://example.com',
'headers' => ['bar' => 'baz'],
'extra' => ['bar' => 'baz'],
],
],
],
Expand Down
5 changes: 5 additions & 0 deletions ...ameworkBundle/Tests/DependencyInjection/Fixtures/xml/http_client_full_default_options.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@
<framework:pin-sha256>jsda84hjtyd4821bgfesd215bsfg5412=</framework:pin-sha256>
<framework:md5>sdhtb481248721thbr=</framework:md5>
</framework:peer-fingerprint>
<framework:extra>
<framework:foo>
<framework:bar>baz</framework:bar>
</framework:foo>
</framework:extra>
</framework:default-options>
</framework:http-client>
</framework:config>
Expand Down
6 changes: 6 additions & 0 deletions ...orkBundle/Tests/DependencyInjection/Fixtures/xml/http_client_override_default_options.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,15 @@
<framework:http-client max-host-connections="4">
<framework:default-options>
<framework:header name="foo">bar</framework:header>
<framework:extra>
<framework:foo>bar</framework:foo>
</framework:extra>
</framework:default-options>
<framework:scoped-client name="foo" base-uri="http://example.com">
<framework:header name="bar">baz</framework:header>
<framework:extra>
<framework:bar>baz</framework:bar>
</framework:extra>
</framework:scoped-client>
</framework:http-client>
</framework:config>
Expand Down
3 changes: 3 additions & 0 deletions ...ameworkBundle/Tests/DependencyInjection/Fixtures/yml/http_client_full_default_options.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@ framework:
peer_fingerprint:
pin-sha256: ['14s5erg62v1v8471g2revg48r7==', 'jsda84hjtyd4821bgfesd215bsfg5412=']
md5: 'sdhtb481248721thbr='
extra:
foo:
bar: 'baz'
2 changes: 2 additions & 0 deletions ...orkBundle/Tests/DependencyInjection/Fixtures/yml/http_client_override_default_options.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ framework:
max_host_connections: 4
default_options:
headers: {'foo': 'bar'}
extra: {'foo': 'bar'}
scoped_clients:
foo:
base_uri: http://example.com
headers: {'bar': 'baz'}
extra: {'bar': 'baz'}
8 changes: 7 additions & 1 deletion src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1852,6 +1852,7 @@ public function testHttpClientDefaultOptions()
$defaultOptions = [
'headers' => [],
'resolve' => [],
'extra' => [],
];
$this->assertSame([$defaultOptions, 4], $container->getDefinition('http_client')->getArguments());

Expand All @@ -1872,17 +1873,21 @@ public function testHttpClientOverrideDefaultOptions()
$container = $this->createContainerFromFile('http_client_override_default_options');

$this->assertSame(['foo' => 'bar'], $container->getDefinition('http_client')->getArgument(0)['headers']);
$this->assertSame(['foo' => 'bar'], $container->getDefinition('http_client')->getArgument(0)['extra']);
$this->assertSame(4, $container->getDefinition('http_client')->getArgument(1));
$this->assertSame('http://example.com', $container->getDefinition('foo')->getArgument(1));

$expected = [
'headers' => [
'bar' => 'baz',
],
'extra' => [
'bar' => 'baz',
],
'query' => [],
'resolve' => [],
];
$this->assertSame($expected, $container->getDefinition('foo')->getArgument(2));
$this->assertEquals($expected, $container->getDefinition('foo')->getArgument(2));
}

public function testHttpClientRetry()
Expand Down Expand Up @@ -1944,6 +1949,7 @@ public function testHttpClientFullDefaultOptions()
'pin-sha256' => ['14s5erg62v1v8471g2revg48r7==', 'jsda84hjtyd4821bgfesd215bsfg5412='],
'md5' => 'sdhtb481248721thbr=',
], $defaultOptions['peer_fingerprint']);
$this->assertSame(['foo' => ['bar' => 'baz']], $defaultOptions['extra']);
}

public function provideMailer(): array
Expand Down