Add initial version of job releasing in dashboard

Author: marickvantuil

dashboard/src/components/Status.vue

@@ -31,7 +31,7 @@ function ucfirst(input) {
 .task-queued, .task-scheduled {
   @apply bg-gray-100 text-gray-500
 }
-.task-running {
+.task-running, .task-released {
   @apply bg-blue-100 text-blue-800
 }
 </style>

dashboard/src/components/Task.vue

@@ -27,6 +27,7 @@ const titles = {
   successful: 'Successful',
   error: 'An error occurred',
   failed: 'Failed permanently',
+  released: 'Released',
 }
 </script>
 
@@ -60,6 +61,13 @@ const titles = {
                   Scheduled: {{ event['scheduled_at'] }} (UTC)
                 </span>
               </div>
+              <div v-if="event['delay']">
+                <span
+                  class="bg-gray-200 text-gray-800 text-xs font-medium mr-2 inline-block mb-1 px-1.5 py-0.5 rounded dark:bg-blue-200 dark:text-blue-800"
+                >
+                  Delay: {{ event['delay'] }} seconds
+                </span>
+              </div>
             </h3>
             <Popper
               :content="event.datetime"

src/CloudTasksJob.php

@@ -128,7 +128,7 @@ public function release($delay = 0)
         }
 
         if (! data_get($this->job, 'internal.errored')) {
-            app('events')->dispatch(new JobReleased($connection, $this));
+            app('events')->dispatch(new JobReleased($connection, $this, $delay));
         }
     }
 }

src/CloudTasksServiceProvider.php

@@ -8,6 +8,7 @@
 use Illuminate\Queue\Events\JobProcessed;
 use Illuminate\Queue\Events\JobProcessing;
 use Illuminate\Support\ServiceProvider as LaravelServiceProvider;
+use Stackkit\LaravelGoogleCloudTasksQueue\Events\JobReleased;
 use Stackkit\LaravelGoogleCloudTasksQueue\Events\TaskCreated;
 use function Safe\file_get_contents;
 use function Safe\json_decode;
@@ -187,5 +188,13 @@ private function registerDashboard(): void
 
             DashboardService::make()->markAsFailed($event);
         });
+
+        app('events')->listen(JobReleased::class, function (JobReleased $event) {
+            if (!CloudTasks::dashboardEnabled()) {
+                return;
+            }
+
+            DashboardService::make()->markAsReleased($event);
+        });
     }
 }

src/DashboardService.php

@@ -9,6 +9,7 @@
 use Illuminate\Queue\Events\JobExceptionOccurred;
 use Illuminate\Queue\Events\JobFailed;
 use Illuminate\Support\Facades\DB;
+use Stackkit\LaravelGoogleCloudTasksQueue\Events\JobReleased;
 use function Safe\json_decode;
 
 class DashboardService
@@ -85,6 +86,10 @@ public function markAsSuccessful(string $uuid): void
     {
         $task = StackkitCloudTask::findByUuid($uuid);
 
+        if ($task->status === 'released') {
+            return;
+        }
+
         $task->status = 'successful';
         $task->addMetadataEvent([
             'status' => $task->status,
@@ -135,6 +140,23 @@ public function markAsFailed(JobFailed $event): void
         $task->save();
     }
 
+    public function markAsReleased(JobReleased $event): void
+    {
+        /** @var CloudTasksJob $job */
+        $job = $event->job;
+
+        $task = StackkitCloudTask::findByUuid($job->uuid());
+
+        $task->status = 'released';
+        $task->addMetadataEvent([
+            'status' => $task->status,
+            'datetime' => now()->utc()->toDateTimeString(),
+            'delay' => $event->delay,
+        ]);
+
+        $task->save();
+    }
+
     private function getTaskName(Task $task): string
     {
         /** @var array $decode */

src/Events/JobReleased.php

@@ -22,16 +22,25 @@ class JobReleased
      */
     public Job $job;
 
+    /**
+     * The job delay in seconds.
+     *
+     * @var int
+     */
+    public int $delay;
+
     /**
      * Create a new event instance.
      *
      * @param  string  $connectionName
      * @param  Job  $job
+     * @param int $delay
      * @return void
      */
-    public function __construct(string $connectionName, Job $job)
+    public function __construct(string $connectionName, Job $job, int $delay = 0)
     {
         $this->job = $job;
         $this->connectionName = $connectionName;
+        $this->delay = $delay;
     }
 }

src/TaskHandler.php

@@ -166,7 +166,7 @@ public static function getCommandProperties(string $command): array
         }
 
         if (app()->bound(Encrypter::class)) {
-            return (array) unserialize(app(Encrypter::class)->decrypt($command), ['allowed_classes' => false]);
+            return (array) unserialize(app(Encrypter::class)->decrypt($command), ['allowed_classes' => ['Illuminate\Support\Carbon']]);
         }
 
         return [];

tests/CloudTasksDashboardTest.php

@@ -10,6 +10,7 @@
 use Stackkit\LaravelGoogleCloudTasksQueue\OpenIdVerificator;
 use Stackkit\LaravelGoogleCloudTasksQueue\StackkitCloudTask;
 use Tests\Support\FailingJob;
+use Tests\Support\JobThatWillBeReleased;
 use Tests\Support\SimpleJob;
 
 class CloudTasksDashboardTest extends TestCase
@@ -413,6 +414,36 @@ public function when_a_job_fails_it_will_be_updated_in_the_dashboard()
         );
     }
 
+    /**
+     * @test
+     */
+    public function when_a_job_is_released_it_will_be_updated_in_the_dashboard()
+    {
+        // Arrange
+        \Illuminate\Support\Carbon::setTestNow(now());
+        CloudTasksApi::fake();
+        OpenIdVerificator::fake();
+        CloudTasksApi::partialMock()->shouldReceive('getRetryConfig')->andReturn(
+            (new RetryConfig())->setMaxAttempts(3)
+        );
+
+        $this->dispatch(new JobThatWillBeReleased())->run();
+
+        // Assert
+        $task = StackkitCloudTask::firstOrFail();
+        $events = $task->getEvents();
+
+        $this->assertCount(4, $events);
+        $this->assertEquals(
+            [
+                'status' => 'released',
+                'datetime' => now()->toDateTimeString(),
+                'diff' => '1 second ago',
+            ],
+            $events[2]
+        );
+    }
+
     /**
      * @test
      */