Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"amphp/hpack": "^3",
"amphp/http": "^2",
"amphp/pipeline": "^1",
"amphp/socket": "^2",
"amphp/socket": "^2.5",
"amphp/sync": "^2",
"league/uri": "^7",
"league/uri-components": "^7",
Expand Down
11 changes: 11 additions & 0 deletions src/Connection/ConnectionLimitingPool.php
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,19 @@ private static function formatUri(Request $request): string

private int $openConnectionCount = 0;

/** Unlike spl_object_id(), these ids are not reused when a callback is destroyed. */
private \WeakMap $connectCallbackIds;

private int $lastConnectCallbackId = 0;

private function __construct(private readonly int $connectionLimit, ?ConnectionFactory $connectionFactory = null)
{
if ($connectionLimit < 1) {
throw new \Error('The connection limit must be greater than 0');
}

$this->connectionFactory = $connectionFactory ?? new DefaultConnectionFactory();
$this->connectCallbackIds = new \WeakMap();
}

public function __clone()
Expand All @@ -80,6 +86,7 @@ public function __clone()
$this->totalConnectionAttempts = 0;
$this->totalStreamRequests = 0;
$this->openConnectionCount = 0;
$this->connectCallbackIds = new \WeakMap();
}

public function getTotalConnectionAttempts(): int
Expand All @@ -104,6 +111,10 @@ public function getStream(Request $request, Cancellation $cancellation): Stream

$uri = self::formatUri($request);

if ($connectCallback = $request->getConnectCallback()) {
$uri .= ' @ ' . ($this->connectCallbackIds[$connectCallback] ??= ++$this->lastConnectCallbackId);
}

[$connection, $stream] = $this->getStreamFor($uri, $request, $cancellation);

$connectionId = \spl_object_id($connection);
Expand Down
12 changes: 12 additions & 0 deletions src/Connection/DefaultConnectionFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,18 @@ public function create(Request $request, Cancellation $cancellation): Connection
$connectContext = $connectContext->withTlsContext($tlsContext);
}

if ($connectCallback = $request->getConnectCallback()) {
// The callback of the request must not replace the one of the connect context
if ($contextCallback = $connectContext->getConnectCallback()) {
$connectCallback = static function (Socket\InternetAddress $address) use ($contextCallback, $connectCallback): void {
$contextCallback($address);
$connectCallback($address);
};
}

$connectContext = $connectContext->withConnectCallback($connectCallback);
}

try {
$socket = $connector->connect(
'tcp://' . $authority,
Expand Down
26 changes: 26 additions & 0 deletions src/Request.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
use Amp\Http\Client\Internal\Phase;
use Amp\Http\HttpMessage;
use Amp\Http\HttpRequest;
use Amp\Socket\ConnectException;
use Amp\Socket\InternetAddress;
use League\Uri;
use Psr\Http\Message\UriInterface;
use function Amp\async;
Expand All @@ -34,6 +36,9 @@ final class Request extends HttpRequest

private float $tcpConnectTimeout = 10;

/** @var null|\Closure(InternetAddress): void */
private ?\Closure $connectCallback = null;

private float $tlsHandshakeTimeout = 10;

private float $transferTimeout = 10;
Expand Down Expand Up @@ -367,6 +372,27 @@ public function setTcpConnectTimeout(float $tcpConnectTimeout): void
$this->tcpConnectTimeout = \max(0, $tcpConnectTimeout);
}

/**
* @return null|\Closure(InternetAddress): void
*/
public function getConnectCallback(): ?\Closure
{
return $this->connectCallback;
}

/**
* Registers a callback invoked with the IP address of each connection attempt, before the connection is opened.
*
* The callback can throw a {@see ConnectException} to skip the address. Any other exception aborts the request.
* Pooled connections are only shared between requests that use the same callback.
*
* @param null|\Closure(InternetAddress): void $connectCallback
*/
public function setConnectCallback(?\Closure $connectCallback): void
{
$this->connectCallback = $connectCallback;
}

/**
* @return float Timeout in seconds for the TLS handshake.
*/
Expand Down
24 changes: 24 additions & 0 deletions test/Connection/ConnectionLimitingPoolTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,30 @@ public function testWaitingRequestRemovedIfConnectionAttemptFails(): void
self::assertSame([], $property->getValue($pool));
}

