Add PHPStan to test environment

Author: clue

.gitattributes

@@ -2,6 +2,7 @@
 /.github/ export-ignore
 /.gitignore export-ignore
 /examples/ export-ignore
+/phpstan.neon.dist export-ignore
 /phpunit.xml.dist export-ignore
 /phpunit.xml.legacy export-ignore
 /tests/ export-ignore

.github/workflows/ci.yml

@@ -47,3 +47,26 @@ jobs:
       - run: composer install
       - run: vendor/bin/phpunit --coverage-text
       - run: time php examples/91-benchmark-throughput.php
+
+  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
+      - run: composer install
+      - run: vendor/bin/phpstan

README.md

@@ -1243,6 +1243,12 @@ If you do not want to run these, they can simply be skipped like this:
 vendor/bin/phpunit --exclude-group internet
 ```
 
+On top of this, we use PHPStan on level 5 to ensure type safety across the project:
+
+```bash
+vendor/bin/phpstan
+```
+
 ## License
 
 MIT, see [LICENSE file](LICENSE).

composer.json

@@ -31,8 +31,9 @@
         "evenement/evenement": "^3.0 || ^2.0 || ^1.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.6 || ^7.5",
-        "clue/stream-filter": "~1.2"
+        "clue/stream-filter": "^1.2",
+        "phpstan/phpstan": "1.11.1 || 1.4.10",
+        "phpunit/phpunit": "^9.6 || ^7.5"
     },
     "autoload": {
         "psr-4": {

phpstan.neon.dist

@@ -0,0 +1,7 @@
+parameters:
+    level: 5
+
+    paths:
+        - examples/
+        - src/
+        - tests/

src/DuplexResourceStream.php

@@ -171,14 +171,15 @@ public function pipe(WritableStreamInterface $dest, array $options = []): Writab
     public function handleData($stream)
     {
         $error = null;
-        \set_error_handler(function ($errno, $errstr, $errfile, $errline) use (&$error) {
+        \set_error_handler(function ($errno, $errstr, $errfile, $errline) use (&$error): bool {
             $error = new \ErrorException(
                 $errstr,
                 0,
                 $errno,
                 $errfile,
                 $errline
             );
+            return true;
         });
 
         $data = \stream_get_contents($stream, $this->bufferSize);

src/ReadableResourceStream.php

@@ -124,14 +124,15 @@ public function close(): void
     public function handleData()
     {
         $error = null;
-        \set_error_handler(function ($errno, $errstr, $errfile, $errline) use (&$error) {
+        \set_error_handler(function ($errno, $errstr, $errfile, $errline) use (&$error): bool {
             $error = new \ErrorException(
                 $errstr,
                 0,
                 $errno,
                 $errfile,
                 $errline
             );
+            return true;
         });
 
         $data = \stream_get_contents($this->stream, $this->bufferSize);

src/ThroughStream.php

@@ -144,6 +144,7 @@ public function write($data): bool
         }
 
         // continue writing if still writable and not paused (throttled), false otherwise
+        // @phpstan-ignore-next-line (may be false when write() causes stream to close)
         return $this->writable && !$this->paused;
     }
 
@@ -157,6 +158,7 @@ public function end($data = null): void
             $this->write($data);
 
             // return if write() already caused the stream to close
+            // @phpstan-ignore-next-line (may be false when write() causes stream to close)
             if (!$this->writable) {
                 return;
             }

src/WritableResourceStream.php

@@ -122,8 +122,9 @@ public function close(): void
     public function handleWrite()
     {
         $error = null;
-        \set_error_handler(function ($_, $errstr) use (&$error) {
+        \set_error_handler(function ($_, $errstr) use (&$error): bool {
             $error = $errstr;
+            return true;
         });
 
         if ($this->writeChunkSize === -1) {

tests/DuplexResourceStreamTest.php

@@ -59,7 +59,7 @@ public function testConstructorThrowsExceptionOnInvalidStream()
         $loop = $this->createLoopMock();
 
         $this->expectException(\InvalidArgumentException::class);
-        new DuplexResourceStream('breakme', $loop);
+        new DuplexResourceStream('breakme', $loop); // @phpstan-ignore-line
     }
 
     /**

tests/ReadableResourceStreamTest.php

@@ -58,7 +58,7 @@ public function testConstructorThrowsExceptionOnInvalidStream()
         $loop = $this->createLoopMock();
 
         $this->expectException(\InvalidArgumentException::class);
-        new ReadableResourceStream(false, $loop);
+        new ReadableResourceStream(false, $loop); // @phpstan-ignore-line
     }
 
     /**
@@ -148,7 +148,7 @@ public function testDataEvent()
         fwrite($stream, "foobar\n");
         rewind($stream);
 
-        $conn->handleData($stream);
+        $conn->handleData();
         $this->assertSame("foobar\n", $capturedData);
     }
 
@@ -171,7 +171,7 @@ public function testDataEventDoesEmitOneChunkMatchingBufferSize()
         fwrite($stream, str_repeat("a", 100000));
         rewind($stream);
 
-        $conn->handleData($stream);
+        $conn->handleData();
 
         $this->assertTrue($conn->isReadable());
         $this->assertEquals(4321, strlen($capturedData));
@@ -197,7 +197,7 @@ public function testDataEventDoesEmitOneChunkUntilStreamEndsWhenBufferSizeIsInfi
         fwrite($stream, str_repeat("a", 100000));
         rewind($stream);
 
-        $conn->handleData($stream);
+        $conn->handleData();
 
         $this->assertTrue($conn->isReadable());
         $this->assertEquals(100000, strlen($capturedData));
@@ -214,7 +214,7 @@ public function testEmptyStreamShouldNotEmitData()
         $conn = new ReadableResourceStream($stream, $loop);
         $conn->on('data', $this->expectCallableNever());
 
-        $conn->handleData($stream);
+        $conn->handleData();
     }
 
     public function testPipeShouldReturnDestination()
@@ -245,7 +245,7 @@ public function testClosingStreamInDataEventShouldNotTriggerError()
         fwrite($stream, "foobar\n");
         rewind($stream);
 
-        $conn->handleData($stream);
+        $conn->handleData();
     }
 
     /**
@@ -344,7 +344,7 @@ public function testDataFiltered()
         fwrite($stream, "foobar\n");
         rewind($stream);
 
-        $conn->handleData($stream);
+        $conn->handleData();
         $this->assertSame("foobr\n", $capturedData);
     }
 
@@ -373,7 +373,7 @@ public function testDataErrorShouldEmitErrorAndClose()
         fwrite($stream, "foobar\n");
         rewind($stream);
 
-        $conn->handleData($stream);
+        $conn->handleData();
     }
 
     /**

tests/ThroughStreamTest.php

@@ -216,7 +216,7 @@ public function endShouldWriteDataBeforeClosing()
     public function endTwiceShouldOnlyEmitOnce()
     {
         $through = new ThroughStream();
-        $through->on('data', $this->expectCallableOnce('first'));
+        $through->on('data', $this->expectCallableOnceWith('first'));
         $through->end('first');
         $through->end('ignored');
     }

tests/WritableResourceStreamTest.php

@@ -58,7 +58,7 @@ public function testConstructorThrowsIfNotAValidStreamResource()
         $loop = $this->createLoopMock();
 
         $this->expectException(\InvalidArgumentException::class);
-        new WritableResourceStream($stream, $loop);
+        new WritableResourceStream($stream, $loop); // @phpstan-ignore-line
     }
 
     /**
@@ -165,6 +165,7 @@ public function testWriteReturnsFalseWhenWritableResourceStreamIsFull()
             ->expects($this->any())
             ->method('addWriteStream')
             ->will($this->returnCallback(function ($stream, $listener) use (&$preventWrites) {
+                /** @var bool $preventWrites */
                 if (!$preventWrites) {
                     call_user_func($listener, $stream);
                 }