Fix pending PHPStan errors in PR #233

phpstan.neon.dist

@@ -26,11 +26,6 @@ parameters:
             count: 1
             path: src/PluginClient.php
 
-        -
-            message: "#^Method Http\\\\Client\\\\Common\\\\EmulatedHttpClient\\:\\:sendRequest\\(\\) should return Psr\\\\Http\\\\Message\\\\ResponseInterface but returns mixed\\.$#"
-            count: 1
-            path: src/EmulatedHttpClient.php
-
         # we still support the obsolete RequestFactory for BC but do not require the package anymore
         -
             message: "#^Call to method createRequest\\(\\) on an unknown class Http\\\\Message\\\\RequestFactory\\.$#"
@@ -51,30 +46,3 @@ parameters:
             message: "#^Property Http\\\\Client\\\\Common\\\\HttpMethodsClient\\:\\:\\$requestFactory has unknown class Http\\\\Message\\\\RequestFactory as its type\\.$#"
             count: 1
             path: src/HttpMethodsClient.php
-
-        -
-            message: "#^Anonymous function should return Psr\\\\Http\\\\Message\\\\ResponseInterface but returns mixed\\.$#"
-            count: 1
-            path: src/Plugin/RedirectPlugin.php
-
-        # phpstan is confused by the optional dependencies. we check for existence first
-        -
-            message: "#^Method Http\\\\Client\\\\Common\\\\Plugin\\\\RedirectPlugin::guessStreamFactory\\(\\) should return Psr\\\\Http\\\\Message\\\\StreamFactoryInterface\\|null but returns Nyholm\\\\Psr7\\\\Factory\\\\Psr17Factory\\.$#"
-            count: 1
-            path: src/Plugin/RedirectPlugin.php
-
-        # phpstan is confused by the optional dependencies. we check for existence first
-        -
-            message: "#^Call to static method streamFor\\(\\) on an unknown class GuzzleHttp\\\\Psr7\\\\Utils\\.$#"
-            count: 1
-            path: src/Plugin/RedirectPlugin.php
-
-        -
-            message: "#^Method Http\\\\Client\\\\Common\\\\Plugin\\\\RetryPlugin\\:\\:retry\\(\\) should return Psr\\\\Http\\\\Message\\\\ResponseInterface but returns mixed\\.$#"
-            count: 1
-            path: src/Plugin/RetryPlugin.php
-
-        -
-            message: "#^Method Http\\\\Client\\\\Common\\\\PluginClient\\:\\:sendRequest\\(\\) should return Psr\\\\Http\\\\Message\\\\ResponseInterface but returns mixed\\.$#"
-            count: 2
-            path: src/PluginClient.php

src/Deferred.php

