diff --git a/composer.json b/composer.json index 7f2394e..cd7d034 100644 --- a/composer.json +++ b/composer.json @@ -28,7 +28,7 @@ "php-amqplib/php-amqplib": "^3.1.0", "yiisoft/factory": "^1.0", "yiisoft/friendly-exception": "^1.0", - "yiisoft/queue": "dev-master" + "yiisoft/queue": "dev-new" }, "require-dev": { "maglnet/composer-require-checker": "^4.4", diff --git a/src/Adapter.php b/src/Adapter.php index 589f017..c204e1d 100644 --- a/src/Adapter.php +++ b/src/Adapter.php @@ -10,7 +10,9 @@ use Yiisoft\Queue\AMQP\Exception\NotImplementedException; use Yiisoft\Queue\Cli\LoopInterface; use Yiisoft\Queue\Enum\JobStatus; +use Yiisoft\Queue\Message\IdEnvelope; use Yiisoft\Queue\Message\MessageInterface; +use Yiisoft\Queue\Message\MessageSerializerInterface; final class Adapter implements AdapterInterface { @@ -23,33 +25,34 @@ public function __construct( public function withChannel(string $channel): self { - $instance = clone $this; - $instance->queueProvider = $this->queueProvider->withChannelName($channel); + $new = clone $this; + $new->queueProvider = $this->queueProvider->withChannelName($channel); - return $instance; + return $new; } /** - * @param callable(MessageInterface): bool $handlerCallback + * @param callable(MessageInterface): bool $handlerCallback */ public function runExisting(callable $handlerCallback): void { $channel = $this->queueProvider->getChannel(); - (new ExistingMessagesConsumer($channel, $this->queueProvider - ->getQueueSettings() - ->getName(), $this->serializer)) - ->consume($handlerCallback); + $queueName = $this->queueProvider->getQueueSettings()->getName(); + $consumer = new ExistingMessagesConsumer( + $channel, + $queueName, + $this->serializer + ); + + $consumer->consume($handlerCallback); } - /** - * @return never - */ - public function status(string $id): JobStatus + public function status(string|int $id): JobStatus { - throw new NotImplementedException('Status check is not supported by the adapter ' . self::class . '.'); + throw new NotImplementedException(sprintf('Status check is not supported by the adapter %s.', self::class)); } - public function push(MessageInterface $message): void + public function push(MessageInterface $message): MessageInterface { $payload = $this->serializer->serialize($message); $amqpMessage = new AMQPMessage( @@ -57,30 +60,28 @@ public function push(MessageInterface $message): void array_merge(['message_id' => uniqid(more_entropy: true)], $this->queueProvider->getMessageProperties()) ); $exchangeSettings = $this->queueProvider->getExchangeSettings(); - $this->queueProvider - ->getChannel() - ->basic_publish( - $amqpMessage, - $exchangeSettings?->getName() ?? '', - $exchangeSettings ? '' : $this->queueProvider - ->getQueueSettings() - ->getName() - ); + $channel = $this->queueProvider->getChannel(); + $channel->basic_publish( + $amqpMessage, + $exchangeSettings?->getName() ?? '', + $exchangeSettings ? '' : $this->queueProvider + ->getQueueSettings() + ->getName() + ); /** @var string $messageId */ $messageId = $amqpMessage->get('message_id'); - $message->setId($messageId); + + return new IdEnvelope($message, $messageId); } public function subscribe(callable $handlerCallback): void { $channel = $this->queueProvider->getChannel(); + $queueName = $this->queueProvider->getQueueSettings()->getName(); + $channel->basic_consume( - $this->queueProvider - ->getQueueSettings() - ->getName(), - $this->queueProvider - ->getQueueSettings() - ->getName(), + $queueName, + $queueName, false, false, false, diff --git a/src/Exception/NoKeyInPayloadException.php b/src/Exception/NoKeyInPayloadException.php deleted file mode 100644 index 79ec038..0000000 --- a/src/Exception/NoKeyInPayloadException.php +++ /dev/null @@ -1,54 +0,0 @@ -expectedKey . '" in payload'; - } - - /** - * @return string - * - * @infection-ignore-all - */ - public function getSolution(): ?string - { - return sprintf( - "We have successfully unserialized a message, but there was no expected key \"%s\". - There are the following keys in the message: %s. - You might want to change message's structure, or make your own implementation of %s, - which won't rely on this key in the message.", - $this->expectedKey, - implode(', ', array_keys($this->payload)), - MessageSerializerInterface::class - ); - } -} diff --git a/src/ExistingMessagesConsumer.php b/src/ExistingMessagesConsumer.php index 4e030eb..f01f97a 100644 --- a/src/ExistingMessagesConsumer.php +++ b/src/ExistingMessagesConsumer.php @@ -8,6 +8,7 @@ use PhpAmqpLib\Message\AMQPMessage; use Throwable; use Yiisoft\Queue\Message\MessageInterface; +use Yiisoft\Queue\Message\MessageSerializerInterface; /** * @internal diff --git a/src/MessageSerializer.php b/src/MessageSerializer.php deleted file mode 100644 index 9afc07e..0000000 --- a/src/MessageSerializer.php +++ /dev/null @@ -1,64 +0,0 @@ - $message->getId(), - 'name' => $message->getHandlerName(), - 'data' => $message->getData(), - 'meta' => $message->getMetadata(), - ]; - - return json_encode($payload, JSON_THROW_ON_ERROR); - } - - /** - * @throws JsonException - * @throws NoKeyInPayloadException - * @throws InvalidArgumentException - */ - public function unserialize(string $value): Message - { - $payload = json_decode($value, true, 512, JSON_THROW_ON_ERROR); - if (!is_array($payload)) { - throw new InvalidArgumentException('Payload must be array. Got ' . get_debug_type($payload) . '.'); - } - - $name = $payload['name'] ?? null; - if (!is_string($name)) { - throw new NoKeyInPayloadException('name', $payload); - } - - $id = $payload['id'] ?? null; - if ($id !== null && !is_string($id)) { - throw new NoKeyInPayloadException('id', $payload); - } - - $meta = $payload['meta'] ?? []; - if (!is_array($meta)) { - throw new NoKeyInPayloadException('meta', $payload); - } - - return new Message( - $name, - $payload['data'] ?? null, - $meta, - $id, - ); - } -} diff --git a/src/MessageSerializerInterface.php b/src/MessageSerializerInterface.php deleted file mode 100644 index 4d84521..0000000 --- a/src/MessageSerializerInterface.php +++ /dev/null @@ -1,14 +0,0 @@ -delayInSeconds; } - public function processPush(PushRequest $request, MessageHandlerPushInterface $handler): PushRequest + public function process(Request $request, MessageHandlerInterface $handler): Request { - $adapter = $request->getAdapter(); - if (!$adapter instanceof Adapter) { - $type = get_debug_type($adapter); - $class = Adapter::class; - throw new InvalidArgumentException( - "This middleware works only with the $class. $type given." - ); - } + $queueProvider = $this->adapter->getQueueProvider(); + $originalExchangeSettings = $queueProvider->getExchangeSettings(); + $delayedExchangeSettings = $this->getExchangeSettings($originalExchangeSettings); + $queueSettings = $this->getQueueSettings( + $queueProvider->getQueueSettings(), + $originalExchangeSettings + ); - $queueProvider = $adapter->getQueueProvider(); - $exchangeSettings = $this->getExchangeSettings($queueProvider->getExchangeSettings()); - $queueSettings = $this->getQueueSettings($queueProvider->getQueueSettings(), $queueProvider->getExchangeSettings()); - $adapter = $adapter->withQueueProvider( + $adapter = $this->adapter->withQueueProvider( $queueProvider ->withMessageProperties($this->getMessageProperties($queueProvider)) - ->withExchangeSettings($exchangeSettings) + ->withExchangeSettings($delayedExchangeSettings) ->withQueueSettings($queueSettings) ); - return $handler->handlePush($request->withAdapter($adapter)); + return $handler->handle( + $request->withQueue( + $request->getQueue()->withAdapter($adapter) + ) + ); } /** @@ -104,7 +118,7 @@ private function getExchangeSettings(?ExchangeSettingsInterface $exchangeSetting /** @noinspection NullPointerExceptionInspection */ return $exchangeSettings ?->withName("{$exchangeSettings->getName()}.dlx") - ->withAutoDelete(true) + ->withAutoDelete(false) ->withType(AMQPExchangeType::TOPIC); } } diff --git a/src/QueueProvider.php b/src/QueueProvider.php index 54bf096..ae50b8b 100644 --- a/src/QueueProvider.php +++ b/src/QueueProvider.php @@ -31,6 +31,7 @@ public function __construct( public function __destruct() { $this->channel?->close(); + //unset($this->channel); } public function getChannel(): AMQPChannel diff --git a/src/Settings/Exchange.php b/src/Settings/Exchange.php index 53e54d8..25935de 100644 --- a/src/Settings/Exchange.php +++ b/src/Settings/Exchange.php @@ -14,7 +14,7 @@ public function __construct( private string $type = AMQPExchangeType::DIRECT, private bool $passive = false, private bool $durable = false, - private bool $autoDelete = true, + private bool $autoDelete = false, private bool $internal = false, private bool $nowait = false, private AMQPTable|array $arguments = [], diff --git a/src/Settings/Queue.php b/src/Settings/Queue.php index 69cb206..6df4bb8 100644 --- a/src/Settings/Queue.php +++ b/src/Settings/Queue.php @@ -14,7 +14,7 @@ public function __construct( private bool $passive = false, private bool $durable = false, private bool $exclusive = false, - private bool $autoDelete = true, + private bool $autoDelete = false, private bool $nowait = false, private AMQPTable|array $arguments = [], private ?int $ticket = null diff --git a/tests/Integration/DelayMiddlewareTest.php b/tests/Integration/DelayMiddlewareTest.php index 2d4003e..b38968c 100644 --- a/tests/Integration/DelayMiddlewareTest.php +++ b/tests/Integration/DelayMiddlewareTest.php @@ -6,24 +6,35 @@ use InvalidArgumentException; use Psr\Container\ContainerInterface; -use Psr\Log\LoggerInterface; +use Psr\Log\NullLogger; +use Yiisoft\EventDispatcher\Dispatcher\Dispatcher; +use Yiisoft\EventDispatcher\Provider\ListenerCollection; +use Yiisoft\EventDispatcher\Provider\Provider; +use Yiisoft\Injector\Injector; use Yiisoft\Queue\Adapter\AdapterInterface; use Yiisoft\Queue\AMQP\Adapter; -use Yiisoft\Queue\AMQP\MessageSerializer; use Yiisoft\Queue\AMQP\Middleware\DelayMiddleware; use Yiisoft\Queue\AMQP\QueueProvider; use Yiisoft\Queue\AMQP\Settings\Queue as QueueSettings; +use Yiisoft\Queue\AMQP\Tests\Support\ExtendedSimpleMessage; +use Yiisoft\Queue\AMQP\Tests\Support\ExtendedSimpleMessageHandler; use Yiisoft\Queue\AMQP\Tests\Support\FakeAdapter; use Yiisoft\Queue\AMQP\Tests\Support\FileHelper; -use Yiisoft\Queue\AMQP\Tests\Support\SimpleMessageHandler; use Yiisoft\Queue\Cli\LoopInterface; use Yiisoft\Queue\Cli\SignalLoop; +use Yiisoft\Queue\Message\JsonMessageSerializer; use Yiisoft\Queue\Message\Message; use Yiisoft\Queue\Middleware\CallableFactory; -use Yiisoft\Queue\Middleware\Push\MiddlewareFactoryPush; -use Yiisoft\Queue\Middleware\Push\PushMiddlewareDispatcher; +use Yiisoft\Queue\Middleware\MiddlewareDispatcher; +use Yiisoft\Queue\Middleware\MiddlewareFactory; use Yiisoft\Queue\Queue; -use Yiisoft\Queue\Worker\WorkerInterface; +use Yiisoft\Queue\Tests\Shared\ExceptionMessage; +use Yiisoft\Queue\Tests\Shared\ExceptionMessageHandler; +use Yiisoft\Queue\Tests\Shared\NullMessage; +use Yiisoft\Queue\Tests\Shared\NullMessageHandler; +use Yiisoft\Queue\Tests\Shared\StackMessage; +use Yiisoft\Queue\Tests\Shared\StackMessageHandler; +use Yiisoft\Queue\Worker\Worker; use Yiisoft\Test\Support\Container\SimpleContainer; final class DelayMiddlewareTest extends TestCase @@ -44,21 +55,22 @@ public function testMainFlow(): void $this->createConnection(), new QueueSettings(), ), - new MessageSerializer(), + new JsonMessageSerializer(), new SignalLoop(), ); $queue = $this->makeQueue($adapter); $time = time(); + $file = 'test-delay-middleware-main'; $queue->push( - new Message('simple', 'test-delay-middleware-main'), - new DelayMiddleware(3), + new ExtendedSimpleMessage(['file_name' => $file, 'payload' => ['time' => $time]]), + fn (Injector $injector) => $injector->make(DelayMiddleware::class, ['delayInSeconds' => 3]), ); sleep(2); - self::assertNull($fileHelper->get('test-delay-middleware-main')); + self::assertNull($fileHelper->get($file)); sleep(2); - $result = $fileHelper->get('test-delay-middleware-main'); + $result = $fileHelper->get($file); self::assertNotNull($result); $result = (int) $result; self::assertGreaterThanOrEqual($time + 3, $result); @@ -67,41 +79,55 @@ public function testMainFlow(): void public function testMainFlowWithFakeAdapter(): void { - $adapterClass = Adapter::class; - $fakeAdapterClass = FakeAdapter::class; - - $adapter = new FakeAdapter( - new QueueProvider( - $this->createConnection(), - new QueueSettings(), - ), - new MessageSerializer(), - new SignalLoop(), - ); - $queue = $this->makeQueue($adapter); + $queue = $this->makeQueue(new FakeAdapter()); $this->expectException(InvalidArgumentException::class); - $this->expectExceptionMessage("This middleware works only with the $adapterClass. $fakeAdapterClass given."); + $this->expectExceptionMessage( + sprintf( + 'This middleware works only with the %s. %s given.', + Adapter::class, + FakeAdapter::class, + ) + ); $queue->push( - new Message('simple', 'test-delay-middleware-main'), - new DelayMiddleware(3), + new Message('test-delay-middleware-main'), + fn (Injector $injector) => $injector->make(DelayMiddleware::class, ['delayInSeconds' => 3]), ); } private function makeQueue(AdapterInterface $adapter): Queue { + $definitions = [ + AdapterInterface::class => $adapter, + ]; + $middlewareDispatcher = new MiddlewareDispatcher( + new MiddlewareFactory( + $container = new SimpleContainer([ + ...$definitions, + ExtendedSimpleMessageHandler::class => new ExtendedSimpleMessageHandler(new FileHelper()), + Injector::class => new Injector(new SimpleContainer($definitions)), + ]), + new CallableFactory($this->createMock(ContainerInterface::class)), + ), + ); + $listeners = new ListenerCollection(); + $listeners = $listeners + ->add(fn (NullMessage $message) => $container->get(NullMessageHandler::class)->handle($message)) + ->add(fn (StackMessage $message) => $container->get(StackMessageHandler::class)->handle($message)) + ->add(fn (ExtendedSimpleMessage $message) => $container->get(ExtendedSimpleMessageHandler::class)->handle($message)) + ->add(fn (ExceptionMessage $message) => $container->get(ExceptionMessageHandler::class)->handle($message)); + return new Queue( - $this->createMock(WorkerInterface::class), - $this->createMock(LoopInterface::class), - $this->createMock(LoggerInterface::class), - new PushMiddlewareDispatcher( - new MiddlewareFactoryPush( - new SimpleContainer([ - 'simple' => new SimpleMessageHandler(new FileHelper()), - ]), - new CallableFactory($this->createMock(ContainerInterface::class)), - ), + new Worker( + $logger = new NullLogger(), + new Dispatcher(new Provider($listeners)), + $container, + $middlewareDispatcher, + $middlewareDispatcher, ), + $this->createMock(LoopInterface::class), + $logger, + $middlewareDispatcher, $adapter, ); } diff --git a/tests/Support/ExtendedSimpleMessage.php b/tests/Support/ExtendedSimpleMessage.php new file mode 100644 index 0000000..adbe2d8 --- /dev/null +++ b/tests/Support/ExtendedSimpleMessage.php @@ -0,0 +1,22 @@ +data = $data; + } +} diff --git a/tests/Support/FakeAdapter.php b/tests/Support/FakeAdapter.php index ddbbe15..7e06054 100644 --- a/tests/Support/FakeAdapter.php +++ b/tests/Support/FakeAdapter.php @@ -5,39 +5,31 @@ namespace Yiisoft\Queue\AMQP\Tests\Support; use Yiisoft\Queue\Adapter\AdapterInterface; -use Yiisoft\Queue\AMQP\MessageSerializerInterface; -use Yiisoft\Queue\AMQP\QueueProviderInterface; -use Yiisoft\Queue\Cli\LoopInterface; use Yiisoft\Queue\Enum\JobStatus; use Yiisoft\Queue\Message\MessageInterface; final class FakeAdapter implements AdapterInterface { public function __construct( - private QueueProviderInterface $queueProvider, - private MessageSerializerInterface $serializer, - private LoopInterface $loop, ) { } public function runExisting(callable $handlerCallback): void { - // TODO: Implement runExisting() method. } - public function status(string $id): JobStatus + public function status(string|int $id): JobStatus { // TODO: Implement status() method. } - public function push(MessageInterface $message): void + public function push(MessageInterface $message): MessageInterface { - // TODO: Implement push() method. + return $message; } public function subscribe(callable $handlerCallback): void { - // TODO: Implement subscribe() method. } public function withChannel(string $channel): AdapterInterface diff --git a/tests/Support/FileHelper.php b/tests/Support/FileHelper.php index beff8b2..d1674a2 100644 --- a/tests/Support/FileHelper.php +++ b/tests/Support/FileHelper.php @@ -14,8 +14,15 @@ final class FileHelper */ public function put(string $fileName, int|string $data): void { - if (file_put_contents("{$this->getRuntimeDir()}/$fileName", $data) === false) { - throw new RuntimeException("Runtime dir {$this->getRuntimeDir()} or file $fileName are not writable."); + $path = $this->getRuntimeDir() . DIRECTORY_SEPARATOR . $fileName; + if (file_put_contents($path, $data) === false) { + throw new RuntimeException( + sprintf( + 'Runtime dir %"s" or file "%s" are not writable.', + $this->getRuntimeDir(), + $fileName + ) + ); } } @@ -28,7 +35,12 @@ public function get(string $filename): ?string $result = file_get_contents($path); if ($result === false) { - throw new RuntimeException("File '$path' exists but is not readable."); + throw new RuntimeException( + sprintf( + 'File "%s" exists but is not readable.', + $path + ) + ); } return $result; diff --git a/tests/Support/MainTestCase.php b/tests/Support/MainTestCase.php index 66a9f16..030f1ae 100644 --- a/tests/Support/MainTestCase.php +++ b/tests/Support/MainTestCase.php @@ -15,10 +15,10 @@ abstract class MainTestCase extends TestCase protected function createConnection(): AMQPStreamConnection { return new AMQPStreamConnection( - getenv('RABBITMQ_HOST'), - getenv('RABBITMQ_PORT'), - getenv('RABBITMQ_USER'), - getenv('RABBITMQ_PASSWORD') + getenv('RABBITMQ_HOST') ?: '127.0.0.1', + getenv('RABBITMQ_PORT') ?: 5672, + getenv('RABBITMQ_USER') ?: 'guest', + getenv('RABBITMQ_PASSWORD') ?: 'guest', ); } diff --git a/tests/Unit/DelayMiddlewareTest.php b/tests/Unit/DelayMiddlewareTest.php index 4d2140f..0bda2a4 100644 --- a/tests/Unit/DelayMiddlewareTest.php +++ b/tests/Unit/DelayMiddlewareTest.php @@ -4,24 +4,28 @@ namespace Yiisoft\Queue\AMQP\Tests\Unit; +use Yiisoft\Queue\AMQP\Adapter; use Yiisoft\Queue\AMQP\Middleware\DelayMiddleware; +use Yiisoft\Queue\AMQP\QueueProviderInterface; +use Yiisoft\Queue\Cli\LoopInterface; +use Yiisoft\Queue\Message\MessageSerializerInterface; final class DelayMiddlewareTest extends UnitTestCase { public function testWithDelay(): void { - $delayMiddleware = new DelayMiddleware(5); + $adapter = new Adapter( + $this->createMock(QueueProviderInterface::class), + $this->createMock(MessageSerializerInterface::class), + $this->createMock(LoopInterface::class), + ); + $delayMiddleware = new DelayMiddleware($adapter, 5); self::assertEquals(5, $delayMiddleware->getDelay()); $delayMiddlewareWithDelay = $delayMiddleware->withDelay(10); - self::assertEquals(10, $delayMiddlewareWithDelay->getDelay()); - } + self::assertNotSame($delayMiddleware, $delayMiddlewareWithDelay); - public function testImmutable(): void - { - $delayMiddleware = new DelayMiddleware(0); - - self::assertNotSame($delayMiddleware, $delayMiddleware->withDelay(1)); + self::assertEquals(10, $delayMiddlewareWithDelay->getDelay()); } } diff --git a/tests/Unit/ExchangeSettingsTest.php b/tests/Unit/ExchangeSettingsTest.php index 5d16634..879dd19 100644 --- a/tests/Unit/ExchangeSettingsTest.php +++ b/tests/Unit/ExchangeSettingsTest.php @@ -7,10 +7,11 @@ use PhpAmqpLib\Exchange\AMQPExchangeType; use PhpAmqpLib\Wire\AMQPTable; use Yiisoft\Queue\AMQP\Adapter; -use Yiisoft\Queue\AMQP\MessageSerializer; + use Yiisoft\Queue\AMQP\QueueProvider; use Yiisoft\Queue\AMQP\Settings\Exchange as ExchangeSettings; use Yiisoft\Queue\AMQP\Settings\Queue as QueueSettings; +use Yiisoft\Queue\Message\JsonMessageSerializer; final class ExchangeSettingsTest extends UnitTestCase { @@ -38,7 +39,7 @@ public function testCommonSettings(): void ]) ) ), - new MessageSerializer(), + new JsonMessageSerializer(), $this->getLoop(), ); $exchangeSettings = $adapter->getQueueProvider()->getExchangeSettings(); diff --git a/tests/Unit/FriendlyExceptionTest.php b/tests/Unit/FriendlyExceptionTest.php deleted file mode 100644 index 6e14fab..0000000 --- a/tests/Unit/FriendlyExceptionTest.php +++ /dev/null @@ -1,29 +0,0 @@ -getName()); - $this->assertMatchesRegularExpression('/test/', $exception->getSolution()); - } - - public function testExchangeDeclaredException(): void - { - $exception = new ExchangeDeclaredException(); - - self::assertSame('Exchange is declared', $exception->getName()); - } -} diff --git a/tests/Unit/MessageSerializerTest.php b/tests/Unit/MessageSerializerTest.php deleted file mode 100644 index 8a2c9a0..0000000 --- a/tests/Unit/MessageSerializerTest.php +++ /dev/null @@ -1,134 +0,0 @@ -createConnection() - ->channel(); - $channel->queue_declare($queue); - $channel->exchange_declare($exchange, AMQPExchangeType::DIRECT); - $channel->queue_bind($queue, $exchange); - $channel->basic_publish($message, $exchange); - } - - /** - * @throws Exception - */ - private function getCustomAdapter(string $queueExchangeName): Adapter - { - $queueProvider = new QueueProvider( - $this->createConnection(), - $this->getQueueSettings(), - ); - return new Adapter( - $queueProvider - ->withQueueSettings(new QueueSettings($queueExchangeName)) - ->withExchangeSettings(new ExchangeSettings($queueExchangeName)), - new MessageSerializer(), - $this->getLoop(), - ); - } - - public function testNoKeyInPayloadExceptionName(): void - { - $queueExchangeName = 'yii-test-no-key-in-payload-exception-name'; - $this->publishWithAMQPLib( - $queueExchangeName, - $queueExchangeName, - new AMQPMessage( - json_encode(['test'], JSON_THROW_ON_ERROR), - ['content_type' => 'text/json', 'delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT] - ) - ); - - $this->expectException(NoKeyInPayloadException::class); - $this - ->getQueue() - ->withAdapter($this->getCustomAdapter($queueExchangeName)) - ->run(); - } - - public function testNoKeyInPayloadExceptionId(): void - { - $queueExchangeName = 'yii-test-no-key-in-payload-exception-id'; - $this->publishWithAMQPLib( - $queueExchangeName, - $queueExchangeName, - new AMQPMessage( - json_encode(['name' => 'ext-simple', 'id' => 1], JSON_THROW_ON_ERROR), - ['content_type' => 'text/json', 'delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT] - ) - ); - - $this->expectException(NoKeyInPayloadException::class); - $this->expectExceptionMessage("No expected key 'id' in payload. Payload's keys list: name, id."); - $this - ->getQueue() - ->withAdapter($this->getCustomAdapter($queueExchangeName)) - ->run(); - } - - public function testNoKeyInPayloadExceptionMeta(): void - { - $queueExchangeName = 'yii-test-no-key-in-payload-exception-meta'; - $this->publishWithAMQPLib( - $queueExchangeName, - $queueExchangeName, - new AMQPMessage( - json_encode(['name' => 'ext-simple', 'meta' => ''], JSON_THROW_ON_ERROR), - ['content_type' => 'text/json', 'delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT] - ) - ); - - $this->expectException(NoKeyInPayloadException::class); - $this->expectExceptionMessage("No expected key 'meta' in payload. Payload's keys list: name, meta."); - $this - ->getQueue() - ->withAdapter($this->getCustomAdapter($queueExchangeName)) - ->run(); - } - - public function testInvalidArgumentException(): void - { - $queueExchangeName = 'yii-test-invalid-argument-exception'; - $this->publishWithAMQPLib( - $queueExchangeName, - $queueExchangeName, - new AMQPMessage( - json_encode('test', JSON_THROW_ON_ERROR), - ['content_type' => 'text/json', 'delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT] - ) - ); - - $this->expectException(InvalidArgumentException::class); - $this - ->getQueue() - ->withAdapter($this->getCustomAdapter($queueExchangeName)) - ->run(); - } -} diff --git a/tests/Unit/QueueFactoryTest.php b/tests/Unit/QueueFactoryTest.php index 6b2f267..f88326f 100644 --- a/tests/Unit/QueueFactoryTest.php +++ b/tests/Unit/QueueFactoryTest.php @@ -6,8 +6,8 @@ use Yiisoft\Injector\Injector; use Yiisoft\Queue\AMQP\QueueProvider; +use Yiisoft\Queue\AMQP\Tests\Support\ExtendedSimpleMessage; use Yiisoft\Queue\AMQP\Tests\Support\FileHelper; -use Yiisoft\Queue\Message\Message; use Yiisoft\Queue\Middleware\CallableFactory; use Yiisoft\Queue\QueueFactory; @@ -16,7 +16,7 @@ class QueueFactoryTest extends UnitTestCase public function testSameChannelName(): void { $queue = $this->getQueue(); - $container = $this->getContainer(); + $container = $this->createContainer(); $factory = new QueueFactory( [], $queue, @@ -42,7 +42,7 @@ public function testDifferentChannel(): void $this->queueProvider = $queueProvider->withExchangeSettings(null); - $container = $this->getContainer(); + $container = $this->createContainer(); $adapter = $this->getAdapter(); $factory = new QueueFactory( @@ -58,7 +58,7 @@ public function testDifferentChannel(): void $time = time(); $queue = $factory->get('channel2'); - $queue->push(new Message('ext-simple', ['file_name' => 'test-channel-run', 'payload' => ['time' => $time]])); + $queue->push(new ExtendedSimpleMessage(['file_name' => 'test-channel-run', 'payload' => ['time' => $time]])); self::assertNull($fileHelper->get('test-channel-run')); diff --git a/tests/Unit/QueueProviderTest.php b/tests/Unit/QueueProviderTest.php index 897f257..db8eab7 100644 --- a/tests/Unit/QueueProviderTest.php +++ b/tests/Unit/QueueProviderTest.php @@ -6,14 +6,15 @@ use Yiisoft\Queue\AMQP\Adapter; use Yiisoft\Queue\AMQP\Exception\ExchangeDeclaredException; -use Yiisoft\Queue\AMQP\MessageSerializer; + use Yiisoft\Queue\AMQP\QueueProvider; use Yiisoft\Queue\AMQP\Settings\Exchange as ExchangeSettings; use Yiisoft\Queue\AMQP\Settings\ExchangeSettingsInterface; use Yiisoft\Queue\AMQP\Settings\Queue as QueueSettings; use Yiisoft\Queue\AMQP\Settings\QueueSettingsInterface; +use Yiisoft\Queue\AMQP\Tests\Support\ExtendedSimpleMessage; use Yiisoft\Queue\AMQP\Tests\Support\FileHelper; -use Yiisoft\Queue\Message\Message; +use Yiisoft\Queue\Message\JsonMessageSerializer; final class QueueProviderTest extends UnitTestCase { @@ -34,7 +35,7 @@ public function testWithQueueAndExchangeSettings(): void ->withExchangeSettings( new ExchangeSettings($this->exchangeName) ), - new MessageSerializer(), + new JsonMessageSerializer(), $this->getLoop(), ); @@ -43,7 +44,7 @@ public function testWithQueueAndExchangeSettings(): void $fileHelper = new FileHelper(); $time = time(); $queue->push( - new Message('ext-simple', ['file_name' => 'test-with-queue-settings', 'payload' => ['time' => $time]]) + new ExtendedSimpleMessage(['file_name' => 'test-with-queue-settings', 'payload' => ['time' => $time]]) ); $message = $this @@ -81,7 +82,7 @@ public function testWithChannelNameExchangeDeclaredException(): void new ExchangeSettings('yii-queue-test-with-channel-name') ) ->withChannelName('yii-queue-test-channel-name'), - new MessageSerializer(), + new JsonMessageSerializer(), $this->getLoop(), ); } diff --git a/tests/Unit/QueueSettingsTest.php b/tests/Unit/QueueSettingsTest.php index 446e6db..e6f4042 100644 --- a/tests/Unit/QueueSettingsTest.php +++ b/tests/Unit/QueueSettingsTest.php @@ -7,10 +7,11 @@ use PhpAmqpLib\Exception\AMQPProtocolChannelException; use PhpAmqpLib\Wire\AMQPTable; use Yiisoft\Queue\AMQP\Adapter; -use Yiisoft\Queue\AMQP\MessageSerializer; + use Yiisoft\Queue\AMQP\QueueProvider; use Yiisoft\Queue\AMQP\Settings\Exchange as ExchangeSettings; use Yiisoft\Queue\AMQP\Settings\Queue as QueueSettings; +use Yiisoft\Queue\Message\JsonMessageSerializer; use Yiisoft\Queue\Message\Message; final class QueueSettingsTest extends UnitTestCase @@ -40,7 +41,7 @@ public function testCommonSettings(): void ->withExchangeSettings( new ExchangeSettings('yii-queue-test-queue-common-settings') ), - new MessageSerializer(), + new JsonMessageSerializer(), $this->getLoop(), ); @@ -49,7 +50,7 @@ public function testCommonSettings(): void self::assertTrue($queueSettings->isDurable()); self::assertTrue($queueSettings->isPassive()); self::assertTrue($queueSettings->isExclusive()); - self::assertTrue($queueSettings->isAutoDeletable()); + self::assertFalse($queueSettings->isAutoDeletable()); self::assertTrue($queueSettings->hasNowait()); self::assertNull($queueSettings->getTicket()); @@ -85,14 +86,14 @@ public function testArgumentsXExpires(): void ->withExchangeSettings( new ExchangeSettings('yii-queue-test-queue-settings-arg') ), - new MessageSerializer(), + new JsonMessageSerializer(), $this->getLoop(), ); $this->getQueue() ->withAdapter($adapter) ->push( - new Message('ext-simple', ['payload' => time()]) + new Message(['payload' => time()]) ); sleep(2); diff --git a/tests/Unit/QueueTest.php b/tests/Unit/QueueTest.php index 84f1619..fad7f15 100644 --- a/tests/Unit/QueueTest.php +++ b/tests/Unit/QueueTest.php @@ -8,17 +8,20 @@ use Yiisoft\Queue\Adapter\AdapterInterface; use Yiisoft\Queue\AMQP\Adapter; use Yiisoft\Queue\AMQP\Exception\NotImplementedException; -use Yiisoft\Queue\AMQP\MessageSerializer; -use Yiisoft\Queue\AMQP\MessageSerializerInterface; use Yiisoft\Queue\AMQP\QueueProvider; use Yiisoft\Queue\AMQP\QueueProviderInterface; use Yiisoft\Queue\AMQP\Settings\Exchange as ExchangeSettings; use Yiisoft\Queue\AMQP\Settings\Queue as QueueSettings; +use Yiisoft\Queue\AMQP\Tests\Support\ExtendedSimpleMessage; use Yiisoft\Queue\AMQP\Tests\Support\FileHelper; use Yiisoft\Queue\Cli\LoopInterface; use Yiisoft\Queue\Exception\JobFailureException; +use Yiisoft\Queue\Message\IdEnvelope; +use Yiisoft\Queue\Message\JsonMessageSerializer; use Yiisoft\Queue\Message\Message; +use Yiisoft\Queue\Message\MessageSerializerInterface; use Yiisoft\Queue\Queue; +use Yiisoft\Queue\Tests\Shared\ExceptionMessage; final class QueueTest extends UnitTestCase { @@ -34,10 +37,11 @@ public function testStatus(): void $queue = $this->getDefaultQueue($adapter); - $message = new Message('ext-simple', null); - $queue->push( - $message, + $message = new IdEnvelope( + new Message(null), + 'test-id', ); + $queue->push($message); $this->expectException(NotImplementedException::class); $this->expectExceptionMessage("Status check is not supported by the adapter $adapterClass."); @@ -59,7 +63,7 @@ public function testRun(): void $queue = $this->getDefaultQueue($this->getAdapter()); $queue->push( - new Message('ext-simple', ['file_name' => $fileName, 'payload' => ['time' => $time]]) + new ExtendedSimpleMessage(['file_name' => $fileName, 'payload' => ['time' => $time]]) ); self::assertNull($fileHelper->get($fileName)); @@ -84,13 +88,13 @@ public function testListenWithException(): void $queueProvider ->withQueueSettings(new QueueSettings($this->queueName)) ->withExchangeSettings(new ExchangeSettings($this->exchangeName)), - new MessageSerializer(), + new JsonMessageSerializer(), $this->getLoop(), ); $queue = $this->getDefaultQueue($adapter); $time = time(); - $queue->push(new Message('exception-listen', ['payload' => ['time' => $time]])); + $queue->push(new ExceptionMessage(['payload' => ['time' => $time]])); $this->expectException(JobFailureException::class); @@ -110,15 +114,14 @@ public function testListen(): void $this->getQueueSettings(), ); $adapter = new Adapter( - $queueProvider - ->withChannelName('yii-queue'), - new MessageSerializer(), + $queueProvider->withChannelName('yii-queue'), + new JsonMessageSerializer(), $mockLoop, ); $queue = $this->getDefaultQueue($adapter); $queue->push( - new Message('ext-simple', ['file_name' => 'test-listen' . $time, 'payload' => ['time' => $time]]) + new ExtendedSimpleMessage(['file_name' => 'test-listen' . $time, 'payload' => ['time' => $time]]) ); $queue->listen(); } diff --git a/tests/Unit/UnitTestCase.php b/tests/Unit/UnitTestCase.php index 2f119c5..1a14636 100644 --- a/tests/Unit/UnitTestCase.php +++ b/tests/Unit/UnitTestCase.php @@ -6,27 +6,33 @@ use PHPUnit\Util\Exception as PHPUnitException; use Psr\Container\ContainerInterface; +use Psr\EventDispatcher\EventDispatcherInterface; use Psr\Log\NullLogger; -use Yiisoft\Injector\Injector; +use Yiisoft\EventDispatcher\Dispatcher\Dispatcher; +use Yiisoft\EventDispatcher\Provider\ListenerCollection; +use Yiisoft\EventDispatcher\Provider\Provider; use Yiisoft\Queue\Adapter\AdapterInterface; use Yiisoft\Queue\AMQP\Adapter; -use Yiisoft\Queue\AMQP\MessageSerializer; use Yiisoft\Queue\AMQP\QueueProvider; use Yiisoft\Queue\AMQP\Settings\Queue as QueueSettings; +use Yiisoft\Queue\AMQP\Tests\Support\ExtendedSimpleMessage; use Yiisoft\Queue\AMQP\Tests\Support\ExtendedSimpleMessageHandler; use Yiisoft\Queue\AMQP\Tests\Support\FileHelper; use Yiisoft\Queue\AMQP\Tests\Support\MainTestCase; use Yiisoft\Queue\Cli\LoopInterface; use Yiisoft\Queue\Cli\SignalLoop; +use Yiisoft\Queue\Message\JsonMessageSerializer; use Yiisoft\Queue\Message\MessageInterface; use Yiisoft\Queue\Middleware\CallableFactory; -use Yiisoft\Queue\Middleware\Consume\ConsumeMiddlewareDispatcher; -use Yiisoft\Queue\Middleware\Consume\MiddlewareFactoryConsume; -use Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareDispatcher; -use Yiisoft\Queue\Middleware\FailureHandling\MiddlewareFactoryFailure; -use Yiisoft\Queue\Middleware\Push\MiddlewareFactoryPush; -use Yiisoft\Queue\Middleware\Push\PushMiddlewareDispatcher; +use Yiisoft\Queue\Middleware\MiddlewareDispatcher; +use Yiisoft\Queue\Middleware\MiddlewareFactory; use Yiisoft\Queue\Queue; +use Yiisoft\Queue\Tests\Shared\ExceptionMessage; +use Yiisoft\Queue\Tests\Shared\ExceptionMessageHandler; +use Yiisoft\Queue\Tests\Shared\NullMessage; +use Yiisoft\Queue\Tests\Shared\NullMessageHandler; +use Yiisoft\Queue\Tests\Shared\StackMessage; +use Yiisoft\Queue\Tests\Shared\StackMessageHandler; use Yiisoft\Queue\Worker\Worker; use Yiisoft\Queue\Worker\WorkerInterface; use Yiisoft\Test\Support\Container\SimpleContainer; @@ -36,6 +42,7 @@ */ abstract class UnitTestCase extends MainTestCase { + protected Dispatcher $eventDispatcher; protected Queue|null $queue = null; protected ?WorkerInterface $worker = null; protected ?ContainerInterface $container = null; @@ -77,10 +84,9 @@ protected function getQueue(): Queue protected function getWorker(): WorkerInterface { return $this->worker ??= new Worker( - $this->getMessageHandlers(), new NullLogger(), - new Injector($this->getContainer()), - $this->getContainer(), + $this->createEventDispatcher(), + $this->createContainer(), $this->getConsumeMiddlewareDispatcher(), $this->getFailureMiddlewareDispatcher(), ); @@ -99,34 +105,38 @@ protected function getMessageHandlers(): array ]; } - protected function getContainer(): ContainerInterface + protected function createContainer(): ContainerInterface { return $this->container ??= new SimpleContainer($this->getContainerDefinitions()); } protected function getContainerDefinitions(): array { - return []; + return [ + ExtendedSimpleMessageHandler::class => new ExtendedSimpleMessageHandler(new FileHelper()), + ExceptionMessageHandler::class => new ExceptionMessageHandler(), + StackMessageHandler::class => new StackMessageHandler(), + NullMessageHandler::class => new NullMessageHandler(), + ]; } - protected function getConsumeMiddlewareDispatcher(): ConsumeMiddlewareDispatcher + protected function getConsumeMiddlewareDispatcher(): MiddlewareDispatcher { - return new ConsumeMiddlewareDispatcher( - new MiddlewareFactoryConsume( - $this->getContainer(), - new CallableFactory($this->getContainer()), + return new MiddlewareDispatcher( + new MiddlewareFactory( + $this->createContainer(), + new CallableFactory($this->createContainer()), ), ); } - protected function getFailureMiddlewareDispatcher(): FailureMiddlewareDispatcher + protected function getFailureMiddlewareDispatcher(): MiddlewareDispatcher { - return new FailureMiddlewareDispatcher( - new MiddlewareFactoryFailure( - $this->getContainer(), - new CallableFactory($this->getContainer()), + return new MiddlewareDispatcher( + new MiddlewareFactory( + $this->createContainer(), + new CallableFactory($this->createContainer()), ), - [], ); } @@ -134,7 +144,7 @@ protected function getAdapter(): AdapterInterface { return $this->adapter ??= new Adapter( $this->getQueueProvider(), - new MessageSerializer(), + new JsonMessageSerializer(), $this->getLoop(), ); } @@ -144,12 +154,12 @@ protected function getLoop(): LoopInterface return $this->loop ??= new SignalLoop(); } - protected function getPushMiddlewareDispatcher(): PushMiddlewareDispatcher + protected function getPushMiddlewareDispatcher(): MiddlewareDispatcher { - return new PushMiddlewareDispatcher( - new MiddlewareFactoryPush( - $this->getContainer(), - new CallableFactory($this->getContainer()), + return new MiddlewareDispatcher( + new MiddlewareFactory( + $this->createContainer(), + new CallableFactory($this->createContainer()), ), ); } @@ -166,4 +176,17 @@ protected function getQueueProvider(): QueueProvider $this->getQueueSettings(), ); } + + protected function createEventDispatcher(): EventDispatcherInterface + { + $container = $this->createContainer(); + $listeners = new ListenerCollection(); + $listeners = $listeners + ->add(fn (NullMessage $message) => $container->get(NullMessageHandler::class)->handle($message)) + ->add(fn (StackMessage $message) => $container->get(StackMessageHandler::class)->handle($message)) + ->add(fn (ExtendedSimpleMessage $message) => $container->get(ExtendedSimpleMessageHandler::class)->handle($message)) + ->add(fn (ExceptionMessage $message) => $container->get(ExceptionMessageHandler::class)->handle($message)); + + return $this->eventDispatcher ??= new Dispatcher(new Provider($listeners)); + } } diff --git a/tests/docker-compose.yml b/tests/docker-compose.yml index 678faf8..2840695 100644 --- a/tests/docker-compose.yml +++ b/tests/docker-compose.yml @@ -18,7 +18,6 @@ x-php: &php services: php81: <<: *php - container_name: yii-queue-amqp-php81 build: context: .. dockerfile: tests/docker/php/Dockerfile @@ -27,7 +26,6 @@ services: php82: <<: *php - container_name: yii-queue-amqp-php82 build: context: .. dockerfile: tests/docker/php/Dockerfile @@ -44,9 +42,12 @@ services: PHP_VERSION: '8.3' rabbitmq: - image: rabbitmq:3-alpine + image: rabbitmq:3-management healthcheck: test: rabbitmq-diagnostics check_port_connectivity interval: 3s timeout: 5s retries: 3 + ports: + - 5672:5672 + - 5673:15672 diff --git a/tests/yii b/tests/yii index 7ae7c3e..825cd3e 100755 --- a/tests/yii +++ b/tests/yii @@ -3,25 +3,23 @@ use PhpAmqpLib\Connection\AMQPStreamConnection; use Psr\Log\NullLogger; +use Yiisoft\EventDispatcher\Dispatcher\Dispatcher; +use Yiisoft\EventDispatcher\Provider\ListenerCollection; +use Yiisoft\EventDispatcher\Provider\Provider; use Yiisoft\Injector\Injector; +use Yiisoft\Queue\Message\JsonMessageSerializer; +use Yiisoft\Queue\Middleware\MiddlewareDispatcher; +use Yiisoft\Queue\Middleware\MiddlewareFactory; +use Yiisoft\Queue\QueueFactoryInterface; use Yiisoft\Test\Support\Container\SimpleContainer; use Yiisoft\Yii\Console\Application; use Yiisoft\Queue\AMQP\Adapter; -use Yiisoft\Queue\AMQP\MessageSerializer; use Yiisoft\Queue\AMQP\QueueProvider; use Yiisoft\Queue\AMQP\Settings\Queue as QueueSettings; -use Yiisoft\Queue\AMQP\Tests\Support\FileHelper; -use Yiisoft\Queue\AMQP\Tests\Support\SimpleMessageHandler; use Yiisoft\Queue\Cli\SignalLoop; use Yiisoft\Queue\Command\ListenCommand; use Yiisoft\Queue\Command\RunCommand; use Yiisoft\Queue\Middleware\CallableFactory; -use Yiisoft\Queue\Middleware\Consume\ConsumeMiddlewareDispatcher; -use Yiisoft\Queue\Middleware\Consume\MiddlewareFactoryConsume; -use Yiisoft\Queue\Middleware\FailureHandling\FailureMiddlewareDispatcher; -use Yiisoft\Queue\Middleware\FailureHandling\MiddlewareFactoryFailure; -use Yiisoft\Queue\Middleware\Push\MiddlewareFactoryPush; -use Yiisoft\Queue\Middleware\Push\PushMiddlewareDispatcher; use Yiisoft\Queue\Queue; use Yiisoft\Queue\QueueFactory; @@ -32,17 +30,14 @@ $container = new SimpleContainer([]); $injector = new Injector($container); $callableFactory = new CallableFactory($container); $worker = new \Yiisoft\Queue\Worker\Worker( - [ - 'simple' => new SimpleMessageHandler(new FileHelper()), - ], $logger, - $injector, + new Dispatcher(new Provider(new ListenerCollection())), $container, - new ConsumeMiddlewareDispatcher(new MiddlewareFactoryConsume($container, $callableFactory)), - new FailureMiddlewareDispatcher(new MiddlewareFactoryFailure($container, $callableFactory), []), + new MiddlewareDispatcher(new MiddlewareFactory($container, $callableFactory)), + new MiddlewareDispatcher(new MiddlewareFactory($container, $callableFactory), []), ); $loop = new SignalLoop(); -$pushMiddlewareDispatcher = new PushMiddlewareDispatcher(new MiddlewareFactoryPush($container, $callableFactory)); +$pushMiddlewareDispatcher = new MiddlewareDispatcher(new MiddlewareFactory($container, $callableFactory)); $adapter = new Adapter( new QueueProvider( new AMQPStreamConnection( @@ -53,7 +48,7 @@ $adapter = new Adapter( ), new QueueSettings(), ), - new MessageSerializer(), + new JsonMessageSerializer(), $loop, ); $queue = new Queue( @@ -73,6 +68,6 @@ $queueFactory = new QueueFactory( $application = new Application(); $application->add(new ListenCommand($queueFactory)); -$application->add(new RunCommand($queueFactory)); +$application->add(new RunCommand($queueFactory, [QueueFactoryInterface::DEFAULT_CHANNEL_NAME])); $application->run();