Add Larastan and fix its issues

Author: marickvantuil

composer.json

@@ -10,10 +10,13 @@
     "require": {
         "ext-json": "*",
         "phpseclib/phpseclib": "~2.0",
-        "google/cloud-tasks": "^1.10"
+        "google/cloud-tasks": "^1.10",
+        "thecodingmachine/safe": "^2.1"
     },
     "require-dev": {
-        "orchestra/testbench": "^4.0 || ^5.0 || ^6.0 || ^7.0"
+        "orchestra/testbench": "^4.0 || ^5.0 || ^6.0 || ^7.0",
+        "nunomaduro/larastan": "^1.0 || ^2.0",
+        "thecodingmachine/phpstan-safe-rule": "^1.2"
     },
     "autoload": {
         "psr-4": {
@@ -22,7 +25,8 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Tests\\": "tests/"
+            "Tests\\": "tests/",
+            "Factories\\": "factories/"
         }
     },
     "extra": {

factories/StackkitCloudTaskFactory.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Support\Str;
+use Stackkit\LaravelGoogleCloudTasksQueue\StackkitCloudTask;
+
+class StackkitCloudTaskFactory extends Factory
+{
+    protected $model = StackkitCloudTask::class;
+
+    public function definition()
+    {
+        return [
+            'status' => 'pending',
+            'queue' => 'barbequeue',
+            'task_uuid' => (string) Str::uuid(),
+            'name' => 'SimpleJob',
+            'metadata' => '{}',
+            'payload' => '{}',
+        ];
+    }
+}

phpstan.neon

@@ -0,0 +1,10 @@
+includes:
+    - ./vendor/nunomaduro/larastan/extension.neon
+    - ./vendor/thecodingmachine/phpstan-safe-rule/phpstan-safe-rule.neon
+parameters:
+    paths:
+        - src
+    level: 9
+    checkMissingIterableValueType: false
+    ignoreErrors:
+        - '/Cannot call method when\(\) on mixed/'

src/Authenticate.php

@@ -2,10 +2,17 @@
 
 namespace Stackkit\LaravelGoogleCloudTasksQueue;
 
+use Closure;
+use Illuminate\Http\Request;
+use Symfony\Component\HttpFoundation\Response;
+
 class Authenticate
 {
-    public function handle($request, $next)
+    /**
+     * @return Response|never
+     */
+    public function handle(Request $request, Closure $next)
     {
         return CloudTasks::check($request) ? $next($request) : abort(403);
     }
-}
+}

src/CloudTasks.php

@@ -4,7 +4,7 @@
 
 use Closure;
 
-class CloudTasks
+final class CloudTasks
 {
     /**
      * The callback that should be used to authenticate Cloud Tasks users.
@@ -34,8 +34,6 @@ public static function auth(Closure $callback)
      */
     public static function check($request)
     {
-        return (static::$authUsing ?: function () {
-            return app()->environment('local');
-        })($request);
+        return (static::$authUsing)($request);
     }
-}
+}

src/CloudTasksApiConcrete.php

@@ -4,10 +4,13 @@
 
 namespace Stackkit\LaravelGoogleCloudTasksQueue;
 
+use Exception;
 use Google\Cloud\Tasks\V2\Attempt;
 use Google\Cloud\Tasks\V2\CloudTasksClient;
 use Google\Cloud\Tasks\V2\RetryConfig;
 use Google\Cloud\Tasks\V2\Task;
+use Google\Protobuf\Duration;
+use Google\Protobuf\Timestamp;
 
 class CloudTasksApiConcrete implements CloudTasksApiContract
 {
@@ -23,7 +26,13 @@ public function __construct(CloudTasksClient $client)
 
     public function getRetryConfig(string $queueName): RetryConfig
     {
-        return $this->client->getQueue($queueName)->getRetryConfig();
+        $retryConfig = $this->client->getQueue($queueName)->getRetryConfig();
+
+        if (! $retryConfig instanceof RetryConfig) {
+            throw new Exception('Queue does not have a retry config.');
+        }
+
+        return $retryConfig;
     }
 
     public function createTask(string $queueName, Task $task): Task
@@ -41,7 +50,6 @@ public function getTask(string $taskName): Task
         return $this->client->getTask($taskName);
     }
 
