Merge pull request #184 from jobvink/master

Add support for job delay in CloudTasksQueue

Author: marickvantuil

src/CloudTasksQueue.php

@@ -133,7 +133,13 @@ public function push($job, $data = '', $queue = null)
             $queue,
             null,
             function ($payload, $queue) use ($job) {
-                return $this->pushRaw($payload, $queue, ['job' => $job]);
+                $options = ['job' => $job];
+
+                if (is_object($job) && property_exists($job, 'delay') && $job->delay !== null) {
+                    $options['delay'] = $job->delay;
+                }
+
+                return $this->pushRaw($payload, $queue, $options);
             }
         );
     }

tests/QueueTest.php

@@ -25,6 +25,7 @@
 use Tests\Support\JobThatWillBeReleased;
 use Illuminate\Queue\Events\JobProcessed;
 use Illuminate\Queue\Events\JobProcessing;
+use Tests\Support\SimpleJobWithDelayProperty;
 use Tests\Support\FailingJobWithExponentialBackoff;
 use Illuminate\Queue\Events\JobReleasedAfterException;
 use Stackkit\LaravelGoogleCloudTasksQueue\IncomingTask;
@@ -613,4 +614,39 @@ public function task_has_configured_dispatch_deadline(): void
             return $task->getDispatchDeadline()->getSeconds() === 1800;
         });
     }
+
+    #[Test]
+    public function it_will_set_the_scheduled_time_when_job_has_delay_property(): void
+    {
+        // Arrange
+        CloudTasksApi::fake();
+        Carbon::setTestNow(now()->addDay());
+
+        // Act
+        $this->dispatch(Bus::batch([
+            new SimpleJobWithDelayProperty(500),
+        ]));
+
+        // Assert
+        CloudTasksApi::assertTaskCreated(function (Task $task): bool {
+            return $task->getScheduleTime()->getSeconds() === now()->addSeconds(500)->timestamp;
+        });
+    }
+
+    #[Test]
+    public function it_will_not_set_scheduled_time_when_job_delay_property_is_null(): void
+    {
+        // Arrange
+        CloudTasksApi::fake();
+
+        // Act
+        $this->dispatch(Bus::batch([
+            new SimpleJobWithDelayProperty(null),
+        ]));
+
+        // Assert
+        CloudTasksApi::assertTaskCreated(function (Task $task): bool {
+            return $task->getScheduleTime() === null;
+        });
+    }
 }

tests/Support/SimpleJobWithDelayProperty.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Support;
+
+class SimpleJobWithDelayProperty extends BaseJob
+{
+    public $tries = 3;
+
+    /**
+     * Create a new job instance.
+     *
+     * @return void
+     */
+    public function __construct($delay = null)
+    {
+        $this->delay = $delay;
+    }
+
+    /**
+     * Execute the job.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        event(new JobOutput('SimpleJobWithDelayProperty:success'));
+    }
+}