[WIP][3.x] Introduce PHPStan

.github/workflows/ci.yml

@@ -120,3 +120,36 @@ jobs:
         uses: docker://hhvm/hhvm:3.30-lts-latest
         with:
           args: hhvm vendor/bin/phpunit
+
+  PHPStan:
+    name: PHPStan (PHP ${{ matrix.php }})
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        php:
+          - 8.3
+          - 8.2
+          - 8.1
+          - 8.0
+          - 7.4
+          - 7.3
+          - 7.2
+          - 7.1
+    steps:
+      - uses: actions/checkout@v4
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: none
+          ini-file: development
+          ini-values: disable_functions='' # do not disable PCNTL functions on PHP < 8.1
+          extensions: sockets, pcntl ${{ matrix.php >= 5.6 && ', event' || '' }} ${{ matrix.php >= 5.4 && ', ev' || '' }}
+        env:
+          fail-fast: true # fail step if any extension can not be installed
+      - name: Install ext-uv on PHP 7+
+        run: |
+          sudo apt-get update -q && sudo apt-get install libuv1-dev
+          echo "yes" | sudo pecl install ${{ matrix.php >= 8.0 && 'uv-0.3.0' || 'uv-0.2.4' }}
+          php -m | grep -q uv || echo "extension=uv.so" >> "$(php -r 'echo php_ini_loaded_file();')"
+      - run: composer install
+      - run: vendor/bin/phpstan

composer.json

@@ -29,6 +29,7 @@
         "php": ">=5.3.0"
     },
     "require-dev": {
+        "phpstan/phpstan": "^1",
         "phpunit/phpunit": "^9.6 || ^5.7 || ^4.8.36"
     },
     "suggest": {

phpstan.neon.dist

@@ -0,0 +1,10 @@
+parameters:
+    level: max
+
+    paths:
+        - src/
+        - tests/
+
+#    ignoreErrors:
+#        - '#type specified#'
+#        - '#expects resource, resource\|false given#'

src/ExtEvLoop.php

@@ -34,7 +34,7 @@
     private $futureTickQueue;
 
     /**
-     * @var SplObjectStorage
+     * @var SplObjectStorage<TimerInterface, \EvTimer>
      */
     private $timers;
 
@@ -71,7 +71,7 @@
         $this->signals = new SignalsHandler();
     }
 
     public function addReadStream($stream, $listener)
     {
         $key = (int)$stream;
 
@@ -97,7 +97,7 @@
         };
     }
 
     public function addWriteStream($stream, $listener)
     {
         $key = (int)$stream;
 
@@ -110,7 +110,7 @@
         $this->writeStreams[$key] = $event;
     }
 
     public function removeReadStream($stream)
     {
         $key = (int)$stream;
 
@@ -122,7 +122,7 @@
         unset($this->readStreams[$key]);
     }
 
     public function removeWriteStream($stream)
     {
         $key = (int)$stream;
 
@@ -192,13 +192,21 @@
             $this->futureTickQueue->tick();
 
             $hasPendingCallbacks = !$this->futureTickQueue->isEmpty();
+            /**
+             * @link https://github.com/phpstan/phpstan/issues/10566
+             * @phpstan-ignore-next-line
+             */
             $wasJustStopped = !$this->running;
             $nothingLeftToDo = !$this->readStreams
                 && !$this->writeStreams
                 && !$this->timers->count()
                 && $this->signals->isEmpty();
 
             $flags = Ev::RUN_ONCE;
+            /**
+             * @link https://github.com/phpstan/phpstan/issues/10566
+             * @phpstan-ignore-next-line
+             */
             if ($wasJustStopped || $hasPendingCallbacks) {
                 $flags |= Ev::RUN_NOWAIT;
             } elseif ($nothingLeftToDo) {
@@ -222,11 +230,13 @@
         }
 
         foreach ($this->readStreams as $key => $stream) {
-            $this->removeReadStream($key);
+            $this->readStreams[$key]->stop();
+            unset($this->readStreams[$key]);
         }
 
         foreach ($this->writeStreams as $key => $stream) {
-            $this->removeWriteStream($key);
+            $this->readStreams[$key]->stop();
+            unset($this->readStreams[$key]);
         }
     }
 

src/ExtEventLoop.php