-
     public function getRetryUntilTimestamp(string $taskName): ?int
     {
         $task = $this->getTask($taskName);
@@ -56,13 +64,16 @@ public function getRetryUntilTimestamp(string $taskName): ?int
 
         $retryConfig = $this->getRetryConfig($queueName);
 
-        if (! $retryConfig->hasMaxRetryDuration()) {
+        $maxRetryDuration = $retryConfig->getMaxRetryDuration();
+        $dispatchTime = $attempt->getDispatchTime();
+
+        if (! $maxRetryDuration instanceof Duration || ! $dispatchTime instanceof Timestamp) {
             return null;
         }
 
-        $maxDurationInSeconds = $retryConfig->getMaxRetryDuration()->getSeconds();
+        $maxDurationInSeconds = (int) $maxRetryDuration->getSeconds();
 
-        $firstAttemptTimestamp = $attempt->getDispatchTime()->toDateTime()->getTimestamp();
+        $firstAttemptTimestamp = $dispatchTime->toDateTime()->getTimestamp();
 
         return $firstAttemptTimestamp + $maxDurationInSeconds;
     }

src/CloudTasksApiController.php

@@ -5,12 +5,14 @@
 use Exception;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Support\Carbon;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
+use Stackkit\LaravelGoogleCloudTasksQueue\Entities\StatRow;
 use const STR_PAD_LEFT;
 
 class CloudTasksApiController
 {
-    public function dashboard()
+    public function dashboard(): array
     {
         $dbDriver = config('database.connections.' . config('database.default') . '.driver');
 
@@ -29,6 +31,9 @@ public function dashboard()
             ],
         ][$dbDriver];
 
+        /**
+         * @var array<StatRow> $stats
+         */
         $stats = DB::table((new StackkitCloudTask())->getTable())
             ->where('created_at', '>=', now()->utc()->startOfDay())
             ->select(
@@ -52,6 +57,7 @@ public function dashboard()
                 ]
             )
             ->get()
+            ->map(fn($row) => StatRow::createFromObject($row))
             ->toArray();
 
         $response = [
@@ -98,6 +104,9 @@ public function dashboard()
         return $response;
     }
 
+    /**
+     * @return Collection<int, StackkitCloudTask>
+     */
     public function tasks()
     {
         Carbon::setTestNowAndTimezone(now()->utc());
@@ -112,12 +121,12 @@ public function tasks()
                 [$hour, $minute] = explode(':', request('time'));
 
                 return $builder
-                    ->where('created_at', '>=', now()->setTime($hour, $minute, 0))
-                    ->where('created_at', '<=', now()->setTime($hour, $minute, 59));
+                    ->where('created_at', '>=', now()->setTime((int) $hour, (int) $minute, 0))
+                    ->where('created_at', '<=', now()->setTime((int) $hour, (int) $minute, 59));
             })
             ->when(request('hour'), function (Builder $builder, $hour) {
-                return $builder->where('created_at', '>=', now()->setTime($hour, 0, 0))
-                    ->where('created_at', '<=', now()->setTime($hour, 59, 59));
+                return $builder->where('created_at', '>=', now()->setTime((int) $hour, 0, 0))
+                    ->where('created_at', '<=', now()->setTime((int) $hour, 59, 59));
             })
             ->when(request('queue'), function (Builder $builder, $queue) {
                 return $builder->where('queue', $queue);
@@ -130,26 +139,23 @@ public function tasks()
 
         $maxId = $tasks->max('id');
 
-        return $tasks->map(function (StackkitCloudTask $task) use ($tasks, $maxId)
+        return $tasks->map(function (StackkitCloudTask $task) use ($maxId)
         {
-                return [
-                    'uuid' => $task->task_uuid,
-                    'id' => str_pad($task->id, strlen($maxId), 0, STR_PAD_LEFT),
-                    'name' => $task->name,
-                    'status' => $task->status,
-                    'attempts' => $task->getNumberOfAttempts(),
-                    'created' => $task->created_at->diffForHumans(),
-                    'queue' => $task->queue,
-                ];
-            });
+            return [
+                'uuid' => $task->task_uuid,
+                'id' => str_pad((string) $task->id, strlen($maxId), '0', STR_PAD_LEFT),
+                'name' => $task->name,
+                'status' => $task->status,
+                'attempts' => $task->getNumberOfAttempts(),
+                'created' => $task->created_at ? $task->created_at->diffForHumans() : null,
+                'queue' => $task->queue,
+            ];
+        });
     }
 
