[#35] - Renames the message table and make the necessary changes to t…

…he classes that manipulates it.
run-as-root · Feb 2, 2024 · 5589b4c · 5589b4c
1 parent 1f2cb77
commit 5589b4c
Show file tree

Hide file tree

Showing 40 changed files with 196 additions and 170 deletions.
diff --git a/composer.json b/composer.json
@@ -62,6 +62,7 @@
         "sniffer": "vendor/bin/phpcs --colors -p ./src --standard=phpcs-ruleset.xml",
         "fix-style": "vendor/bin/phpcbf --colors -p ./src --standard=phpcs-ruleset.xml",
         "sniffer:php8.1": "vendor/bin/phpcs -p ./src --standard=vendor/phpcompatibility/php-compatibility/PHPCompatibility --runtime-set testVersion 8.1",
+        "sniffer:php8.2": "vendor/bin/phpcs -p ./src --standard=vendor/phpcompatibility/php-compatibility/PHPCompatibility --runtime-set testVersion 8.2",
         "mess-detector": "vendor/bin/phpmd src html phpmd-ruleset.xml --exclude \"Test\" --strict --reportfile reports/phpmd/phpmd.html"
     }
 }
diff --git a/src/Api/Data/MessageInterface.php → src/Api/Data/QueueErrorMessageInterface.php b/src/Api/Data/MessageInterface.php → src/Api/Data/QueueErrorMessageInterface.php
@@ -4,9 +4,9 @@
 
 namespace RunAsRoot\MessageQueueRetry\Api\Data;
 