@@ -22,12 +22,12 @@
  */
 final class ExtEventLoop implements LoopInterface
 {
     private $eventBase;
     private $futureTickQueue;
     private $timerCallback;
     private $timerEvents;
     private $streamCallback;
     private $readEvents = array();
     private $writeEvents = array();
     private $readListeners = array();
     private $writeListeners = array();
@@ -196,6 +196,10 @@
             $this->futureTickQueue->tick();
 
             $flags = EventBase::LOOP_ONCE;
+            /**
+             * @link https://github.com/phpstan/phpstan/issues/10566
+             * @phpstan-ignore-next-line
+             */
             if (!$this->running || !$this->futureTickQueue->isEmpty()) {
                 $flags |= EventBase::LOOP_NONBLOCK;
             } elseif (!$this->readEvents && !$this->writeEvents && !$this->timerEvents->count() && $this->signals->isEmpty()) {

src/ExtUvLoop.php

@@ -213,6 +213,10 @@ public function run()
             $this->futureTickQueue->tick();
 
             $hasPendingCallbacks = !$this->futureTickQueue->isEmpty();
+            /**
+             * @link https://github.com/phpstan/phpstan/issues/10566
+             * @phpstan-ignore-next-line
+             */
             $wasJustStopped = !$this->running;
             $nothingLeftToDo = !$this->readStreams
                 && !$this->writeStreams
@@ -223,12 +227,20 @@ public function run()
             // otherwise use UV::RUN_NOWAIT.
             // @link http://docs.libuv.org/en/v1.x/loop.html#c.uv_run
             $flags = \UV::RUN_ONCE;
+            /**
+             * @link https://github.com/phpstan/phpstan/issues/10566
+             * @phpstan-ignore-next-line
+             */
             if ($wasJustStopped || $hasPendingCallbacks) {
                 $flags = \UV::RUN_NOWAIT;
             } elseif ($nothingLeftToDo) {
                 break;
             }
 
+            /**
+             * @link https://github.com/JetBrains/phpstorm-stubs/pull/1614
+             * @phpstan-ignore-next-line
+             */
             \uv_run($this->uv, $flags);
         }
     }
@@ -261,6 +273,10 @@ private function removeStream($stream)
         if (!isset($this->readStreams[(int) $stream])
             && !isset($this->writeStreams[(int) $stream])) {
             \uv_poll_stop($this->streamEvents[(int) $stream]);
+            /**
+             * @link https://github.com/JetBrains/phpstorm-stubs/pull/1615
+             * @phpstan-ignore-next-line
+             */
             \uv_close($this->streamEvents[(int) $stream]);
             unset($this->streamEvents[(int) $stream]);
             return;

src/Loop.php

@@ -87,6 +87,7 @@ public static function addReadStream($stream, $listener)
         if (self::$instance === null) {
             self::get();
         }
+        assert(self::$instance instanceof LoopInterface);
         self::$instance->addReadStream($stream, $listener);
     }
 
@@ -105,6 +106,9 @@ public static function addWriteStream($stream, $listener)
         if (self::$instance === null) {
             self::get();
         }
+
+        assert(self::$instance instanceof LoopInterface);
+
         self::$instance->addWriteStream($stream, $listener);
     }
 
@@ -150,6 +154,9 @@ public static function addTimer($interval, $callback)
         if (self::$instance === null) {
             self::get();
         }
+
+        assert(self::$instance instanceof LoopInterface);
+
         return self::$instance->addTimer($interval, $callback);
     }
 
@@ -167,6 +174,9 @@ public static function addPeriodicTimer($interval, $callback)
         if (self::$instance === null) {
             self::get();
         }
+
+        assert(self::$instance instanceof LoopInterface);
+
         return self::$instance->addPeriodicTimer($interval, $callback);
     }
 
@@ -198,6 +208,8 @@ public static function futureTick($listener)
             self::get();
         }
 
+        assert(self::$instance instanceof LoopInterface);
+
         self::$instance->futureTick($listener);
     }
 
@@ -216,6 +228,8 @@ public static function addSignal($signal, $listener)
             self::get();
         }
 
+        assert(self::$instance instanceof LoopInterface);
+
         self::$instance->addSignal($signal, $listener);
     }
 
@@ -247,6 +261,8 @@ public static function run()
             self::get();
         }
 
+        assert(self::$instance instanceof LoopInterface);
+
         self::$instance->run();
     }
 

src/SignalsHandler.php

@@ -47,6 +47,9 @@ public function call($signal)
         }
     }
 
