Add PHPStan to test environment

Author: clue

.gitattributes

@@ -2,6 +2,7 @@
 /.github/workflows/ 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

@@ -37,3 +37,25 @@ jobs:
           <?php
           $metrics = simplexml_load_file('clover.xml')->project->metrics;
           exit((int) $metrics['statements'] === (int) $metrics['coveredstatements'] ? 0 : 1);
+
+  PHPStan:
+    name: PHPStan (PHP ${{ matrix.php }})
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        php:
+          - 8.2
+          - 8.1
+          - 8.0
+          - 7.4
+          - 7.3
+          - 7.2
+          - 7.1
+    steps:
+      - uses: actions/checkout@v3
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: none
+      - run: composer install
+      - run: vendor/bin/phpstan

composer.json

@@ -21,6 +21,7 @@
     },
     "require-dev": {
         "clue/block-react": "^1.5",
+        "phpstan/phpstan": "1.8.11 || 1.4.10",
         "phpunit/phpunit": "^9.5 || ^7.5"
     },
     "autoload": {

phpstan.neon.dist

@@ -0,0 +1,15 @@
+parameters:
+    level: 3
+
+    paths:
+        - examples/
+        - src/
+        - tests/
+
+    reportUnmatchedIgnoredErrors: false
+    ignoreErrors:
+        # ignore generic usage like `PromiseInterface<T>` until fixed upstream
+        - '/^PHPDoc tag @return contains generic type React\\Promise\\PromiseInterface<.+> but interface React\\Promise\\PromiseInterface is not generic\.$/'
+        # ignore undefined methods due to magic `__call()` method
+        - '/^Call to an undefined method Clue\\React\\Redis\\RedisClient::.+\(\)\.$/'
+        - '/^Call to an undefined method Clue\\React\\Redis\\Io\\StreamingClient::.+\(\)\.$/'

src/Io/Factory.php

@@ -91,6 +91,7 @@ public function createClient(string $uri): PromiseInterface
             $connecting->then(function (ConnectionInterface $connection) {
                 $connection->close();
             });
+            assert(\method_exists($connecting, 'cancel'));
             $connecting->cancel();
         });
 

src/RedisClient.php

@@ -46,7 +46,7 @@ class RedisClient extends EventEmitter
     /** @var float */
     private $idlePeriod = 0.001;
 
-    /** @var ?TimerInterface */
+    /** @var ?\React\EventLoop\TimerInterface */
     private $idleTimer = null;
 
     /** @var int */
@@ -221,6 +221,7 @@ public function close(): void
                 $redis->close();
             });
             if ($this->promise !== null) {
+                assert(\method_exists($this->promise, 'cancel'));
                 $this->promise->cancel();
                 $this->promise = null;
             }

tests/FunctionalTest.php

@@ -106,6 +106,7 @@ public function testInvalidCommand()
         if (method_exists($this, 'expectException')) {
             $this->expectException('Exception');
         } else {
+            assert(method_exists($this, 'setExpectedException'));
             $this->setExpectedException('Exception');
         }
         await($promise, $this->loop);

tests/Io/FactoryStreamingClientTest.php

@@ -444,6 +444,8 @@ public function testCancelWillRejectPromise()
         $this->connector->expects($this->once())->method('connect')->with('127.0.0.1:2')->willReturn($promise);
 
         $promise = $this->factory->createClient('redis://127.0.0.1:2');
+
+        assert(method_exists($promise, 'cancel'));
         $promise->cancel();
 
         $promise->then(null, $this->expectCallableOnceWith($this->isInstanceOf(\RuntimeException::class)));
@@ -526,6 +528,8 @@ public function testCancelWillRejectWithUriInMessageAndCancelConnectorWhenConnec
         $this->connector->expects($this->once())->method('connect')->willReturn($deferred->promise());
 
         $promise = $this->factory->createClient($uri);
+
+        assert(method_exists($promise, 'cancel'));
         $promise->cancel();
 
         $promise->then(null, $this->expectCallableOnceWith(
@@ -550,6 +554,8 @@ public function testCancelWillCloseConnectionWhenConnectionWaitsForSelect()
         $this->connector->expects($this->once())->method('connect')->willReturn(resolve($stream));
 
         $promise = $this->factory->createClient('redis://127.0.0.1:2/123');
+
+        assert(method_exists($promise, 'cancel'));
         $promise->cancel();
 
         $promise->then(null, $this->expectCallableOnceWith(

tests/RedisClientTest.php

@@ -347,6 +347,7 @@ public function testCloseAfterPingRejectsWillEmitClose()
         $client = $this->createMock(StreamingClient::class);
         $client->expects($this->once())->method('__call')->willReturn($deferred->promise());
         $client->expects($this->once())->method('close')->willReturnCallback(function () use ($client) {
+            assert($client instanceof StreamingClient);
             $client->emit('close');
         });
 
@@ -356,11 +357,10 @@ public function testCloseAfterPingRejectsWillEmitClose()
         $this->loop->expects($this->once())->method('addTimer')->willReturn($timer);
         $this->loop->expects($this->once())->method('cancelTimer')->with($timer);
 
-        $ref = $this->redis;
-        $ref->ping()->then(null, function () use ($ref, $client) {
-            $ref->close();
+        $this->redis->ping()->then(null, function () {
+            $this->redis->close();
         });
-        $ref->on('close', $this->expectCallableOnce());
+        $this->redis->on('close', $this->expectCallableOnce());
         $deferred->reject(new \RuntimeException());
     }
 
@@ -423,6 +423,7 @@ public function testEmitsNoErrorEventWhenUnderlyingClientEmitsError()
         $deferred->resolve($client);
 
         $this->redis->on('error', $this->expectCallableNever());
+        assert($client instanceof StreamingClient);
         $client->emit('error', [$error]);
     }
 
@@ -438,6 +439,7 @@ public function testEmitsNoCloseEventWhenUnderlyingClientEmitsClose()
         $deferred->resolve($client);
 
         $this->redis->on('close', $this->expectCallableNever());
+        assert($client instanceof StreamingClient);
         $client->emit('close');
     }
 

tests/TestCase.php

@@ -36,7 +36,7 @@ protected function expectCallableNever(): callable
     protected function createCallableMock(): MockObject
     {
         if (method_exists(MockBuilder::class, 'addMethods')) {
-            // PHPUnit 9+
+            // @phpstan-ignore-next-line requires PHPUnit 9+
             return $this->getMockBuilder(\stdClass::class)->addMethods(['__invoke'])->getMock();
         } else {
             // legacy PHPUnit < 9