Skip to content

[WIP] Let guzzle choose the handler for http requests #60167

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

Draft
julien-nc wants to merge 1 commit into
base: master
Choose a base branch
from
+159 −55
Draft

[WIP] Let guzzle choose the handler for http requests #60167

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
16 changes: 13 additions & 3 deletions lib/private/Http/Client/Client.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,19 @@ public function __construct(
}

private function buildRequestOptions(array $options): array {
$streamResponse = !empty($options[RequestOptions::STREAM]);
$proxy = $this->getProxyUri();

$defaults = [
RequestOptions::VERIFY => $this->getCertBundle(),
RequestOptions::TIMEOUT => IClient::DEFAULT_REQUEST_TIMEOUT,
// Prefer HTTP/2 globally (PSR-7 request version)
RequestOptions::VERSION => '2.0',
// Guzzle's StreamHandler only supports HTTP/1.x, so streamed
// responses must not force the default HTTP/2 transport settings.
RequestOptions::VERSION => $streamResponse ? '1.1' : '2.0',
];
$defaults['curl'][\CURLOPT_HTTP_VERSION] = \CURL_HTTP_VERSION_2TLS;
$defaults['curl'][\CURLOPT_HTTP_VERSION] = $streamResponse
? \CURL_HTTP_VERSION_1_1
: \CURL_HTTP_VERSION_2TLS;

$options['nextcloud']['allow_local_address'] = $this->isLocalAddressAllowed($options);
if ($options['nextcloud']['allow_local_address'] === false) {
Expand All @@ -75,6 +79,12 @@ private function buildRequestOptions(array $options): array {

$options = array_merge($defaults, $options);

if ($streamResponse) {
$options[RequestOptions::VERSION] = '1.1';
$options['curl'] ??= [];
$options['curl'][\CURLOPT_HTTP_VERSION] = \CURL_HTTP_VERSION_1_1;
}

if (!isset($options[RequestOptions::HEADERS]['User-Agent'])) {
$userAgent = 'Nextcloud-Server-Crawler/' . $this->serverVersion->getVersionString();
$overwriteCliUrl = $this->config->getSystemValueString('overwrite.cli.url');
Expand Down
4 changes: 2 additions & 2 deletions lib/private/Http/Client/ClientService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
namespace OC\Http\Client;

use GuzzleHttp\Client as GuzzleClient;
use GuzzleHttp\Handler\CurlHandler;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
use GuzzleHttp\Utils;
use OCP\Diagnostics\IEventLogger;
use OCP\Http\Client\IClient;
use OCP\Http\Client\IClientService;
Expand Down Expand Up @@ -41,7 +41,7 @@ public function __construct(

#[\Override]
public function newClient(): IClient {
$handler = new CurlHandler();
$handler = Utils::chooseHandler();
Copy link
Copy Markdown
Member

@marcelklehr marcelklehr May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does this do?

Copy link
Copy Markdown
Member Author

@julien-nc julien-nc May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It lets Guzzle choose the handler depending on the request options. So the StreamHandler is chosen when 'stream' => true is passed to the request options.

Copy link
Copy Markdown
Member

@marcelklehr marcelklehr May 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! maybe a comment?

$stack = HandlerStack::create($handler);
if ($this->config->getSystemValueBool('dns_pinning', true)) {
$stack->push($this->dnsPinMiddleware->addDnsPinning());
Expand Down
126 changes: 76 additions & 50 deletions tests/lib/Http/Client/ClientServiceTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,9 @@

namespace Test\Http\Client;

use GuzzleHttp\Client as GuzzleClient;
use GuzzleHttp\Handler\CurlHandler;
use GuzzleHttp\Handler\MockHandler;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
use GuzzleHttp\Psr7\Response;
use OC\Http\Client\Client;
use OC\Http\Client\ClientService;
use OC\Http\Client\DnsPinMiddleware;
Expand All @@ -22,7 +21,6 @@
use OCP\IConfig;
use OCP\Security\IRemoteHostValidator;
use OCP\ServerVersion;
use Psr\Http\Message\RequestInterface;
use Psr\Log\LoggerInterface;

/**
Expand All @@ -32,21 +30,38 @@ class ClientServiceTest extends \Test\TestCase {
public function testNewClient(): void {
/** @var IConfig $config */
$config = $this->createMock(IConfig::class);
$config->method('getSystemValueBool')
->with('dns_pinning', true)
->willReturn(true);
$config->method('getSystemValueBool')->willReturnMap([
['dns_pinning', true, true],
['installed', false, false],
['allow_local_remote_servers', false, false],
['http_client_add_user_agent_url', false, false],
]);
/** @var ICertificateManager $certificateManager */
$certificateManager = $this->createMock(ICertificateManager::class);
$dnsPinMiddleware = $this->createMock(DnsPinMiddleware::class);
$dnsMiddleware = static fn (callable $handler): callable => $handler;
$dnsPinMiddleware
->expects($this->atLeastOnce())
->method('addDnsPinning')
->willReturn(function (): void {
});
->willReturn($dnsMiddleware);
$remoteHostValidator = $this->createMock(IRemoteHostValidator::class);
$remoteHostValidator->method('isValid')->willReturn(true);
$eventLogger = $this->createMock(IEventLogger::class);
$eventLogger->expects($this->once())
->method('start')
->with('http:request', 'GET request to /');
$eventLogger->expects($this->once())
->method('end')
->with('http:request');
$logger = $this->createMock(LoggerInterface::class);
$serverVersion = $this->createMock(ServerVersion::class);
$serverVersion->method('getVersionString')->willReturn('1.0.0');
$config->method('getSystemValueString')->willReturnMap([
['proxy', '', ''],
['overwrite.cli.url', '', ''],
]);
$config->method('getSystemValue')->with('proxyexclude', [])->willReturn([]);
$certificateManager->method('getDefaultCertificatesBundlePath')->willReturn('/tmp/certificates.crt');

$clientService = new ClientService(
$config,
Expand All @@ -58,27 +73,22 @@ public function testNewClient(): void {
$serverVersion,
);

$handler = new CurlHandler();
$stack = HandlerStack::create($handler);
$stack->push($dnsPinMiddleware->addDnsPinning());
$stack->push(Middleware::tap(function (RequestInterface $request) use ($eventLogger): void {
$eventLogger->start('http:request', $request->getMethod() . ' request to ' . $request->getRequestTarget());
}, function () use ($eventLogger): void {
$eventLogger->end('http:request');
}), 'event logger');
$guzzleClient = new GuzzleClient(['handler' => $stack]);
$client = $clientService->newClient();
$this->assertEquals(new Client(
$config,
$certificateManager,
$this->getGuzzleClient($client),
$remoteHostValidator,
$logger,
$serverVersion,
), $client);

$stack = $this->getHandlerStack($client);
$this->assertStringContainsString("Name: ''", (string)$stack);
$this->assertStringContainsString("Name: 'event logger'", (string)$stack);

$this->assertEquals(
new Client(
$config,
$certificateManager,
$guzzleClient,
$remoteHostValidator,
$logger,
$serverVersion,
),
$clientService->newClient()
);
$stack->setHandler(new MockHandler([new Response(200)]));
$this->assertSame(200, $client->get('https://example.com')->getStatusCode());
}

public function testDisableDnsPinning(): void {
Expand All @@ -93,12 +103,25 @@ public function testDisableDnsPinning(): void {
$dnsPinMiddleware
->expects($this->never())
->method('addDnsPinning')
->willReturn(function (): void {
});
->willReturn(static fn (callable $handler): callable => $handler);
$remoteHostValidator = $this->createMock(IRemoteHostValidator::class);
$remoteHostValidator->method('isValid')->willReturn(true);
$eventLogger = $this->createMock(IEventLogger::class);
$logger = $this->createMock(LoggerInterface::class);
$serverVersion = $this->createMock(ServerVersion::class);
$serverVersion->method('getVersionString')->willReturn('1.0.0');
$config->method('getSystemValueBool')->willReturnMap([
['dns_pinning', true, false],
['installed', false, false],
['allow_local_remote_servers', false, false],
['http_client_add_user_agent_url', false, false],
]);
$config->method('getSystemValueString')->willReturnMap([
['proxy', '', ''],
['overwrite.cli.url', '', ''],
]);
$config->method('getSystemValue')->with('proxyexclude', [])->willReturn([]);
$certificateManager->method('getDefaultCertificatesBundlePath')->willReturn('/tmp/certificates.crt');

$clientService = new ClientService(
$config,
Expand All @@ -110,25 +133,28 @@ public function testDisableDnsPinning(): void {
$serverVersion,
);

$handler = new CurlHandler();
$stack = HandlerStack::create($handler);
$stack->push(Middleware::tap(function (RequestInterface $request) use ($eventLogger): void {
$eventLogger->start('http:request', $request->getMethod() . ' request to ' . $request->getRequestTarget());
}, function () use ($eventLogger): void {
$eventLogger->end('http:request');
}), 'event logger');
$guzzleClient = new GuzzleClient(['handler' => $stack]);
$client = $clientService->newClient();
$this->assertEquals(new Client(
$config,
$certificateManager,
$this->getGuzzleClient($client),
$remoteHostValidator,
$logger,
$serverVersion,
), $client);

$this->assertEquals(
new Client(
$config,
$certificateManager,
$guzzleClient,
$remoteHostValidator,
$logger,
$serverVersion,
),
$clientService->newClient()
);
$stack = $this->getHandlerStack($client);
$this->assertStringNotContainsString("Name: ''", (string)$stack);
$this->assertStringContainsString("Name: 'event logger'", (string)$stack);
}

private function getGuzzleClient(Client $client): \GuzzleHttp\Client {
return self::invokePrivate($client, 'client');
}

private function getHandlerStack(Client $client): HandlerStack {
/** @var HandlerStack $stack */
$stack = $this->getGuzzleClient($client)->getConfig('handler');
return $stack;
}
}
68 changes: 68 additions & 0 deletions tests/lib/Http/Client/ClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,23 @@ public function testGet(): void {
$this->assertEquals(418, $this->client->get('http://localhost/', [])->getStatusCode());
}

public function testGetStreamUsesHttp11(): void {
$this->setUpDefaultRequestOptions();

$options = array_merge($this->defaultRequestOptions, [
'stream' => true,
'version' => '1.1',
'curl' => [
\CURLOPT_HTTP_VERSION => \CURL_HTTP_VERSION_1_1,
],
]);

$this->guzzleClient->method('request')
->with('get', 'http://localhost/', $options)
->willReturn(new Response(418));
$this->assertEquals(418, $this->client->get('http://localhost/', ['stream' => true])->getStatusCode());
}

public function testGetWithOptions(): void {
$this->setUpDefaultRequestOptions();

Expand Down Expand Up @@ -522,6 +539,57 @@ public function testSetDefaultOptionsWithNotInstalled(): void {
], self::invokePrivate($this->client, 'buildRequestOptions', [[]]));
}

public function testSetDefaultOptionsWithStream(): void {
$this->config
->expects($this->exactly(3))
->method('getSystemValueBool')
->willReturnMap([
['installed', false, true],
['allow_local_remote_servers', false, false],
['http_client_add_user_agent_url', false, false],
]);
$this->config
->expects($this->exactly(2))
->method('getSystemValueString')
->willReturnMap([
['proxy', '', ''],
['overwrite.cli.url', '', ''],
]);
$this->certificateManager
->expects($this->once())
->method('getAbsoluteBundlePath')
->with()
->willReturn('/my/path.crt');

$this->serverVersion->method('getVersionString')
->willReturn('123.45.6');

$this->assertEquals([
'verify' => '/my/path.crt',
'headers' => [
'User-Agent' => 'Nextcloud-Server-Crawler/123.45.6',
'Accept-Encoding' => 'gzip',
],
'timeout' => 30,
'nextcloud' => [
'allow_local_address' => false,
],
'allow_redirects' => [
'on_redirect' => function (
\Psr\Http\Message\RequestInterface $request,
\Psr\Http\Message\ResponseInterface $response,
\Psr\Http\Message\UriInterface $uri,
): void {
},
],
'stream' => true,
'version' => '1.1',
'curl' => [
\CURLOPT_HTTP_VERSION => \CURL_HTTP_VERSION_1_1,
],
], self::invokePrivate($this->client, 'buildRequestOptions', [['stream' => true]]));
}

public function testSetDefaultOptionsWithProxy(): void {
$this->config
->expects($this->exactly(3))
Expand Down
Loading