Setup psalm level to 2 (#504)

.gitattributes

@@ -12,3 +12,4 @@
 /phpunit.xml.dist   export-ignore
 /support            export-ignore
 /psalm.xml          export-ignore
+/stubs              export-ignore

composer.json

@@ -31,8 +31,8 @@
         "enqueue/amqp-bunny": "^0.10.0",
         "enqueue/amqp-ext": "^0.10.8",
         "enqueue/stomp": "^0.10.0",
-        "pda/pheanstalk": "^v5.0.0",
-        "aws/aws-sdk-php": ">=2.4",
+        "pda/pheanstalk": "^5.0.0",
+        "aws/aws-sdk-php": "3.285.0",
         "vimeo/psalm": "^5.10.0"
     },
     "suggest": {

phpunit.xml.dist

@@ -10,17 +10,21 @@
     displayDetailsOnSkippedTests="true"
     executionOrder="random"
 >
-  <testsuites>
-    <testsuite name="Yii2-Queue">
-      <directory>./tests</directory>
-      <exclude>./tests/app</exclude>
-      <exclude>./tests/docker</exclude>
-      <exclude>./tests/runtime</exclude>
-    </testsuite>
-  </testsuites>
-  <source>
-    <include>
-      <directory>./src</directory>
-    </include>
-  </source>
+    <testsuites>
+        <testsuite name="Yii2-Queue">
+            <directory>./tests</directory>
+            <exclude>./tests/app</exclude>
+            <exclude>./tests/docker</exclude>
+            <exclude>./tests/runtime</exclude>
+        </testsuite>
+    </testsuites>
+    <source>
+        <include>
+            <directory>./src</directory>
+        </include>
+        <exclude>
+            <directory>./src/debug</directory>
+            <directory>./src/gii</directory>
+        </exclude>
+    </source>
 </phpunit>

psalm.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <psalm
-    errorLevel="4"
+    errorLevel="2"
     findUnusedBaselineEntry="true"
     findUnusedCode="false"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -20,4 +20,8 @@
     <extraFiles>
         <directory name="vendor"/>
     </extraFiles>
+    <stubs>
+        <file name="stubs/psalm/BaseYii.php" preloadClasses="true"/>
+        <file name="support/ide-helper.php"/>
+    </stubs>
 </psalm>

src/ExecEvent.php

@@ -10,6 +10,8 @@
 
 namespace yii\queue;
 
+use Throwable;
+
 /**
  * Exec Event.
  *
@@ -23,23 +25,23 @@ class ExecEvent extends JobEvent
      * @see Queue::EVENT_AFTER_EXEC
      * @see Queue::EVENT_AFTER_ERROR
      */
-    public int $attempt;
+    public int $attempt = 0;
     /**
      * @var mixed result of a job execution in case job is done.
      * @see Queue::EVENT_AFTER_EXEC
      * @since 2.1.1
      */
-    public $result;
+    public mixed $result = null;
     /**
-     * @var null|\Exception|\Throwable
+     * @var null|Throwable
      * @see Queue::EVENT_AFTER_ERROR
      * @since 2.1.1
      */
-    public $error;
+    public ?Throwable $error = null;
     /**
-     * @var null|bool
+     * @var bool
      * @see Queue::EVENT_AFTER_ERROR
      * @since 2.1.1
      */
-    public $retry;
+    public bool $retry = true;
 }

src/InvalidJobException.php

