[4.x-dev] Can set the HandlerUrl using a Closure callback. If given, the handler url is used from that closure.

Author: aaajeetee

src/CloudTasksQueue.php

@@ -25,11 +25,17 @@
 class CloudTasksQueue extends LaravelQueue implements QueueContract
 {
     private Closure | array $headers = [];
+    private static ?Closure $handlerUrlCallback = null;
 
     public function __construct(public array $config, public CloudTasksClient $client, public $dispatchAfterCommit = false)
     {
         //
     }
+    
+    public static function configureHandlerUrlUsing(Closure $callback): void
+    {
+        static::$handlerUrlCallback = $callback;
+    }
 
     /**
      * Get the size of the queue.
@@ -190,12 +196,6 @@ private function enrichPayloadWithInternalData(
     public function addPayloadToTask(array $payload, Task $task, mixed $job): Task
     {
         $headers = value($this->headers, $payload) ?: [];
-        if ($job instanceof HasTaskHeaders) {
-            $headers = [
-                ...$headers,
-                ...$job->taskHeaders(),
-            ];
-        }
 
         if (!empty($this->config['app_engine'])) {
             $path = \Safe\parse_url(route('cloud-tasks.handle-task'), PHP_URL_PATH);
@@ -254,8 +254,8 @@ public function release(CloudTasksJob $job, int $delay = 0): void
     /** @param string|object $job */
     public function getHandler(mixed $job): string
     {
-        if ($job instanceof HasTaskHandlerUrl) {
-            return $job->taskHandlerUrl();
+        if (static::$handlerUrlCallback) {
+            return (static::$handlerUrlCallback)($job);
         }
 
         if (empty($this->config['handler'])) {

src/HasTaskHandlerUrl.php

@@ -16,9 +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\CustomHeadersJob;
 use Tests\Support\FailingJob;
 use Tests\Support\FailingJobWithExponentialBackoff;
 use Tests\Support\JobOutput;
@@ -76,18 +75,21 @@ public function it_posts_to_the_configured_handler_url()
     }
 
     #[Test]
-    public function it_posts_to_the_job_handler_url()
+    public function it_posts_to_the_callback_handler_url()
     {
         // Arrange
         $this->setConfigValue('handler', 'https://docker.for.mac.localhost:8081');
         CloudTasksApi::fake();
+        CloudTasksQueue::configureHandlerUrlUsing(static fn(SimpleJob $job) => 'https://example.com/api/my-custom-route?job=' . $job->id);
 
         // Act
-        $this->dispatch(new CustomHandlerUrlJob());
+        $job = new SimpleJob();
+        $job->id = 1;
+        $this->dispatch($job);
 
         // Assert
         CloudTasksApi::assertTaskCreated(function (Task $task): bool {
-            return $task->getHttpRequest()->getUrl() === 'https://example.com/api/my-custom-route';
+            return $task->getHttpRequest()->getUrl() === 'https://example.com/api/my-custom-route?job=1';
         });
     }
 
@@ -510,23 +512,4 @@ public function headers_can_be_added_to_the_task_with_job_context()
             return $task->getHttpRequest()->getHeaders()['X-MyHeader'] === SimpleJob::class;
         });
     }
-
-    #[Test]
-    public function job_headers_can_be_added_to_the_task()
-    {
-        // Arrange
-        CloudTasksApi::fake();
-
-        // Act
-        Queue::connection()->setTaskHeaders([
-            'X-MyHeader' => 'MyValue',
-        ]);
-        $this->dispatch((new CustomHeadersJob()));
-
-        // Assert
-        CloudTasksApi::assertTaskCreated(function (Task $task): bool {
-            $headers = $task->getHttpRequest()->getHeaders();
-            return $headers['X-MyHeader'] === 'MyValue' && $headers['X-MyJobHeader'] === 'MyJobValue';
-        });
-    }
 }