ci: remove psalm and replace annotations with phpstan (#2031)

Author: Litarnus

.github/workflows/ci.yml

@@ -73,7 +73,7 @@ jobs:
 
       # These dependencies are not used running the tests but can cause deprecation warnings so we remove them before running the tests
       - name: Remove unused dependencies
-        run: composer remove vimeo/psalm phpstan/phpstan friendsofphp/php-cs-fixer  --dev --no-interaction --no-update
+        run: composer remove phpstan/phpstan friendsofphp/php-cs-fixer --dev --no-interaction --no-update
 
       - name: Remove RoadRunner dependencies on unsupported PHP versions
         if: ${{ matrix.os == 'windows-latest' || matrix.php.version == '7.2' || matrix.php.version == '7.3' || matrix.php.version == '7.4' || matrix.php.version == '8.0' }}

.github/workflows/static-analysis.yaml

@@ -47,20 +47,3 @@ jobs:
       - name: Run script
         run: vendor/bin/phpstan analyse
 
-  psalm:
-    name: Psalm
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v6
-
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: '8.3'
-
-      - name: Install dependencies
-        run: composer update --no-progress --no-interaction --prefer-dist
-
-      - name: Run script
-        run: vendor/bin/psalm

composer.json

@@ -41,8 +41,7 @@
         "phpstan/phpstan": "^1.3",
         "phpunit/phpunit": "^8.5.52|^9.6.34",
         "spiral/roadrunner-http": "^3.6",
-        "spiral/roadrunner-worker": "^3.6",
-        "vimeo/psalm": "^4.17"
+        "spiral/roadrunner-worker": "^3.6"
     },
     "suggest": {
         "monolog/monolog": "Allow sending log messages to Sentry by using the included Monolog handler."
@@ -67,14 +66,12 @@
         "check": [
             "@cs-check",
             "@phpstan",
-            "@psalm",
             "@tests"
         ],
         "tests": "vendor/bin/phpunit --verbose",
         "cs-check": "vendor/bin/php-cs-fixer fix --verbose --diff --dry-run",
         "cs-fix": "vendor/bin/php-cs-fixer fix --verbose --diff",
-        "phpstan": "vendor/bin/phpstan analyse",
-        "psalm": "vendor/bin/psalm"
+        "phpstan": "vendor/bin/phpstan analyse"
     },
     "config": {
         "sort-packages": true

psalm-baseline.xml

@@ -323,7 +323,7 @@ public function withTimestamp(float $timestamp): self
      *
      * @param array $data Data used to populate the breadcrumb
      *
-     * @psalm-param array{
+     * @phpstan-param array{
      *     level: string,
      *     type?: string,
      *     category: string,

psalm.xml.dist

@@ -58,7 +58,7 @@ class Client implements ClientInterface
     /**
      * @var array<string, IntegrationInterface> The stack of integrations
      *
-     * @psalm-var array<class-string<IntegrationInterface>, IntegrationInterface>
+     * @phpstan-var array<class-string<IntegrationInterface>, IntegrationInterface>
      */
     private $integrations;
 
@@ -224,11 +224,11 @@ public function captureLastError(?Scope $scope = null, ?EventHint $hint = null):
     /**
      * {@inheritdoc}
      *
-     * @psalm-template T of IntegrationInterface
+     * @phpstan-template T of IntegrationInterface
      */
     public function getIntegration(string $className): ?IntegrationInterface
     {
-        /** @psalm-var T|null */
+        /** @phpstan-var T|null */
         return $this->integrations[$className] ?? null;
     }
 

src/Breadcrumb.php

@@ -61,11 +61,11 @@ public function captureEvent(Event $event, ?EventHint $hint = null, ?Scope $scop
      *
      * @param string $className The FQCN of the integration
      *
-     * @psalm-template T of IntegrationInterface
+     * @phpstan-template T of IntegrationInterface
      *
-     * @psalm-param class-string<T> $className
+     * @phpstan-param class-string<T> $className
      *
-     * @psalm-return T|null
+     * @phpstan-return T|null
      */
     public function getIntegration(string $className): ?IntegrationInterface;
 

src/Client.php

@@ -13,7 +13,7 @@
  * error handler more than once is not supported and will lead to nasty
  * problems. The code is based on the Symfony ErrorHandler component.
  *
- * @psalm-import-type StacktraceFrame from FrameBuilder
+ * @phpstan-import-type StacktraceFrame from FrameBuilder
  */
 final class ErrorHandler
 {
@@ -44,21 +44,21 @@ final class ErrorHandler
     /**
      * @var callable[] List of listeners that will act on each captured error
      *
-     * @psalm-var (callable(\ErrorException): void)[]
+     * @phpstan-var (callable(\ErrorException): void)[]
      */
     private $errorListeners = [];
 
     /**
      * @var callable[] List of listeners that will act of each captured fatal error
      *
-     * @psalm-var (callable(FatalErrorException): void)[]
+     * @phpstan-var (callable(FatalErrorException): void)[]
      */
     private $fatalErrorListeners = [];
 
     /**
      * @var callable[] List of listeners that will act on each captured exception
      *
-     * @psalm-var (callable(\Throwable): void)[]
+     * @phpstan-var (callable(\Throwable): void)[]
      */
     private $exceptionListeners = [];
 
@@ -76,7 +76,7 @@ final class ErrorHandler
     /**
      * @var callable|null The previous exception handler, if any
      *
-     * @psalm-var null|callable(\Throwable): void
+     * @phpstan-var null|callable(\Throwable): void
      */
     private $previousExceptionHandler;
 
@@ -250,7 +250,7 @@ public static function registerOnceExceptionHandler(): self
      *                           and that must accept a single argument
      *                           of type \ErrorException
      *
-     * @psalm-param callable(\ErrorException): void $listener
+     * @phpstan-param callable(\ErrorException): void $listener
      */
     public function addErrorHandlerListener(callable $listener): void
     {
@@ -265,7 +265,7 @@ public function addErrorHandlerListener(callable $listener): void
      *                           and that must accept a single argument
      *                           of type \Sentry\Exception\FatalErrorException
      *
-     * @psalm-param callable(FatalErrorException): void $listener
+     * @phpstan-param callable(FatalErrorException): void $listener
      */
     public function addFatalErrorHandlerListener(callable $listener): void
     {
@@ -280,7 +280,7 @@ public function addFatalErrorHandlerListener(callable $listener): void
      *                           and that must accept a single argument
      *                           of type \Throwable
      *
-     * @psalm-param callable(\Throwable): void $listener
+     * @phpstan-param callable(\Throwable): void $listener
      */
     public function addExceptionHandlerListener(callable $listener): void
     {
@@ -460,7 +460,7 @@ private function handleException(\Throwable $exception): void
      * @param string                           $file      The filename the backtrace was raised in
      * @param int                              $line      The line number the backtrace was raised at
      *
-     * @psalm-param list<StacktraceFrame> $backtrace
+     * @phpstan-param list<StacktraceFrame> $backtrace
      *
      * @return array<int, mixed>
      */

src/ClientInterface.php

@@ -908,13 +908,13 @@ public function setSdkMetadata(string $name, $data): self
     /**
      * Gets the SDK metadata.
      *
-     * @psalm-template T of string|null
+     * @phpstan-template T of string|null
      *
-     * @psalm-param T $name
+     * @phpstan-param T $name
      *
      * @return mixed
      *
-     * @psalm-return (T is string ? mixed : array<string, mixed>|null)
+     * @phpstan-return (T is string ? mixed : array<string, mixed>|null)
      */
     public function getSdkMetadata(?string $name = null)
     {