Make PHPStan happy

Author: Marick van Tuil

README.md

@@ -45,6 +45,7 @@ Add a new queue connection to `config/queue.php`
   'service_account_email' => env('CLOUD_TASKS_SERVICE_EMAIL', ''),
 
   'backoff' => 0,
+  'after_commit' => false,
 ],
 ```
 

composer.json

@@ -16,7 +16,6 @@
     "require-dev": {
         "orchestra/testbench": "^10.0",
         "thecodingmachine/phpstan-safe-rule": "^1.2",
-        "laravel/legacy-factories": "^1.3",
         "laravel/pint": "^1.13",
         "larastan/larastan": "^3.0"
     },
@@ -27,8 +26,7 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Tests\\": "tests/",
-            "Factories\\": "factories/"
+            "Tests\\": "tests/"
         }
     },
     "extra": {

phpstan.neon

@@ -5,3 +5,5 @@ parameters:
     paths:
         - src
     level: 9
+    ignoreErrors:
+        - "/dispatchAfterCommit with no type specified/"

src/CloudTasksApiFake.php

@@ -10,8 +10,17 @@
 
 class CloudTasksApiFake implements CloudTasksApiContract
 {
+    /**
+     * @var array<int, array{
+     *     queueName: string,
+     *     task: Task
+     * }>
+     */
     public array $createdTasks = [];
 
+    /**
+     * @var array<int, string>
+     */
     public array $deletedTasks = [];
 
     public function createTask(string $queueName, Task $task): Task

src/CloudTasksConnector.php

@@ -7,8 +7,25 @@
 use Google\Cloud\Tasks\V2\Client\CloudTasksClient;
 use Illuminate\Queue\Connectors\ConnectorInterface;
 
+/**
+ * @phpstan-type QueueConfig array{
+ *     driver: string,
+ *     project: string,
+ *     location: string,
+ *     queue: string,
+ *     app_engine?: bool,
+ *     app_engine_service?: string,
+ *     handler?: string,
+ *     service_account_email?: string,
+ *     backoff?: int,
+ *     after_commit?: bool
+ * }
+ */
 class CloudTasksConnector implements ConnectorInterface
 {
+    /**
+     * @param  QueueConfig  $config
+     */
     public function connect(array $config): CloudTasksQueue
     {
         return new CloudTasksQueue(

src/CloudTasksJob.php

@@ -14,18 +14,48 @@
 use Illuminate\Contracts\Queue\Job as JobContract;
 use Stackkit\LaravelGoogleCloudTasksQueue\Events\JobReleased;
 
+/**
+ * @phpstan-type JobShape array{
+ *      uuid: string,
+ *      displayName: string,
+ *      job: string,
+ *      maxTries: int,
+ *      maxExceptions: int|null,
+ *      failOnTimeout: bool,
+ *      backoff: int|null,
+ *      timeout: int|null,
+ *      retryUntil: int|null,
+ *      data: array{
+ *          commandName: string,
+ *          command: string
+ *      },
+ *      internal?: array{
+ *          attempts: int,
+ *          errored?: bool
+ *      }
+ *  }
+ * @phpstan-type JobBeforeDispatch object{
+ *     queue: ?string
+ * }&\stdClass
+ */
 class CloudTasksJob extends LaravelJob implements JobContract
 {
     protected $container;
 
     private CloudTasksQueue $driver;
 
+    /**
+     * @var JobShape
+     */
     public array $job;
 
     protected $connectionName;
 
     protected $queue;
 
+    /**
+     * @param  JobShape  $job
+     */
     public function __construct(
         Container $container,
         CloudTasksQueue $driver,
@@ -53,9 +83,9 @@ public function getRawBody(): string
         return json_encode($this->job);
     }
 
-    public function attempts(): ?int
+    public function attempts(): int
     {
-        return $this->job['internal']['attempts'];
+        return $this->job['internal']['attempts'] ?? 0;
     }
 
     public function setAttempts(int $attempts): void

src/CloudTasksQueue.php

@@ -5,6 +5,7 @@
 namespace Stackkit\LaravelGoogleCloudTasksQueue;
 
 use Closure;
+use Exception;
 use Illuminate\Support\Str;
 
 use function Safe\json_decode;
@@ -23,17 +24,34 @@
 use Illuminate\Contracts\Queue\Queue as QueueContract;
 use Stackkit\LaravelGoogleCloudTasksQueue\Events\TaskCreated;
 
+/**
+ * @phpstan-import-type QueueConfig from CloudTasksConnector
+ * @phpstan-import-type JobShape from CloudTasksJob
+ * @phpstan-import-type JobBeforeDispatch from CloudTasksJob
+ *
+ * @phpstan-type JobOptions array{
+ *     job?: Closure|string|object,
+ *     delay?: ?int
+ * }
+ */
 class CloudTasksQueue extends LaravelQueue implements QueueContract
 {
-    private static ?Closure $handlerUrlCallback = null;
+    protected static ?Closure $handlerUrlCallback = null;
 
-    private static ?Closure $taskHeadersCallback = null;
+    protected static ?Closure $taskHeadersCallback = null;
 
     /** @var (Closure(IncomingTask): WorkerOptions)|null */
-    private static ?Closure $workerOptionsCallback = null;
+    protected static ?Closure $workerOptionsCallback = null;
 
-    public function __construct(public array $config, public CloudTasksClient $client, public $dispatchAfterCommit = false)
-    {
+    /**
+     * @param  QueueConfig  $config
+     */
+    public function __construct(
+        public array $config,
+        public CloudTasksClient $client,
+        // @phpstan-ignore-next-line
+        public $dispatchAfterCommit = false,
+    ) {
         //
     }
 
@@ -92,15 +110,20 @@ public function size($queue = null): int
     /**
      * Push a new job onto the queue.
      *
-     * @param  string|object  $job
+     * @param  string|Closure|JobBeforeDispatch  $job
      * @param  mixed  $data
      * @param  string|null  $queue
-     * @return void
+     * @return mixed
      */
     public function push($job, $data = '', $queue = null)
     {
-        if (! ($job instanceof Closure)) {
-            $job->queue = $queue ?? $job->queue ?? $this->config['queue'];
+        if (! $queue) {
+            $queue = $this->getQueueForJob($job);
+        }
+
+        if (is_object($job) && ! $job instanceof Closure) {
+            /** @var JobBeforeDispatch $job */
+            $job->queue = $queue;
         }
 
         return $this->enqueueUsing(
@@ -119,6 +142,7 @@ function ($payload, $queue) use ($job) {
      *
      * @param  string  $payload
      * @param  string|null  $queue
+     * @param  JobOptions  $options
      * @return string
      */
     public function pushRaw($payload, $queue = null, array $options = [])
@@ -133,13 +157,18 @@ public function pushRaw($payload, $queue = null, array $options = [])
      * Push a new job onto the queue after a delay.
      *
      * @param  \DateTimeInterface|\DateInterval|int  $delay
-     * @param  string|object  $job
+     * @param  Closure|string|JobBeforeDispatch  $job
      * @param  mixed  $data
      * @param  string|null  $queue
-     * @return void
+     * @return mixed
      */
     public function later($delay, $job, $data = '', $queue = null)
     {
+        // Laravel pls fix your typehints
+        if (! $queue) {
+            $queue = $this->getQueueForJob($job);
+        }
+
         return $this->enqueueUsing(
             $job,
             $this->createPayload($job, $queue, $data),
@@ -157,7 +186,7 @@ function ($payload, $queue, $delay) use ($job) {
      * @param  string|null  $queue
      * @param  string  $payload
      * @param  \DateTimeInterface|\DateInterval|int  $delay
-     * @param  string|object  $job
+     * @param  Closure|string|object|null  $job
      * @return string
      */
     protected function pushToCloudTasks($queue, $payload, $delay, mixed $job)
@@ -166,6 +195,7 @@ protected function pushToCloudTasks($queue, $payload, $delay, mixed $job)
 
         $payload = (array) json_decode($payload, true);
 
+        /** @var JobShape $payload */
         $task = tap(new Task)->setName($this->taskName($queue, $payload['displayName']));
 
         $payload = $this->enrichPayloadWithAttempts($payload);
@@ -200,33 +230,43 @@ private function taskName(string $queueName, string $displayName): string
         );
     }
 
-    private function enrichPayloadWithAttempts(
-        array $payload,
-    ): array {
+    /**
+     * @param  JobShape  $payload
+     * @return JobShape
+     */
+    private function enrichPayloadWithAttempts(array $payload): array
+    {
         $payload['internal'] = [
             'attempts' => $payload['internal']['attempts'] ?? 0,
         ];
 
         return $payload;
     }
 
-    /** @param string|object $job */
-    public function addPayloadToTask(array $payload, Task $task, mixed $job): Task
+    /**
+     * @param  Closure|string|object|null  $job
+     * @param  JobShape  $payload
+     */
+    public function addPayloadToTask(array $payload, Task $task, $job): Task
     {
         $headers = $this->headers($payload);
 
         if (! empty($this->config['app_engine'])) {
             $path = \Safe\parse_url(route('cloud-tasks.handle-task'), PHP_URL_PATH);
 
+            if (! is_string($path)) {
+                throw new Exception('Something went wrong parsing the route.');
+            }
+
             $appEngineRequest = new AppEngineHttpRequest;
             $appEngineRequest->setRelativeUri($path);
             $appEngineRequest->setHttpMethod(HttpMethod::POST);
             $appEngineRequest->setBody(json_encode($payload));
             $appEngineRequest->setHeaders($headers);
 
-            if (! empty($service = $this->config['app_engine_service'])) {
+            if (! empty($this->config['app_engine_service'])) {
                 $routing = new AppEngineRouting;
-                $routing->setService($service);
+                $routing->setService($this->config['app_engine_service']);
                 $appEngineRequest->setAppEngineRouting($routing);
             }
 
@@ -239,7 +279,7 @@ public function addPayloadToTask(array $payload, Task $task, mixed $job): Task
             $httpRequest->setHeaders($headers);
 
             $token = new OidcToken;
-            $token->setServiceAccountEmail($this->config['service_account_email']);
+            $token->setServiceAccountEmail($this->config['service_account_email'] ?? '');
             $httpRequest->setOidcToken($token);
             $task->setHttpRequest($httpRequest);
         }
@@ -267,7 +307,9 @@ public function release(CloudTasksJob $job, int $delay = 0): void
         );
     }
 
-    /** @param string|object $job */
+    /**
+     * @param  Closure|string|object|null  $job
+     */
     public function getHandler(mixed $job): string
     {
         if (static::$handlerUrlCallback) {
@@ -280,11 +322,11 @@ public function getHandler(mixed $job): string
 
         $handler = rtrim($this->config['handler'], '/');
 
-        if (str_ends_with($handler, '/'.config('cloud-tasks.uri'))) {
+        if (str_ends_with($handler, '/'.config()->string('cloud-tasks.uri'))) {
             return $handler;
         }
 
-        return $handler.'/'.config('cloud-tasks.uri');
+        return $handler.'/'.config()->string('cloud-tasks.uri');
     }
 
     /**
@@ -299,4 +341,19 @@ private function headers(mixed $payload): array
 
         return (static::$taskHeadersCallback)($payload);
     }
+
+    /**
+     * @param  Closure|string|JobBeforeDispatch  $job
+     */
+    private function getQueueForJob(mixed $job): string
+    {
+        if (is_object($job) && ! $job instanceof Closure) {
+            /** @var JobBeforeDispatch $job */
+            if (! empty($job->queue)) {
+                return $job->queue;
+            }
+        }
+
+        return $this->config['queue'];
+    }
 }