Track job attempts internally

Author: marickvantuil

src/CloudTasksQueue.php

@@ -143,11 +143,19 @@ protected function pushToCloudTasks($queue, $payload, $delay = 0)
         // we will add it manually here if it's not present yet.
         [$payload, $uuid] = $this->withUuid($payload);
 
+        // Since 3.x tasks are released back onto the queue after an exception has
+        // been thrown. This means we lose the native [X-CloudTasks-TaskRetryCount] header
+        // value and need to manually set and update the number of times a task has been attempted.
+        $payload = $this->withAttempts($payload);
+
         $httpRequest->setBody($payload);
 
         $task = $this->createTask();
         $task->setHttpRequest($httpRequest);
 
+        // 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
+        // a failure. Cloud Tasks will retry the task according to the RetryConfig.
         if (!empty($this->config['dispatch_deadline'])) {
             $task->setDispatchDeadline(new Duration(['seconds' => $this->config['dispatch_deadline']]));
         }
@@ -182,6 +190,20 @@ private function withUuid(string $payload): array
         ];
     }
 
+    private function withAttempts(string $payload): string
+    {
+        /** @var array $decoded */
+        $decoded = json_decode($payload, true);
+
+        if (!isset($decoded['internal']['attempts'])) {
+            $decoded['internal']['attempts'] = 0;
+        } else {
+            $decoded['internal']['attempts']++;
+        }
+
+        return json_encode($decoded);
+    }
+
     /**
      * Pop the next job off of the queue.
      *

src/TaskHandler.php

@@ -124,7 +124,7 @@ private function handleTask(array $task): void
 
         $this->loadQueueRetryConfig($job);
 
-        $job->setAttempts((int) request()->header('X-CloudTasks-TaskRetryCount'));
+        $job->setAttempts($task['internal']['attempts']);
         $job->setMaxTries($this->retryConfig->getMaxAttempts());
 
         // If the job is being attempted again we also check if a

tests/TestCase.php

@@ -149,6 +149,8 @@ public function run(): void
                 rescue(function (): void {
                     app(TaskHandler::class)->handle($this->payload);
                 });
+
+                $this->payload = $this->incrementAttempts($this->payload);
             }
 
             public function runWithoutExceptionHandler(): void
@@ -158,6 +160,17 @@ public function runWithoutExceptionHandler(): void
 
                 app(TaskHandler::class)->handle($this->payload);
 
+                $this->payload = $this->incrementAttempts($this->payload);
+            }
+
+            private function incrementAttempts(string $payload): string
+            {
+                $decoded = \Safe\json_decode($payload, true);
+
+                $decoded['internal']['attempts'] ??= 0;
+                $decoded['internal']['attempts']++;
+
+                return json_encode($decoded);
             }
         };
     }