@@ -10,6 +10,8 @@
 
 /**
  * A deferred allow to return a promise which has not been resolved yet.
+ *
+ * @implements Promise<ResponseInterface>
  */
 final class Deferred implements Promise
 {
@@ -52,7 +54,9 @@ public function __construct(callable $waitCallback)
     }
 
     /**
-     * {@inheritdoc}
+     * @param callable(ResponseInterface): ResponseInterface|null $onFulfilled
+     * @param callable(\Throwable): ResponseInterface|null $onRejected
+     * @return Promise<ResponseInterface>
      */
     public function then(callable $onFulfilled = null, callable $onRejected = null): Promise
     {
@@ -86,16 +90,14 @@ public function then(callable $onFulfilled = null, callable $onRejected = null):
         return $deferred;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getState(): string
     {
         return $this->state;
     }
 
     /**
      * Resolve this deferred with a Response.
+     * @param ResponseInterface $response
      */
     public function resolve(ResponseInterface $response): void
     {
@@ -129,8 +131,8 @@ public function reject(ClientExceptionInterface $exception): void
     }
 
     /**
-     * {@inheritdoc}
-     */
+     * {@inheritDoc}
+    */
     public function wait($unwrap = true)
     {
         if (Promise::PENDING === $this->state) {

src/HttpAsyncClientDecorator.php

@@ -5,6 +5,8 @@
 namespace Http\Client\Common;
 
 use Http\Client\HttpAsyncClient;
+use Http\Promise\Promise;
+use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\RequestInterface;
 
 /**
@@ -20,9 +22,8 @@ trait HttpAsyncClientDecorator
     protected $httpAsyncClient;
 
     /**
-     * {@inheritdoc}
-     *
      * @see HttpAsyncClient::sendAsyncRequest
+     * @return Promise<ResponseInterface>
      */
     public function sendAsyncRequest(RequestInterface $request)
     {

src/HttpAsyncClientEmulator.php

@@ -17,16 +17,13 @@
 trait HttpAsyncClientEmulator
 {
     /**
-     * {@inheritdoc}
-     *
      * @see HttpClient::sendRequest
      */
     abstract public function sendRequest(RequestInterface $request): ResponseInterface;
 
     /**
-     * {@inheritdoc}
-     *
      * @see HttpAsyncClient::sendAsyncRequest
+     * @return \Http\Promise\Promise<ResponseInterface|\Throwable>
      */
     public function sendAsyncRequest(RequestInterface $request)
     {

src/HttpClientDecorator.php

@@ -21,8 +21,6 @@ trait HttpClientDecorator
     protected $httpClient;
 
     /**
-     * {@inheritdoc}
-     *
      * @see ClientInterface::sendRequest
      */
     public function sendRequest(RequestInterface $request): ResponseInterface

src/HttpClientEmulator.php

@@ -15,8 +15,6 @@
 trait HttpClientEmulator
 {
     /**
-     * {@inheritdoc}
-     *
      * @see HttpClient::sendRequest
      */
     public function sendRequest(RequestInterface $request): ResponseInterface
@@ -27,8 +25,6 @@ public function sendRequest(RequestInterface $request): ResponseInterface
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @see HttpAsyncClient::sendAsyncRequest
      */
     abstract public function sendAsyncRequest(RequestInterface $request);

src/HttpClientPool/HttpClientPool.php

@@ -7,6 +7,7 @@
 use Http\Client\Common\Exception\HttpClientNotFoundException;
 use Http\Client\Common\HttpClientPool as HttpClientPoolInterface;
 use Http\Client\HttpAsyncClient;
+use Http\Promise\Promise;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -53,16 +54,13 @@ public function addHttpClient($client): void
     abstract protected function chooseHttpClient(): HttpClientPoolItem;
 
     /**
-     * {@inheritdoc}
+     * @return Promise<ResponseInterface>
      */
     public function sendAsyncRequest(RequestInterface $request)
     {
         return $this->chooseHttpClient()->sendAsyncRequest($request);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function sendRequest(RequestInterface $request): ResponseInterface
     {
         return $this->chooseHttpClient()->sendRequest($request);

src/HttpClientPool/HttpClientPoolItem.php

@@ -8,6 +8,7 @@
 use Http\Client\Exception;
 use Http\Client\HttpAsyncClient;
 use Http\Client\HttpClient;
+use Http\Promise\Promise;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -69,9 +70,6 @@ public function __construct($client, int $reenableAfter = null)
         $this->reenableAfter = $reenableAfter;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function sendRequest(RequestInterface $request): ResponseInterface
     {
         if ($this->isDisabled()) {
@@ -93,7 +91,7 @@ public function sendRequest(RequestInterface $request): ResponseInterface
     }
 
     /**
-     * {@inheritdoc}
+     * @return Promise<ResponseInterface>
      */
     public function sendAsyncRequest(RequestInterface $request)
     {

src/HttpClientPool/LeastUsedClientPool.php

@@ -15,9 +15,6 @@
  */
 final class LeastUsedClientPool extends HttpClientPool
 {
-    /**
-     * {@inheritdoc}
-     */
     protected function chooseHttpClient(): HttpClientPoolItem
     {
         $clientPool = array_filter($this->clientPool, function (HttpClientPoolItem $clientPoolItem) {

src/HttpClientPool/RandomClientPool.php

@@ -13,9 +13,6 @@
  */
 final class RandomClientPool extends HttpClientPool
 {
-    /**
-     * {@inheritdoc}
-     */
     protected function chooseHttpClient(): HttpClientPoolItem
     {
         $clientPool = array_filter($this->clientPool, function (HttpClientPoolItem $clientPoolItem) {

src/HttpClientPool/RoundRobinClientPool.php

@@ -13,9 +13,6 @@
  */
 final class RoundRobinClientPool extends HttpClientPool
 {
-    /**
-     * {@inheritdoc}
-     */
     protected function chooseHttpClient(): HttpClientPoolItem
     {
         $last = current($this->clientPool);

src/HttpClientRouter.php

@@ -7,13 +7,12 @@
 use Http\Client\Common\Exception\HttpClientNoMatchException;
 use Http\Client\HttpAsyncClient;
 use Http\Message\RequestMatcher;
+use Http\Promise\Promise;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
 /**
- * {@inheritdoc}
- *
  * @author Joel Wurtz <[email protected]>
  */
 final class HttpClientRouter implements HttpClientRouterInterface
@@ -23,16 +22,13 @@ final class HttpClientRouter implements HttpClientRouterInterface
      */
     private $clients = [];
 
-    /**
-     * {@inheritdoc}
-     */
     public function sendRequest(RequestInterface $request): ResponseInterface
     {
         return $this->chooseHttpClient($request)->sendRequest($request);
     }
 
     /**
-     * {@inheritdoc}
+     * @return Promise<ResponseInterface>
      */
     public function sendAsyncRequest(RequestInterface $request)
     {

src/Plugin.php

@@ -5,6 +5,7 @@
 namespace Http\Client\Common;
 
 use Http\Promise\Promise;
+use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\RequestInterface;
 
 /**
@@ -24,10 +25,10 @@ interface Plugin
      *
      * @see http://docs.php-http.org/en/latest/plugins/build-your-own.html
      *
-     * @param callable(RequestInterface): Promise $next  Next middleware in the chain, the request is passed as the first argument
-     * @param callable(RequestInterface): Promise $first First middleware in the chain, used to to restart a request
+     * @param callable(RequestInterface): Promise<ResponseInterface> $next  Next middleware in the chain, the request is passed as the first argument
+     * @param callable(RequestInterface): Promise<ResponseInterface> $first First middleware in the chain, used to to restart a request
      *
-     * @return Promise Resolves a PSR-7 Response or fails with an Http\Client\Exception (The same as HttpAsyncClient)
+     * @return Promise<ResponseInterface> Resolves a PSR-7 Response or fails with an Http\Client\Exception (The same as HttpAsyncClient)
      */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise;
 }

src/Plugin/AddHostPlugin.php

@@ -48,9 +48,6 @@ public function __construct(UriInterface $host, array $config = [])
         $this->replace = $options['replace'];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         if ($this->replace || '' === $request->getUri()->getHost()) {

src/Plugin/AuthenticationPlugin.php

@@ -26,9 +26,6 @@ public function __construct(Authentication $authentication)
         $this->authentication = $authentication;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         $request = $this->authentication->authenticate($request);

src/Plugin/BaseUriPlugin.php

@@ -24,7 +24,7 @@ final class BaseUriPlugin implements Plugin
     /**
      * @var AddPathPlugin|null
      */
-    private $addPathPlugin = null;
+    private $addPathPlugin;
 
     /**
      * @param UriInterface $uri        Has to contain a host name and can have a path
@@ -39,9 +39,6 @@ public function __construct(UriInterface $uri, array $hostConfig = [])
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         $addHostNext = function (RequestInterface $request) use ($next, $first) {

src/Plugin/ContentLengthPlugin.php

@@ -16,9 +16,6 @@
  */
 final class ContentLengthPlugin implements Plugin
 {
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         if (!$request->hasHeader('Content-Length')) {

src/Plugin/ContentTypePlugin.php

@@ -57,9 +57,6 @@ public function __construct(array $config = [])
         $this->sizeLimit = $options['size_limit'];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         if (!$request->hasHeader('Content-Type')) {

src/Plugin/CookiePlugin.php

@@ -33,9 +33,6 @@ public function __construct(CookieJar $cookieJar)
         $this->cookieJar = $cookieJar;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         $cookies = [];

src/Plugin/DecoderPlugin.php

@@ -48,9 +48,6 @@ public function __construct(array $config = [])
         $this->useContentEncoding = $options['use_content_encoding'];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         $encodings = extension_loaded('zlib') ? ['gzip', 'deflate'] : ['identity'];

src/Plugin/ErrorPlugin.php

@@ -54,9 +54,6 @@ public function __construct(array $config = [])
         $this->onlyServerException = $options['only_server_exception'];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         $promise = $next($request);

src/Plugin/HeaderAppendPlugin.php

@@ -34,9 +34,6 @@ public function __construct(array $headers)
         $this->headers = $headers;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         foreach ($this->headers as $header => $headerValue) {