public function testConnectionsAreOnlySharedWithTheSameConnectCallback(): void
{
$factory = $this->createMock(ConnectionFactory::class);
$factory->expects(self::exactly(3))
->method('create')
->willReturnCallback(fn (Request $request) => $this->createMockConnection($request));

$client = (new HttpClientBuilder)
->usingPool(ConnectionLimitingPool::byAuthority(1, $factory))
->build();

$callbackA = static function (InternetAddress $address): void {
};
$callbackB = static function (InternetAddress $address): void {
};

foreach ([null, $callbackA, $callbackA, $callbackB, null] as $callback) {
$request = new Request('http://localhost');
$request->setConnectCallback($callback);

$client->request($request);
}
}

private function createMockConnection(Request $request): Connection&MockObject
{
$response = new Response('1.1', 200, null, [], new ReadableBuffer, $request, Future::complete(new Trailers([])));
Expand Down
76 changes: 76 additions & 0 deletions test/Connection/DefaultConnectionFactoryTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<?php declare(strict_types=1);

namespace Amp\Http\Client\Connection;

use Amp\CancelledException;
use Amp\Http\Client\HttpClientBuilder;
use Amp\Http\Client\Request;
use Amp\Http\Client\SocketException;
use Amp\NullCancellation;
use Amp\PHPUnit\AsyncTestCase;
use Amp\Socket;
use Amp\Socket\ConnectContext;
use Amp\Socket\InternetAddress;
use Amp\TimeoutCancellation;

class DefaultConnectionFactoryTest extends AsyncTestCase
{
public function testConnectCallbackIsCalledBeforeConnecting(): void
{
$server = Socket\listen('127.0.0.1:0');
$serverAddress = (string) $server->getAddress();

$request = new Request('http://' . $serverAddress . '/');
$request->setTransferTimeout(1);
$request->setConnectCallback(static function (InternetAddress $address): void {
throw new \RuntimeException('Blocked ' . $address->toString());
});

try {
(new HttpClientBuilder)->retry(0)->build()->request($request);
self::fail('The request should have been blocked');
} catch (\RuntimeException $e) {
self::assertSame('Blocked ' . $serverAddress, $e->getMessage());
}

try {
$server->accept(new TimeoutCancellation(0.1));
self::fail('No connection should have been opened');
} catch (CancelledException) {
$server->close();
}
}

public function testConnectCallbackIsAddedToTheOneOfTheConnectContext(): void
{
$calls = [];

$connector = $this->createMock(Socket\SocketConnector::class);
$connector->expects(self::once())
->method('connect')
->willReturnCallback(static function (string $uri, ConnectContext $context): Socket\Socket {
$context->getConnectCallback()?->__invoke(new InternetAddress('127.0.0.1', 80));

throw new Socket\ConnectException('Connection refused');
});

$factory = new DefaultConnectionFactory(
$connector,
(new ConnectContext)->withConnectCallback(static function (InternetAddress $address) use (&$calls): void {
$calls[] = 'context ' . $address->toString();
}),
);

$request = new Request('http://localhost/');
$request->setConnectCallback(static function (InternetAddress $address) use (&$calls): void {
$calls[] = 'request ' . $address->toString();
});

try {
$factory->create($request, new NullCancellation);
self::fail('The connection should have failed');
} catch (SocketException) {
self::assertSame(['context 127.0.0.1:80', 'request 127.0.0.1:80'], $calls);
}
}
}
19 changes: 19 additions & 0 deletions test/RequestTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
use Amp\ByteStream\ReadableBuffer;
use Amp\Future;
use Amp\PHPUnit\AsyncTestCase;
use Amp\Socket\InternetAddress;
use function Amp\ByteStream\buffer;

class RequestTest extends AsyncTestCase
Expand Down Expand Up @@ -259,6 +260,24 @@ public function testBodySizeLimit(): void
$this->assertSame(100, $request->getBodySizeLimit());
}

public function testConnectCallback(): void
{
$request = new Request('https://amphp.org/');

$this->assertNull($request->getConnectCallback());

$callback = static function (InternetAddress $address): void {
};
$request->setConnectCallback($callback);

$this->assertSame($callback, $request->getConnectCallback());
$this->assertSame($callback, (clone $request)->getConnectCallback());

$request->setConnectCallback(null);

$this->assertNull($request->getConnectCallback());
}

public function testIdempotent(): void
{
$this->assertTrue((new Request('https://localhost/', 'GET'))->isIdempotent());
Expand Down
Loading