Remove the withChannelName() method from QueueInterface (#225)

viktorprogger · StyleCIBot · web-flow · commit 552564ee949e · 2024-12-08T22:50:45.000+05:00
* Remove the withChannelName() method from QueueInterface

* Apply fixes from StyleCI

* Bugfix

* Bugfix

* Apply fixes from StyleCI

* Bugfix

* Apply fixes from StyleCI

---------

Co-authored-by: StyleCI Bot &lt;bot@styleci.io&gt;
diff --git a/src/Adapter/AdapterInterface.php b/src/Adapter/AdapterInterface.php
@@ -20,7 +20,7 @@ public function runExisting(callable $handlerCallback): void;
     /**
      * Returns status code of a message with the given id.
      *
-     * @param string $id ID of a job message.
+     * @param int|string $id ID of a job message.
      *
      * @throws InvalidArgumentException When there is no such id in the adapter.
      *
@@ -41,4 +41,6 @@ public function push(MessageInterface $message): MessageInterface;
     public function subscribe(callable $handlerCallback): void;
 
     public function withChannel(string $channel): self;
+
+    public function getChannelName(): string;
 }
diff --git a/src/Adapter/SynchronousAdapter.php b/src/Adapter/SynchronousAdapter.php
@@ -86,4 +86,9 @@ public function withChannel(string $channel): self
 
         return $new;
     }
+
+    public function getChannelName(): string
+    {
+        return $this->channel;
+    }
 }
diff --git a/src/Debug/QueueCollector.php b/src/Debug/QueueCollector.php
@@ -51,13 +51,17 @@ public function collectStatus(string $id, JobStatus $status): void
     }
 
     public function collectPush(
-        string $channel,
+        ?string $channel,
         MessageInterface $message,
         string|array|callable|MiddlewarePushInterface ...$middlewareDefinitions,
     ): void {
         if (!$this->isActive()) {
             return;
         }
+        if ($channel === null) {
+            $channel = 'null';
+        }
+
         $this->pushes[$channel][] = [
             'message' => $message,
             'middlewares' => $middlewareDefinitions,
@@ -69,7 +73,7 @@ public function collectWorkerProcessing(MessageInterface $message, QueueInterfac
         if (!$this->isActive()) {
             return;
         }
-        $this->processingMessages[$queue->getChannelName()][] = $message;
+        $this->processingMessages[$queue->getChannelName() ?? 'null'][] = $message;
     }
 
     private function reset(): void
diff --git a/src/Debug/QueueDecorator.php b/src/Debug/QueueDecorator.php
@@ -21,7 +21,7 @@ public function __construct(
     public function status(string|int $id): JobStatus
     {
         $result = $this->queue->status($id);
-        $this->collector->collectStatus($id, $result);
+        $this->collector->collectStatus((string) $id, $result);
 
         return $result;
     }
@@ -50,15 +50,8 @@ public function withAdapter(AdapterInterface $adapter): QueueInterface
         return new self($this->queue->withAdapter($adapter), $this->collector);
     }
 
-    public function getChannelName(): string
+    public function getChannelName(): ?string
     {
         return $this->queue->getChannelName();
     }
-
-    public function withChannelName(string $channel): QueueInterface
-    {
-        $new = clone $this;
-        $new->queue = $this->queue->withChannelName($channel);
-        return $new;
-    }
 }
diff --git a/src/Middleware/FailureHandling/FailureMiddlewareDispatcher.php b/src/Middleware/FailureHandling/FailureMiddlewareDispatcher.php
@@ -37,6 +37,7 @@ public function dispatch(
         FailureHandlingRequest $request,
         MessageFailureHandlerInterface $finishHandler
     ): FailureHandlingRequest {
+        /** @var string $channelName It is always string in this context */
         $channelName = $request->getQueue()->getChannelName();
         if (!isset($this->middlewareDefinitions[$channelName]) || $this->middlewareDefinitions[$channelName] === []) {
             $channelName = self::DEFAULT_PIPELINE;
diff --git a/src/Provider/AdapterFactoryQueueProvider.php b/src/Provider/AdapterFactoryQueueProvider.php
@@ -85,7 +85,7 @@ private function getOrTryToCreate(string $channel): QueueInterface|null
                     ),
                 );
             }
