[4.x-dev] Can use the task handler url from the job, if available. Otherwise it falls back to the configured handler url.

Author: aaajeetee

src/CloudTasksQueue.php

@@ -57,8 +57,8 @@ public function push($job, $data = '', $queue = null)
             $this->createPayload($job, $queue, $data),
             $queue,
             null,
-            function ($payload, $queue) {
-                return $this->pushRaw($payload, $queue);
+            function ($payload, $queue) use ($job) {
+                return $this->pushRaw($payload, $queue, ['job' => $job]);
             }
         );
     }
@@ -73,8 +73,9 @@ function ($payload, $queue) {
     public function pushRaw($payload, $queue = null, array $options = [])
     {
         $delay = ! empty($options['delay']) ? $options['delay'] : 0;
+        $job = $options['job'] ?? null;
 
-        return $this->pushToCloudTasks($queue, $payload, $delay);
+        return $this->pushToCloudTasks($queue, $payload, $delay, $job);
     }
 
     /**
@@ -93,8 +94,8 @@ public function later($delay, $job, $data = '', $queue = null)
             $this->createPayload($job, $queue, $data),
             $queue,
             $delay,
-            function ($payload, $queue, $delay) {
-                return $this->pushToCloudTasks($queue, $payload, $delay);
+            function ($payload, $queue, $delay) use ($job) {
+                return $this->pushToCloudTasks($queue, $payload, $delay, $job);
             }
         );
     }
@@ -105,9 +106,10 @@ function ($payload, $queue, $delay) {
      * @param  string|null  $queue
      * @param  string  $payload
      * @param  \DateTimeInterface|\DateInterval|int  $delay
+     * @param  string|object $job
      * @return string
      */
-    protected function pushToCloudTasks($queue, $payload, $delay = 0)
+    protected function pushToCloudTasks($queue, $payload, $delay, mixed $job)
     {
         $queue = $queue ?: $this->config['queue'];
 
@@ -122,7 +124,7 @@ protected function pushToCloudTasks($queue, $payload, $delay = 0)
             connectionName: $this->getConnectionName(),
         );
 
-        $this->addPayloadToTask($payload, $task);
+        $this->addPayloadToTask($payload, $task, $job);
 
         // The deadline for requests sent to the app. If the app does not respond by
         // this deadline then the request is cancelled and the attempt is marked as
@@ -184,7 +186,8 @@ private function enrichPayloadWithInternalData(
         return $payload;
     }
 
-    public function addPayloadToTask(array $payload, Task $task): Task
+    /** @param string|object $job */
+    public function addPayloadToTask(array $payload, Task $task, mixed $job): Task
     {
         $headers = value($this->headers, $payload) ?: [];
 
@@ -206,7 +209,7 @@ public function addPayloadToTask(array $payload, Task $task): Task
             $task->setAppEngineHttpRequest($appEngineRequest);
         } else {
             $httpRequest = new HttpRequest();
-            $httpRequest->setUrl($this->getHandler());
+            $httpRequest->setUrl($this->getHandler($job));
             $httpRequest->setBody(json_encode($payload));
             $httpRequest->setHttpMethod(HttpMethod::POST);
             $httpRequest->setHeaders($headers);
@@ -237,13 +240,18 @@ public function release(CloudTasksJob $job, int $delay = 0): void
 
         $payload = $job->getRawBody();
 
-        $options = ['delay' => $delay];
+        $options = ['delay' => $delay, 'job' => $job];
 
         $this->pushRaw($payload, $job->getQueue(), $options);
     }
 
-    public function getHandler(): string
+    /** @param string|object $job */
+    public function getHandler(mixed $job): string
     {
+        if ($job instanceof HasTaskHandlerUrl) {
+            return $job->taskHandlerUrl();
+        }
+
         if (empty($this->config['handler'])) {
             $this->config['handler'] = request()->getSchemeAndHttpHost();
         }

src/HasTaskHandlerUrl.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stackkit\LaravelGoogleCloudTasksQueue;
+
+interface HasTaskHandlerUrl
+{
+    public function taskHandlerUrl(): string;
+}

tests/QueueTest.php

@@ -16,8 +16,8 @@
 use Illuminate\Support\Facades\Queue;
 use PHPUnit\Framework\Attributes\Test;
 use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksApi;
-use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksQueue;
 use Stackkit\LaravelGoogleCloudTasksQueue\Events\JobReleased;
+use Tests\Support\CustomHandlerUrlJob;
 use Tests\Support\FailingJob;
 use Tests\Support\FailingJobWithExponentialBackoff;
 use Tests\Support\JobOutput;
@@ -59,7 +59,7 @@ public function it_posts_to_the_handler()
     }
 
     #[Test]
-    public function it_posts_to_the_correct_handler_url()
+    public function it_posts_to_the_configured_handler_url()
     {
         // Arrange
         $this->setConfigValue('handler', 'https://docker.for.mac.localhost:8081');
@@ -74,6 +74,22 @@ public function it_posts_to_the_correct_handler_url()
         });
     }
 
+    #[Test]
+    public function it_posts_to_the_job_handler_url()
+    {
+        // Arrange
+        $this->setConfigValue('handler', 'https://docker.for.mac.localhost:8081');
+        CloudTasksApi::fake();
+
+        // Act
+        $this->dispatch(new CustomHandlerUrlJob());
+
+        // Assert
+        CloudTasksApi::assertTaskCreated(function (Task $task): bool {
+            return $task->getHttpRequest()->getUrl() === 'https://example.com/api/my-custom-route';
+        });
+    }
+
     #[Test]
     public function it_posts_the_serialized_job_payload_to_the_handler()
     {

tests/Support/CustomHandlerUrlJob.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Support;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Stackkit\LaravelGoogleCloudTasksQueue\HasTaskHandlerUrl;
+
+class CustomHandlerUrlJob implements ShouldQueue, HasTaskHandlerUrl
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    public function handle(): void
+    {
+        event(new JobOutput('CustomHandlerUrlJob:success'));
+    }
+
+    public function taskHandlerUrl(): string
+    {
+        return 'https://example.com/api/my-custom-route';
+    }
+}