@@ -30,10 +30,10 @@ class InvalidJobException extends Exception
      * @param Throwable|null $previous
      */
     public function __construct(
-        private string $serialized,
-        string $message = '',
-        int $code = 0,
-        Throwable $previous = null
+        private readonly string $serialized,
+        string                  $message = '',
+        int                     $code = 0,
+        Throwable               $previous = null
     )
     {
         parent::__construct($message, $code, $previous);

src/JobEvent.php

@@ -21,20 +21,25 @@
 abstract class JobEvent extends Event
 {
     /**
-     * @var Queue
      * @inheritdoc
      */
+    public $name = '';
+    /**
+     * @var Queue|null|object
+     * @inheritdoc
+     * @psalm-suppress PropertyNotSetInConstructor
+     */
     public $sender;
     /**
      * @var int|string|null unique id of a job
      */
-    public string|int|null $id;
+    public string|int|null $id = null;
     /**
      * @var Closure|JobInterface|null|mixed
      */
     public mixed $job;
     /**
      * @var int time to reserve in seconds of the job
      */
-    public int $ttr;
+    public int $ttr = 0;
 }

src/LogBehavior.php

@@ -12,6 +12,7 @@
 
 use Yii;
 use yii\base\Behavior;
+use yii\base\Component;
 
 /**
  * Log Behavior.
@@ -21,7 +22,7 @@
 class LogBehavior extends Behavior
 {
     /**
-     * @var Queue
+     * @var Queue|null|Component
      * @inheritdoc
      */
     public $owner;
@@ -138,7 +139,7 @@ protected function getExecTitle(ExecEvent $event): string
     {
         $title = $this->getJobTitle($event);
         $extra = "attempt: $event->attempt";
-        if ($pid = $event->sender->getWorkerPid()) {
+        if ($pid = $event->sender?->getWorkerPid()) {
             $extra .= ", PID: $pid";
         }
         return "$title ($extra)";

src/PushEvent.php

@@ -20,9 +20,9 @@ class PushEvent extends JobEvent
     /**
      * @var int
      */
-    public int $delay;
+    public int $delay = 0;
     /**
      * @var int|string|null
      */
-    public string|int|null $priority;
+    public string|int|null $priority = null;
 }

src/Queue.php

@@ -10,6 +10,7 @@
 
 namespace yii\queue;
 
+use Throwable;
 use yii\base\Component;
 use yii\base\InvalidArgumentException;
 use yii\base\InvalidConfigException;
@@ -88,8 +89,6 @@ public function init(): void
     {
         parent::init();
 
-        $this->serializer = Instance::ensure($this->serializer, SerializerInterface::class);
-
         if ($this->ttr <= 0) {
             throw new InvalidConfigException('Default TTR must be greater that zero.');
         }
@@ -141,7 +140,7 @@ public function priority(int|string|null $value): static
      * @param JobInterface|mixed $job
      * @return int|string|null id of a job message
      */
-    public function push($job): int|string|null
+    public function push(mixed $job): int|string|null
     {
         $event = new PushEvent([
             'job' => $job,
@@ -174,7 +173,7 @@ public function push($job): int|string|null
             throw new InvalidArgumentException('Job delay must be positive.');
         }
 
-        $message = $this->serializer->serialize($event->job);
+        $message = $this->getSerializer()->serialize($event->job);
         $event->id = $this->pushMessage($message, $event->ttr, $event->delay, $event->priority);
         $this->trigger(self::EVENT_AFTER_PUSH, $event);
 
@@ -225,8 +224,9 @@ protected function handleMessage(int|string $id, string $message, int $ttr, int
             return $this->handleError($event);
         }
         try {
-            $event->result = $event->job->execute($this);
-        } catch (\Exception|\Throwable $error) {
+            /** @psalm-suppress PossiblyUndefinedMethod */
+            $event->result = $event->job?->execute($this);
+        } catch (Throwable $error) {
             $event->error = $error;
             return $this->handleError($event);
         }
@@ -243,7 +243,7 @@ protected function handleMessage(int|string $id, string $message, int $ttr, int
     public function unserializeMessage(string $serialized): array
     {
         try {
-            $job = $this->serializer->unserialize($serialized);
+            $job = $this->getSerializer()->unserialize($serialized);
         } catch (\Exception $e) {
             return [null, new InvalidJobException($serialized, $e->getMessage(), 0, $e)];
         }
@@ -307,4 +307,10 @@ public function isDone(int|string $id): bool
      * @return int status code
      */
     abstract public function status(int|string $id): int;
+
+    private function getSerializer(): SerializerInterface
+    {
+        /** @psalm-var SerializerInterface */
+        return Instance::ensure($this->serializer, SerializerInterface::class);
+    }
 }

src/RetryableJobInterface.php

@@ -10,7 +10,6 @@
 
 namespace yii\queue;
 
-use Exception;
 use Throwable;
 
 /**
@@ -27,8 +26,8 @@ public function getTtr(): int;
 
     /**
      * @param int $attempt number
-     * @param Exception|Throwable $error from last execute of the job
+     * @param Throwable|null $error from last execute of the job
      * @return bool
      */
-    public function canRetry(int $attempt, $error): bool;
+    public function canRetry(int $attempt, ?Throwable $error): bool;
 }

src/cli/Action.php

@@ -26,7 +26,7 @@ abstract class Action extends BaseAction
      */
     public Queue $queue;
     /**
-     * @var Command|ConsoleController
+     * @inheritdoc
      */
     public $controller;
 

src/cli/Command.php

@@ -124,8 +124,9 @@ public function beforeAction($action): bool
             if ($this->phpBinary === null) {
                 $this->phpBinary = PHP_BINARY;
             }
-            $this->queue->messageHandler = function ($id, $message, $ttr, $attempt) {
-                return $this->handleMessage($id, $message, (int)$ttr, (int)$attempt);
+            /** @psalm-suppress MissingClosureReturnType */
+            $this->queue->messageHandler = function (int|string|null $id, string $message, int $ttr, int $attempt) {
+                return $this->handleMessage($id, $message, $ttr, $attempt);
             };
         }
 
@@ -136,14 +137,14 @@ public function beforeAction($action): bool
      * Executes a job.
      * The command is internal, and used to isolate a job execution. Manual usage is not provided.
      *
-     * @param string|null $id of a message
+     * @param string $id of a message
      * @param int $ttr time to reserve
      * @param int $attempt number
      * @param int $pid of a worker
      * @return int exit code
      * @internal It is used with isolate mode.
      */
-    public function actionExec(?string $id, int $ttr, int $attempt, int $pid): int
+    public function actionExec(string $id, int $ttr, int $attempt, int $pid): int
     {
         if ($this->queue->execute($id, file_get_contents('php://stdin'), $ttr, $attempt, $pid ?: null)) {
             return self::EXEC_DONE;
@@ -164,6 +165,7 @@ public function actionExec(?string $id, int $ttr, int $attempt, int $pid): int
     protected function handleMessage(int|string|null $id, string $message, ?int $ttr, int $attempt): bool
     {
         // Child process command: php yii queue/exec "id" "ttr" "attempt" "pid"
+        /** @psalm-suppress PossiblyUndefinedArrayOffset */
         $cmd = [
             $this->phpBinary,
             $_SERVER['SCRIPT_FILENAME'],
@@ -185,7 +187,7 @@ protected function handleMessage(int|string|null $id, string $message, ?int $ttr
 
         $process = new Process($cmd, null, null, $message, $ttr);
         try {
-            $result = $process->run(function ($type, $buffer) {
+            $result = $process->run(function (string $type, string $buffer) {
                 if ($type === Process::ERR) {
                     $this->stderr($buffer);
                 } else {

src/cli/Queue.php

@@ -70,7 +70,6 @@ abstract class Queue extends BaseQueue implements BootstrapInterface
      */
     protected function getCommandId(): string
     {
-        /** @psalm-suppress UndefinedClass */
         foreach (Yii::$app->getComponents(false) as $id => $component) {
             if ($component === $this) {
                 return Inflector::camel2id($id);
@@ -103,7 +102,6 @@ protected function runWorker(callable $handler): ?int
     {
         $this->_workerPid = getmypid();
         /** @var LoopInterface $loop */
-        /** @psalm-suppress UndefinedClass */
         $loop = Yii::createObject($this->loopConfig, [$this]);
 
         $event = new WorkerEvent(['loop' => $loop]);