Remove deprecated $timeout argument

Author: clue

README.md

@@ -54,7 +54,7 @@ Async\await(…);
 
 ### await()
 
-The `await(PromiseInterface $promise, ?LoopInterface $loop = null, ?float $timeout = null): mixed` function can be used to
+The `await(PromiseInterface $promise, ?LoopInterface $loop = null): mixed` function can be used to
 block waiting for the given `$promise` to be fulfilled.
 
 ```php
@@ -89,17 +89,6 @@ use the [default loop](https://github.com/reactphp/event-loop#loop). This value
 SHOULD NOT be given unless you're sure you want to explicitly use a given event
 loop instance.
 
-If no `$timeout` argument is given and the promise stays pending, then this
-will potentially wait/block forever until the promise is settled. To avoid
-this, API authors creating promises are expected to provide means to
-configure a timeout for the promise instead. For more details, see also the
-[`timeout()` function](https://github.com/reactphp/promise-timer#timeout).
-
-If the deprecated `$timeout` argument is given and the promise is still pending once the
-timeout triggers, this will `cancel()` the promise and throw a `TimeoutException`.
-This implies that if you pass a really small (or negative) value, it will still
-start a timer and will thus trigger at the earliest possible time in the future.
-
 Note that this function will assume control over the event loop. Internally, it
 will actually `run()` the loop until the promise settles and then calls `stop()` to
 terminate execution of the loop. This means this function is more suited for

composer.json

@@ -28,8 +28,7 @@
     "require": {
         "php": ">=5.3.2",
         "react/event-loop": "^1.2",
-        "react/promise": "^2.8 || ^1.2.1",
-        "react/promise-timer": "^1.5"
+        "react/promise": "^2.8 || ^1.2.1"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.3 || ^5.7 || ^4.8.35"

src/functions.php

@@ -6,7 +6,6 @@
 use React\EventLoop\LoopInterface;
 use React\Promise\Deferred;
 use React\Promise\PromiseInterface;
-use React\Promise\Timer;
 
 /**
  * Block waiting for the given `$promise` to be fulfilled.
@@ -43,17 +42,6 @@
  * SHOULD NOT be given unless you're sure you want to explicitly use a given event
  * loop instance.
  *
- * If no `$timeout` argument is given and the promise stays pending, then this
- * will potentially wait/block forever until the promise is settled. To avoid
- * this, API authors creating promises are expected to provide means to
- * configure a timeout for the promise instead. For more details, see also the
- * [`timeout()` function](https://github.com/reactphp/promise-timer#timeout).
- *
- * If the deprecated `$timeout` argument is given and the promise is still pending once the
- * timeout triggers, this will `cancel()` the promise and throw a `TimeoutException`.
- * This implies that if you pass a really small (or negative) value, it will still
- * start a timer and will thus trigger at the earliest possible time in the future.
- *
  * Note that this function will assume control over the event loop. Internally, it
  * will actually `run()` the loop until the promise settles and then calls `stop()` to
  * terminate execution of the loop. This means this function is more suited for
@@ -63,23 +51,17 @@
  *
  * @param PromiseInterface $promise
  * @param ?LoopInterface   $loop
- * @param ?float           $timeout [deprecated] (optional) maximum timeout in seconds or null=wait forever
  * @return mixed returns whatever the promise resolves to
  * @throws \Exception when the promise is rejected
- * @throws \React\Promise\Timer\TimeoutException if the $timeout is given and triggers
  */
-function await(PromiseInterface $promise, LoopInterface $loop = null, $timeout = null)
+function await(PromiseInterface $promise, LoopInterface $loop = null)
 {
     $wait = true;
     $resolved = null;
     $exception = null;
     $rejected = false;
     $loop = $loop ?: Loop::get();
 
-    if ($timeout !== null) {
-        $promise = Timer\timeout($promise, $timeout, $loop);
-    }
-
     $promise->then(
         function ($c) use (&$resolved, &$wait, $loop) {
             $resolved = $c;

tests/AwaitTest.php

@@ -6,7 +6,6 @@
 use React\EventLoop\Loop;
 use React\Promise;
 use React\Promise\Deferred;
-use React\Promise\Timer\TimeoutException;
 
 class AwaitTest extends TestCase
 {
@@ -93,40 +92,6 @@ public function testAwaitOneInterrupted()
         $this->assertEquals(2, React\Async\await($promise, $this->loop));
     }
 
-    public function testAwaitOncePendingWillThrowOnTimeout()
-    {
-        $promise = new Promise\Promise(function () { });
-
-        $this->setExpectedException('React\Promise\Timer\TimeoutException');
-        React\Async\await($promise, $this->loop, 0.001);
-    }
-
-    public function testAwaitOncePendingWillThrowAndCallCancellerOnTimeout()
-    {
-        $cancelled = false;
-        $promise = new Promise\Promise(function () { }, function () use (&$cancelled) {
-            $cancelled = true;
-        });
-
-        try {
-            React\Async\await($promise, $this->loop, 0.001);
-        } catch (TimeoutException $expected) {
-            $this->assertTrue($cancelled);
-        }
-    }
-
-    public function testAwaitOnceWithTimeoutWillResolvemmediatelyAndCleanUpTimeout()
-    {
-        $promise = Promise\resolve(true);
-
-        $time = microtime(true);
-        React\Async\await($promise, $this->loop, 5.0);
-        $this->loop->run();
-        $time = microtime(true) - $time;
-
-        $this->assertLessThan(0.1, $time);
-    }
-
     public function testAwaitOneResolvesShouldNotCreateAnyGarbageReferences()
     {
         if (class_exists('React\Promise\When') && PHP_VERSION_ID >= 50400) {
@@ -161,25 +126,6 @@ public function testAwaitOneRejectedShouldNotCreateAnyGarbageReferences()
         $this->assertEquals(0, gc_collect_cycles());
     }
 
-    public function testAwaitOneRejectedWithTimeoutShouldNotCreateAnyGarbageReferences()
-    {
-        if (class_exists('React\Promise\When') && PHP_VERSION_ID >= 50400) {
-            $this->markTestSkipped('Not supported on legacy Promise v1 API with PHP 5.4+');
-        }
-
-        gc_collect_cycles();
-
-        $promise = Promise\reject(new \RuntimeException());
-        try {
-            React\Async\await($promise, $this->loop, 0.001);
-        } catch (\Exception $e) {
-            // no-op
-        }
-        unset($promise, $e);
-
-        $this->assertEquals(0, gc_collect_cycles());
-    }
-
     public function testAwaitNullValueShouldNotCreateAnyGarbageReferences()
     {
         if (!interface_exists('React\Promise\CancellablePromiseInterface')) {
@@ -203,68 +149,6 @@ public function testAwaitNullValueShouldNotCreateAnyGarbageReferences()
         $this->assertEquals(0, gc_collect_cycles());
     }
 
-    /**
-     * @requires PHP 7
-     */
-    public function testAwaitPendingPromiseWithTimeoutAndCancellerShouldNotCreateAnyGarbageReferences()
-    {
-        if (class_exists('React\Promise\When')) {
-            $this->markTestSkipped('Not supported on legacy Promise v1 API');
-        }
-
-        gc_collect_cycles();
-
-        $promise = new \React\Promise\Promise(function () { }, function () {
-            throw new \RuntimeException();
-        });
-        try {
-            React\Async\await($promise, $this->loop, 0.001);
-        } catch (\Exception $e) {
-            // no-op
-        }
-        unset($promise, $e);
-
-        $this->assertEquals(0, gc_collect_cycles());
-    }
-
-    /**
-     * @requires PHP 7
-     */
-    public function testAwaitPendingPromiseWithTimeoutAndWithoutCancellerShouldNotCreateAnyGarbageReferences()
-    {
-        gc_collect_cycles();
-
-        $promise = new \React\Promise\Promise(function () { });
-        try {
-            React\Async\await($promise, $this->loop, 0.001);
-        } catch (\Exception $e) {
-            // no-op
-        }
-        unset($promise, $e);
-
-        $this->assertEquals(0, gc_collect_cycles());
-    }
-
-    /**
-     * @requires PHP 7
-     */
-    public function testAwaitPendingPromiseWithTimeoutAndNoOpCancellerShouldNotCreateAnyGarbageReferences()
-    {
-        gc_collect_cycles();
-
-        $promise = new \React\Promise\Promise(function () { }, function () {
-            // no-op
-        });
-        try {
-            React\Async\await($promise, $this->loop, 0.001);
-        } catch (\Exception $e) {
-            // no-op
-        }
-        unset($promise, $e);
-
-        $this->assertEquals(0, gc_collect_cycles());
-    }
-
     protected function createPromiseResolved($value = null, $delay = 0.01)
     {
         $deferred = new Deferred();