-interface MessageInterface
+interface QueueErrorMessageInterface
 {
-    public const TABLE_NAME = 'run_as_root_message';
+    public const TABLE_NAME = 'run_as_root_queue_error_message';
     public const ENTITY_ID = 'entity_id';
     public const TOPIC_NAME = 'topic_name';
     public const MESSAGE_BODY = 'message_body';

diff --git a/src/Builder/MessageBodyDownloadFileNameBuilder.php b/src/Builder/MessageBodyDownloadFileNameBuilder.php
@@ -4,11 +4,11 @@
 
 namespace RunAsRoot\MessageQueueRetry\Builder;
 
-use RunAsRoot\MessageQueueRetry\Model\Message;
+use RunAsRoot\MessageQueueRetry\Model\QueueErrorMessage;
 
 class MessageBodyDownloadFileNameBuilder
 {
-    public function build(Message $message): string
+    public function build(QueueErrorMessage $message): string
     {
         return $message->getTopicName() . '_' . $message->getId() . '.json';
     }

diff --git a/src/Controller/Adminhtml/Index/Index.php b/src/Controller/Adminhtml/Index/Index.php
@@ -24,7 +24,7 @@ public function execute(): Page
     {
         /** @var \Magento\Backend\Model\View\Result\Page $resultPage */
         $resultPage = $this->resultPageFactory->create();
-        $resultPage->getConfig()->getTitle()->prepend(__('Messages')->render());
+        $resultPage->getConfig()->getTitle()->prepend(__('Queue Error Messages')->render());
         $resultPage->setActiveMenu('RunAsRoot_MessageQueueRetry::message_queue_retry');
 
         return $resultPage;

diff --git a/src/Controller/Adminhtml/Message/Download.php b/src/Controller/Adminhtml/Message/Download.php
@@ -10,18 +10,18 @@
 use Magento\Framework\Controller\Result\RawFactory;
 use RunAsRoot\MessageQueueRetry\Exception\EmptyQueueMessageBodyException;
 use RunAsRoot\MessageQueueRetry\Exception\MessageNotFoundException;
-use RunAsRoot\MessageQueueRetry\Mapper\MessageToRawResponseMapper;
-use RunAsRoot\MessageQueueRetry\Repository\MessageRepository;
+use RunAsRoot\MessageQueueRetry\Mapper\QueueErrorMessageToRawResponseMapper;
+use RunAsRoot\MessageQueueRetry\Repository\QueueErrorMessageRepository;
 
 class Download extends Action
 {
     public const ADMIN_RESOURCE = 'RunAsRoot_MessageQueueRetry::download';
 
     public function __construct(
         Context $context,
-        private MessageRepository $messageRepository,
+        private QueueErrorMessageRepository $messageRepository,
         private RawFactory $rawFactory,
-        private MessageToRawResponseMapper $messageToRawResponseMapper
+        private QueueErrorMessageToRawResponseMapper $messageToRawResponseMapper
     ) {
         parent::__construct($context);
     }

diff --git a/src/Controller/Adminhtml/Message/MassDelete.php b/src/Controller/Adminhtml/Message/MassDelete.php
@@ -8,20 +8,21 @@
 use Magento\Backend\App\Action\Context;
 use Magento\Framework\Controller\Result\Redirect;
 use Magento\Framework\Controller\Result\RedirectFactory;
+use Magento\Framework\Data\Collection\AbstractDb;
 use Magento\Ui\Component\MassAction\Filter;
-use RunAsRoot\MessageQueueRetry\Model\Message;
-use RunAsRoot\MessageQueueRetry\Model\ResourceModel\Message\MessageCollectionFactory;
-use RunAsRoot\MessageQueueRetry\Repository\MessageRepository;
+use RunAsRoot\MessageQueueRetry\Model\QueueErrorMessage;
+use RunAsRoot\MessageQueueRetry\Model\ResourceModel\QueueErrorMessage\QueueErrorMessageCollectionFactory;
+use RunAsRoot\MessageQueueRetry\Repository\QueueErrorMessageRepository;
 
 class MassDelete extends Action
 {
     public const ADMIN_RESOURCE = 'RunAsRoot_MessageQueueRetry::mass_delete';
 
     public function __construct(
         Context $context,
-        private MessageRepository $messageRepository,
+        private QueueErrorMessageRepository $messageRepository,
         private RedirectFactory $redirectFactory,
-        private MessageCollectionFactory $collectionFactory,
+        private QueueErrorMessageCollectionFactory $collectionFactory,
         private Filter $filter
     ) {
         parent::__construct($context);
@@ -32,10 +33,12 @@ public function execute(): Redirect
         $redirect = $this->redirectFactory->create();
 
         try {
-            $collection = $this->filter->getCollection($this->collectionFactory->create());
+            /** @var AbstractDb $messageCollection */
+            $messageCollection = $this->collectionFactory->create();
+            $collection = $this->filter->getCollection($messageCollection);
 
             foreach ($collection->getItems() as $message) {
-                if (!$message instanceof Message) {
+                if (!$message instanceof QueueErrorMessage) {
                     continue;
                 }
 

diff --git a/src/Controller/Adminhtml/Message/MassRequeue.php b/src/Controller/Adminhtml/Message/MassRequeue.php
@@ -8,9 +8,10 @@
 use Magento\Backend\App\Action\Context;
 use Magento\Framework\Controller\Result\Redirect;
 use Magento\Framework\Controller\Result\RedirectFactory;
+use Magento\Framework\Data\Collection\AbstractDb;
 use Magento\Ui\Component\MassAction\Filter;
-use RunAsRoot\MessageQueueRetry\Model\Message;
-use RunAsRoot\MessageQueueRetry\Model\ResourceModel\Message\MessageCollectionFactory;
+use RunAsRoot\MessageQueueRetry\Model\QueueErrorMessage;
+use RunAsRoot\MessageQueueRetry\Model\ResourceModel\QueueErrorMessage\QueueErrorMessageCollectionFactory;
 use RunAsRoot\MessageQueueRetry\Service\PublishMessageToQueueService;
 
 class MassRequeue extends Action
@@ -21,7 +22,7 @@ public function __construct(
         Context $context,
         private PublishMessageToQueueService $publishMessageToQueueService,
         private RedirectFactory $redirectFactory,
-        private MessageCollectionFactory $collectionFactory,
+        private QueueErrorMessageCollectionFactory $collectionFactory,
         private Filter $filter
     ) {
         parent::__construct($context);
@@ -32,10 +33,12 @@ public function execute(): Redirect
         $redirect = $this->redirectFactory->create();
 
         try {
-            $collection = $this->filter->getCollection($this->collectionFactory->create());
+            /** @var AbstractDb $messageCollection */
+            $messageCollection = $this->collectionFactory->create();
+            $collection = $this->filter->getCollection($messageCollection);
 
             foreach ($collection->getItems() as $message) {
-                if (!$message instanceof Message) {
+                if (!$message instanceof QueueErrorMessage) {
                     continue;
                 }
 

diff --git a/src/Mapper/MessageToRawResponseMapper.php → .../QueueErrorMessageToRawResponseMapper.php b/src/Mapper/MessageToRawResponseMapper.php → .../QueueErrorMessageToRawResponseMapper.php
@@ -7,9 +7,9 @@
 use Magento\Framework\Controller\Result\Raw as RawResponse;
 use RunAsRoot\MessageQueueRetry\Builder\MessageBodyDownloadFileNameBuilder;
 use RunAsRoot\MessageQueueRetry\Exception\EmptyQueueMessageBodyException;
-use RunAsRoot\MessageQueueRetry\Model\Message;
+use RunAsRoot\MessageQueueRetry\Model\QueueErrorMessage;
 
-class MessageToRawResponseMapper
+class QueueErrorMessageToRawResponseMapper
 {
     public function __construct(
         private MessageBodyDownloadFileNameBuilder $messageBodyDownloadFileNameBuilder
@@ -19,7 +19,7 @@ public function __construct(
     /**
      * @throws EmptyQueueMessageBodyException
      */
-    public function map(Message $message, RawResponse $rawResponse): RawResponse
+    public function map(QueueErrorMessage $message, RawResponse $rawResponse): RawResponse
     {
         $messageBody = $message->getMessageBody();
 

diff --git a/src/Model/Message.php → src/Model/QueueErrorMessage.php b/src/Model/Message.php → src/Model/QueueErrorMessage.php
@@ -5,11 +5,11 @@
 namespace RunAsRoot\MessageQueueRetry\Model;
 
 use Magento\Framework\Model\AbstractModel;
-use RunAsRoot\MessageQueueRetry\Api\Data\MessageInterface;
-use RunAsRoot\MessageQueueRetry\Model\ResourceModel\Message\MessageCollection;
-use RunAsRoot\MessageQueueRetry\Model\ResourceModel\MessageResource;
+use RunAsRoot\MessageQueueRetry\Api\Data\QueueErrorMessageInterface;
+use RunAsRoot\MessageQueueRetry\Model\ResourceModel\QueueErrorMessage\QueueErrorMessageCollection;
+use RunAsRoot\MessageQueueRetry\Model\ResourceModel\QueueErrorMessageResource;
 
-class Message extends AbstractModel implements MessageInterface
+class QueueErrorMessage extends AbstractModel implements QueueErrorMessageInterface
 {
     public function getTopicName(): string
     {
@@ -73,7 +73,7 @@ public function setCreatedAt(string $value): void
 
     protected function _construct(): void
     {
-        $this->_init(MessageResource::class);
-        $this->_collectionName = MessageCollection::class;
+        $this->_init(QueueErrorMessageResource::class);
+        $this->_collectionName = QueueErrorMessageCollection::class;
     }
 }
diff --git a/src/Model/ResourceModel/Message/MessageCollection.php b/src/Model/ResourceModel/Message/MessageCollection.php
diff --git a/src/Model/ResourceModel/MessageResource.php b/src/Model/ResourceModel/MessageResource.php
diff --git a/src/Model/ResourceModel/QueueErrorMessage/QueueErrorMessageCollection.php b/src/Model/ResourceModel/QueueErrorMessage/QueueErrorMessageCollection.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RunAsRoot\MessageQueueRetry\Model\ResourceModel\QueueErrorMessage;
+
+use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;
+use RunAsRoot\MessageQueueRetry\Model\QueueErrorMessage as Model;
+use RunAsRoot\MessageQueueRetry\Model\ResourceModel\QueueErrorMessageResource as ResourceModel;
+
+class QueueErrorMessageCollection extends AbstractCollection
+{
+    protected function _construct(): void
+    {
+        $this->_init(Model::class, ResourceModel::class);
+    }
+}
diff --git a/src/Model/ResourceModel/QueueErrorMessageResource.php b/src/Model/ResourceModel/QueueErrorMessageResource.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RunAsRoot\MessageQueueRetry\Model\ResourceModel;
+
+use Magento\Framework\Model\ResourceModel\Db\AbstractDb;
+use RunAsRoot\MessageQueueRetry\Api\Data\QueueErrorMessageInterface;
+
+class QueueErrorMessageResource extends AbstractDb
+{
+    protected function _construct(): void
+    {
+        $this->_init(QueueErrorMessageInterface::TABLE_NAME, QueueErrorMessageInterface::ENTITY_ID);
+    }
+}
diff --git a/src/Repository/Command/CreateMessageCommand.php b/src/Repository/Command/CreateMessageCommand.php
@@ -5,8 +5,8 @@
 namespace RunAsRoot\MessageQueueRetry\Repository\Command;
 
 use RunAsRoot\MessageQueueRetry\Exception\MessageCouldNotBeCreatedException;
-use RunAsRoot\MessageQueueRetry\Model\Message;
-use RunAsRoot\MessageQueueRetry\Model\ResourceModel\MessageResource as ResourceModel;
+use RunAsRoot\MessageQueueRetry\Model\QueueErrorMessage;
+use RunAsRoot\MessageQueueRetry\Model\ResourceModel\QueueErrorMessageResource as ResourceModel;
 
 class CreateMessageCommand
 {
@@ -17,7 +17,7 @@ public function __construct(private ResourceModel $resourceModel)
     /**
      * @throws MessageCouldNotBeCreatedException
      */
-    public function execute(Message $message): Message
+    public function execute(QueueErrorMessage $message): QueueErrorMessage
     {
         try {
             $this->resourceModel->save($message);

diff --git a/src/Repository/Command/DeleteMessageByIdCommand.php b/src/Repository/Command/DeleteMessageByIdCommand.php
@@ -5,7 +5,7 @@
 namespace RunAsRoot\MessageQueueRetry\Repository\Command;
 
 use RunAsRoot\MessageQueueRetry\Exception\MessageCouldNotBeDeletedException;
-use RunAsRoot\MessageQueueRetry\Model\ResourceModel\MessageResource as ResourceModel;
+use RunAsRoot\MessageQueueRetry\Model\ResourceModel\QueueErrorMessageResource as ResourceModel;
 use RunAsRoot\MessageQueueRetry\Repository\Query\FindMessageByIdQuery;
 
 class DeleteMessageByIdCommand

diff --git a/src/Repository/Command/DeleteMessageCommand.php b/src/Repository/Command/DeleteMessageCommand.php
@@ -5,8 +5,8 @@
 namespace RunAsRoot\MessageQueueRetry\Repository\Command;
 
 use RunAsRoot\MessageQueueRetry\Exception\MessageCouldNotBeDeletedException;
-use RunAsRoot\MessageQueueRetry\Model\Message;
-use RunAsRoot\MessageQueueRetry\Model\ResourceModel\MessageResource as ResourceModel;
+use RunAsRoot\MessageQueueRetry\Model\QueueErrorMessage;
+use RunAsRoot\MessageQueueRetry\Model\ResourceModel\QueueErrorMessageResource as ResourceModel;
 
 class DeleteMessageCommand
 {
@@ -17,7 +17,7 @@ public function __construct(private ResourceModel $resourceModel)
     /**
      * @throws MessageCouldNotBeDeletedException
      */
-    public function execute(Message $message): void
+    public function execute(QueueErrorMessage $message): void
     {
         try {
             $this->resourceModel->delete($message);

diff --git a/src/Repository/Query/FindMessageByIdQuery.php b/src/Repository/Query/FindMessageByIdQuery.php
@@ -5,9 +5,9 @@
 namespace RunAsRoot\MessageQueueRetry\Repository\Query;
 
 use RunAsRoot\MessageQueueRetry\Exception\MessageNotFoundException;
-use RunAsRoot\MessageQueueRetry\Model\Message;
-use RunAsRoot\MessageQueueRetry\Model\MessageFactory as ModelFactory;
-use RunAsRoot\MessageQueueRetry\Model\ResourceModel\MessageResource as ResourceModel;
+use RunAsRoot\MessageQueueRetry\Model\QueueErrorMessage;
+use RunAsRoot\MessageQueueRetry\Model\QueueErrorMessageFactory as ModelFactory;
+use RunAsRoot\MessageQueueRetry\Model\ResourceModel\QueueErrorMessageResource as ResourceModel;
 
 class FindMessageByIdQuery
 {
@@ -20,7 +20,7 @@ public function __construct(
     /**
      * @throws MessageNotFoundException
      */
-    public function execute(int $entityId): Message
+    public function execute(int $entityId): QueueErrorMessage
     {
         $model = $this->modelFactory->create();
         $this->resourceModel->load($model, $entityId);

diff --git a/src/Repository/MessageRepository.php → ...epository/QueueErrorMessageRepository.php b/src/Repository/MessageRepository.php → ...epository/QueueErrorMessageRepository.php
@@ -7,13 +7,13 @@
 use RunAsRoot\MessageQueueRetry\Exception\MessageCouldNotBeCreatedException;
 use RunAsRoot\MessageQueueRetry\Exception\MessageCouldNotBeDeletedException;
 use RunAsRoot\MessageQueueRetry\Exception\MessageNotFoundException;
-use RunAsRoot\MessageQueueRetry\Model\Message;
+use RunAsRoot\MessageQueueRetry\Model\QueueErrorMessage;
 use RunAsRoot\MessageQueueRetry\Repository\Command\CreateMessageCommand;
 use RunAsRoot\MessageQueueRetry\Repository\Command\DeleteMessageByIdCommand;
 use RunAsRoot\MessageQueueRetry\Repository\Command\DeleteMessageCommand;
 use RunAsRoot\MessageQueueRetry\Repository\Query\FindMessageByIdQuery;
 
-class MessageRepository
+class QueueErrorMessageRepository
 {
     public function __construct(
         private CreateMessageCommand $createMessageCommand,
@@ -26,15 +26,15 @@ public function __construct(
     /**
      * @throws MessageNotFoundException
      */
-    public function findById(int $id): Message
+    public function findById(int $id): QueueErrorMessage
     {
         return $this->findMessageByIdQuery->execute($id);
     }
 
     /**
      * @throws MessageCouldNotBeCreatedException
      */
-    public function create(Message $message): Message
+    public function create(QueueErrorMessage $message): QueueErrorMessage
     {
         return $this->createMessageCommand->execute($message);
     }
@@ -50,7 +50,7 @@ public function deleteById(int $id): void
     /**
      * @throws MessageCouldNotBeDeletedException
      */
-    public function delete(Message $message): void
+    public function delete(QueueErrorMessage $message): void
     {
         $this->deleteMessageCommand->execute($message);
     }