Job status enumeration (#235)

yiisoft · Jan 26, 2025 · 72885e8 · 72885e8
1 parent 5a13e3e
commit 72885e8
Show file tree

Hide file tree

Showing 21 changed files with 48 additions and 179 deletions.
diff --git a/src/Adapter/AdapterInterface.php b/src/Adapter/AdapterInterface.php
@@ -6,7 +6,7 @@
 
 use BackedEnum;
 use InvalidArgumentException;
-use Yiisoft\Queue\Enum\JobStatus;
+use Yiisoft\Queue\JobStatus;
 use Yiisoft\Queue\Message\MessageInterface;
 
 interface AdapterInterface
@@ -24,8 +24,6 @@ public function runExisting(callable $handlerCallback): void;
      * @param int|string $id ID of a job message.
      *
      * @throws InvalidArgumentException When there is no such id in the adapter.
-     *
-     * @return JobStatus
      */
     public function status(string|int $id): JobStatus;
 

diff --git a/src/Adapter/SynchronousAdapter.php b/src/Adapter/SynchronousAdapter.php
@@ -7,7 +7,7 @@
 use BackedEnum;
 use InvalidArgumentException;
 use Yiisoft\Queue\ChannelNormalizer;
-use Yiisoft\Queue\Enum\JobStatus;
+use Yiisoft\Queue\JobStatus;
 use Yiisoft\Queue\Message\MessageInterface;
 use Yiisoft\Queue\QueueInterface;
 use Yiisoft\Queue\Worker\WorkerInterface;
@@ -55,11 +55,11 @@ public function status(string|int $id): JobStatus
         }
 
         if ($id < $this->current) {
-            return JobStatus::done();
+            return JobStatus::DONE;
         }
 
         if (isset($this->messages[$id])) {
-            return JobStatus::waiting();
+            return JobStatus::WAITING;
         }
 
         throw new InvalidArgumentException('There is no message with the given ID.');

diff --git a/src/Debug/QueueCollector.php b/src/Debug/QueueCollector.php
@@ -4,9 +4,9 @@
 
 namespace Yiisoft\Queue\Debug;
 
+use Yiisoft\Queue\JobStatus;
 use Yiisoft\Yii\Debug\Collector\CollectorTrait;
 use Yiisoft\Yii\Debug\Collector\SummaryCollectorInterface;
-use Yiisoft\Queue\Enum\JobStatus;
 use Yiisoft\Queue\Message\MessageInterface;
 use Yiisoft\Queue\Middleware\Push\MiddlewarePushInterface;
 use Yiisoft\Queue\QueueInterface;
@@ -38,15 +38,9 @@ public function collectStatus(string $id, JobStatus $status): void
             return;
         }
 
-        $statusText = match (true) {
-            $status->isDone() => 'done',
-            $status->isReserved() => 'reserved',
-            $status->isWaiting() => 'waiting',
-            default => 'unknown'
-        };
         $this->statuses[] = [
             'id' => $id,
-            'status' => $statusText,
+            'status' => $status->key(),
         ];
     }
 

diff --git a/src/Debug/QueueDecorator.php b/src/Debug/QueueDecorator.php
@@ -5,7 +5,7 @@
 namespace Yiisoft\Queue\Debug;
 
 use Yiisoft\Queue\Adapter\AdapterInterface;
-use Yiisoft\Queue\Enum\JobStatus;
+use Yiisoft\Queue\JobStatus;
 use Yiisoft\Queue\Message\MessageInterface;
 use Yiisoft\Queue\Middleware\Push\MiddlewarePushInterface;
 use Yiisoft\Queue\QueueInterface;

diff --git a/src/Enum/JobStatus.php b/src/Enum/JobStatus.php
diff --git a/src/JobStatus.php b/src/JobStatus.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Queue;
+
+enum JobStatus: int
+{
+    case WAITING = 1;
+    case RESERVED = 2;
+    case DONE = 3;
+
+    public function key(): string
+    {
+        return match ($this) {
+            self::WAITING => 'waiting',
+            self::RESERVED => 'reserved',
+            self::DONE => 'done',
+        };
+    }
+}
diff --git a/src/Queue.php b/src/Queue.php
@@ -7,7 +7,6 @@
 use Psr\Log\LoggerInterface;
 use Yiisoft\Queue\Adapter\AdapterInterface;
 use Yiisoft\Queue\Cli\LoopInterface;
