🚧 Validate some PHPStan

darkwood-com · Aug 13, 2024 · 5f1eb06 · 5f1eb06
1 parent 7285f6c
commit 5f1eb06
Show file tree

Hide file tree

Showing 15 changed files with 63 additions and 34 deletions.
diff --git a/examples/flow.php b/examples/flow.php
@@ -18,7 +18,7 @@
 use Flow\Ip;
 use Flow\IpStrategy\MaxIpStrategy;
 
-$driver = match (random_int(4, 4)) {
+$driver = match (random_int(1, 4)) {
     1 => new AmpDriver(),
     2 => new FiberDriver(),
     3 => new ReactDriver(),

diff --git a/src/AsyncHandler/AsyncHandler.php b/src/AsyncHandler/AsyncHandler.php
@@ -8,6 +8,11 @@
 use Flow\Event;
 use Flow\Event\AsyncEvent;
 
+/**
+ * @template T
+ *
+ * @implements AsyncHandlerInterface<T>
+ */
 final class AsyncHandler implements AsyncHandlerInterface
 {
     public static function getSubscribedEvents()

diff --git a/src/AsyncHandler/BatchAsyncHandler.php b/src/AsyncHandler/BatchAsyncHandler.php
@@ -12,12 +12,24 @@
 use Symfony\Component\Messenger\Handler\BatchHandlerTrait;
 use Throwable;
 
+/**
+ * @template T1
+ * @template T2
+ *
+ * @implements AsyncHandlerInterface<T1>
+ */
 final class BatchAsyncHandler implements BatchHandlerInterface, AsyncHandlerInterface
 {
     use BatchHandlerTrait;
 
+    /**
+     * @var AsyncHandlerInterface<T2>
+     */
     private AsyncHandlerInterface $asyncHandler;
 
+    /**
+     * @param null|AsyncHandlerInterface<T2> $asyncHandler
+     */
     public function __construct(
         private int $batchSize = 10,
         ?AsyncHandlerInterface $asyncHandler = null,
@@ -46,7 +58,7 @@ public function async(AsyncEvent $event): void
      * https://github.com/phpstan/phpstan/issues/6039
      * https://phpstan.org/r/8f7de023-9888-4dcb-b12c-e2fcf9547b6c.
      *
-     * @param array{0: AsyncEvent, 1: Acknowledger}[] $jobs
+     * @param array{0: AsyncEvent<T1>, 1: Acknowledger}[] $jobs
      *
      * @phpstan-ignore method.unused
      */

diff --git a/src/AsyncHandler/DeferAsyncHandler.php b/src/AsyncHandler/DeferAsyncHandler.php
@@ -8,6 +8,11 @@
 use Flow\Event;
 use Flow\Event\AsyncEvent;
 
+/**
+ * @template T
+ *
+ * @implements AsyncHandlerInterface<T>
+ */
 final class DeferAsyncHandler implements AsyncHandlerInterface
 {
     public static function getSubscribedEvents()

diff --git a/src/AsyncHandlerInterface.php b/src/AsyncHandlerInterface.php
@@ -7,7 +7,13 @@
 use Flow\Event\AsyncEvent;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
+/**
+ * @template T
+ */
 interface AsyncHandlerInterface extends EventSubscriberInterface
 {
+    /**
+     * @param AsyncEvent<T> $event
+     */
     public function async(AsyncEvent $event): void;
 }
diff --git a/src/Driver/AmpDriver.php b/src/Driver/AmpDriver.php
@@ -46,6 +46,9 @@ public function __construct(?Driver $driver = null)
         }
     }
 
+    /**
+     * @return Closure(TArgs): Future<TReturn>
+     */
     public function async(Closure $callback): Closure
     {
         return static function (...$args) use ($callback) {
@@ -59,6 +62,9 @@ public function async(Closure $callback): Closure
         };
     }
 
+    /**
+     * @return Future<TReturn>
+     */
     public function defer(Closure $callback): Future
     {
         $deferred = new DeferredFuture();
@@ -84,20 +90,18 @@ public function await(array &$stream): void
             return function (mixed $data) use ($job) {
                 $async = $this->async($job);
 
-                if ($data === null) {
-                    $future = $async();
-                } else {
-                    $future = $async($data);
-                }
+                $future = $async($data);
 
-                return static function ($map) use ($future) {
+                return static function (Closure $map) use ($future) {
+                    /** @var Closure(TReturn): mixed $map */
                     $future->map($map);
                 };
             };
         };
 
         $defer = function (Closure $job) {
-            return function ($map) use ($job) {
+            return function (Closure $map) use ($job) {
+                /** @var Closure(TReturn): mixed $map */
                 $future = $this->defer($job);
                 $future->map($map);
             };
@@ -143,7 +147,7 @@ public function delay(float $seconds): void
         delay($seconds);
     }
 
-    public function tick($interval, Closure $callback): Closure
+    public function tick(float $interval, Closure $callback): Closure
     {
         $this->ticks++;
         $tickId = EventLoop::repeat($interval, $callback);

diff --git a/src/Driver/FiberDriver.php b/src/Driver/FiberDriver.php
@@ -54,11 +54,7 @@ public function await(array &$stream): void
                     $exception = null;
 
                     try {
-                        if ($data === null) {
-                            $fiber->start();
-                        } else {
-                            $fiber->start($data);
-                        }
+                        $fiber->start($data);
                     } catch (Throwable $fiberException) {
                         $exception = $fiberException;
                     }

diff --git a/src/Driver/ReactDriver.php b/src/Driver/ReactDriver.php
@@ -59,6 +59,9 @@ public function async(Closure $callback): Closure
         };
     }
 
+    /**
+     * @return Promise<TReturn>
+     */
     public function defer(Closure $callback): Promise
     {
         $deferred = new Deferred();
@@ -82,11 +85,7 @@ public function await(array &$stream): void
             return function (mixed $data) use ($job) {
                 $async = $this->async($job);
 
-                if ($data === null) {
-                    $promise = $async();
-                } else {
-                    $promise = $async($data);
-                }
+                $promise = $async($data);
 
                 return static function ($then) use ($promise) {
                     $promise->then($then);

diff --git a/src/Driver/SpatieDriver.php b/src/Driver/SpatieDriver.php
@@ -71,13 +71,7 @@ public function await(array &$stream): void
             return function (mixed $data) use ($job) {
                 $async = $this->async($job);
 
-                if ($data === null) {
-                    $fn = $async();
-                } else {
-                    $fn = $async($data);
-                }
-
-                return $fn;
+                return $async($data);
             };
         };
 

diff --git a/src/Driver/SwooleDriver.php b/src/Driver/SwooleDriver.php
@@ -65,13 +65,7 @@ public function await(array &$stream): void
             return function (mixed $data) use ($job) {
                 $async = $this->async($job);
 
-                if ($data === null) {
-                    $fn = $async();
-                } else {
-                    $fn = $async($data);
-                }
-
-                return $fn;
+                return $async($data);
             };
         };
 

diff --git a/src/DriverInterface.php b/src/DriverInterface.php
@@ -24,6 +24,8 @@ public function async(Closure $callback): Closure;
      * $callback will be given two callbacks
      * - an complete callback to store result
      * - an async callback to go to the next async call.
+     *
+     * @param Closure(callable(TReturn): void, callable(mixed, callable): void): void $callback
      */
     public function defer(Closure $callback): mixed;
 

diff --git a/src/Event/AsyncEvent.php b/src/Event/AsyncEvent.php
@@ -8,8 +8,14 @@
 use Flow\Ip;
 use Symfony\Contracts\EventDispatcher\Event;
 
+/**
+ * @template T
+ */
 final class AsyncEvent extends Event
 {
+    /**
+     * @param Ip<T> $ip
+     */
     public function __construct(
         private Closure $async,
         private Closure $defer,
@@ -33,6 +39,9 @@ public function getJob(): Closure
         return $this->job;
     }
 
+    /**
+     * @return Ip<T>
+     */
     public function getIp(): Ip
     {
         return $this->ip;

diff --git a/src/Flow/Flow.php b/src/Flow/Flow.php
@@ -62,6 +62,7 @@ class Flow implements FlowInterface
      * @param Closure(T1): T2                   $job
      * @param Closure(ExceptionInterface): void $errorJob
      * @param null|IpStrategyInterface<T1>      $ipStrategy
+     * @param null|AsyncHandlerInterface<T1>    $asyncHandler
      * @param null|DriverInterface<T1,T2>       $driver
      */
     public function __construct(

diff --git a/src/Flow/YFlow.php b/src/Flow/YFlow.php
@@ -22,6 +22,7 @@ class YFlow extends Flow
     /**
      * @param null|Closure(ExceptionInterface): void $errorJob
      * @param null|IpStrategyInterface<T1>           $ipStrategy
+     * @param null|AsyncHandlerInterface<T1>         $asyncHandler
      * @param null|DriverInterface<T1,T2>            $driver
      */
     public function __construct(

diff --git a/tools/php-cs-fixer/.php-cs-fixer.php b/tools/php-cs-fixer/.php-cs-fixer.php
@@ -26,6 +26,7 @@
         'php_unit_internal_class' => false, // From @PhpCsFixer but we don't want it
         'php_unit_test_class_requires_covers' => false, // From @PhpCsFixer but we don't want it
         'phpdoc_add_missing_param_annotation' => false, // From @PhpCsFixer but we don't want it
+        'phpdoc_to_comment' => false, // We want PHPStan keep pass with anotation line comments
         'concat_space' => ['spacing' => 'one'],
         'ordered_class_elements' => true, // Symfony(PSR12) override the default value, but we don't want
         'blank_line_before_statement' => true, // Symfony(PSR12) override the default value, but we don't want