Use Promise v3 template types

SimonFrings · SimonFrings · commit 1400c281bb06 · 2024-05-17T12:23:41.000+02:00
diff --git a/src/functions.php b/src/functions.php
@@ -191,6 +191,7 @@ function async(callable $function): callable
 {
     return static function (mixed ...$args) use ($function): PromiseInterface {
         $fiber = null;
+        /** @var PromiseInterface<T> $promise*/
         $promise = new Promise(function (callable $resolve, callable $reject) use ($function, $args, &$fiber): void {
             $fiber = new \Fiber(function () use ($resolve, $reject, $function, $args, &$fiber): void {
                 try {
@@ -627,6 +628,7 @@ function coroutine(callable $function, mixed ...$args): PromiseInterface
     }
 
     $promise = null;
+    /** @var Deferred<T> $deferred*/
     $deferred = new Deferred(function () use (&$promise) {
         /** @var ?PromiseInterface<T> $promise */
         if ($promise instanceof PromiseInterface && \method_exists($promise, 'cancel')) {
@@ -734,6 +736,7 @@ function parallel(iterable $tasks): PromiseInterface
         $deferred->resolve($results);
     }
 
+    /** @var PromiseInterface<array<T>> Can't define `Deferred()` above, currently not supported by PHPStan, see https://github.com/phpstan/phpstan/issues/11032 */
     return $deferred->promise();
 }
 
@@ -789,6 +792,7 @@ function series(iterable $tasks): PromiseInterface
 
     $next();
 
+    /** @var PromiseInterface<array<T>> Can't define `Deferred()` above, currently not supported by PHPStan, see https://github.com/phpstan/phpstan/issues/11032 */
     return $deferred->promise();
 }
 
@@ -800,6 +804,7 @@ function series(iterable $tasks): PromiseInterface
 function waterfall(iterable $tasks): PromiseInterface
 {
     $pending = null;
+    /** @var Deferred<T> $deferred*/
     $deferred = new Deferred(function () use (&$pending) {
         /** @var ?PromiseInterface<T> $pending */
         if ($pending instanceof PromiseInterface && \method_exists($pending, 'cancel')) {
diff --git a/tests/AwaitTest.php b/tests/AwaitTest.php
@@ -129,7 +129,7 @@ public function testAwaitThrowsUnexpectedValueExceptionWhenPromiseIsRejectedWith
         }
 
         $promise = new Promise(function ($_, $reject) {
-            $reject(false);
+            $reject(false); // @phpstan-ignore-line
         });
 
         $this->expectException(\UnexpectedValueException::class);
@@ -147,7 +147,7 @@ public function testAwaitThrowsUnexpectedValueExceptionWhenPromiseIsRejectedWith
         }
 
         $promise = new Promise(function ($_, $reject) {
-            $reject(null);
+            $reject(null); // @phpstan-ignore-line
         });
 
         try {
@@ -331,7 +331,7 @@ public function testAwaitShouldNotCreateAnyGarbageReferencesForPromiseRejectedWi
         gc_collect_cycles();
 
         $promise = new Promise(function ($_, $reject) {
-            $reject(null);
+            $reject(null); // @phpstan-ignore-line
         });
         try {
             $await($promise);

Original file line number	Diff line number	Diff line change
`@@ -191,6 +191,7 @@ function async(callable $function): callable`
`191`	`191`	`{`
`192`	`192`	`return static function (mixed ...$args) use ($function): PromiseInterface {`
`193`	`193`	`$fiber = null;`
	`194`	`+ /** @var PromiseInterface<T> $promise*/`
`194`	`195`	`$promise = new Promise(function (callable $resolve, callable $reject) use ($function, $args, &$fiber): void {`
`195`	`196`	`$fiber = new \Fiber(function () use ($resolve, $reject, $function, $args, &$fiber): void {`
`196`	`197`	`try {`
`@@ -627,6 +628,7 @@ function coroutine(callable $function, mixed ...$args): PromiseInterface`
`627`	`628`	`}`
`628`	`629`
`629`	`630`	`$promise = null;`
	`631`	`+ /** @var Deferred<T> $deferred*/`
`630`	`632`	`$deferred = new Deferred(function () use (&$promise) {`
`631`	`633`	`/** @var ?PromiseInterface<T> $promise */`
`632`	`634`	`if ($promise instanceof PromiseInterface && \method_exists($promise, 'cancel')) {`
`@@ -734,6 +736,7 @@ function parallel(iterable $tasks): PromiseInterface`
`734`	`736`	`$deferred->resolve($results);`
`735`	`737`	`}`
`736`	`738`
	`739`	+ /** @var PromiseInterface<array<T>> Can't define `Deferred()` above, currently not supported by PHPStan, see https://github.com/phpstan/phpstan/issues/11032 */
`737`	`740`	`return $deferred->promise();`
`738`	`741`	`}`
`739`	`742`
`@@ -789,6 +792,7 @@ function series(iterable $tasks): PromiseInterface`
`789`	`792`
`790`	`793`	`$next();`
`791`	`794`
	`795`	+ /** @var PromiseInterface<array<T>> Can't define `Deferred()` above, currently not supported by PHPStan, see https://github.com/phpstan/phpstan/issues/11032 */
`792`	`796`	`return $deferred->promise();`
`793`	`797`	`}`
`794`	`798`
`@@ -800,6 +804,7 @@ function series(iterable $tasks): PromiseInterface`
`800`	`804`	`function waterfall(iterable $tasks): PromiseInterface`
`801`	`805`	`{`
`802`	`806`	`$pending = null;`
	`807`	`+ /** @var Deferred<T> $deferred*/`
`803`	`808`	`$deferred = new Deferred(function () use (&$pending) {`
`804`	`809`	`/** @var ?PromiseInterface<T> $pending */`
`805`	`810`	`if ($pending instanceof PromiseInterface && \method_exists($pending, 'cancel')) {`