Merge pull request #18 from run-as-root/develop

Improvements

- Replace Rewrite by Around Plugin on the message reject function
- Fix Retries Count
- Refactory
- Removes the unused PHPUnit test coverage pipeline

Author: cristiano-pacheco

.github/workflows/test_extension.yml

@@ -80,12 +80,3 @@ jobs:
 
       - name: PHP Unit
         run: composer test
-
-      - name: phpunit-coverage-badge
-        uses: timkrase/phpunit-coverage-badge@v1.2.1
-        with:
-          report: reports/test-reports/clover.xml
-          coverage_badge_path: output/coverage.svg
-          push_badge: true
-          commit_message: "Update coverage badge"
-          repo_token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -5,7 +5,7 @@
 
 # run-as-root/magento2-message-queue-retry
 
-It gives the possibility to process the same queue message more than once, 
+It gives the possibility to process the same queue message more than once,
 utilizing The RabbitMQ's [dead letter exchange](https://www.rabbitmq.com/dlx.html)  feature.
 
 ## Table of Contents
@@ -25,7 +25,7 @@ utilizing The RabbitMQ's [dead letter exchange](https://www.rabbitmq.com/dlx.htm
 To be able to use this module, you have to manually configure the dead letter exchange(s) for the queue(s) you want to enable the retry mechanismm through the `queue_topology.xml` file.
 An example will be given in the [Configuration](#configuration) section.
 
-Other requisite is that your exchanges have to have a relation from one exchange to only one topic and queue, 
+Other requisite is that your exchanges have to have a relation from one exchange to only one topic and queue,
 
 For example:
 
@@ -95,7 +95,7 @@ Is possible to configure the ACL for each action in the grid and the module conf
 
 Two steps are necessary to configure the retry for a queue:
 1. Configure the dead letter exchange
-1. Enable the message queue retry and delclare the retry limit configuration
+2. Enable the message queue retry and declare the retry limit configuration
 
 Let's imagine a scenario that the `erp_order_export` queue already exists in your project and to simplify the example the topic name, exchange name and queue name are the same: `erp_order_export`.
 
@@ -178,7 +178,7 @@ System > Configuration > RUN-AS-ROOT > Message Queue Retry
 
 ![img.png](docs/configuration.png)
 
-Note that if the queue is not declared in the configuration it will the default Magento consumer behavior.
+**Important note:** Make sure to configure the retry limit of your queue in the module configuration. If you configure the dead letter exchange and do not set the retry limit in the configuration(System > Configuration > RUN-AS-ROOT > Message Queue Retry), the message will be in a retry loop, that is, execute until the consumer process the message without throwing an exception. This is the default behavior for the RabbitMQ dead letter exchange and will work this way even if this module is not installed.
 
 For more information of how to configure message queues in Magento 2, you can take a look [here](https://developer.adobe.com/commerce/php/development/components/message-queues/configuration/).
 

composer.json

@@ -63,6 +63,6 @@
         "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",
-        "mess-detector": "vendor/bin/phpmd src html phpmd-ruleset.xml --exclude \"Test,src/Queue/Consumer.php\" --strict --reportfile reports/phpmd/phpmd.html"
+        "mess-detector": "vendor/bin/phpmd src html phpmd-ruleset.xml --exclude \"Test\" --strict --reportfile reports/phpmd/phpmd.html"
     }
 }

phpstan.neon.dist

@@ -5,7 +5,6 @@ parameters:
   excludePaths:
     analyseAndScan:
       - src/Test
-      - src/Queue/Consumer.php
   ignoreErrors:
     - '#Method .*construct\(\) has parameter \$data with no value type specified in iterable type array#'
 

src/Plugin/HandleQueueMessageRejectPlugin.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RunAsRoot\MessageQueueRetry\Plugin;
+
+use JsonException;
+use Magento\Framework\MessageQueue\EnvelopeInterface;
+use Magento\Framework\MessageQueue\QueueInterface;
+use RunAsRoot\MessageQueueRetry\Exception\MessageCouldNotBeCreatedException;
+use RunAsRoot\MessageQueueRetry\Service\IsMessageShouldBeSavedForRetryService;
+use RunAsRoot\MessageQueueRetry\Service\SaveFailedMessageService;
+
+class HandleQueueMessageRejectPlugin
+{
+    public function __construct(
+        private IsMessageShouldBeSavedForRetryService $isMessageShouldBeSavedForRetryService,
+        private SaveFailedMessageService $saveFailedMessageService
+    ) {
+    }
+
+    /**
+     * @throws MessageCouldNotBeCreatedException
+     * @throws JsonException
+     */
+    public function aroundReject(
+        QueueInterface $subject,
+        callable $proceed,
+        EnvelopeInterface $envelope,
+        bool $requeue,
+        string $error
+    ): void {
+        if (!$error) {
+            $proceed($envelope, $requeue, $error);
+            return;
+        }
+
+        $shouldBeSavedForRetry = $this->isMessageShouldBeSavedForRetryService->execute($envelope);
+
+        if (!$shouldBeSavedForRetry) {
+            $proceed($envelope, $requeue, $error);
+            return;
+        }
+
+        $this->saveFailedMessageService->execute($envelope, $error);
+        $subject->acknowledge($envelope);
+    }
+}

src/Queue/Consumer.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RunAsRoot\MessageQueueRetry\Service;
+
+use Magento\Framework\MessageQueue\EnvelopeInterface;
+use PhpAmqpLib\Wire\AMQPTable;
+
+class GetMessageRetriesCountService
+{
+    public function execute(EnvelopeInterface $message): int
+    {
+        $messageProperties = $message->getProperties();
+        $applicationHeaders = $messageProperties['application_headers'] ?? null;
+
+        // If there are no application headers, then it is the first time the message has been processed.
+        if (!$applicationHeaders instanceof AMQPTable) {
+            return 0;
+        }
+
+        if (isset($applicationHeaders->getNativeData()['x-death'][0]['count'])) {
+            return $applicationHeaders->getNativeData()['x-death'][0]['count'];
+        }
+
+        return 0;
+    }
+}