+    /**
+     * @phpstan-impure
+     */
     public function count($signal)
     {
         if (!isset($this->signals[$signal])) {

src/StreamSelectLoop.php

@@ -63,6 +63,9 @@ final class StreamSelectLoop implements LoopInterface
     private $running;
     private $pcntl = false;
     private $pcntlPoll = false;
+    /**
+     * @var SignalsHandler
+     */
     private $signals;
 
     public function __construct()
@@ -183,7 +186,13 @@ public function run()
 
             $this->timers->tick();
 
-            // Future-tick queue has pending callbacks ...
+            /**
+             * Future-tick queue has pending callbacks ...
+             *
+             *
+             * @link https://github.com/phpstan/phpstan/issues/10566
+             * @phpstan-ignore-next-line
+             */
             if (!$this->running || !$this->futureTickQueue->isEmpty()) {
                 $timeout = 0;
 
@@ -286,7 +295,7 @@ private function streamSelect(array &$read, array &$write, $timeout)
                 }
             }
 
-            /** @var ?callable $previous */
+            /** @var ?(callable(int, string, string, int): bool) $previous */
             $previous = \set_error_handler(function ($errno, $errstr) use (&$previous) {
                 // suppress warnings that occur when `stream_select()` is interrupted by a signal
                 // PHP defines `EINTR` through `ext-sockets` or `ext-pcntl`, otherwise use common default (Linux & Mac)
@@ -305,7 +314,7 @@ private function streamSelect(array &$read, array &$write, $timeout)
             } catch (\Throwable $e) { // @codeCoverageIgnoreStart
                 \restore_error_handler();
                 throw $e;
-            } catch (\Exception $e) {
+            } catch (\Exception $e) { /** @phpstan-ignore-line */
                 \restore_error_handler();
                 throw $e;
             } // @codeCoverageIgnoreEnd

tests/ExtEventLoopTest.php

@@ -62,15 +62,6 @@ public function createStream()
         return $stream;
     }
 
-    public function writeToStream($stream, $content)
-    {
-        if ('Linux' !== PHP_OS) {
-            return parent::writeToStream($stream, $content);
-        }
-
-        fwrite($stream, $content);
-    }
-
     /**
      * @group epoll-readable-error
      */

tests/StreamSelectLoopTest.php

@@ -61,6 +61,7 @@ public function testStreamSelectReportsWarningForStreamWithFilter()
         $error = null;
         $previous = set_error_handler(function ($_, $errstr) use (&$error) {
             $error = $errstr;
+            return true;
         });
 
         try {
@@ -73,7 +74,9 @@ public function testStreamSelectReportsWarningForStreamWithFilter()
 
         $this->assertNotNull($error);
 
-        $now = set_error_handler(function () { });
+        $now = set_error_handler(function () {
+            return true;
+        });
         restore_error_handler();
         $this->assertEquals($previous, $now);
     }
@@ -114,7 +117,9 @@ public function testStreamSelectThrowsWhenCustomErrorHandlerThrowsForStreamWithF
 
         $this->assertInstanceOf('RuntimeException', $e);
 
-        $now = set_error_handler(function () { });
+        $now = set_error_handler(function () {
+            return true;
+        });
         restore_error_handler();
         $this->assertEquals($previous, $now);
     }
@@ -176,7 +181,6 @@ public function testSignalInterruptWithStream($signal)
         $loop = $this->loop;
         list($writeStream, $readStream) = $this->createSocketPair();
         $loop->addReadStream($readStream, function ($stream) use ($loop) {
-            /** @var $loop LoopInterface */
             $read = fgets($stream);
             if ($read === "end loop\n") {
                 $loop->stop();

tests/bin/12-undefined.php

@@ -9,4 +9,9 @@
     echo 'never';
 });
 
+/**
+ * We're ignore this line because the test using this file relies on the error caused by it.
+ *
+ * @phpstan-ignore-next-line
+ */
 $undefined->foo('bar');

tests/bin/22-stop-uncaught.php

@@ -9,6 +9,11 @@
     echo 'never';
 });
 
+/**
+ * Ignoring the next line until we raise the minimum PHP version to 7.1
+ *
+ * @phpstan-ignore-next-line
+ */
 set_exception_handler(function (Exception $e) {
     echo 'Uncaught error occured' . PHP_EOL;
     Loop::stop();