[3.x] Add template annotations

Adds template annotations turning the `PromiseInterface` into a generic. Variables `$p1` and `$p2` in the following code example both are `PromiseInterface<int|string>`. ```php $f = function (): int|string { return time() % 2 ? 'string' : time(); }; /** * @return PromiseInterface<int|string> */ $fp = function (): PromiseInterface { return resolve(time() % 2 ? 'string' : time()); }; $p1 = resolve($f()); $p2 = $fp(); ``` When calling `then` on `$p1` or `$p2`, PHPStan understand that function `$f1` is type hinting its parameter fine, but `$f2` will throw during runtime: ```php $p2->then(static function (int|string $a) {}); $p2->then(static function (bool $a) {}); ``` Builds on top of reactphp#246 and reactphp#188 and is a requirement for reactphp/async#40
WyriHaximus-secret-labs · Jul 8, 2023 · 1dc9cd3 · 1dc9cd3
1 parent d87b562
commit 1dc9cd3
Show file tree

Hide file tree

Showing 32 changed files with 308 additions and 43 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,6 +1,7 @@
 /.gitattributes export-ignore
 /.github/ export-ignore
 /.gitignore export-ignore
+/phpstan.legacy.neon.dist export-ignore
 /phpstan.neon.dist export-ignore
 /phpunit.xml.dist export-ignore
 /phpunit.xml.legacy export-ignore

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -35,6 +35,7 @@ jobs:
     name: PHPStan (PHP ${{ matrix.php }})
     runs-on: ubuntu-22.04
     strategy:
+      fail-fast: false
       matrix:
         php:
           - 8.2
@@ -52,3 +53,6 @@ jobs:
           coverage: none
       - run: composer install
       - run: vendor/bin/phpstan
+        if: ${{ matrix.php >= 7.2 }}
+      - run: vendor/bin/phpstan --configuration="phpstan.legacy.neon.dist"
+        if: ${{ matrix.php < 7.2 }}
diff --git a/phpstan.legacy.neon.dist b/phpstan.legacy.neon.dist
@@ -0,0 +1,7 @@
+parameters:
+	ignoreErrors:
+		- '#Template type T is declared as covariant, but occurs in contravariant position in parameter result of method React\\Promise\\Promise::settle\(\).#'
+		- '#Template type T is declared as covariant, but occurs in contravariant position in parameter promise of method React\\Promise\\Promise::unwrap\(\).#'
+
+includes:
+	- phpstan.neon.dist
diff --git a/src/Deferred.php b/src/Deferred.php
@@ -2,9 +2,14 @@
 
 namespace React\Promise;
 
+/**
+ * @template T
+ */
 final class Deferred
 {
-    /** @var Promise */
+    /**
+     * @var PromiseInterface<T>
+     */
     private $promise;
 
     /** @var callable */
@@ -21,13 +26,16 @@ public function __construct(callable $canceller = null)
         }, $canceller);
     }
 
