Refactor some tests

Author: marickvantuil

src/CloudTasksQueue.php

@@ -175,7 +175,7 @@ private function taskName(string $queueName, array $payload): string
             $this->config['project'],
             $this->config['location'],
             $queueName,
-            $displayName.'-'.$payload['uuid'].'-'.Carbon::now()->getTimeStampMs(),
+            $displayName.'-'. bin2hex(random_bytes(8)),
         );
     }
 

tests/QueueTest.php

@@ -463,16 +463,16 @@ public function it_adds_a_task_name_based_on_the_display_name()
     {
         // Arrange
         CloudTasksApi::fake();
-        Carbon::setTestNow(Carbon::create(2023, 6, 1, 20, 2, 37));
 
         // Act
         $this->dispatch((new SimpleJob()));
 
         // Assert
-        CloudTasksApi::assertTaskCreated(function (Task $task, string $queueName): bool {
-            $uuid = \Safe\json_decode($task->getHttpRequest()->getBody(), true)['uuid'];
-
-            return $task->getName() === 'projects/my-test-project/locations/europe-west6/queues/barbequeue/tasks/Tests-Support-SimpleJob-'.$uuid.'-1685649757000';
+        CloudTasksApi::assertTaskCreated(function (Task $task): bool {
+            return str_starts_with(
+                $task->getName(),
+                'projects/my-test-project/locations/europe-west6/queues/barbequeue/tasks/Tests-Support-SimpleJob'
+            );
         });
     }
 }

tests/Support/FailingJobWithUnlimitedTries.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Support;
+
+class FailingJobWithUnlimitedTries extends FailingJob
+{
+    public $tries = 500;
+}

tests/TaskHandlerTest.php

@@ -18,6 +18,7 @@
 use Tests\Support\FailingJobWithMaxTries;
 use Tests\Support\FailingJobWithMaxTriesAndRetryUntil;
 use Tests\Support\FailingJobWithRetryUntil;
+use Tests\Support\FailingJobWithUnlimitedTries;
 use Tests\Support\SimpleJob;
 
 class TaskHandlerTest extends TestCase
@@ -146,16 +147,16 @@ public function after_max_retry_until_it_will_log_to_failed_table_and_delete_the
      */
     public function test_unlimited_max_attempts()
     {
-        // Arrange
-
         // Act
-        $job = $this->dispatch(new FailingJob());
-        foreach (range(1, 50) as $attempt) {
-            $job->run();
-            CloudTasksApi::assertDeletedTaskCount($attempt);
-            CloudTasksApi::assertTaskDeleted($job->task->getName());
-            $this->assertDatabaseCount('failed_jobs', 0);
+        $job = $this->dispatch(new FailingJobWithUnlimitedTries());
+
+        foreach (range(0, 50) as $attempt) {
+            usleep(1000);
+            $job = $job->runAndGetReleasedJob();
         }
+
+        // -1 because the last job is not run.
+        CloudTasksApi::assertDeletedTaskCount(51);
     }
 
     /**
@@ -164,7 +165,6 @@ public function test_unlimited_max_attempts()
     public function test_max_attempts_in_combination_with_retry_until()
     {
         // Arrange
-
         $this->travelTo('2020-01-01 00:00:00');
 
         $job = $this->dispatch(new FailingJobWithMaxTriesAndRetryUntil());
@@ -174,13 +174,14 @@ public function test_max_attempts_in_combination_with_retry_until()
         // Act & Assert
 
         // The max attempts is 3, but the retryUntil is set to 5 minutes from now.
-        // So when we attempt the job 10 times, it should still not fail.
-        foreach (range(1, 10) as $attempt) {
-            $job = $job->runAndGetReleasedJob();
-            CloudTasksApi::assertDeletedTaskCount($attempt);
-            CloudTasksApi::assertTaskDeleted($job->task->getName());
-            $this->assertDatabaseCount('failed_jobs', 0);
-        }
+        // So when we attempt the job 4 times, it should still not fail.
+        $job = $job
+            ->runAndGetReleasedJob()
+            ->runAndGetReleasedJob()
+            ->runAndGetReleasedJob()
+            ->runAndGetReleasedJob();
+
+        $this->assertDatabaseCount('failed_jobs', 0);
 
         // Now we travel to 5 minutes from now, and the job should fail.
         $this->travelTo('2020-01-01 00:05:00');
@@ -244,16 +245,16 @@ public function attempts_are_tracked_internally()
 
         // Act & Assert
         $job = $this->dispatch(new FailingJob());
-        $job->run();
-        $releasedJob = null;
+
+        $released = $job->runAndGetReleasedJob();
 
         Event::assertDispatched(JobReleasedAfterException::class, function ($event) use (&$releasedJob) {
             $releasedJob = $event->job->getRawBody();
 
             return $event->job->attempts() === 1;
         });
 
-        $this->runFromPayload($releasedJob);
+        $released->run();
 
         Event::assertDispatched(JobReleasedAfterException::class, function ($event) {
             return $event->job->attempts() === 2;
@@ -270,23 +271,9 @@ public function retried_jobs_get_a_new_name()
         CloudTasksApi::fake();
 
         // Act & Assert
-        Carbon::setTestNow(Carbon::createFromTimestamp(1685035628));
-        $job = $this->dispatch(new FailingJob());
-        Carbon::setTestNow(Carbon::createFromTimestamp(1685035629));
-
-        $job->run();
-
-        // Assert
-        CloudTasksApi::assertCreatedTaskCount(2);
-        CloudTasksApi::assertTaskCreated(function (Task $task): bool {
-            [$timestamp] = array_reverse(explode('-', $task->getName()));
-
-            return $timestamp === '1685035628000';
-        });
-        CloudTasksApi::assertTaskCreated(function (Task $task): bool {
-            [$timestamp] = array_reverse(explode('-', $task->getName()));
-
-            return $timestamp === '1685035629000';
-        });
+        $this->assertCount(0, $this->createdTasks);
+        $this->dispatch(new FailingJob())->runAndGetReleasedJob();
+        $this->assertCount(2, $this->createdTasks);
+        $this->assertNotEquals($this->createdTasks[0]->getName(), $this->createdTasks[1]->getName());
     }
 }

tests/TestCase.php

@@ -27,12 +27,18 @@ class TestCase extends \Orchestra\Testbench\TestCase
 
     public string $releasedJobPayload;
 
+    public array $createdTasks = [];
+
     protected function setUp(): void
     {
         parent::setUp();
 
         $this->withFactories(__DIR__.'/../factories');
 
+        Event::listen(TaskCreated::class, function (TaskCreated $event) {
+            $this->createdTasks[] = $event->task;
+        });
+
         Event::listen(
             JobReleasedAfterException::class,
             function ($event) {
@@ -123,13 +129,11 @@ protected function setConfigValue($key, $value)
     public function dispatch($job)
     {
         $payload = null;
-        $payloadAsArray = [];
         $task = null;
 
-        Event::listen(TaskCreated::class, function (TaskCreated $event) use (&$payload, &$payloadAsArray, &$task) {
+        Event::listen(TaskCreated::class, function (TaskCreated $event) use (&$payload, &$task) {
             $request = $event->task->getHttpRequest() ?? $event->task->getAppEngineHttpRequest();
             $payload = $request->getBody();
-            $payloadAsArray = json_decode($payload, true);
             $task = $event->task;
         });
 
@@ -168,9 +172,18 @@ public function runAndGetReleasedJob(): self
                     app(TaskHandler::class)->handle($this->payload);
                 });
 
+                $releasedTask = end($this->testCase->createdTasks);
+
+                if (! $releasedTask) {
+                    $this->testCase->fail('No task was released.');
+                }
+
+                $payload = $releasedTask->getAppEngineHttpRequest()?->getBody()
+                    ?: $releasedTask->getHttpRequest()->getBody();
+
                 return new self(
-                    $this->testCase->releasedJobPayload,
-                    $this->task,
+                    $payload,
+                    $releasedTask,
                     $this->testCase
                 );
             }