Merge pull request #47 from BedrockStreaming/feat/phpstan-update

feat: update phpstan and fix reported errors

composer.json

@@ -31,7 +31,7 @@
         "ext-curl": "^7.1",
         "react/event-loop": "^1.0",
         "react/promise": "^2.7",
-        "phpstan/phpstan": "^0.10.5",
+        "phpstan/phpstan": "^0.12",
         "symfony/http-client": "^4.3",
         "psr/http-factory": "^1.0",
         "http-interop/http-factory-guzzle": "^1.0"

examples/tests/ExamplesTest.php

@@ -29,7 +29,7 @@ public function examplesProvider()
     /**
      * @dataProvider examplesProvider
      */
-    public function testExampleShouldRun(string $exampleFile, string $eventloopName, string $exampleCode)
+    public function testExampleShouldRun(string $exampleFile, string $eventloopName, string $exampleCode): void
     {
         // Sanitize loop name to create a relevant temporary filename
         $eventLoopFileId = preg_replace('/[^a-z0-9]+/', '', strtolower($eventloopName));

phpstan.neon

@@ -0,0 +1,24 @@
+parameters:
+	checkMissingIterableValueType: false
+	checkGenericClassInNonGenericObjectType: false
+	ignoreErrors:
+		-
+			message: '#Negated boolean expression is always true\.#'
+			path: src/Adapter/Amp/Internal/PromiseWrapper.php
+			count: 1
+		-
+			message: '#Negated boolean expression is always true\.#'
+			path: src/Adapter/ReactPhp/Internal/PromiseWrapper.php
+			count: 1
+		-
+			message: '#Anonymous function should return Generator but empty return statement found.#'
+			path: src/Adapter/Tornado/EventLoop.php
+			count: 1
+		-
+			message: '#Unreachable statement - code above always terminates\.#'
+			path: src/Adapter/Tornado/EventLoop.php
+			count: 1
+		-
+			message: '#Unreachable statement - code above always terminates\.#'
+			path: tests/EventLoopTest.php
+			count: 3

src/Adapter/Amp/Internal/PromiseWrapper.php

@@ -24,7 +24,7 @@ private function __construct()
     {
     }
 
-    public static function createUnhandled(\Amp\Promise $ampPromise, FailingPromiseCollection $failingPromiseCollection)
+    public static function createUnhandled(\Amp\Promise $ampPromise, FailingPromiseCollection $failingPromiseCollection): self
     {
         $promiseWrapper = new self();
         $promiseWrapper->isHandled = false;
@@ -40,7 +40,7 @@ function (?\Throwable $reason, $value) use ($promiseWrapper, $failingPromiseColl
         return $promiseWrapper;
     }
 
-    public static function createHandled(\Amp\Promise $ampPromise)
+    public static function createHandled(\Amp\Promise $ampPromise): self
     {
         $promiseWrapper = new self();
         $promiseWrapper->isHandled = true;

src/Adapter/Guzzle/HttpClient.php

@@ -16,6 +16,7 @@ class HttpClient implements \M6Web\Tornado\HttpClient
     /** @var GuzzleClientWrapper */
     private $clientWrapper;
 
+    /** @var int */
     private $nbConcurrentRequests = 0;
 
     public function __construct(EventLoop $eventLoop, GuzzleClientWrapper $clientWrapper)
@@ -67,7 +68,8 @@ private function http2fallback(RequestInterface $request): RequestInterface
         if (
             'https' !== $request->getUri()->getScheme()
             || !\defined('CURL_VERSION_HTTP2')
-            || !(CURL_VERSION_HTTP2 & curl_version()['features'])
+            || (($curlVersion = curl_version()) === false)
+            || !(CURL_VERSION_HTTP2 & $curlVersion['features'])
         ) {
             return $request->withProtocolVersion('1.1');
         }

src/Adapter/ReactPhp/Internal/PromiseWrapper.php

@@ -24,7 +24,7 @@ private function __construct()
     {
     }
 
-    public static function createUnhandled(\React\Promise\PromiseInterface $reactPromise, FailingPromiseCollection $failingPromiseCollection)
+    public static function createUnhandled(\React\Promise\PromiseInterface $reactPromise, FailingPromiseCollection $failingPromiseCollection): self
     {
         $promiseWrapper = new self();
         $promiseWrapper->isHandled = false;
@@ -41,7 +41,7 @@ function (?\Throwable $reason) use ($promiseWrapper, $failingPromiseCollection)
         return $promiseWrapper;
     }
 
-    public static function createHandled(\React\Promise\PromiseInterface $reactPromise)
+    public static function createHandled(\React\Promise\PromiseInterface $reactPromise): self
     {
         $promiseWrapper = new self();
         $promiseWrapper->isHandled = true;

src/Adapter/Symfony/HttpClient.php

@@ -79,7 +79,7 @@ private function symfonyEventLoop(): \Generator
             $currentJobs = $this->jobs;
             $this->jobs = [];
             /**
-             * @var SfResponseInterface
+             * @var SfResponseInterface $response
              * @var ChunkInterface      $chunk
              */
             foreach ($this->symfonyClient->stream($currentJobs, 0) as $response => $chunk) {

src/Adapter/Tornado/Internal/PendingPromise.php

@@ -12,9 +12,13 @@
  */
 class PendingPromise implements Promise, Deferred
 {
+    /** @var mixed */
     private $value;
+    /** @var \Throwable */
     private $throwable;
+    /** @var callable[][] */
     private $callbacks = [];
+    /** @var bool */
     private $isSettled = false;
     /** @var ?FailingPromiseCollection */
     private $failingPromiseCollection;
@@ -26,15 +30,15 @@ private function __construct()
     {
     }
 
-    public static function createUnhandled(FailingPromiseCollection $failingPromiseCollection)
+    public static function createUnhandled(FailingPromiseCollection $failingPromiseCollection): self
     {
         $promiseWrapper = new self();
         $promiseWrapper->failingPromiseCollection = $failingPromiseCollection;
 
         return $promiseWrapper;
     }
 
-    public static function createHandled()
+    public static function createHandled(): self
     {
         $promiseWrapper = new self();
         $promiseWrapper->failingPromiseCollection = null;
@@ -103,7 +107,7 @@ private function triggerCallbacks(): self
         return $this;
     }
 
-    private function settle()
+    private function settle(): void
     {
         if ($this->isSettled) {
             throw new \LogicException('Cannot resolve/reject a promise already settled.');

src/Adapter/Tornado/Internal/StreamEventLoop.php

@@ -16,11 +16,17 @@ class StreamEventLoop
     /** @var PendingPromise[] */
     private $pendingPromises = [];
 
+    /**
+     * @param resource $stream
+     */
     public function readable(EventLoop $eventLoop, $stream): PendingPromise
     {
         return $this->recordStream($eventLoop, $stream, $this->readStreams);
     }
 
+    /**
+     * @param resource $stream
+     */
     public function writable(EventLoop $eventLoop, $stream): PendingPromise
     {
         return $this->recordStream($eventLoop, $stream, $this->writeStreams);
@@ -58,6 +64,9 @@ private function internalLoop(EventLoop $eventLoop): \Generator
         }
     }
 
+    /**
+     * @param resource $stream
+     */
     private function recordStream(EventLoop $eventLoop, $stream, array &$streamsList): PendingPromise
     {
         $streamId = (int) $stream;

src/Adapter/Tornado/Internal/Task.php

@@ -8,7 +8,9 @@
  */
 class Task
 {
+    /** @var \Generator */
     private $generator;
+    /** @var PendingPromise */
     private $promise;
 
     public function __construct(\Generator $generator, PendingPromise $pendingPromise)

src/Adapter/Tornado/SynchronousEventLoop.php

@@ -156,11 +156,12 @@ public function deferred(): Deferred
         $deferred = new class() implements Deferred {
             /** @var SynchronousEventLoop */
             public $eventLoop;
-            private $promise;
+            /** @var ?Promise */
+            private $promise = null;
 
             public function getPromise(): Promise
             {
-                if (!$this->promise) {
+                if ($this->promise === null) {
                     throw new \Error('Synchronous Deferred must be resolved/rejected before to retrieve its promise.');
                 }
 

src/Deferred.php

@@ -14,6 +14,7 @@ public function getPromise(): Promise;
 
     /**
      * Resolves associated promise.
+     * @param mixed $value
      */
     public function resolve($value): void;
 

src/EventLoop.php

@@ -40,6 +40,7 @@ public function promiseRace(Promise ...$promises): Promise;
 
     /**
      * Creates a promise already resolved with $value.
+     * @param mixed $value
      */
     public function promiseFulfilled($value): Promise;
 

tests/Adapter/Amp/EventLoopTest.php

@@ -12,21 +12,21 @@ protected function createEventLoop(): EventLoop
         return new Amp\EventLoop();
     }
 
-    public function testStreamShouldReadFromWritable($expectedSequence = '')
+    public function testStreamShouldReadFromWritable(string $expectedSequence = ''): void
     {
         // Because Amp resolve promises in a slightly different order.
         parent::testStreamShouldReadFromWritable('W0R0W12345R12R34W6R56R');
     }
 
-    public function testStreamShouldNotBeWritableIfClosed()
+    public function testStreamShouldNotBeWritableIfClosed(): void
     {
         assert_options(ASSERT_EXCEPTION, 1);
         $this->expectException(\Throwable::class);
 
         parent::testStreamShouldNotBeWritableIfClosed();
     }
 
-    public function testStreamShouldNotBeReadableIfClosed()
+    public function testStreamShouldNotBeReadableIfClosed(): void
     {
         assert_options(ASSERT_EXCEPTION, 1);
         $this->expectException(\Throwable::class);

tests/Adapter/Guzzle/HttpClientTest.php

@@ -20,7 +20,7 @@ protected function createHttpClient(EventLoop $eventLoop, array $responsesOrExce
     /**
      * @dataProvider eventLoopProvider
      */
-    public function testWrapperIsTicked(EventLoop $eventLoop)
+    public function testWrapperIsTicked(EventLoop $eventLoop): void
     {
         $httpClient = new \M6Web\Tornado\Adapter\Guzzle\HttpClient(
             $eventLoop,
@@ -35,7 +35,7 @@ public function testWrapperIsTicked(EventLoop $eventLoop)
     /**
      * @dataProvider eventLoopProvider
      */
-    public function testRequestExceptionsAreSuccessful(EventLoop $eventLoop)
+    public function testRequestExceptionsAreSuccessful(EventLoop $eventLoop): void
     {
         $request = new Request('GET', 'http://www.example.com');
         $expectedResponse = new Response(500, [], 'An error occurred');

tests/Adapter/Tornado/SynchronousEventLoopTest.php

@@ -12,31 +12,31 @@ protected function createEventLoop(): EventLoop
         return new Tornado\SynchronousEventLoop();
     }
 
-    public function testIdle($expectedSequence = '')
+    public function testIdle(string $expectedSequence = ''): void
     {
         //By definition, this is not an asynchronous EventLoop
         parent::testIdle('AAABBC');
     }
 
-    public function testPromiseRaceShouldResolvePromisesArray(int $expectedValue = 2)
+    public function testPromiseRaceShouldResolvePromisesArray(int $expectedValue = 2): void
     {
         // In the synchronous case, there is no race, first promise always win
         parent::testPromiseRaceShouldResolvePromisesArray(1);
     }
 
-    public function testPromiseRaceShouldRejectIfFirstSettledPromiseRejects(int $expectedValue = 2)
+    public function testPromiseRaceShouldRejectIfFirstSettledPromiseRejects(int $expectedValue = 2): void
     {
         // In the synchronous case, there is no race, first promise always win
         parent::testPromiseRaceShouldRejectIfFirstSettledPromiseRejects(1);
     }
 
-    public function testStreamShouldReadFromWritable($expectedSequence = '')
+    public function testStreamShouldReadFromWritable(string $expectedSequence = ''): void
     {
         // Never wait…
         parent::testStreamShouldReadFromWritable('W0W12345W6R01R23R45R6R');
     }
 
-    public function testDelay()
+    public function testDelay(): void
     {
         $expectedDelay = 42; /*ms*/
         $eventLoop = $this->createEventLoop();
@@ -54,14 +54,14 @@ public function testDelay()
         $this->assertLessThanOrEqual($expectedDelay + 10, $duration);
     }
 
-    public function testWaitFunctionShouldReturnAsSoonAsPromiseIsResolved()
+    public function testWaitFunctionShouldReturnAsSoonAsPromiseIsResolved(): void
     {
         // By definition, synchronous event loop can only wait a promise if already resolved.
         // So this use case is not relevant for this particular implementation.
         $this->assertTrue(true);
     }
 
-    public function testWaitFunctionShouldThrowIfPromiseCannotBeResolved()
+    public function testWaitFunctionShouldThrowIfPromiseCannotBeResolved(): void
     {
         $eventLoop = $this->createEventLoop();
         $deferred = $eventLoop->deferred();