Skip to content
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

Jump to bottom

Improve promise cancellation and close underlying socket connection #89

Merged
merged 1 commit into from
Jan 14, 2019
Merged

Improve promise cancellation and close underlying socket connection #89

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
20 changes: 16 additions & 4 deletions src/Connector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,21 @@ public function __invoke($url, array $subProtocols = [], array $headers = []) {

$uriString = $scheme . '://' . $uri->getHost() . ':' . $port;

return $connector->connect($uriString)->then(function(ConnectionInterface $conn) use ($request, $subProtocols) {
$futureWsConn = new Deferred;
$connecting = $connector->connect($uriString);

$futureWsConn = new Deferred(function ($_, $reject) use ($url, $connecting) {
$reject(new \RuntimeException(
'Connection to ' . $url . ' cancelled during handshake'
));

// either close active connection or cancel pending connection attempt
$connecting->then(function (ConnectionInterface $connection) {
$connection->close();
});
$connecting->cancel();
});

$connecting->then(function(ConnectionInterface $conn) use ($request, $subProtocols, $futureWsConn) {
$earlyClose = function() use ($futureWsConn) {
$futureWsConn->reject(new \RuntimeException('Connection closed before handshake'));
};
Expand Down Expand Up @@ -98,9 +110,9 @@ public function __invoke($url, array $subProtocols = [], array $headers = []) {

$stream->on('data', $headerParser);
$stream->write(gPsr\str($request));
}, array($futureWsConn, 'reject'));

return $futureWsConn->promise();
});
return $futureWsConn->promise();
}

/**
Expand Down
67 changes: 67 additions & 0 deletions tests/unit/ConnectorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
use Ratchet\Client\Connector;
use React\EventLoop\Factory;
use React\Promise\RejectedPromise;
use React\Promise\Promise;

class ConnectorTest extends TestCase
{
Expand Down Expand Up @@ -36,4 +37,70 @@ public function testSecureConnectionUsesTlsScheme($uri, $expectedConnectorUri) {

$pawlConnector($uri);
}

public function testConnectorRejectsWhenUnderlyingSocketConnectorRejects()
{
$exception = new RuntimeException('Connection failed');

$loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();
$connector = $this->getMockBuilder('React\Socket\ConnectorInterface')->getMock();
$connector->expects($this->once())->method('connect')->willReturn(\React\Promise\reject($exception));

$pawlConnector = new Connector($loop, $connector);

$promise = $pawlConnector('ws://localhost');

$actual = null;
$promise->then(null, function ($reason) use (&$actual) {
$actual = $reason;
});
$this->assertSame($exception, $actual);
}

public function testCancelConnectorShouldCancelUnderlyingSocketConnectorWhenSocketConnectionIsPending()
{
$promise = new Promise(function () { }, function () use (&$cancelled) {
++$cancelled;
});

$loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();
$connector = $this->getMockBuilder('React\Socket\ConnectorInterface')->getMock();
$connector->expects($this->once())->method('connect')->willReturn($promise);

$pawlConnector = new Connector($loop, $connector);

$promise = $pawlConnector('ws://localhost');

$this->assertNull($cancelled);
$promise->cancel();
$this->assertEquals(1, $cancelled);

$message = null;
$promise->then(null, function ($reason) use (&$message) {
$message = $reason->getMessage();
});
$this->assertEquals('Connection to ws://localhost cancelled during handshake', $message);
}

public function testCancelConnectorShouldCloseUnderlyingSocketConnectionWhenHandshakeIsPending()
{
$connection = $this->getMockBuilder('React\Socket\ConnectionInterface')->getMock();
$connection->expects($this->once())->method('close');

$loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();
$connector = $this->getMockBuilder('React\Socket\ConnectorInterface')->getMock();
$connector->expects($this->once())->method('connect')->willReturn(\React\Promise\resolve($connection));

$pawlConnector = new Connector($loop, $connector);

$promise = $pawlConnector('ws://localhost');

$promise->cancel();

$message = null;
$promise->then(null, function ($reason) use (&$message) {
$message = $reason->getMessage();
});
$this->assertEquals('Connection to ws://localhost cancelled during handshake', $message);
}
}