From 8760d38e2fc419f8da18858e15917131ff99bafe Mon Sep 17 00:00:00 2001 From: Fabian Meyer Date: Mon, 17 Oct 2022 11:40:29 +0200 Subject: [PATCH] Use reactphp/async instead of clue/reactphp-block --- README.md | 21 ++++---- composer.json | 2 +- tests/FunctionalClientTest.php | 97 +++++++++++++++++----------------- tests/IntegrationTest.php | 6 +-- 4 files changed, 63 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index 06733ba..582f794 100644 --- a/README.md +++ b/README.md @@ -154,21 +154,20 @@ If this looks strange to you, you can also use the more traditional [blocking AP As stated above, this library provides you a powerful, async API by default. -If, however, you want to integrate this into your traditional, blocking environment, -you should look into also using [clue/reactphp-block](https://github.com/clue/reactphp-block). - -The resulting blocking code could look something like this: +You can also integrate this into your traditional, blocking environment by using +[reactphp/async](https://github.com/reactphp/async). This allows you to simply +await commands on the client like this: ```php -use Clue\React\Block; +use function React\Async\await; $client = new Clue\React\Docker\Client(); $promise = $client->imageInspect('busybox'); try { - $results = Block\await($promise, Loop::get()); - // resporesults successfully received + $results = await($promise); + // response results successfully received } catch (Exception $e) { // an error occured while performing the request } @@ -177,15 +176,19 @@ try { Similarly, you can also process multiple commands concurrently and await an array of results: ```php +use function React\Async\await; + $promises = array( $client->imageInspect('busybox'), $client->imageInspect('ubuntu'), ); -$inspections = Block\awaitAll($promises, Loop::get()); +$inspections = await(all($promises)); ``` -Please refer to [clue/reactphp-block](https://github.com/clue/reactphp-block#readme) for more details. +This is made possible thanks to fibers available in PHP 8.1+ and our +compatibility API that also works on all supported PHP versions. +Please refer to [reactphp/async](https://github.com/reactphp/async#readme) for more details. #### Command streaming diff --git a/composer.json b/composer.json index 1bd084e..8ee7150 100644 --- a/composer.json +++ b/composer.json @@ -28,7 +28,7 @@ "rize/uri-template": "^0.3" }, "require-dev": { - "clue/block-react": "^1.5", + "react/async": "^4 || ^3 || ^2", "clue/caret-notation": "^0.2", "clue/tar-react": "^0.2", "phpunit/phpunit": "^9.3 || ^5.7 || ^4.8.35" diff --git a/tests/FunctionalClientTest.php b/tests/FunctionalClientTest.php index d04bac8..56ff0bb 100644 --- a/tests/FunctionalClientTest.php +++ b/tests/FunctionalClientTest.php @@ -2,7 +2,6 @@ namespace Clue\Tests\React\Docker; -use Clue\React\Block; use Clue\React\Docker\Client; use React\EventLoop\Loop; use React\Promise\Stream; @@ -21,7 +20,7 @@ public function setUpClient() $promise = $this->client->ping(); try { - Block\await($promise, Loop::get()); + \React\Async\await($promise); } catch (\Exception $e) { $this->markTestSkipped('Unable to connect to docker ' . $e->getMessage()); } @@ -42,7 +41,7 @@ public function testImageInspectCheckIfBusyboxExists() $promise = $this->client->imageInspect('busybox:latest'); try { - Block\await($promise, Loop::get()); + \React\Async\await($promise); } catch (\RuntimeException $e) { $this->markTestSkipped('Image "busybox" not downloaded yet'); } @@ -59,7 +58,7 @@ public function testCreateStartAndRemoveContainer() ); $promise = $this->client->containerCreate($config); - $container = Block\await($promise, Loop::get()); + $container = \React\Async\await($promise); $this->assertNotNull($container['Id']); $this->assertEmpty($container['Warnings']); @@ -67,22 +66,22 @@ public function testCreateStartAndRemoveContainer() $start = microtime(true); $promise = $this->client->containerStart($container['Id']); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); $this->assertEquals('', $ret); $promise = $this->client->containerLogs($container['Id'], false, true, true); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); $this->assertEquals("test\n", $ret); $promise = $this->client->containerAttach($container['Id'], true, false); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); $this->assertEquals("test\n", $ret); $promise = $this->client->containerRemove($container['Id'], false, true); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); $this->assertEquals('', $ret); @@ -90,7 +89,7 @@ public function testCreateStartAndRemoveContainer() // get all events between starting and removing for this container $promise = $this->client->events($start, $end, array('container' => array($container['Id']))); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); // expects "start", "attach", "kill", "die", "destroy" events $this->assertEquals(5, count($ret)); @@ -113,13 +112,13 @@ public function testStartRunning() ); $promise = $this->client->containerCreate($config); - $container = Block\await($promise, Loop::get()); + $container = \React\Async\await($promise); $this->assertNotNull($container['Id']); $this->assertEmpty($container['Warnings']); $promise = $this->client->containerStart($container['Id']); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); $this->assertEquals('', $ret); @@ -134,7 +133,7 @@ public function testStartRunning() public function testExecCreateWhileRunning($container) { $promise = $this->client->execCreate($container, array('echo', '-n', 'hello', 'world')); - $exec = Block\await($promise, Loop::get()); + $exec = \React\Async\await($promise); $this->assertTrue(is_array($exec)); $this->assertTrue(is_string($exec['Id'])); @@ -149,7 +148,7 @@ public function testExecCreateWhileRunning($container) public function testExecInspectBeforeRunning($exec) { $promise = $this->client->execInspect($exec); - $info = Block\await($promise, Loop::get()); + $info = \React\Async\await($promise); $this->assertTrue(is_array($info)); $this->assertFalse($info['Running']); @@ -163,7 +162,7 @@ public function testExecInspectBeforeRunning($exec) public function testExecStartWhileRunning($exec) { $promise = $this->client->execStart($exec); - $output = Block\await($promise, Loop::get()); + $output = \React\Async\await($promise); $this->assertEquals('hello world', $output); } @@ -175,7 +174,7 @@ public function testExecStartWhileRunning($exec) public function testExecInspectAfterRunning($exec) { $promise = $this->client->execInspect($exec); - $info = Block\await($promise, Loop::get()); + $info = \React\Async\await($promise); $this->assertTrue(is_array($info)); $this->assertFalse($info['Running']); @@ -189,13 +188,13 @@ public function testExecInspectAfterRunning($exec) public function testExecStringCommandWithOutputWhileRunning($container) { $promise = $this->client->execCreate($container, 'echo -n hello world'); - $exec = Block\await($promise, Loop::get()); + $exec = \React\Async\await($promise); $this->assertTrue(is_array($exec)); $this->assertTrue(is_string($exec['Id'])); $promise = $this->client->execStart($exec['Id']); - $output = Block\await($promise, Loop::get()); + $output = \React\Async\await($promise); $this->assertEquals('hello world', $output); } @@ -207,7 +206,7 @@ public function testExecStringCommandWithOutputWhileRunning($container) public function testExecStreamOutputInMultipleChunksWhileRunning($container) { $promise = $this->client->execCreate($container, 'echo -n hello && sleep 0.2 && echo -n world'); - $exec = Block\await($promise, Loop::get()); + $exec = \React\Async\await($promise); $this->assertTrue(is_array($exec)); $this->assertTrue(is_string($exec['Id'])); @@ -216,7 +215,7 @@ public function testExecStreamOutputInMultipleChunksWhileRunning($container) $stream->once('data', $this->expectCallableOnceWith('hello')); $stream->on('end', $this->expectCallableOnce()); - $output = Block\await(Stream\buffer($stream), Loop::get()); + $output = \React\Async\await(Stream\buffer($stream)); $this->assertEquals('helloworld', $output); } @@ -228,13 +227,13 @@ public function testExecStreamOutputInMultipleChunksWhileRunning($container) public function testExecUserSpecificCommandWithOutputWhileRunning($container) { $promise = $this->client->execCreate($container, 'whoami', false, false, true, true, 'nobody'); - $exec = Block\await($promise, Loop::get()); + $exec = \React\Async\await($promise); $this->assertTrue(is_array($exec)); $this->assertTrue(is_string($exec['Id'])); $promise = $this->client->execStart($exec['Id']); - $output = Block\await($promise, Loop::get()); + $output = \React\Async\await($promise); $this->assertEquals('nobody', rtrim($output)); } @@ -246,13 +245,13 @@ public function testExecUserSpecificCommandWithOutputWhileRunning($container) public function testExecStringCommandWithStderrOutputWhileRunning($container) { $promise = $this->client->execCreate($container, 'echo -n hello world >&2'); - $exec = Block\await($promise, Loop::get()); + $exec = \React\Async\await($promise); $this->assertTrue(is_array($exec)); $this->assertTrue(is_string($exec['Id'])); $promise = $this->client->execStart($exec['Id']); - $output = Block\await($promise, Loop::get()); + $output = \React\Async\await($promise); $this->assertEquals('hello world', $output); } @@ -264,7 +263,7 @@ public function testExecStringCommandWithStderrOutputWhileRunning($container) public function testExecStreamCommandWithTtyAndStderrOutputWhileRunning($container) { $promise = $this->client->execCreate($container, 'echo -n hello world >&2', true); - $exec = Block\await($promise, Loop::get()); + $exec = \React\Async\await($promise); $this->assertTrue(is_array($exec)); $this->assertTrue(is_string($exec['Id'])); @@ -273,7 +272,7 @@ public function testExecStreamCommandWithTtyAndStderrOutputWhileRunning($contain $stream->once('data', $this->expectCallableOnce('hello world')); $stream->on('end', $this->expectCallableOnce()); - $output = Block\await(Stream\buffer($stream), Loop::get()); + $output = \React\Async\await(Stream\buffer($stream)); $this->assertEquals('hello world', $output); } @@ -285,7 +284,7 @@ public function testExecStreamCommandWithTtyAndStderrOutputWhileRunning($contain public function testExecStreamStderrCustomEventWhileRunning($container) { $promise = $this->client->execCreate($container, 'echo -n hello world >&2'); - $exec = Block\await($promise, Loop::get()); + $exec = \React\Async\await($promise); $this->assertTrue(is_array($exec)); $this->assertTrue(is_string($exec['Id'])); @@ -296,7 +295,7 @@ public function testExecStreamStderrCustomEventWhileRunning($container) $stream->on('error', $this->expectCallableNever()); $stream->on('end', $this->expectCallableOnce()); - $output = Block\await(Stream\buffer($stream), Loop::get()); + $output = \React\Async\await(Stream\buffer($stream)); $this->assertEquals('', $output); } @@ -308,7 +307,7 @@ public function testExecStreamStderrCustomEventWhileRunning($container) public function testExecStreamEmptyOutputWhileRunning($container) { $promise = $this->client->execCreate($container, array('true')); - $exec = Block\await($promise, Loop::get()); + $exec = \React\Async\await($promise); $this->assertTrue(is_array($exec)); $this->assertTrue(is_string($exec['Id'])); @@ -316,7 +315,7 @@ public function testExecStreamEmptyOutputWhileRunning($container) $stream = $this->client->execStartStream($exec['Id'], true); $stream->on('end', $this->expectCallableOnce()); - $output = Block\await(Stream\buffer($stream), Loop::get()); + $output = \React\Async\await(Stream\buffer($stream)); $this->assertEquals('', $output); } @@ -328,13 +327,13 @@ public function testExecStreamEmptyOutputWhileRunning($container) public function testExecDetachedWhileRunning($container) { $promise = $this->client->execCreate($container, array('sleep', '10')); - $exec = Block\await($promise, Loop::get()); + $exec = \React\Async\await($promise); $this->assertTrue(is_array($exec)); $this->assertTrue(is_string($exec['Id'])); $promise = $this->client->execStartDetached($exec['Id'], true); - $output = Block\await($promise, Loop::get()); + $output = \React\Async\await($promise); $this->assertEquals('', $output); } @@ -346,7 +345,7 @@ public function testExecDetachedWhileRunning($container) public function testRemoveRunning($container) { $promise = $this->client->containerRemove($container, true, true); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); $this->assertEquals('', $ret); } @@ -355,13 +354,13 @@ public function testContainerRemoveInvalid() { $promise = $this->client->containerRemove('invalid123'); $this->setExpectedException('RuntimeException'); - Block\await($promise, Loop::get()); + \React\Async\await($promise); } public function testImageSearch() { $promise = $this->client->imageSearch('clue'); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); $this->assertGreaterThan(9, count($ret)); } @@ -374,17 +373,17 @@ public function testImageTag() { // create new tag "bb:now" on "busybox:latest" $promise = $this->client->imageTag('busybox', 'bb', 'now'); - Block\await($promise, Loop::get()); + \React\Async\await($promise); // delete tag "bb:now" again $promise = $this->client->imageRemove('bb:now'); - Block\await($promise, Loop::get()); + \React\Async\await($promise); } public function testImageCreateStreamMissingWillEmitJsonError() { $promise = $this->client->version(); - $version = Block\await($promise, Loop::get()); + $version = \React\Async\await($promise); // old API reports a progress with error message, newer API just returns 404 right away // https://docs.docker.com/engine/api/version-history/ @@ -438,39 +437,39 @@ public function testCreateConnectDisconnectAndRemoveNetwork() $networkName = uniqid('reactphp-docker', true); $promise = $this->client->containerCreate($containerConfig); - $container = Block\await($promise, Loop::get()); + $container = \React\Async\await($promise); $start = microtime(true); $promise = $this->client->networkCreate($networkName); - $network = Block\await($promise, Loop::get()); + $network = \React\Async\await($promise); $this->assertNotNull($network['Id']); $this->assertEquals('', $network['Warning']); $promise = $this->client->networkConnect($network['Id'], $container['Id']); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); $this->assertEquals('', $ret); $promise = $this->client->networkDisconnect($network['Id'], $container['Id'], false); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); $this->assertEquals('', $ret); $promise = $this->client->networkRemove($network['Id']); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); $this->assertEquals('', $ret); $end = microtime(true); $promise = $this->client->containerRemove($container['Id']); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); // get all events between starting and removing for this container $promise = $this->client->events($start, $end, array('network' => array($network['Id']))); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); // expects "create", "disconnect", "destroy" events ("connect" will be skipped because we don't start the container) $this->assertCount(3, $ret); @@ -490,19 +489,19 @@ public function testCreateAndCommitContainer() ); $promise = $this->client->containerCreate($config); - $container = Block\await($promise, Loop::get()); + $container = \React\Async\await($promise); $this->assertNotNull($container['Id']); $this->assertEmpty($container['Warnings']); $promise = $this->client->containerCommit($container['Id']); - $image = Block\await($promise, Loop::get()); + $image = \React\Async\await($promise); $this->assertNotNull($image['Id']); $this->assertArrayNotHasKey('message', $image); $promise = $this->client->containerRemove($container['Id'], false, true); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); $this->assertEquals('', $ret); @@ -512,13 +511,13 @@ public function testCreateAndCommitContainer() ); $promise = $this->client->containerCreate($config); - $container = Block\await($promise, Loop::get()); + $container = \React\Async\await($promise); $this->assertNotNull($container['Id']); $this->assertEmpty($container['Warnings']); $promise = $this->client->containerRemove($container['Id'], false, true); - $ret = Block\await($promise, Loop::get()); + $ret = \React\Async\await($promise); $this->assertEquals('', $ret); } diff --git a/tests/IntegrationTest.php b/tests/IntegrationTest.php index b1f7b69..2ad9d10 100644 --- a/tests/IntegrationTest.php +++ b/tests/IntegrationTest.php @@ -34,7 +34,7 @@ public function testPingCtorWithExplicitUnixUrlSendsRequestToGivenUnixSocket() $client = new Client(null, 'unix://' . $path); $client->ping(); - $value = \Clue\React\Block\await($deferred->promise(), Loop::get(), 1.0); + $value = \React\Async\await(\React\Promise\Timer\timeout($deferred->promise(),1.0)); unlink($path); $this->assertEquals('/_ping', $value); @@ -44,8 +44,6 @@ public function testPingCtorWithExplicitUnixUrlSendsRequestToGivenUnixSocket() public function testPingCtorWithExplicitHttpUrlSendsRequestToGivenHttpUrlWithBase() { - $loop = Loop::get(); - $deferred = new Deferred(); $http = new \React\Http\HttpServer(function (ServerRequestInterface $request) use ($deferred) { $deferred->resolve($request->getRequestTarget()); @@ -57,7 +55,7 @@ public function testPingCtorWithExplicitHttpUrlSendsRequestToGivenHttpUrlWithBas $client = new Client(null, str_replace('tcp://', 'http://', $socket->getAddress()) . '/base/'); $client->ping(); - $value = \Clue\React\Block\await($deferred->promise(), $loop, 1.0); + $value = \React\Async\await(\React\Promise\Timer\timeout($deferred->promise(),1.0)); $this->assertEquals('/base/_ping', $value);