[4.x-dev] Added "setTaskHeadersUsing()" method to allow a closure to be passed for the task headers. This is the same as the "configureHandlerUrlUsing()" method. Also added some forget methods so these callbacks can be easily cleared if necessary.

Author: aaajeetee

README.md

@@ -102,26 +102,44 @@ Please check the table below on what the values mean and what their value should
 
 #### Passing headers to a task
 
-You can pass headers to a task by using the `withHeaders` method on the queue connection.
+You can pass headers to a task by using the `setTaskHeadersUsing` method on the `CloudTasksQueue` class.
 
 ```php
-use Illuminate\Queue\Queue;
+use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksQueue;
 
-Queue::connection()->setTaskHeaders([
+CloudTasksQueue::setTaskHeadersUsing(static fn() => [
   'X-My-Header' => 'My-Value',
 ]);
 ```
 
-If necessary, the current job being dispatched is also available:
+If necessary, the current payload being dispatched is also available:
 
 ```php
-use Illuminate\Queue\Queue;
+use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksQueue;
 
-Queue::connection()->setTaskHeaders(fn (array $job) => [
-    'X-My-Header' => $job['displayName']
+CloudTasksQueue::setTaskHeadersUsing(static fn(array $payload) => [
+  'X-My-Header' => $payload['displayName'],
 ]);
 ```
 
+#### Configure task handler url
+
+You can set the handler url for a task by using the `configureHandlerUrlUsing` method on the `CloudTasksQueue` class.
+
+```php
+use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksQueue;
+
+CloudTasksQueue::configureHandlerUrlUsing(static fn() => 'https://example.com/my-url');
+```
+
+If necessary, the current job being dispatched is also available:
+
+```php
+use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksQueue;
+
+CloudTasksQueue::configureHandlerUrlUsing(static fn(MyJob $job) => 'https://example.com/my-url/' . $job->something());
+```
+
 <details>
 <summary>
 How it works & Differences

src/CloudTasksQueue.php

@@ -24,8 +24,8 @@
 
 class CloudTasksQueue extends LaravelQueue implements QueueContract
 {
-    private Closure|array $headers = [];
     private static ?Closure $handlerUrlCallback = null;
+    private static ?Closure $taskHeadersCallback = null;
 
     public function __construct(public array $config, public CloudTasksClient $client, public $dispatchAfterCommit = false)
     {
@@ -37,6 +37,21 @@ public static function configureHandlerUrlUsing(Closure $callback): void
         static::$handlerUrlCallback = $callback;
     }
 
+    public static function forgetHandlerUrlCallback(): void
+    {
+        self::$handlerUrlCallback = null;
+    }
+
+    public static function setTaskHeadersUsing(Closure $callback): void
+    {
+        static::$taskHeadersCallback = $callback;
+    }
+
+    public static function forgetTaskHeadersCallback(): void
+    {
+        self::$taskHeadersCallback = null;
+    }
+
     /**
      * Get the size of the queue.
      *
@@ -194,7 +209,7 @@ private function enrichPayloadWithInternalData(
     /** @param string|object $job */
     public function addPayloadToTask(array $payload, Task $task, mixed $job): Task
     {
-        $headers = value($this->headers, $payload) ?: [];
+        $headers = $this->headers($payload);
 
         if (! empty($this->config['app_engine'])) {
             $path = \Safe\parse_url(route('cloud-tasks.handle-task'), PHP_URL_PATH);
@@ -270,8 +285,16 @@ public function getHandler(mixed $job): string
         return $handler.'/'.config('cloud-tasks.uri');
     }
 
-    public function setTaskHeaders(Closure|array $headers): void
+    /**
+     * @param array<string, mixed> $payload 
+     * @return array<string, mixed> 
+     */
+    private function headers(mixed $payload): array
     {
-        $this->headers = $headers;
+        if (!static::$taskHeadersCallback) {
+            return [];
+        }
+
+        return (static::$taskHeadersCallback)($payload);
     }
 }

tests/QueueTest.php

@@ -14,6 +14,7 @@
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Queue;
+use Override;
 use PHPUnit\Framework\Attributes\Test;
 use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksApi;
 use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksQueue;
@@ -28,6 +29,15 @@
 
 class QueueTest extends TestCase
 {
+    #[Override]
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        CloudTasksQueue::forgetHandlerUrlCallback();
+        CloudTasksQueue::forgetTaskHeadersCallback();
+    }
+
     #[Test]
     public function a_http_request_with_the_handler_url_is_made()
     {
@@ -480,7 +490,7 @@ public function headers_can_be_added_to_the_task()
         CloudTasksApi::fake();
 
         // Act
-        Queue::connection()->setTaskHeaders([
+        CloudTasksQueue::setTaskHeadersUsing(static fn() => [
             'X-MyHeader' => 'MyValue',
         ]);
 
@@ -499,11 +509,9 @@ public function headers_can_be_added_to_the_task_with_job_context()
         CloudTasksApi::fake();
 
         // Act
-        Queue::connection()->setTaskHeaders(function (array $payload) {
-            return [
-                'X-MyHeader' => $payload['displayName'],
-            ];
-        });
+        CloudTasksQueue::setTaskHeadersUsing(static fn(array $payload) => [
+            'X-MyHeader' => $payload['displayName'],
+        ]);
 
         $this->dispatch((new SimpleJob()));