Introduce QueueProviderInterface::getNames() method

Author: vjik

config/di.php

@@ -59,14 +59,4 @@
         '__construct()' => ['middlewareDefinitions' => $params['yiisoft/queue']['middlewares-fail']],
     ],
     MessageSerializerInterface::class => JsonMessageSerializer::class,
-    RunCommand::class => [
-        '__construct()' => [
-            'queues' => array_keys($params['yiisoft/queue']['queues']),
-        ],
-    ],
-    ListenAllCommand::class => [
-        '__construct()' => [
-            'queues' => array_keys($params['yiisoft/queue']['queues']),
-        ],
-    ],
 ];

src/Command/ListenAllCommand.php

@@ -25,7 +25,6 @@ final class ListenAllCommand extends Command
     public function __construct(
         private readonly QueueProviderInterface $queueProvider,
         private readonly LoopInterface $loop,
-        private readonly array $queues,
     ) {
         parent::__construct();
     }
@@ -39,7 +38,7 @@ public function configure(): void
             'queue',
             InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
             'Queue name list to connect to',
-            $this->queues,
+            $this->queueProvider->getNames(),
         )
             ->addOption(
                 'pause',

src/Command/RunCommand.php

@@ -20,7 +20,6 @@ final class RunCommand extends Command
 {
     public function __construct(
         private readonly QueueProviderInterface $queueProvider,
-        private readonly array $queues,
     ) {
         parent::__construct();
     }
@@ -31,7 +30,7 @@ public function configure(): void
             'queue',
             InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
             'Queue name list to connect to.',
-            $this->queues,
+            $this->queueProvider->getNames(),
         )
             ->addOption(
                 'maximum',

src/Debug/QueueProviderInterfaceProxy.php

@@ -26,4 +26,9 @@ public function has(string|BackedEnum $name): bool
     {
         return $this->queueProvider->has($name);
     }
+
+    public function getNames(): array
+    {
+        return $this->queueProvider->getNames();
+    }
 }

src/Provider/AdapterFactoryQueueProvider.php

@@ -13,6 +13,7 @@
 use Yiisoft\Queue\QueueInterface;
 
 use function array_key_exists;
+use function array_keys;
 use function sprintf;
 
 /**
@@ -30,6 +31,11 @@ final class AdapterFactoryQueueProvider implements QueueProviderInterface
 
     private readonly StrictFactory $factory;
 
+    /**
+     * @psalm-var list<string>
+     */
+    private readonly array $names;
+
     /**
      * @param QueueInterface $baseQueue Base queue for queues creation.
      * @param array $definitions Adapter definitions indexed by queue names.
@@ -45,6 +51,7 @@ public function __construct(
         ?ContainerInterface $container = null,
         bool $validate = true,
     ) {
+        $this->names = array_keys($definitions);
         try {
             $this->factory = new StrictFactory($definitions, $container, $validate);
         } catch (InvalidConfigException $exception) {
@@ -70,6 +77,11 @@ public function has(string|BackedEnum $name): bool
         return $this->factory->has($name);
     }
 
+    public function getNames(): array
+    {
+        return $this->names;
+    }
+
     /**
      * @throws InvalidQueueConfigException
      */

src/Provider/CompositeQueueProvider.php

@@ -7,6 +7,10 @@
 use BackedEnum;
 use Yiisoft\Queue\QueueInterface;
 
+use function array_merge;
+use function array_unique;
+use function array_values;
+
 /**
  * Composite queue provider.
  */
@@ -45,4 +49,13 @@ public function has(string|BackedEnum $name): bool
         }
         return false;
     }
+
+    public function getNames(): array
+    {
+        $names = [];
+        foreach ($this->providers as $provider) {
+            $names[] = $provider->getNames();
+        }
+        return array_values(array_unique(array_merge(...$names)));
+    }
 }

src/Provider/PredefinedQueueProvider.php

@@ -9,6 +9,7 @@
 use Yiisoft\Queue\StringNormalizer;
 
 use function array_key_exists;
+use function array_keys;
 use function get_debug_type;
 use function sprintf;
 
@@ -62,4 +63,9 @@ public function has(string|BackedEnum $name): bool
         $name = StringNormalizer::normalize($name);
         return array_key_exists($name, $this->queues);
     }
+
+    public function getNames(): array
+    {
+        return array_keys($this->queues);
+    }
 }

src/Provider/QueueFactoryProvider.php

@@ -12,6 +12,7 @@
 use Yiisoft\Queue\StringNormalizer;
 
 use function array_key_exists;
+use function array_keys;
 use function sprintf;
 
 /**
@@ -29,6 +30,11 @@ final class QueueFactoryProvider implements QueueProviderInterface
 
     private readonly StrictFactory $factory;
 
+    /**
+     * @psalm-var list<string>
+     */
+    private readonly array $names;
+
     /**
      * @param array $definitions Queue definitions indexed by queue names.
      * @param ContainerInterface|null $container Container to use for dependencies resolving.
@@ -43,6 +49,7 @@ public function __construct(
         ?ContainerInterface $container = null,
         bool $validate = true,
     ) {
+        $this->names = array_keys($definitions);
         try {
             $this->factory = new StrictFactory($definitions, $container, $validate);
         } catch (InvalidConfigException $exception) {
@@ -68,6 +75,11 @@ public function has(string|BackedEnum $name): bool
         return $this->factory->has($name);
     }
 
+    public function getNames(): array
+    {
+        return $this->names;
+    }
+
     /**
      * @throws InvalidQueueConfigException
      */

src/Provider/QueueProviderInterface.php

@@ -35,4 +35,13 @@ public function get(string|BackedEnum $name): QueueInterface;
      * @return bool Whether the queue exists.
      */
     public function has(string|BackedEnum $name): bool;
+
+    /**
+     * Returns a list of queue names.
+     *
+     * @return string[] Queue names.
+     *
+     * @psalm-return list<string>
+     */
+    public function getNames(): array;
 }

tests/Unit/Debug/QueueProviderInterfaceProxyTest.php

@@ -33,4 +33,14 @@ public function testHas(): void
 
         $this->assertTrue($factory->has('test'));
     }
+
+    public function testGetNames(): void
+    {
+        $queueFactory = $this->createMock(QueueProviderInterface::class);
+        $queueFactory->expects($this->once())->method('getNames')->willReturn(['queue1', 'queue2']);
+        $collector = new QueueCollector();
+        $factory = new QueueProviderInterfaceProxy($queueFactory, $collector);
+
+        $this->assertSame(['queue1', 'queue2'], $factory->getNames());
+    }
 }