[4.x-dev] A job can also have task headers, which are merged with any other headers.

Author: aaajeetee

src/CloudTasksQueue.php

@@ -190,6 +190,12 @@ 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);

src/HasTaskHeaders.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stackkit\LaravelGoogleCloudTasksQueue;
+
+interface HasTaskHeaders
+{
+    /** @return array<string, mixed> */
+    public function taskHeaders(): array;
+}

tests/QueueTest.php

@@ -18,6 +18,7 @@
 use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksApi;
 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;
@@ -509,4 +510,23 @@ 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';
+        });
+    }
 }

tests/Support/CustomHeadersJob.php

@@ -0,0 +1,30 @@
+<?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\HasTaskHeaders;
+
+class CustomHeadersJob implements ShouldQueue, HasTaskHeaders
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    public function handle(): void
+    {
+        event(new JobOutput('CustomHandlerUrlJob:success'));
+    }
+
+    /** @inheritdoc */
+    public function taskHeaders(): array
+    {
+        return [
+            'X-MyJobHeader' => 'MyJobValue',
+        ];
+    }
+}