-            $this->queues[$channel] = $this->baseQueue->withAdapter($adapter)->withChannelName($channel);
+            $this->queues[$channel] = $this->baseQueue->withAdapter($adapter->withChannel($channel));
         } else {
             $this->queues[$channel] = null;
         }
diff --git a/src/Provider/PrototypeQueueProvider.php b/src/Provider/PrototypeQueueProvider.php
@@ -4,6 +4,7 @@
 
 namespace Yiisoft\Queue\Provider;
 
+use Yiisoft\Queue\Adapter\AdapterInterface;
 use Yiisoft\Queue\QueueInterface;
 
 /**
@@ -17,12 +18,13 @@ final class PrototypeQueueProvider implements QueueProviderInterface
      */
     public function __construct(
         private readonly QueueInterface $baseQueue,
+        private readonly AdapterInterface $baseAdapter,
     ) {
     }
 
     public function get(string $channel): QueueInterface
     {
-        return $this->baseQueue->withChannelName($channel);
+        return $this->baseQueue->withAdapter($this->baseAdapter->withChannel($channel));
     }
 
     public function has(string $channel): bool
diff --git a/src/Queue.php b/src/Queue.php
@@ -32,16 +32,15 @@ public function __construct(
         private LoggerInterface $logger,
         private PushMiddlewareDispatcher $pushMiddlewareDispatcher,
         private ?AdapterInterface $adapter = null,
-        private string $channelName = QueueInterface::DEFAULT_CHANNEL_NAME,
         MiddlewarePushInterface|callable|array|string ...$middlewareDefinitions
     ) {
         $this->middlewareDefinitions = $middlewareDefinitions;
         $this->adapterPushHandler = new AdapterPushHandler();
     }
 
-    public function getChannelName(): string
+    public function getChannelName(): ?string
     {
-        return $this->channelName;
+        return $this->adapter?->getChannelName();
     }
 
     public function push(
@@ -136,14 +135,6 @@ public function withMiddlewaresAdded(MiddlewarePushInterface|callable|array|stri
         return $instance;
     }
 
-    public function withChannelName(string $channel): self
-    {
-        $instance = clone $this;
-        $instance->channelName = $channel;
-        $instance->adapter = $this->adapter?->withChannel($channel);
-        return $instance;
-    }
-
     private function handle(MessageInterface $message): bool
     {
         $this->worker->process($message, $this);
diff --git a/src/QueueInterface.php b/src/QueueInterface.php
@@ -36,7 +36,7 @@ public function run(int $max = 0): int;
     public function listen(): void;
 
     /**
-     * @param string $id A message id
+     * @param int|string $id A message id
      *
      * @throws InvalidArgumentException when there is no such id in the adapter
      *
@@ -46,7 +46,5 @@ public function status(string|int $id): JobStatus;
 
     public function withAdapter(AdapterInterface $adapter): self;
 
-    public function getChannelName(): string;
-
-    public function withChannelName(string $channel): self;
+    public function getChannelName(): ?string;
 }
diff --git a/stubs/StubAdapter.php b/stubs/StubAdapter.php
@@ -7,12 +7,17 @@
 use Yiisoft\Queue\Adapter\AdapterInterface;
 use Yiisoft\Queue\Enum\JobStatus;
 use Yiisoft\Queue\Message\MessageInterface;
+use Yiisoft\Queue\QueueInterface;
 
 /**
  * Stub adapter that does nothing. Job status is always "done".
  */
 final class StubAdapter implements AdapterInterface
 {
+    public function __construct(private string $channelName = QueueInterface::DEFAULT_CHANNEL_NAME)
+    {
+    }
+
     public function runExisting(callable $handlerCallback): void
     {
     }
@@ -33,6 +38,14 @@ public function subscribe(callable $handlerCallback): void
 
     public function withChannel(string $channel): AdapterInterface
     {
-        return clone $this;
+        $new = clone $this;
+        $new->channelName = $channel;
+
+        return $new;
+    }
+
+    public function getChannelName(): string
+    {
+        return $this->channelName;
     }
 }
diff --git a/stubs/StubQueue.php b/stubs/StubQueue.php
@@ -15,10 +15,8 @@
  */
 final class StubQueue implements QueueInterface
 {
-    public function __construct(
-        private string $channelName = QueueInterface::DEFAULT_CHANNEL_NAME,
-        private ?AdapterInterface $adapter = null,
-    ) {
+    public function __construct(private ?AdapterInterface $adapter = null)
+    {
     }
 
     public function push(
@@ -51,21 +49,12 @@ public function withAdapter(AdapterInterface $adapter): QueueInterface
     {
         $new = clone $this;
         $new->adapter = $adapter;
-        return $new;
-    }
 
-    public function getChannelName(): string
-    {
-        return $this->channelName;
+        return $new;
     }
 
-    public function withChannelName(string $channel): QueueInterface
+    public function getChannelName(): ?string
     {
-        $new = clone $this;
-        $new->channelName = $channel;
-        if ($new->adapter !== null) {
-            $new->adapter = $new->adapter->withChannel($channel);
-        }
-        return $new;
+        return $this->adapter?->getChannelName();
     }
 }
diff --git a/tests/App/DummyQueue.php b/tests/App/DummyQueue.php
@@ -47,9 +47,4 @@ public function getChannelName(): string
     {
         return $this->channelName;
     }
-
-    public function withChannelName(string $channel): QueueInterface
-    {
-        throw new Exception('`withChannelName()` method is not implemented yet.');
-    }
 }
diff --git a/tests/App/FakeAdapter.php b/tests/App/FakeAdapter.php
@@ -43,4 +43,9 @@ public function withChannel(string $channel): AdapterInterface
 
         return $instance;
     }
+
+    public function getChannelName(): string
+    {
+        return $this->channel;
+    }
 }
diff --git a/tests/Benchmark/Support/VoidAdapter.php b/tests/Benchmark/Support/VoidAdapter.php
@@ -49,4 +49,9 @@ public function withChannel(string $channel): AdapterInterface
     {
         throw new RuntimeException('Method is not implemented');
     }
+
+    public function getChannelName(): string
+    {
+        throw new RuntimeException('Method is not implemented');
+    }
 }
