Updated code quality for phpstan to level 6

Author: indy2kro

phpstan.neon

@@ -1,6 +1,5 @@
 parameters:
     paths:
         - ./src
-        - ./tests/unit
     # The level 9 is the highest level (with check for mixed type)
-    level: 8
+    level: 6

rector.php

@@ -16,7 +16,6 @@
 return RectorConfig::configure()
     ->withPaths([
         __DIR__.'/src',
-        __DIR__.'/tests/unit',
     ])
     // uncomment to reach your current PHP version
     ->withPhpSets()

src/Codeception/Lib/Connector/Guzzle.php

@@ -23,6 +23,9 @@
 
 class Guzzle extends AbstractBrowser
 {
+    /**
+     * @var array<string, mixed>
+     */
     protected array $requestOptions = [
         'allow_redirects' => false,
         'headers'         => [],
@@ -159,7 +162,7 @@ protected function createResponse(Psr7Response $psr7Response): BrowserKitRespons
     protected function getAbsoluteUri(string $uri): string
     {
         $baseUri = $this->client->getConfig('base_uri');
-        if ((str_contains($uri, '://') === 0 || str_contains($uri, '://') === false) && !str_starts_with($uri, '//')) {
+        if (str_contains($uri, '://') === false && !str_starts_with($uri, '//')) {
             if (str_starts_with($uri, '/')) {
                 $baseUriPath = $baseUri->getPath();
                 if (!empty($baseUriPath) && str_starts_with($uri, (string) $baseUriPath)) {
@@ -178,9 +181,9 @@ protected function getAbsoluteUri(string $uri): string
         return Uri::mergeUrls((string)$baseUri, $uri);
     }
 
-    protected function doRequest($request)
+    protected function doRequest(object $request): BrowserKitResponse
     {
-        /** @var $request BrowserKitRequest **/
+        /** @var BrowserKitRequest $request **/
         $guzzleRequest = new Psr7Request(
             $request->getMethod(),
             $request->getUri(),
@@ -190,12 +193,12 @@ protected function doRequest($request)
         $options = $this->requestOptions;
         $options['cookies'] = $this->extractCookies($guzzleRequest->getUri()->getHost());
         $multipartData = $this->extractMultipartFormData($request);
-        if (!empty($multipartData)) {
+        if ($multipartData !== []) {
             $options['multipart'] = $multipartData;
         }
 
         $formData = $this->extractFormData($request);
-        if (empty($multipartData) && $formData) {
+        if ($multipartData === [] && $formData) {
             $options['form_params'] = $formData;
         }
 
@@ -213,6 +216,7 @@ protected function doRequest($request)
             $response = $requestException->getResponse();
         }
 
+        // @phpstan-ignore-next-line
         return $this->createResponse($response);
     }
 
@@ -237,6 +241,9 @@ protected function extractHeaders(BrowserKitRequest $browserKitRequest): array
         return $headers;
     }
 
+    /**
+     * @return array<int, mixed>|null
+     */
     protected function extractFormData(BrowserKitRequest $browserKitRequest): ?array
     {
         if (!in_array(strtoupper($browserKitRequest->getMethod()), ['POST', 'PUT', 'PATCH', 'DELETE'])) {
@@ -257,7 +264,10 @@ protected function extractFormData(BrowserKitRequest $browserKitRequest): ?array
         return $browserKitRequest->getParameters();
     }
 
-    protected function extractMultipartFormData(BrowserKitRequest $browserKitRequest)
+    /**
+     * @return array<string, mixed>
+     */
+    protected function extractMultipartFormData(BrowserKitRequest $browserKitRequest): array
     {
         if (!in_array(strtoupper($browserKitRequest->getMethod()), ['POST', 'PUT', 'PATCH'])) {
             return [];
@@ -275,7 +285,10 @@ protected function extractMultipartFormData(BrowserKitRequest $browserKitRequest
         return $parts;
     }
 
-    protected function formatMultipart($parts, string $key, $value)
+    /**
+     * @return array<string, mixed>
+     */
+    protected function formatMultipart(mixed $parts, string $key, mixed $value): array
     {
         if (is_array($value)) {
             foreach ($value as $subKey => $subValue) {
@@ -289,7 +302,11 @@ protected function formatMultipart($parts, string $key, $value)
         return $parts;
     }
 
-    protected function mapFiles($requestFiles, ?string $arrayName = ''): array
+    /**
+     * @param array<int, mixed> $requestFiles
+     * @return array<int, mixed>
+     */
+    protected function mapFiles(array $requestFiles, ?string $arrayName = ''): array
     {
         $files = [];
         foreach ($requestFiles as $name => $info) {
@@ -329,7 +346,7 @@ protected function mapFiles($requestFiles, ?string $arrayName = ''): array
         return $files;
     }
 
-    protected function extractCookies($host): GuzzleCookieJar
+    protected function extractCookies(string $host): GuzzleCookieJar
     {
         $jar = [];
         $cookies = $this->getCookieJar()->all();
@@ -345,7 +362,7 @@ protected function extractCookies($host): GuzzleCookieJar
         return new GuzzleCookieJar(false, $jar);
     }
 
-    public static function createHandler($handler): GuzzleHandlerStack
+    public static function createHandler(mixed $handler): GuzzleHandlerStack
     {
         if ($handler instanceof GuzzleHandlerStack) {
             return $handler;
@@ -370,6 +387,9 @@ public static function createHandler($handler): GuzzleHandlerStack
         return GuzzleHandlerStack::create();
     }
 
+    /**
+     * @param array<string, mixed> $config
+     */
     public function setAwsAuth(array $config): void
     {
         $this->awsCredentials = new AwsCredentials($config['key'], $config['secret']);

src/Codeception/Module/PhpBrowser.php

@@ -132,14 +132,14 @@ public function _initialize(): void
 
     public function _before(TestInterface $test): void
     {
-        if (!$this->client instanceof \Symfony\Component\BrowserKit\AbstractBrowser) {
+        if (!$this->client instanceof AbstractBrowser) {
             $this->client = new Guzzle();
         }
 
         $this->_prepareSession();
     }
 
-    public function _getUrl()
+    public function _getUrl(): string
     {
         return $this->config['url'];
     }
@@ -152,12 +152,14 @@ public function setHeader(string $name, string $value): void
         $this->haveHttpHeader($name, $value);
     }
 
-    public function amHttpAuthenticated($username, $password): void
+    public function amHttpAuthenticated(string $username, string $password): void
     {
-        $this->client->setAuth($username, $password);
+        if ($this->client instanceof Guzzle) {
+            $this->client->setAuth($username, $password);
+        }
     }
 
-    public function amOnUrl($url): void
+    public function amOnUrl(string $url): void
     {
         $host = Uri::retrieveHost($url);
         $config = $this->config;
@@ -172,7 +174,7 @@ public function amOnUrl($url): void
         $this->amOnPage($page);
     }
 
-    public function amOnSubdomain($subdomain): void
+    public function amOnSubdomain(string $subdomain): void
     {
         $url = $this->config['url'];
         $url = preg_replace('#(https?://)(.*\.)(.*\.)#', "$1$3", $url); // removing current subdomain
@@ -183,7 +185,7 @@ public function amOnSubdomain($subdomain): void
         $this->_reconfigure($config);
     }
 
-    protected function onReconfigure()
+    protected function onReconfigure(): void
     {
         $this->_prepareSession();
     }
@@ -203,18 +205,13 @@ protected function onReconfigure()
      *
      * It is not recommended to use this command on a regular basis.
      * If Codeception lacks important Guzzle Client methods, implement them and submit patches.
-     *
-     * @return mixed
      */
-    public function executeInGuzzle(Closure $function)
+    public function executeInGuzzle(Closure $function): mixed
     {
         return $function($this->guzzle);
     }
 
-    /**
-     * @return int|string
-     */
-    public function _getResponseCode()
+    public function _getResponseCode(): int|string
     {
         return $this->getResponseStatusCode();
     }
@@ -252,10 +249,15 @@ public function _prepareSession(): void
         $defaults['handler'] = $handlerStack;
         $this->guzzle = new GuzzleClient($defaults);
 
-        $this->client->setRefreshMaxInterval($this->config['refresh_max_interval']);
-        $this->client->setClient($this->guzzle);
+        if ($this->client instanceof Guzzle) {
+            $this->client->setRefreshMaxInterval($this->config['refresh_max_interval']);
+            $this->client->setClient($this->guzzle);
+        }
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function _backupSession(): array
     {
         return [
@@ -266,13 +268,19 @@ public function _backupSession(): array
         ];
     }
 
+    /**
+     * @param array<string, mixed> $session
+     */
     public function _loadSession($session): void
     {
         foreach ($session as $key => $val) {
             $this->$key = $val;
         }
     }
 
+    /**
+     * @param ?array<string, mixed> $session
+     */
     public function _closeSession($session = null): void
     {
         unset($session);