+    /**
+     * @return PromiseInterface<T>
+     */
     public function promise(): PromiseInterface
     {
         return $this->promise;
     }
 
     /**
-     * @param mixed $value
+     * @param T $value
      */
     public function resolve($value): void
     {

diff --git a/src/Internal/FulfilledPromise.php b/src/Internal/FulfilledPromise.php
@@ -7,14 +7,17 @@
 
 /**
  * @internal
+ *
+ * @template-implements PromiseInterface<T>
+ * @template-covariant T
  */
 final class FulfilledPromise implements PromiseInterface
 {
-    /** @var mixed */
+    /** @var T */
     private $value;
 
     /**
-     * @param mixed $value
+     * @param T $value
      * @throws \InvalidArgumentException
      */
     public function __construct($value = null)
@@ -33,7 +36,11 @@ public function then(callable $onFulfilled = null, callable $onRejected = null):
         }
 
         try {
-            return resolve($onFulfilled($this->value));
+            /**
+             * @var PromiseInterface<T>|T $result
+             */
+            $result = $onFulfilled($this->value);
+            return resolve($result);
         } catch (\Throwable $exception) {
             return new RejectedPromise($exception);
         }

diff --git a/src/Internal/RejectedPromise.php b/src/Internal/RejectedPromise.php
@@ -8,6 +8,9 @@
 
 /**
  * @internal
+ *
+ * @template-implements PromiseInterface<never>
+ * @template-covariant T
  */
 final class RejectedPromise implements PromiseInterface
 {

diff --git a/src/Promise.php b/src/Promise.php
@@ -4,12 +4,16 @@
 
 use React\Promise\Internal\RejectedPromise;
 
+/**
+ * @template-implements PromiseInterface<T>
+ * @template-covariant T
+ */
 final class Promise implements PromiseInterface
 {
     /** @var ?callable */
     private $canceller;
 
-    /** @var ?PromiseInterface */
+    /** @var ?PromiseInterface<T> */
     private $result;
 
     /** @var callable[] */
@@ -80,11 +84,11 @@ public function catch(callable $onRejected): PromiseInterface
     public function finally(callable $onFulfilledOrRejected): PromiseInterface
     {
         return $this->then(static function ($value) use ($onFulfilledOrRejected) {
-            return resolve($onFulfilledOrRejected())->then(function () use ($value) {
+            return resolve($onFulfilledOrRejected())->then(static function () use ($value) {
                 return $value;
             });
         }, static function ($reason) use ($onFulfilledOrRejected) {
-            return resolve($onFulfilledOrRejected())->then(function () use ($reason) {
+            return resolve($onFulfilledOrRejected())->then(static function () use ($reason) {
                 return new RejectedPromise($reason);
             });
         });
@@ -175,6 +179,10 @@ private function reject(\Throwable $reason): void
         $this->settle(reject($reason));
     }
 
+    /**
+     * Test out if null can be promise
+     * @param PromiseInterface<T>|PromiseInterface<never> $result
+     */
     private function settle(PromiseInterface $result): void
     {
         $result = $this->unwrap($result);
@@ -207,13 +215,17 @@ private function settle(PromiseInterface $result): void
         }
     }
 
+    /**
+     * @param PromiseInterface<T>|PromiseInterface<never> $promise
+     * @return PromiseInterface<T>
+     */
     private function unwrap(PromiseInterface $promise): PromiseInterface
     {
         while ($promise instanceof self && null !== $promise->result) {
             $promise = $promise->result;
         }
 
-        return $promise;
+        return $promise; /** @phpstan-ignore-line */
     }
 
     private function call(callable $cb): void

diff --git a/src/PromiseInterface.php b/src/PromiseInterface.php
@@ -2,6 +2,9 @@
 
 namespace React\Promise;
 
+/**
+ * @template-covariant T
+ */
 interface PromiseInterface
 {
     /**
@@ -28,9 +31,9 @@ interface PromiseInterface
      *  2. `$onFulfilled` and `$onRejected` will never be called more
      *      than once.
      *
-     * @param callable|null $onFulfilled
-     * @param callable|null $onRejected
-     * @return PromiseInterface
+     * @template Fulfilled as PromiseInterface<T>|T
+     * @param ?(callable(T): (Fulfilled|void)) $onFulfilled
+     * @return PromiseInterface<T>
      */
     public function then(?callable $onFulfilled = null, ?callable $onRejected = null): PromiseInterface;
 
@@ -44,8 +47,7 @@ public function then(?callable $onFulfilled = null, ?callable $onRejected = null
      * Additionally, you can type hint the `$reason` argument of `$onRejected` to catch
      * only specific errors.
      *
-     * @param callable $onRejected
-     * @return PromiseInterface
+     * @return PromiseInterface<T>
      */
     public function catch(callable $onRejected): PromiseInterface;
 
@@ -91,8 +93,8 @@ public function catch(callable $onRejected): PromiseInterface;
      *     ->finally('cleanup');
      * ```
      *
-     * @param callable $onFulfilledOrRejected
-     * @return PromiseInterface
+     * @param callable(): (mixed|void) $onFulfilledOrRejected
+     * @return PromiseInterface<T>
      */
     public function finally(callable $onFulfilledOrRejected): PromiseInterface;
 
@@ -118,7 +120,7 @@ public function cancel(): void;
      * ```
      *
      * @param callable $onRejected
-     * @return PromiseInterface
+     * @return PromiseInterface<T>
      * @deprecated 3.0.0 Use catch() instead
      * @see self::catch()
      */
@@ -135,7 +137,7 @@ public function otherwise(callable $onRejected): PromiseInterface;
      * ```
      *
      * @param callable $onFulfilledOrRejected
-     * @return PromiseInterface
+     * @return PromiseInterface<T>
      * @deprecated 3.0.0 Use finally() instead
      * @see self::finally()
      */

diff --git a/src/functions.php b/src/functions.php
@@ -17,8 +17,9 @@
  *
  * If `$promiseOrValue` is a promise, it will be returned as is.
  *
- * @param mixed $promiseOrValue
- * @return PromiseInterface
+ * @template T
+ * @param PromiseInterface<T>|T $promiseOrValue
+ * @return PromiseInterface<T>
  */
 function resolve($promiseOrValue): PromiseInterface
 {
@@ -30,6 +31,7 @@ function resolve($promiseOrValue): PromiseInterface
         $canceller = null;
 
         if (\method_exists($promiseOrValue, 'cancel')) {
+            /** @var callable $canceller */
             $canceller = [$promiseOrValue, 'cancel'];
         }
 
@@ -54,8 +56,7 @@ function resolve($promiseOrValue): PromiseInterface
  * throwing an exception. For example, it allows you to propagate a rejection with
  * the value of another promise.
  *
- * @param \Throwable $reason
- * @return PromiseInterface
+ * @return PromiseInterface<never>
  */
 function reject(\Throwable $reason): PromiseInterface
 {
@@ -68,8 +69,9 @@ function reject(\Throwable $reason): PromiseInterface
  * will be an array containing the resolution values of each of the items in
  * `$promisesOrValues`.
  *
- * @param iterable<mixed> $promisesOrValues
- * @return PromiseInterface
+ * @template T
+ * @param iterable<PromiseInterface<T>|T> $promisesOrValues
+ * @return PromiseInterface<array<T>>
  */
 function all(iterable $promisesOrValues): PromiseInterface
 {
@@ -86,7 +88,11 @@ function all(iterable $promisesOrValues): PromiseInterface
             $values[$i] = null;
             ++$toResolve;
 
-            resolve($promiseOrValue)->then(
+            /**
+             * @var PromiseInterface<T> $p
+             */
+            $p = resolve($promiseOrValue);
+            $p->then(
                 function ($value) use ($i, &$values, &$toResolve, &$continue, $resolve): void {
                     $values[$i] = $value;
 
@@ -119,8 +125,9 @@ function (\Throwable $reason) use (&$continue, $reject): void {
  * The returned promise will become **infinitely pending** if  `$promisesOrValues`
  * contains 0 items.
  *
- * @param iterable<mixed> $promisesOrValues
- * @return PromiseInterface
+ * @template T
+ * @param iterable<PromiseInterface<T>|T> $promisesOrValues
+ * @return PromiseInterface<T>
  */
 function race(iterable $promisesOrValues): PromiseInterface
 {
@@ -154,8 +161,9 @@ function race(iterable $promisesOrValues): PromiseInterface
  * The returned promise will also reject with a `React\Promise\Exception\LengthException`
  * if `$promisesOrValues` contains 0 items.
  *
- * @param iterable<mixed> $promisesOrValues
- * @return PromiseInterface
+ * @template T
+ * @param iterable<PromiseInterface<T>|T> $promisesOrValues
+ * @return PromiseInterface<T>
  */
 function any(iterable $promisesOrValues): PromiseInterface
 {
@@ -170,7 +178,11 @@ function any(iterable $promisesOrValues): PromiseInterface
             $cancellationQueue->enqueue($promiseOrValue);
             ++$toReject;
 
-            resolve($promiseOrValue)->then(
+            /**
+             * @var PromiseInterface<T> $p
+             */
+            $p = resolve($promiseOrValue);
+            $p->then(
                 function ($value) use ($resolve, &$continue): void {
                     $continue = false;
                     $resolve($value);

diff --git a/tests/DeferredTest.php b/tests/DeferredTest.php
@@ -54,7 +54,6 @@ public function shouldRejectWithoutCreatingGarbageCyclesIfCancellerHoldsReferenc
         gc_collect_cycles();
         gc_collect_cycles(); // clear twice to avoid leftovers in PHP 7.4 with ext-xdebug and code coverage turned on
 
-        /** @var Deferred $deferred */
         $deferred = new Deferred(function () use (&$deferred) {
             assert($deferred instanceof Deferred);
         });

diff --git a/tests/FunctionAnyTest.php b/tests/FunctionAnyTest.php
@@ -52,6 +52,7 @@ public function shouldResolveWithAnInputValue(): void
             ->expects(self::once())
             ->method('__invoke')
             ->with(self::identicalTo(1));
+        assert(is_callable($mock));
 
         any([1, 2, 3])
             ->then($mock);

diff --git a/tests/FunctionResolveTestThenShouldNotReportUnhandled.phpt b/tests/FunctionResolveTestThenShouldNotReportUnhandled.phpt
@@ -10,7 +10,9 @@ use function React\Promise\resolve;
 
 require __DIR__ . '/../vendor/autoload.php';
 
-resolve(42)->then('var_dump');
+/** @var callable $callable */
+$callable = 'var_dump';
+resolve(42)->then($callable);
 
 ?>
 --EXPECT--

diff --git a/tests/Internal/CancellationQueueTest.php b/tests/Internal/CancellationQueueTest.php
@@ -96,6 +96,9 @@ public function rethrowsExceptionsThrownFromCancel(): void
         $cancellationQueue();
     }
 
+    /**
+     * @return Deferred<never>
+     */
     private function getCancellableDeferred(): Deferred
     {
         return new Deferred($this->expectCallableOnce());

diff --git a/tests/Internal/FulfilledPromiseTest.php b/tests/Internal/FulfilledPromiseTest.php
@@ -9,14 +9,17 @@
 use React\Promise\PromiseTest\PromiseSettledTestTrait;
 use React\Promise\TestCase;
 
+/**
+ * @template T
+ */
 class FulfilledPromiseTest extends TestCase
 {
     use PromiseSettledTestTrait,
         PromiseFulfilledTestTrait;
 
     public function getPromiseTestAdapter(callable $canceller = null): CallbackPromiseAdapter
     {
-        /** @var ?FulfilledPromise */
+        /** @var ?FulfilledPromise<T> */
         $promise = null;
 
         return new CallbackPromiseAdapter([

diff --git a/tests/Internal/RejectedPromiseTest.php b/tests/Internal/RejectedPromiseTest.php
@@ -9,14 +9,17 @@
 use React\Promise\PromiseTest\PromiseSettledTestTrait;
 use React\Promise\TestCase;
 
+/**
+ * @template T
+ */
 class RejectedPromiseTest extends TestCase
 {
     use PromiseSettledTestTrait,
         PromiseRejectedTestTrait;
 
     public function getPromiseTestAdapter(callable $canceller = null): CallbackPromiseAdapter
     {
-        /** @var ?RejectedPromise */
+        /** @var ?RejectedPromise<never> */
         $promise = null;
 
         return new CallbackPromiseAdapter([