-use Yiisoft\Queue\Enum\JobStatus;
 use Yiisoft\Queue\Exception\AdapterConfiguration\AdapterNotConfiguredException;
 use Yiisoft\Queue\Message\MessageInterface;
 use Yiisoft\Queue\Middleware\Push\AdapterPushHandler;

diff --git a/src/QueueInterface.php b/src/QueueInterface.php
@@ -6,7 +6,6 @@
 
 use InvalidArgumentException;
 use Yiisoft\Queue\Adapter\AdapterInterface;
-use Yiisoft\Queue\Enum\JobStatus;
 use Yiisoft\Queue\Message\MessageInterface;
 use Yiisoft\Queue\Middleware\Push\MiddlewarePushInterface;
 

diff --git a/stubs/StubAdapter.php b/stubs/StubAdapter.php
@@ -7,7 +7,7 @@
 use BackedEnum;
 use Yiisoft\Queue\Adapter\AdapterInterface;
 use Yiisoft\Queue\ChannelNormalizer;
-use Yiisoft\Queue\Enum\JobStatus;
+use Yiisoft\Queue\JobStatus;
 use Yiisoft\Queue\Message\MessageInterface;
 use Yiisoft\Queue\QueueInterface;
 
@@ -30,7 +30,7 @@ public function runExisting(callable $handlerCallback): void
 
     public function status(int|string $id): JobStatus
     {
-        return JobStatus::done();
+        return JobStatus::DONE;
     }
 
     public function push(MessageInterface $message): MessageInterface

diff --git a/stubs/StubQueue.php b/stubs/StubQueue.php
@@ -5,7 +5,7 @@
 namespace Yiisoft\Queue\Stubs;
 
 use Yiisoft\Queue\Adapter\AdapterInterface;
-use Yiisoft\Queue\Enum\JobStatus;
+use Yiisoft\Queue\JobStatus;
 use Yiisoft\Queue\Message\MessageInterface;
 use Yiisoft\Queue\Middleware\Push\MiddlewarePushInterface;
 use Yiisoft\Queue\QueueInterface;
@@ -37,7 +37,7 @@ public function listen(): void
 
     public function status(int|string $id): JobStatus
     {
-        return JobStatus::done();
+        return JobStatus::DONE;
     }
 
     public function getAdapter(): ?AdapterInterface

diff --git a/tests/App/DummyQueue.php b/tests/App/DummyQueue.php
@@ -6,7 +6,7 @@
 
 use Exception;
 use Yiisoft\Queue\Adapter\AdapterInterface;
-use Yiisoft\Queue\Enum\JobStatus;
+use Yiisoft\Queue\JobStatus;
 use Yiisoft\Queue\Message\MessageInterface;
 use Yiisoft\Queue\Middleware\Push\MiddlewarePushInterface;
 use Yiisoft\Queue\QueueInterface;

diff --git a/tests/App/FakeAdapter.php b/tests/App/FakeAdapter.php
@@ -7,7 +7,7 @@
 use BackedEnum;
 use Yiisoft\Queue\Adapter\AdapterInterface;
 use Yiisoft\Queue\ChannelNormalizer;
-use Yiisoft\Queue\Enum\JobStatus;
+use Yiisoft\Queue\JobStatus;
 use Yiisoft\Queue\Message\MessageInterface;
 
 final class FakeAdapter implements AdapterInterface

diff --git a/tests/Benchmark/Support/VoidAdapter.php b/tests/Benchmark/Support/VoidAdapter.php
@@ -8,7 +8,7 @@
 use InvalidArgumentException;
 use RuntimeException;
 use Yiisoft\Queue\Adapter\AdapterInterface;
-use Yiisoft\Queue\Enum\JobStatus;
+use Yiisoft\Queue\JobStatus;
 use Yiisoft\Queue\Message\IdEnvelope;
 use Yiisoft\Queue\Message\MessageInterface;
 use Yiisoft\Queue\Message\MessageSerializerInterface;

diff --git a/tests/Unit/Adapter/SynchronousAdapterTest.php b/tests/Unit/Adapter/SynchronousAdapterTest.php
@@ -6,7 +6,7 @@
 
 use PHPUnit\Framework\Attributes\DataProvider;
 use Yiisoft\Queue\Adapter\SynchronousAdapter;
