Update psalm verison + Psalm level 1 (#69)

* Update vimeo/psalm requirement from ^4.18 to ^5.3

Updates the requirements on [vimeo/psalm](https://github.com/vimeo/psalm) to permit the latest version.
- [Release notes](https://github.com/vimeo/psalm/releases)
- [Commits](vimeo/psalm@4.18...5.3.0)

---
updated-dependencies:
- dependency-name: vimeo/psalm
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <[email protected]>

* Update composer.json

* fix tests

* fix psalm bug

* level 1

* Apply fixes from StyleCI

* fix

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sergei Predvoditelev <[email protected]>
Co-authored-by: StyleCI Bot <[email protected]>

Author: 3 people

composer.json

@@ -44,7 +44,7 @@
         "rector/rector": "^0.15.10",
         "roave/infection-static-analysis-plugin": "^1.16",
         "spatie/phpunit-watcher": "^1.23",
-        "vimeo/psalm": "^4.18",
+        "vimeo/psalm": "^4.30|^5.6",
         "yiisoft/test-support": "^1.3"
     },
     "autoload": {

psalm.xml

@@ -1,6 +1,8 @@
 <?xml version="1.0"?>
 <psalm
-    errorLevel="2"
+    errorLevel="1"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"

src/Exception/ErrorException.php

@@ -83,8 +83,12 @@ public function getSolution(): ?string
     private function addXDebugTraceToFatalIfAvailable(): void
     {
         if ($this->isXdebugStackAvailable()) {
-            // XDebug trace can't be modified and used directly with PHP 7
-            // @see https://github.com/yiisoft/yii2/pull/11723
+            /**
+             * XDebug trace can't be modified and used directly with PHP 7
+             *
+             * @see https://github.com/yiisoft/yii2/pull/11723
+             * @psalm-var array<int,array>
+             */
             $xDebugTrace = array_slice(array_reverse(xdebug_get_function_stack()), 1, -1);
             $trace = [];
 
@@ -102,6 +106,7 @@ private function addXDebugTraceToFatalIfAvailable(): void
 
                 // XDebug has a different key name
                 if (isset($frame['params']) && !isset($frame['args'])) {
+                    /** @var mixed */
                     $frame['args'] = $frame['params'];
                 }
                 $trace[] = $frame;

src/Middleware/ErrorCatcher.php

@@ -37,6 +37,9 @@
  */
 final class ErrorCatcher implements MiddlewareInterface
 {
+    /**
+     * @psalm-var array<string,class-string<ThrowableRendererInterface>>
+     */
     private array $renderers = [
         'application/json' => JsonRenderer::class,
         'application/xml' => XmlRenderer::class,
@@ -146,6 +149,7 @@ private function generateErrorResponse(Throwable $t, ServerRequestInterface $req
     private function getRenderer(string $contentType): ?ThrowableRendererInterface
     {
         if (isset($this->renderers[$contentType])) {
+            /** @var ThrowableRendererInterface */
             return $this->container->get($this->renderers[$contentType]);
         }
 

src/Middleware/ExceptionResponder.php

@@ -73,6 +73,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
                     }
 
                     if (is_callable($responseHandler)) {
+                        /** @var ResponseInterface */
                         return $this->injector->invoke($responseHandler, ['exception' => $t]);
                     }
                 }

src/Renderer/HtmlRenderer.php

@@ -108,6 +108,14 @@ final class HtmlRenderer implements ThrowableRendererInterface
      * - maxSourceLines: int, maximum number of source code lines to be displayed. Defaults to 19.
      * - maxTraceLines: int, maximum number of trace source code lines to be displayed. Defaults to 13.
      * - traceHeaderLine: string, trace header line with placeholders to be be substituted. Defaults to null.
+     *
+     * @psalm-param array{
+     *   template?: string,
+     *   verboseTemplate?: string,
+     *   maxSourceLines?: int,
+     *   maxTraceLines?: int,
+     *   traceHeaderLine?: string,
+     * } $settings
      */
     public function __construct(array $settings = [])
     {
@@ -264,6 +272,9 @@ public function argumentsToString(array $args): string
         $count = 0;
         $isAssoc = $args !== array_values($args);
 
+        /**
+         * @var mixed $value
+         */
         foreach ($args as $key => $value) {
             $count++;
 
@@ -306,6 +317,8 @@ public function argumentsToString(array $args): string
             }
         }
 
+        /** @var string[] $args */
+
         ksort($args);
         return implode(', ', $args);
     }
@@ -423,6 +436,7 @@ private function renderTemplate(string $path, array $parameters): string
         }
 
         $renderer = function (): void {
+            /** @psalm-suppress MixedArgument */
             extract(func_get_arg(1), EXTR_OVERWRITE);
             require func_get_arg(0);
         };
@@ -524,6 +538,8 @@ private function groupVendorCallStackItems(array $items): array
             $groupedItems[$groupIndex][$index] = $item;
         }
 
+        /** @psalm-var array<int, array<int, string>> $groupedItems It's need for Psalm <=4.30 only. */
+
         return $groupedItems;
     }
 
@@ -571,6 +587,7 @@ private function getVendorPaths(): array
         $rootPath = dirname(__DIR__, 4);
 
         // If the error handler is installed as a vendor package.
+        /** @psalm-suppress InvalidLiteralArgument It is Psalm bug, {@see https://github.com/vimeo/psalm/issues/9196} */
         if (strlen($rootPath) > 6 && str_contains($rootPath, 'vendor')) {
             $this->vendorPaths = [$rootPath];
             return $this->vendorPaths;
@@ -579,6 +596,7 @@ private function getVendorPaths(): array
         // If the error handler is installed for development in `yiisoft/yii-dev-tool`.
         if (is_file("{$rootPath}/yii-dev") || is_file("{$rootPath}/yii-dev.bat")) {
             $vendorPaths = glob("{$rootPath}/dev/*/vendor");
+            /** @var string[] */
             $this->vendorPaths = empty($vendorPaths) ? [] : str_replace(['/', '\\'], DIRECTORY_SEPARATOR, $vendorPaths);
             return $this->vendorPaths;
         }

tests/Middleware/ErrorCatcherTest.php

@@ -84,7 +84,7 @@ public function testAddedRenderer(): void
     public function testThrownExceptionWithRendererIsNotImplementThrowableRendererInterface()
     {
         $this->expectException(InvalidArgumentException::class);
-        $this->expectErrorMessage(
+        $this->expectExceptionMessage(
             'Class "' . self::class . '" does not implement "' . ThrowableRendererInterface::class . '".',
         );
         $this
@@ -95,7 +95,7 @@ public function testThrownExceptionWithRendererIsNotImplementThrowableRendererIn
     public function testThrownExceptionWithInvalidContentType()
     {
         $this->expectException(InvalidArgumentException::class);
-        $this->expectErrorMessage('Invalid content type.');
+        $this->expectExceptionMessage('Invalid content type.');
         $this
             ->createErrorCatcher()
             ->withRenderer('test invalid content type', PlainTextRenderer::class);
@@ -197,7 +197,7 @@ public function testForceContentType(): void
     public function testForceContentTypeSetInvalidType(): void
     {
         $this->expectException(InvalidArgumentException::class);
-        $this->expectErrorMessage('The renderer for image/gif is not set.');
+        $this->expectExceptionMessage('The renderer for image/gif is not set.');
         $this
             ->createErrorCatcher()
             ->forceContentType('image/gif');