Fix flaky pause/resume queue tests

phpstan.neon

@@ -5,6 +5,10 @@ parameters:
     paths:
         - src
     level: 9
+    # QueuePaused/QueueResumed only exist in newer Laravel versions; the code
+    # guards them with class_exists(), so the ignore is unmatched on versions
+    # where they do exist. Don't fail when that happens.
+    reportUnmatchedIgnoredErrors: false
     ignoreErrors:
         - "/dispatchAfterCommit with no type specified/"
         - message: "#Illuminate\\\\Queue\\\\Events\\\\Queue(Paused|Resumed)#"

src/CloudTasksApi.php

@@ -5,15 +5,16 @@
 namespace Stackkit\LaravelGoogleCloudTasksQueue;
 
 use Google\Cloud\Tasks\V2\Task;
+use Google\Cloud\Tasks\V2\Queue;
 use Illuminate\Support\Facades\Facade;
 
 /**
  * @method static Task createTask(string $queueName, Task $task)
  * @method static void deleteTask(string $taskName)
  * @method static Task getTask(string $taskName)
  * @method static bool exists(string $taskName)
- * @method static void pause(string $queue)
- * @method static void resume(string $queue)
+ * @method static Queue pause(string $queue)
+ * @method static Queue resume(string $queue)
  */
 class CloudTasksApi extends Facade
 {

src/CloudTasksApiConcrete.php

@@ -6,6 +6,7 @@
 
 use Google\Cloud\Tasks\V2\Task;
 use Google\ApiCore\ApiException;
+use Google\Cloud\Tasks\V2\Queue;
 use Google\Cloud\Tasks\V2\GetTaskRequest;
 use Google\Cloud\Tasks\V2\CreateTaskRequest;
 use Google\Cloud\Tasks\V2\DeleteTaskRequest;
@@ -68,13 +69,13 @@ public function exists(string $taskName): bool
         return false;
     }
 
-    public function pause(string $queue): void
+    public function pause(string $queue): Queue
     {
-        $this->client->pauseQueue(PauseQueueRequest::build($queue));
+        return $this->client->pauseQueue(PauseQueueRequest::build($queue));
     }
 
-    public function resume(string $queue): void
+    public function resume(string $queue): Queue
     {
-        $this->client->resumeQueue(ResumeQueueRequest::build($queue));
+        return $this->client->resumeQueue(ResumeQueueRequest::build($queue));
     }
 }

src/CloudTasksApiContract.php

@@ -5,6 +5,7 @@
 namespace Stackkit\LaravelGoogleCloudTasksQueue;
 
 use Google\Cloud\Tasks\V2\Task;
+use Google\Cloud\Tasks\V2\Queue;
 
 interface CloudTasksApiContract
 {
@@ -16,7 +17,7 @@ public function getTask(string $taskName): Task;
 
     public function exists(string $taskName): bool;
 
-    public function pause(string $queue): void;
+    public function pause(string $queue): Queue;
 
-    public function resume(string $queue): void;
+    public function resume(string $queue): Queue;
 }

src/CloudTasksApiFake.php

@@ -7,6 +7,8 @@
 use Closure;
 use PHPUnit\Framework\Assert;
 use Google\Cloud\Tasks\V2\Task;
+use Google\Cloud\Tasks\V2\Queue;
+use Google\Cloud\Tasks\V2\Queue\State;
 
 class CloudTasksApiFake implements CloudTasksApiContract
 {
@@ -56,14 +58,18 @@ public function exists(string $taskName): bool
         return false;
     }
 
-    public function pause(string $queue): void
+    public function pause(string $queue): Queue
     {
         $this->pausedQueues[$queue] = true;
+
+        return (new Queue)->setName($queue)->setState(State::PAUSED);
     }
 
-    public function resume(string $queue): void
+    public function resume(string $queue): Queue
     {
         unset($this->pausedQueues[$queue]);
+
+        return (new Queue)->setName($queue)->setState(State::RUNNING);
     }
 
     public function assertTaskDeleted(string $taskName): void

tests/CloudTasksApiTest.php

@@ -11,7 +11,6 @@
 use Google\Cloud\Tasks\V2\HttpRequest;
 use Google\Cloud\Tasks\V2\Queue\State;
 use PHPUnit\Framework\Attributes\Test;
-use Google\Cloud\Tasks\V2\GetQueueRequest;
 use Google\Cloud\Tasks\V2\Client\CloudTasksClient;
 use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksApi;
 
@@ -150,13 +149,11 @@ public function it_can_pause_queues(): void
             env('CI_CLOUD_TASKS_QUEUE').'-pause'
         );
 
-        $this->ensureQueueIs($queueName, State::RUNNING);
-
         // Act
-        CloudTasksApi::pause($queueName);
+        $queue = CloudTasksApi::pause($queueName);
 
         // Assert
-        $this->assertEquals(State::PAUSED, $this->waitForQueueState($queueName, State::PAUSED));
+        $this->assertEquals(State::PAUSED, $queue->getState());
     }
 
     #[Test]
@@ -168,54 +165,10 @@ public function it_can_resume_queues(): void
             env('CI_CLOUD_TASKS_QUEUE').'-pause'
         );
 
-        $this->ensureQueueIs($queueName, State::PAUSED);
-
         // Act
-        CloudTasksApi::resume($queueName);
+        $queue = CloudTasksApi::resume($queueName);
 
         // Assert
-        $this->assertEquals(State::RUNNING, $this->waitForQueueState($queueName, State::RUNNING));
-    }
-
-    private function getQueueState(string $queue): int
-    {
-        return $this->client->getQueue(GetQueueRequest::build($queue))->getState();
-    }
-
-    private function waitForQueueState(string $queue, int $waitForState): ?int
-    {
-        $state = null;
-        $backoff = [1, 5, 10, 30, 60];
-
-        foreach ($backoff as $delay) {
-            $state = $this->getQueueState($queue);
-
-            if ($state === $waitForState) {
-                return $state;
-            }
-
-            sleep($delay);
-        }
-
-        return $this->getQueueState($queue);
-    }
-
-    private function ensureQueueIs(string $queue, int $desiredState): void
-    {
-        $currentState = $this->getQueueState($queue);
-
-        if ($currentState === $desiredState) {
-            return;
-        }
-
-        if ($currentState === State::RUNNING && $desiredState === State::PAUSED) {
-            CloudTasksApi::pause($queue);
-        }
-
-        if ($currentState === State::PAUSED && $desiredState === State::RUNNING) {
-            CloudTasksApi::resume($queue);
-        }
-
-        $this->assertEquals($desiredState, $this->waitForQueueState($queue, $desiredState));
+        $this->assertEquals(State::RUNNING, $queue->getState());
     }
 }