diff --git a/tests/Unit/Debug/QueueDecoratorTest.php b/tests/Unit/Debug/QueueDecoratorTest.php
@@ -99,26 +99,12 @@ public function testGetChannelName(): void
         $this->assertEquals('getChannelName', $decorator->getChannelName());
     }
 
-    public function testWithChannelName(): void
-    {
-        $queue = $this->createMock(QueueInterface::class);
-        $queue->expects($this->once())->method('withChannelName')->willReturn($queue);
-        $collector = new QueueCollector();
-        $decorator = new QueueDecorator(
-            $queue,
-            $collector,
-        );
-
-        $this->assertInstanceOf(QueueInterface::class, $decorator->withChannelName('test'));
-    }
-
     public function testImmutable(): void
     {
         $queueDecorator = new QueueDecorator(
             $this->createMock(QueueInterface::class),
             new QueueCollector()
         );
         $this->assertNotSame($queueDecorator, $queueDecorator->withAdapter(new FakeAdapter()));
-        $this->assertNotSame($queueDecorator, $queueDecorator->withChannelName('test'));
     }
 }
diff --git a/tests/Unit/Provider/CompositeQueueProviderTest.php b/tests/Unit/Provider/CompositeQueueProviderTest.php
@@ -15,7 +15,7 @@ final class CompositeQueueProviderTest extends TestCase
 {
     public function testBase(): void
     {
-        $queue = new StubQueue('channel');
+        $queue = new StubQueue(new StubAdapter());
         $provider = new CompositeQueueProvider(
             new AdapterFactoryQueueProvider(
                 $queue,
@@ -38,7 +38,10 @@ public function testBase(): void
     public function testNotFound(): void
     {
         $provider = new CompositeQueueProvider(
-            new AdapterFactoryQueueProvider(new StubQueue('channel'), ['channel1' => new StubAdapter()]),
+            new AdapterFactoryQueueProvider(
+                new StubQueue(new StubAdapter()),
+                ['channel1' => new StubAdapter()]
+            ),
         );
 
         $this->expectException(ChannelNotFoundException::class);
diff --git a/tests/Unit/Provider/PrototypeQueueProviderTest.php b/tests/Unit/Provider/PrototypeQueueProviderTest.php
@@ -6,6 +6,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Yiisoft\Queue\Provider\PrototypeQueueProvider;
+use Yiisoft\Queue\Stubs\StubAdapter;
 use Yiisoft\Queue\Stubs\StubQueue;
 
 final class PrototypeQueueProviderTest extends TestCase
@@ -14,6 +15,7 @@ public function testBase(): void
     {
         $provider = new PrototypeQueueProvider(
             new StubQueue(),
+            new StubAdapter(),
         );
 
         $queue = $provider->get('test-channel');
diff --git a/tests/Unit/Stubs/StubQueueTest.php b/tests/Unit/Stubs/StubQueueTest.php
@@ -6,7 +6,6 @@
 
 use PHPUnit\Framework\TestCase;
 use Yiisoft\Queue\Message\Message;
-use Yiisoft\Queue\QueueInterface;
 use Yiisoft\Queue\Stubs\StubQueue;
 use Yiisoft\Queue\Stubs\StubAdapter;
 
@@ -20,7 +19,7 @@ public function testBase(): void
         $this->assertSame($message, $queue->push($message));
         $this->assertSame(0, $queue->run());
         $this->assertTrue($queue->status('test')->isDone());
-        $this->assertSame(QueueInterface::DEFAULT_CHANNEL_NAME, $queue->getChannelName());
+        $this->assertNull($queue->getChannelName());
         $this->assertNull($queue->getAdapter());
         $queue->listen();
     }
@@ -34,15 +33,4 @@ public function testWithAdapter(): void
         $this->assertNotSame($queue, $sourceQueue);
         $this->assertInstanceOf(StubAdapter::class, $queue->getAdapter());
     }
-
-    public function testWithChannelName(): void
-    {
-        $sourceQueue = new StubQueue();
-
-        $queue = $sourceQueue->withChannelName('test');
-
-        $this->assertNotSame($queue, $sourceQueue);
-        $this->assertSame(QueueInterface::DEFAULT_CHANNEL_NAME, $sourceQueue->getChannelName());
-        $this->assertSame('test', $queue->getChannelName());
-    }
 }

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public function runExisting(callable $handlerCallback): void;`
`20`	`20`	`/**`
`21`	`21`	`* Returns status code of a message with the given id.`
`22`	`22`	`*`
`23`		`- * @param string $id ID of a job message.`
	`23`	`+ * @param int\|string $id ID of a job message.`
`24`	`24`	`*`
`25`	`25`	`* @throws InvalidArgumentException When there is no such id in the adapter.`
`26`	`26`	`*`
`@@ -41,4 +41,6 @@ public function push(MessageInterface $message): MessageInterface;`
`41`	`41`	`public function subscribe(callable $handlerCallback): void;`
`42`	`42`
`43`	`43`	`public function withChannel(string $channel): self;`
	`44`	`+`
	`45`	`+ public function getChannelName(): string;`
`44`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -86,4 +86,9 @@ public function withChannel(string $channel): self`
`86`	`86`
`87`	`87`	`return $new;`
`88`	`88`	`}`
	`89`	`+`
	`90`	`+ public function getChannelName(): string`
	`91`	`+ {`
	`92`	`+ return $this->channel;`
	`93`	`+ }`
`89`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public function __construct(`
`21`	`21`	`public function status(string\|int $id): JobStatus`
`22`	`22`	`{`
`23`	`23`	`$result = $this->queue->status($id);`
`24`		`- $this->collector->collectStatus($id, $result);`
	`24`	`+ $this->collector->collectStatus((string) $id, $result);`
`25`	`25`
`26`	`26`	`return $result;`
`27`	`27`	`}`
`@@ -50,15 +50,8 @@ public function withAdapter(AdapterInterface $adapter): QueueInterface`
`50`	`50`	`return new self($this->queue->withAdapter($adapter), $this->collector);`
`51`	`51`	`}`
`52`	`52`
`53`		`- public function getChannelName(): string`
	`53`	`+ public function getChannelName(): ?string`
`54`	`54`	`{`
`55`	`55`	`return $this->queue->getChannelName();`
`56`	`56`	`}`
`57`		`-`
`58`		`- public function withChannelName(string $channel): QueueInterface`
`59`		`- {`
`60`		`- $new = clone $this;`
`61`		`- $new->queue = $this->queue->withChannelName($channel);`
`62`		`- return $new;`
`63`		`- }`
`64`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ private function getOrTryToCreate(string $channel): QueueInterface\|null`
`85`	`85`	`),`
`86`	`86`	`);`
`87`	`87`	`}`
`88`		`- $this->queues[$channel] = $this->baseQueue->withAdapter($adapter)->withChannelName($channel);`
	`88`	`+ $this->queues[$channel] = $this->baseQueue->withAdapter($adapter->withChannel($channel));`
`89`	`89`	`} else {`
`90`	`90`	`$this->queues[$channel] = null;`
`91`	`91`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace Yiisoft\Queue\Provider;`
`6`	`6`
	`7`	`+use Yiisoft\Queue\Adapter\AdapterInterface;`
`7`	`8`	`use Yiisoft\Queue\QueueInterface;`
`8`	`9`
`9`	`10`	`/**`
`@@ -17,12 +18,13 @@ final class PrototypeQueueProvider implements QueueProviderInterface`
`17`	`18`	`*/`
`18`	`19`	`public function __construct(`
`19`	`20`	`private readonly QueueInterface $baseQueue,`
	`21`	`+ private readonly AdapterInterface $baseAdapter,`
`20`	`22`	`) {`
`21`	`23`	`}`
`22`	`24`
`23`	`25`	`public function get(string $channel): QueueInterface`
`24`	`26`	`{`
`25`		`- return $this->baseQueue->withChannelName($channel);`
	`27`	`+ return $this->baseQueue->withAdapter($this->baseAdapter->withChannel($channel));`
`26`	`28`	`}`
`27`	`29`
`28`	`30`	`public function has(string $channel): bool`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function run(int $max = 0): int;`
`36`	`36`	`public function listen(): void;`
`37`	`37`
`38`	`38`	`/**`
`39`		`- * @param string $id A message id`
	`39`	`+ * @param int\|string $id A message id`
`40`	`40`	`*`
`41`	`41`	`* @throws InvalidArgumentException when there is no such id in the adapter`
`42`	`42`	`*`
`@@ -46,7 +46,5 @@ public function status(string\|int $id): JobStatus;`
`46`	`46`
`47`	`47`	`public function withAdapter(AdapterInterface $adapter): self;`
`48`	`48`
`49`		`- public function getChannelName(): string;`
`50`		`-`
`51`		`- public function withChannelName(string $channel): self;`
	`49`	`+ public function getChannelName(): ?string;`
`52`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,12 +7,17 @@`
`7`	`7`	`use Yiisoft\Queue\Adapter\AdapterInterface;`
`8`	`8`	`use Yiisoft\Queue\Enum\JobStatus;`
`9`	`9`	`use Yiisoft\Queue\Message\MessageInterface;`
	`10`	`+use Yiisoft\Queue\QueueInterface;`
`10`	`11`
`11`	`12`	`/**`
`12`	`13`	`* Stub adapter that does nothing. Job status is always "done".`
`13`	`14`	`*/`
`14`	`15`	`final class StubAdapter implements AdapterInterface`
`15`	`16`	`{`
	`17`	`+ public function __construct(private string $channelName = QueueInterface::DEFAULT_CHANNEL_NAME)`
	`18`	`+ {`
	`19`	`+ }`
	`20`	`+`
`16`	`21`	`public function runExisting(callable $handlerCallback): void`
`17`	`22`	`{`
`18`	`23`	`}`
`@@ -33,6 +38,14 @@ public function subscribe(callable $handlerCallback): void`
`33`	`38`
`34`	`39`	`public function withChannel(string $channel): AdapterInterface`
`35`	`40`	`{`
`36`		`- return clone $this;`
	`41`	`+ $new = clone $this;`
	`42`	`+ $new->channelName = $channel;`
	`43`	`+`
	`44`	`+ return $new;`
	`45`	`+ }`
	`46`	`+`
	`47`	`+ public function getChannelName(): string`
	`48`	`+ {`
	`49`	`+ return $this->channelName;`
`37`	`50`	`}`
`38`	`51`	`}`