-    public function task($uuid)
+    public function task(string $uuid): array
     {
-        /**
-         * @var StackkitCloudTask $task
-         */
-        $task = StackkitCloudTask::whereTaskUuid($uuid)->firstOrFail();
+        $task = StackkitCloudTask::findByUuid($uuid);
 
         return [
             'id' => $task->id,
@@ -160,4 +166,4 @@ public function task($uuid)
             'exception' => $task->getMetadata()['exception'] ?? null,
         ];
     }
-}
+}

src/CloudTasksJob.php

@@ -2,33 +2,34 @@
 
 namespace Stackkit\LaravelGoogleCloudTasksQueue;
 
-use Google\Cloud\Tasks\V2\CloudTasksClient;
 use Illuminate\Container\Container;
 use Illuminate\Queue\Jobs\Job as LaravelJob;
 use Illuminate\Contracts\Queue\Job as JobContract;
+use function Safe\json_encode;
 
 class CloudTasksJob extends LaravelJob implements JobContract
 {
-    private $job;
-    private $attempts;
-    private $maxTries;
-    public $retryUntil = null;
+    private array $job;
+    private ?int $attempts;
+    private ?int $maxTries;
+    public ?int $retryUntil = null;
 
     /**
      * @var CloudTasksQueue
      */
     public $cloudTasksQueue;
 
-    public function __construct($job, CloudTasksQueue $cloudTasksQueue)
+    public function __construct(array $job, CloudTasksQueue $cloudTasksQueue)
     {
         $this->job = $job;
         $this->container = Container::getInstance();
         $this->cloudTasksQueue = $cloudTasksQueue;
+        /** @var \stdClass $command */
         $command = unserialize($job['data']['command']);
         $this->queue = $command->queue;
     }
 
-    public function getJobId()
+    public function getJobId(): string
     {
         return $this->job['uuid'];
     }
@@ -38,64 +39,64 @@ public function uuid(): string
         return $this->job['uuid'];
     }
 
-    public function getRawBody()
+    public function getRawBody(): string
     {
         return json_encode($this->job);
     }
 
-    public function attempts()
+    public function attempts(): ?int
     {
         return $this->attempts;
     }
 
-    public function setAttempts($attempts)
+    public function setAttempts(int $attempts): void
     {
         $this->attempts = $attempts;
     }
 
-    public function setMaxTries($maxTries)
+    public function setMaxTries(int $maxTries): void
     {
-        if ((int) $maxTries === -1) {
+        if ($maxTries === -1) {
             $maxTries = 0;
         }
 
         $this->maxTries = $maxTries;
     }
 
-    public function maxTries()
+    public function maxTries(): ?int
     {
         return $this->maxTries;
     }
 
-    public function setQueue($queue)
+    public function setQueue(string $queue): void
     {
         $this->queue = $queue;
     }
 
-    public function setRetryUntil($retryUntil)
+    public function setRetryUntil(?int $retryUntil): void
     {
         $this->retryUntil = $retryUntil;
     }
 
-    public function retryUntil()
+    public function retryUntil(): ?int
     {
         return $this->retryUntil;
     }
 
     // timeoutAt was renamed to retryUntil in 8.x but we still support this.
-    public function timeoutAt()
+    public function timeoutAt(): ?int
     {
         return $this->retryUntil;
     }
 
-    public function delete()
+    public function delete(): void
     {
         parent::delete();
 
         $this->cloudTasksQueue->delete($this);
     }
 
-    public function fire()
+    public function fire(): void
     {
         $this->attempts++;