Merge pull request #50 from needle-project/feature/0.5.0

Feature/0.5.0

Author: needle-project

.travis.yml

@@ -0,0 +1,8 @@
+# Release Notes for 0.5.x
+
+### [0.5.0](https://github.com/needle-project/laravel-rabbitmq/compare/0.4.3...feature/0.5.0) - 2024-03 - *!NOT RELEASED*
+* Add automatically `delivery_mode` to 2 (persistent) for durable entities
+* Add additional arguments for entities in order to support `quorum` type
+* Add `ticket` argument
+* Add properties for AMQP Messages when publishing
+* Fixed `wait` for consumers to align with consumer timeout

CHANGELOG.md

@@ -1,4 +1,3 @@
-[![Build Status](https://travis-ci.org/needle-project/process-transaction.svg?branch=master)](https://travis-ci.org/needle-project/process-transaction)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/needle-project/laravel-rabbitmq/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/needle-project/laravel-rabbitmq/?branch=master)
 [![Code Coverage](https://scrutinizer-ci.com/g/needle-project/laravel-rabbitmq/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/needle-project/laravel-rabbitmq/?branch=master)
 [![Total Downloads](https://poser.pugx.org/needle-project/laravel-rabbitmq/downloads)](https://packagist.org/packages/needle-project/laravel-rabbitmq)
@@ -30,9 +29,16 @@ A simple rabbitmq library for laravel based on Publish–Subscribe pattern where
 
 	3.4. [Custom Message Processor](#34-custom-message-processor)
 
-4. [Contribute](#4-contribute)
+4. [Examples](#4-examples)
+
+5. [Contribute](#5-contribute)
+
+	5.1 [Local Development](#51-local-development)
+
+    5.2 [Required Help](#52-required-help)
+
+6. [Special "Thank You"](#6-special-thank-you)
 
-	4.1 [Local Development](#41-local-development)
 
 # 1. Install
 Run: 
@@ -197,7 +203,7 @@ Defining a publishers:
 ```
 
 ### 2.5. Consumers
-A consumer will alway get message from a queue.
+A consumer will always get message from a queue.
 Define a consumer:
 ```php
 'consumers' => [
@@ -290,7 +296,7 @@ php artisan rabbitmq:publish aPublisherName MyMessage
 ### 3.2. Consuming a message
 Consuming message should be done by running a command in deamon mode. While PHP is not intended to do that, you can use [supervisor](http://supervisord.org/index.html) for that.
 
-The **flow** of the consummer is rather simple:
+The **flow** of the consumer is rather simple:
 CLI Consumers -> Get message -> Passes it to the `message_processor` key from configuration.
 
 A message processor is a class that implements `NeedleProject\LaravelRabbitMq\Processor` interface. If you do no want to handle acknowledgement you can extend  `\NeedleProject\LaravelRabbitMq\Processor\AbstractMessageProcessor` which require implementation of `processMessage(AMQPMessage $message): bool` method.
@@ -320,19 +326,19 @@ rabbitmq:publish | Publish one message using a consumer | `php artisan rabbitmq:
 rabbitmq:setup | Creates all queues and exchanges | `php artisan rabbitmq:setup` or `php artisan rabbitmq:setup --force`. **NOTE** When using force, all queues and exchanges will be deleted first and then re-created.
 
 ### 3.4. Custom Message Processor
-At the current moment there is the posibility to either implement the `MessageProcessorInterface` class or extend the `AbstractMessageProcessor`.
+At the current moment there is the possibility to either implement the `MessageProcessorInterface` class or extend the `AbstractMessageProcessor`.
 
 When using the `AbstractMessageProcessor`, you will have access to extra API than can be used in your `processMessage()`:
 ```php
 protected function ack(AMQPMessage $message);
 protected function nack(AMQPMessage $message, bool $redeliver = true);
 ```
 
-# 4. Contribute
-You are free to contribute by submiting pull request or reporting any issue in Github.
+# 5. Contribute
+You are free to contribute by submitting pull request or reporting any issue in Github.
 At the current stage of the project, no contribution procedure is defined.
 
-## 4.1 Local Development
+## 5.1 Local Development
 Run composer install (with ignore-platform-reqs to avoid missing extensions):
 ```bash
  docker run --rm -v $(pwd):/app jitesoft/phpunit:8.1 composer install --ignore-platform-req=ext-sockets
@@ -342,3 +348,12 @@ Run unit tests via Docker:
 ```bash
 docker run --rm -v $(pwd):/app jitesoft/phpunit:8.1 phpunit --configuration phpunit.xml
 ```
+
+## 5.2. Required Help
+There are multiple topics for which the library needs help
+- CI Pipeline: There is a need for a configuration of *scrutinizer* (or any other tool) that can cover running tests for all supported PHP Versions and Laravel Framework versions
+- Documentation: Any improvement to easy the use of the library it's welcome
+- Examples: A section of examples that proves the library's different real-world scenario examples
+
+## 6. Special "Thank you"
+Special "Thank you" goes out to the library [contributors](https://github.com/needle-project/laravel-rabbitmq/graphs/contributors).

README.md

@@ -14,10 +14,12 @@
 	    "php-amqplib/php-amqplib": ">=2.7|3.*"
     },
     "require-dev": {
-        "phpunit/phpunit": "9.*",
-        "squizlabs/php_codesniffer": "2.*",
+        "phpunit/phpunit": "9.*|10.*",
+        "squizlabs/php_codesniffer": "3.7.*",
         "phpmd/phpmd" : "@stable",
-        "laravel/framework" : "5.*|6.*|7.*|8.*"
+        "laravel/framework": "7.*|8.*|9.*|10.*",
+        "phpstan/phpstan": "^1.10",
+        "phpcompatibility/php-compatibility": "^9.3"
     },
     "autoload": {
         "psr-4": {"NeedleProject\\LaravelRabbitMq\\": "src/"}
@@ -37,6 +39,7 @@
     "config": {
         "allow-plugins": {
             "kylekatarnls/update-helper": true
-        }
+        },
+        "process-timeout": 1200
     }
 }

composer.json

@@ -0,0 +1,46 @@
+<?xml version="1.0"?>
+<ruleset name="Ruleset"
+         xmlns="http://pmd.sf.net/ruleset/1.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0
+                     http://pmd.sf.net/ruleset_xml_schema.xsd"
+         xsi:noNamespaceSchemaLocation="
+                     http://pmd.sf.net/ruleset_xml_schema.xsd">
+    <rule ref="rulesets/codesize.xml/CyclomaticComplexity">
+    </rule>
+    <rule ref="rulesets/codesize.xml/NPathComplexity">
+    </rule>
+    <rule ref="rulesets/codesize.xml/ExcessiveMethodLength">
+    </rule>
+    <rule ref="rulesets/codesize.xml/ExcessiveClassLength">
+    </rule>
+    <rule ref="rulesets/codesize.xml/ExcessiveParameterList">
+    </rule>
+    <rule ref="rulesets/design.xml/ExitExpression">
+    </rule>
+    <rule ref="rulesets/design.xml/EvalExpression">
+    </rule>
+    <rule ref="rulesets/design.xml/GotoStatement">
+    </rule>
+    <rule ref="rulesets/design.xml/DepthOfInheritance">
+    </rule>
+    <rule ref="rulesets/design.xml/DevelopmentCodeFragment">
+        <properties>
+            <property name="ignore-namespaces" value="true"/>
+            <property name="unwanted-functions" value="var_dump,print_r,debug_zval_dump,debug_print_backtrace,dd,dump" description="Comma separated list of suspect function images." />
+        </properties>
+    </rule>
+    <rule ref="rulesets/naming.xml/LongVariable">
+        <properties>
+            <property name="maximum" description="The variable length reporting threshold" value="30"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/naming.xml/ConstructorWithNameAsEnclosingClass">
+    </rule>
+    <rule ref="rulesets/naming.xml/ConstantNamingConventions">
+    </rule>
+    <rule ref="rulesets/naming.xml/BooleanGetMethodName">
+    </rule>
+    <rule ref="rulesets/unusedcode.xml">
+    </rule>
+</ruleset>

phpmd.xml

@@ -1,9 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" colors="true" bootstrap="vendor/autoload.php">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.4/phpunit.xsd" colors="true" bootstrap="vendor/autoload.php" cacheDirectory=".phpunit.cache">
   <coverage>
-    <include>
-      <directory suffix=".php">src/</directory>
-    </include>
     <report>
       <html outputDirectory="coverage" lowUpperBound="35"/>
     </report>
@@ -17,4 +14,9 @@
     </testsuite>
   </testsuites>
   <logging/>
+  <source>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+  </source>
 </phpunit>

phpunit.xml

@@ -53,7 +53,9 @@ public function createContainer(array $config)
 
         foreach ($config['consumers'] as $consumerAliasName => $consumerDetails) {
             $prefetchCount    = $consumerDetails['prefetch_count'];
-            $globalPrefetch   = array_key_exists('global_prefetch', $consumerDetails) ? $consumerDetails['global_prefetch'] : true;
+            $globalPrefetch   = array_key_exists('global_prefetch', $consumerDetails)
+                ? $consumerDetails['global_prefetch']
+                : true;
             $messageProcessor = $consumerDetails['message_processor'];
 
             if ($queues->has($consumerDetails['queue'])) {

src/Builder/ContainerBuilder.php

@@ -66,5 +66,6 @@ public function handle()
     {
         $this->getPublisher($this->input->getArgument('publisher'))
             ->publish($this->input->getArgument('message'));
+        return 0;
     }
-}
+}

src/Command/BasePublisherCommand.php

@@ -79,8 +79,7 @@ private function addAttributesOnEntities(array $entityConfig): array
      */
     private function addPrefetchOnConsumers(array $consumers): array
     {
-        foreach ($consumers as $consumerAliasName => $consumerDefinition)
-        {
+        foreach ($consumers as $consumerAliasName => $consumerDefinition) {
             if (!isset($consumerDefinition['prefetch_count'])) {
                 $consumerDefinition['prefetch_count'] = 1;
             }

src/ConfigHelper.php

@@ -2,11 +2,13 @@
 namespace NeedleProject\LaravelRabbitMq\Entity;
 
 use NeedleProject\LaravelRabbitMq\AMQPConnection;
+use NeedleProject\LaravelRabbitMq\Interpreter\EntityArgumentsInterpreter;
 use NeedleProject\LaravelRabbitMq\PublisherInterface;
 use PhpAmqpLib\Channel\AMQPChannel;
 use PhpAmqpLib\Exception\AMQPChannelClosedException;
 use PhpAmqpLib\Exception\AMQPProtocolChannelException;
 use PhpAmqpLib\Message\AMQPMessage;
+use PhpAmqpLib\Wire\AMQPTable;
 
 /**
  * Class ExchangeEntity
@@ -17,7 +19,7 @@
 class ExchangeEntity implements PublisherInterface, AMQPEntityInterface
 {
     /**
-     * @const int   Retry count when a Channel Closed exeption is thrown
+     * @const int   Retry count when a Channel Closed exception is thrown
      */
     const MAX_RETRIES = 3;
 
@@ -36,6 +38,8 @@ class ExchangeEntity implements PublisherInterface, AMQPEntityInterface
         'internal'                     => false,
         // Whether to receive a Declare confirmation
         'nowait'                       => false,
+        // Additional arguments for queue creation
+        'arguments'                    => [],
         // Whether to auto create the entity before publishing/consuming it
         'auto_create'                  => false,
         // whether to "hide" the exception on re-declare.
@@ -44,6 +48,8 @@ class ExchangeEntity implements PublisherInterface, AMQPEntityInterface
         // whether to throw on exception when trying to
         // bind to an in-existent queue/exchange
         'throw_exception_on_bind_fail' => true,
+        // no ideea what it represents - @todo - find a documentation that states it's role
+        'ticket'                       => null
     ];
 
     /**
@@ -62,7 +68,7 @@ class ExchangeEntity implements PublisherInterface, AMQPEntityInterface
     protected $attributes;
 
     /**
-     * @var int 
+     * @var int
      */
     protected $retryCount = 0;
 
@@ -133,7 +139,11 @@ public function create()
                     $this->attributes['durable'],
                     $this->attributes['auto_delete'],
                     $this->attributes['internal'],
-                    $this->attributes['nowait']
+                    $this->attributes['nowait'],
+                    EntityArgumentsInterpreter::interpretArguments(
+                        $this->attributes['arguments']
+                    ),
+                    $this->attributes['ticket']
                 );
         } catch (AMQPProtocolChannelException $e) {
             // 406 is a soft error triggered for precondition failure (when redeclaring with different parameters)
@@ -162,7 +172,7 @@ public function bind()
                         $bindItem['routing_key']
                     );
             } catch (AMQPProtocolChannelException $e) {
-                // 404 is the code for trying to bind to an non-existing entity
+                // 404 is the code for trying to bind to a non-existing entity
                 if (true === $this->attributes['throw_exception_on_bind_fail'] || $e->amqp_reply_code !== 404) {
                     throw $e;
                 }
@@ -192,18 +202,25 @@ public function reconnect()
      *
      * @param string $message
      * @param string $routingKey
+     * @param array $properties
      * @return mixed|void
      * @throws AMQPProtocolChannelException
      */
-    public function publish(string $message, string $routingKey = '')
+    public function publish(string $message, string $routingKey = '', array $properties = [])
     {
         try {
             if ($this->attributes['auto_create'] === true) {
                 $this->create();
                 $this->bind();
             }
             $this->getChannel()->basic_publish(
-                new AMQPMessage($message),
+                new AMQPMessage(
+                    $message,
+                    EntityArgumentsInterpreter::interpretProperties(
+                        $this->attributes,
+                        $properties
+                    )
+                ),
                 $this->attributes['name'],
                 $routingKey,
                 true