Improve task deduplication and name in Cloud Tasks

Author: marickvantuil

src/CloudTasksQueue.php

@@ -16,6 +16,7 @@
 use Google\Protobuf\Timestamp;
 use Illuminate\Contracts\Queue\Queue as QueueContract;
 use Illuminate\Queue\Queue as LaravelQueue;
+use Illuminate\Support\Str;
 use Stackkit\LaravelGoogleCloudTasksQueue\Events\TaskCreated;
 
 use function Safe\json_decode;
@@ -112,7 +113,7 @@ protected function pushToCloudTasks($queue, $payload, $delay = 0)
 
         $payload = (array) json_decode($payload, true);
 
-        $task = tap(new Task())->setName($this->taskName($queue));
+        $task = tap(new Task())->setName($this->taskName($queue, $payload['displayName']));
 
         $payload = $this->enrichPayloadWithInternalData(
             payload: $payload,
@@ -143,13 +144,16 @@ protected function pushToCloudTasks($queue, $payload, $delay = 0)
         return $payload['uuid'];
     }
 
-    private function taskName(string $queueName): string
+    private function taskName(string $queueName, string $displayName): string
     {
         return CloudTasksClient::taskName(
             $this->config['project'],
             $this->config['location'],
             $queueName,
-            bin2hex(random_bytes(16)),
+            str($displayName)
+                ->afterLast('\\')
+                ->prepend((string) Str::ulid(), '-')
+                ->toString(),
         );
     }
 

tests/QueueTest.php

@@ -14,6 +14,7 @@
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Queue;
+use Illuminate\Support\Str;
 use PHPUnit\Framework\Attributes\Test;
 use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksApi;
 use Stackkit\LaravelGoogleCloudTasksQueue\Events\JobReleased;
@@ -440,13 +441,14 @@ public function it_adds_a_pre_defined_task_name()
     {
         // Arrange
         CloudTasksApi::fake();
+        Str::createUlidsUsingSequence(['01HSR4V9QE2F4T0K8RBAYQ88KE']);
 
         // Act
         $this->dispatch((new SimpleJob()));
 
         // Assert
         CloudTasksApi::assertTaskCreated(function (Task $task): bool {
-            return str($task->getName())->test('/projects\/.+\/locations\/.+\/queues\/.+\/tasks\/[a-z0-9]{16}/');
+            return $task->getName() === 'projects/my-test-project/locations/europe-west6/queues/barbequeue/tasks/01HSR4V9QE2F4T0K8RBAYQ88KE-SimpleJob';
         });
     }