-use Yiisoft\Queue\Enum\JobStatus;
+use Yiisoft\Queue\JobStatus;
 use Yiisoft\Queue\Message\IdEnvelope;
 use Yiisoft\Queue\Message\Message;
 use Yiisoft\Queue\QueueInterface;
@@ -35,7 +35,7 @@ public function testNonIntegerId(): void
         $id = $envelope->getMetadata()[IdEnvelope::MESSAGE_ID_KEY];
 
         $wrongId = "$id ";
-        self::assertEquals(JobStatus::waiting(), $queue->status($wrongId));
+        self::assertSame(JobStatus::WAITING, $queue->status($wrongId));
     }
 
     public function testIdSetting(): void

diff --git a/tests/Unit/Debug/QueueCollectorTest.php b/tests/Unit/Debug/QueueCollectorTest.php
@@ -4,10 +4,10 @@
 
 namespace Yiisoft\Queue\Tests\Unit\Debug;
 
+use Yiisoft\Queue\JobStatus;
 use Yiisoft\Yii\Debug\Collector\CollectorInterface;
 use Yiisoft\Yii\Debug\Tests\Shared\AbstractCollectorTestCase;
 use Yiisoft\Queue\Debug\QueueCollector;
-use Yiisoft\Queue\Enum\JobStatus;
 use Yiisoft\Queue\Message\Message;
 use Yiisoft\Queue\Tests\App\DummyQueue;
 
@@ -26,7 +26,7 @@ protected function setUp(): void
      */
     protected function collectTestData(CollectorInterface $collector): void
     {
-        $collector->collectStatus('12345', JobStatus::done());
+        $collector->collectStatus('12345', JobStatus::DONE);
         $collector->collectPush('chan1', $this->pushMessage);
         $collector->collectPush('chan2', $this->pushMessage);
         $collector->collectWorkerProcessing(

diff --git a/tests/Unit/Debug/QueueDecoratorTest.php b/tests/Unit/Debug/QueueDecoratorTest.php
@@ -8,10 +8,10 @@
 use Yiisoft\Queue\Adapter\AdapterInterface;
 use Yiisoft\Queue\Debug\QueueCollector;
 use Yiisoft\Queue\Debug\QueueDecorator;
+use Yiisoft\Queue\JobStatus;
 use Yiisoft\Queue\Message\MessageInterface;
 use Yiisoft\Queue\QueueInterface;
 use Yiisoft\Queue\Tests\App\FakeAdapter;
-use Yiisoft\Queue\Tests\Unit\Support\TestJobStatus;
 
 class QueueDecoratorTest extends TestCase
 {
@@ -34,7 +34,7 @@ public function testWithAdapter(): void
     public function testStatus(): void
     {
         $queue = $this->createMock(QueueInterface::class);
-        $jobStatus = TestJobStatus::withStatus(1);
+        $jobStatus = JobStatus::WAITING;
         $queue->expects($this->once())->method('status')->willReturn($jobStatus);
         $collector = new QueueCollector();
         $decorator = new QueueDecorator(

diff --git a/tests/Unit/JobStatusTest.php b/tests/Unit/JobStatusTest.php
diff --git a/tests/Unit/QueueTest.php b/tests/Unit/QueueTest.php
@@ -6,6 +6,7 @@
 
 use Yiisoft\Queue\Cli\SignalLoop;
 use Yiisoft\Queue\Exception\AdapterConfiguration\AdapterNotConfiguredException;
+use Yiisoft\Queue\JobStatus;
 use Yiisoft\Queue\Message\Message;
 use Yiisoft\Queue\Tests\App\FakeAdapter;
 use Yiisoft\Queue\Tests\TestCase;
@@ -96,11 +97,11 @@ public function testStatus(): void
         $id = $envelope->getMetadata()[IdEnvelope::MESSAGE_ID_KEY];
 
         $status = $queue->status($id);
-        self::assertTrue($status->isWaiting());
+        self::assertSame(JobStatus::WAITING, $status);
 
         $queue->run();
         $status = $queue->status($id);
-        self::assertTrue($status->isDone());
+        self::assertSame(JobStatus::DONE, $status);
     }
 
     public function testAdapterNotConfiguredException(): void