Remove QueueInterface::withAdapter() and AdapterFactoryQueueProvider (#266)

Author: vjik

config/di.php

@@ -17,22 +17,12 @@
 use Yiisoft\Queue\Middleware\Push\MiddlewareFactoryPush;
 use Yiisoft\Queue\Middleware\Push\MiddlewareFactoryPushInterface;
 use Yiisoft\Queue\Middleware\Push\PushMiddlewareDispatcher;
-use Yiisoft\Queue\Provider\AdapterFactoryQueueProvider;
-use Yiisoft\Queue\Provider\QueueProviderInterface;
-use Yiisoft\Queue\Queue;
-use Yiisoft\Queue\QueueInterface;
 use Yiisoft\Queue\Worker\Worker as QueueWorker;
 use Yiisoft\Queue\Worker\WorkerInterface;
 
 /* @var array $params */
 
 return [
-    AdapterFactoryQueueProvider::class => [
-        '__construct()' => [
-            'definitions' => $params['yiisoft/queue']['queues'],
-        ],
-    ],
-    QueueProviderInterface::class => AdapterFactoryQueueProvider::class,
     QueueWorker::class => [
         'class' => QueueWorker::class,
         '__construct()' => [$params['yiisoft/queue']['handlers']],
@@ -43,7 +33,6 @@
             ? $container->get(SignalLoop::class)
             : $container->get(SimpleLoop::class);
     },
-    QueueInterface::class => Queue::class,
     MiddlewareFactoryPushInterface::class => MiddlewareFactoryPush::class,
     MiddlewareFactoryConsumeInterface::class => MiddlewareFactoryConsume::class,
     MiddlewareFactoryFailureInterface::class => MiddlewareFactoryFailure::class,

config/params.php

@@ -2,7 +2,6 @@
 
 declare(strict_types=1);
 
-use Yiisoft\Queue\Adapter\AdapterInterface;
 use Yiisoft\Queue\Command\ListenAllCommand;
 use Yiisoft\Queue\Command\ListenCommand;
 use Yiisoft\Queue\Command\RunCommand;
@@ -22,9 +21,6 @@
     ],
     'yiisoft/queue' => [
         'handlers' => [],
-        'queues' => [
-            QueueProviderInterface::DEFAULT_QUEUE => AdapterInterface::class,
-        ],
         'middlewares-push' => [],
         'middlewares-consume' => [],
         'middlewares-fail' => [],

src/Debug/QueueDecorator.php

@@ -4,8 +4,6 @@
 
 namespace Yiisoft\Queue\Debug;
 
-use BackedEnum;
-use Yiisoft\Queue\Adapter\AdapterInterface;
 use Yiisoft\Queue\JobStatus;
 use Yiisoft\Queue\Message\MessageInterface;
 use Yiisoft\Queue\Middleware\Push\MiddlewarePushInterface;
@@ -45,11 +43,6 @@ public function listen(): void
         $this->queue->listen();
     }
 
-    public function withAdapter(AdapterInterface $adapter, string|BackedEnum|null $queueName = null): static
-    {
-        return new self($this->queue->withAdapter($adapter, $queueName), $this->collector);
-    }
-
     public function getName(): string
     {
         return $this->queue->getName();

src/Exception/AdapterConfiguration/AdapterNotConfiguredException.php

@@ -4,18 +4,17 @@
 
 namespace Yiisoft\Queue\Middleware\Push;
 
-use Yiisoft\Queue\Exception\AdapterConfiguration\AdapterNotConfiguredException;
-
 /**
  * @internal
  */
 final class AdapterPushHandler implements MessageHandlerPushInterface
 {
     public function handlePush(PushRequest $request): PushRequest
     {
-        if (($adapter = $request->getAdapter()) === null) {
-            throw new AdapterNotConfiguredException();
-        }
-        return $request->withMessage($adapter->push($request->getMessage()));
+        return $request->withMessage(
+            $request->getAdapter()->push(
+                $request->getMessage(),
+            ),
+        );
     }
 }

src/Middleware/Push/AdapterPushHandler.php

@@ -9,14 +9,17 @@
 
 final class PushRequest
 {
-    public function __construct(private MessageInterface $message, private ?AdapterInterface $adapter) {}
+    public function __construct(
+        private MessageInterface $message,
+        private AdapterInterface $adapter,
+    ) {}
 
     public function getMessage(): MessageInterface
     {
         return $this->message;
     }
 
-    public function getAdapter(): ?AdapterInterface
+    public function getAdapter(): AdapterInterface
     {
         return $this->adapter;
     }

src/Middleware/Push/PushRequest.php

@@ -8,7 +8,6 @@
 use Psr\Log\LoggerInterface;
 use Yiisoft\Queue\Adapter\AdapterInterface;
 use Yiisoft\Queue\Cli\LoopInterface;
-use Yiisoft\Queue\Exception\AdapterConfiguration\AdapterNotConfiguredException;
 use Yiisoft\Queue\Message\MessageInterface;
 use Yiisoft\Queue\Middleware\Push\AdapterPushHandler;
 use Yiisoft\Queue\Middleware\Push\MessageHandlerPushInterface;
@@ -29,12 +28,12 @@ final class Queue implements QueueInterface
     private string $name;
 
     public function __construct(
+        private readonly AdapterInterface $adapter,
         private readonly WorkerInterface $worker,
         private readonly LoopInterface $loop,
         private readonly LoggerInterface $logger,
         private readonly PushMiddlewareDispatcher $pushMiddlewareDispatcher,
         string|BackedEnum $name = QueueProviderInterface::DEFAULT_QUEUE,
-        private ?AdapterInterface $adapter = null,
         MiddlewarePushInterface|callable|array|string ...$middlewareDefinitions,
     ) {
         $this->name = StringNormalizer::normalize($name);
@@ -51,7 +50,6 @@ public function push(
         MessageInterface $message,
         MiddlewarePushInterface|callable|array|string ...$middlewareDefinitions,
     ): MessageInterface {
-        $this->checkAdapter();
         $this->logger->debug(
             'Preparing to push message with handler name "{handlerName}".',
             ['handlerName' => $message->getHandlerName()],
@@ -74,8 +72,6 @@ public function push(
 
     public function run(int $max = 0): int
     {
-        $this->checkAdapter();
-
         $this->logger->debug('Start processing queue messages.');
         $count = 0;
 
@@ -100,30 +96,16 @@ public function run(int $max = 0): int
 
     public function listen(): void
     {
-        $this->checkAdapter();
-
         $this->logger->info('Start listening to the queue.');
         $this->adapter->subscribe(fn(MessageInterface $message) => $this->handle($message));
         $this->logger->info('Finish listening to the queue.');
     }
 
     public function status(string|int $id): JobStatus
     {
-        $this->checkAdapter();
         return $this->adapter->status($id);
     }
 
-    public function withAdapter(AdapterInterface $adapter, string|BackedEnum|null $queueName = null): static
-    {
-        $new = clone $this;
-        $new->adapter = $adapter;
-        if ($queueName !== null) {
-            $new->name = StringNormalizer::normalize($queueName);
-        }
-
-        return $new;
-    }
-
     public function withMiddlewares(MiddlewarePushInterface|callable|array|string ...$middlewareDefinitions): self
     {
         $instance = clone $this;
@@ -147,16 +129,6 @@ private function handle(MessageInterface $message): bool
         return $this->loop->canContinue();
     }
 
-    /**
-     * @psalm-assert AdapterInterface $this->adapter
-     */
-    private function checkAdapter(): void
-    {
-        if ($this->adapter === null) {
-            throw new AdapterNotConfiguredException();
-        }
-    }
-
     private function createPushHandler(MiddlewarePushInterface|callable|array|string ...$middlewares): MessageHandlerPushInterface
     {
         return new class (

src/Provider/AdapterFactoryQueueProvider.php

@@ -4,9 +4,7 @@
 
 namespace Yiisoft\Queue;
 
-use BackedEnum;
 use InvalidArgumentException;
-use Yiisoft\Queue\Adapter\AdapterInterface;
 use Yiisoft\Queue\Message\MessageInterface;
 use Yiisoft\Queue\Middleware\Push\MiddlewarePushInterface;
 
@@ -41,14 +39,6 @@ public function listen(): void;
      */
     public function status(string|int $id): JobStatus;
 
-    /**
-     * @param AdapterInterface $adapter Adapter to use.
-     * @param string|BackedEnum|null $queueName Queue name to use.
-     *
-     * @return static A new queue with the given adapter and queue name.
-     */
-    public function withAdapter(AdapterInterface $adapter, string|BackedEnum|null $queueName = null): static;
-
     /**
      * Returns the logical name of the queue.
      */