Add idle event and ability to configure exit or not. (#419)

* Add idle event and ability to configure exit or not.
* fix tests on php 5.3. remove ::class const
* Update documentation about idle event

Author: makasim

Event/AMQPEvent.php

@@ -15,6 +15,7 @@
 class AMQPEvent extends Event
 {
     const ON_CONSUME                = 'on_consume';
+    const ON_IDLE                   = 'on_idle';
     const BEFORE_PROCESSING_MESSAGE = 'before_processing';
     const AFTER_PROCESSING_MESSAGE  = 'after_processing';
 

Event/OnIdleEvent.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace OldSound\RabbitMqBundle\Event;
+
+use OldSound\RabbitMqBundle\RabbitMq\Consumer;
+
+/**
+ * Class OnIdleEvent
+ *
+ * @package OldSound\RabbitMqBundle\Command
+ */
+class OnIdleEvent extends AMQPEvent
+{
+    const NAME = AMQPEvent::ON_IDLE;
+
+    /**
+     * @var bool
+     */
+    private $forceStop;
+
+    /**
+     * OnConsumeEvent constructor.
+     *
+     * @param Consumer $consumer
+     */
+    public function __construct(Consumer $consumer)
+    {
+        $this->setConsumer($consumer);
+
+        $this->forceStop = true;
+    }
+
+    /**
+     * @return boolean
+     */
+    public function isForceStop()
+    {
+        return $this->forceStop;
+    }
+
+    /**
+     * @param boolean $forceStop
+     */
+    public function setForceStop($forceStop)
+    {
+        $this->forceStop = $forceStop;
+    }
+}

README.md

@@ -351,6 +351,32 @@ class AfterProcessingMessageEvent extends AMQPEvent
 Event raised after processing a AMQPMessage.
 If the process message will throw an Exception the event will not raise.
 
+##### IDLE MESSAGE #####
+
+```php
+<?php
+class OnIdleEvent extends AMQPEvent
+{
+    const NAME = AMQPEvent::ON_IDLE;
+
+    /**
+     * OnIdleEvent constructor.
+     *
+     * @param AMQPMessage $AMQPMessage
+     */
+    public function __construct(Consumer $consumer)
+    {
+        $this->setConsumer($consumer);
+        
+        $this->forceStop = true;
+    }
+}
+```
+
+Event raised when `wait` method exit by timeout without receiving a message. 
+In order to make use of this event a consumer `idle_timeout` has to be [configured](#idle-timeout). 
+By default process exit on idle timeout, you can prevent it by setting `$event->setForceStop(false)` in a listener.
+
 #### Idle timeout ####
 
 If you need to set a timeout when there are no messages from your queue during a period of time, you can set the `idle_timeout` in seconds.

RabbitMq/Consumer.php

@@ -5,6 +5,7 @@
 use OldSound\RabbitMqBundle\Event\AfterProcessingMessageEvent;
 use OldSound\RabbitMqBundle\Event\BeforeProcessingMessageEvent;
 use OldSound\RabbitMqBundle\Event\OnConsumeEvent;
+use OldSound\RabbitMqBundle\Event\OnIdleEvent;
 use OldSound\RabbitMqBundle\MemoryChecker\MemoryConsumptionChecker;
 use OldSound\RabbitMqBundle\MemoryChecker\NativeMemoryUsageProvider;
 use PhpAmqpLib\Exception\AMQPTimeoutException;
@@ -55,10 +56,15 @@ public function consume($msgAmount)
                 try {
                     $this->getChannel()->wait(null, false, $this->getIdleTimeout());
                 } catch (AMQPTimeoutException $e) {
-                    if (null !== $this->getIdleTimeoutExitCode()) {
-                        return $this->getIdleTimeoutExitCode();
-                    } else {
-                        throw $e;
+                    $idleEvent = new OnIdleEvent($this);
+                    $this->dispatchEvent(OnIdleEvent::NAME, $idleEvent);
+
+                    if ($idleEvent->isForceStop()) {
+                        if (null !== $this->getIdleTimeoutExitCode()) {
+                            return $this->getIdleTimeoutExitCode();
+                        } else {
+                            throw $e;
+                        }
                     }
                 }
             }

Tests/Event/OnIdleEventTest.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace OldSound\RabbitMqBundle\Tests\Event;
+
+use OldSound\RabbitMqBundle\Event\OnIdleEvent;
+use OldSound\RabbitMqBundle\RabbitMq\Consumer;
+
+/**
+ * Class OnIdleEventTest
+ *
+ * @package OldSound\RabbitMqBundle\Tests\Event
+ */
+class OnIdleEventTest extends \PHPUnit_Framework_TestCase
+{
+    protected function getConsumer()
+    {
+        return new Consumer(
+            $this->getMockBuilder('\PhpAmqpLib\Connection\AMQPConnection')
+                ->disableOriginalConstructor()
+                ->getMock(),
+            $this->getMockBuilder('\PhpAmqpLib\Channel\AMQPChannel')
+                ->disableOriginalConstructor()
+                ->getMock()
+        );
+    }
+
+    public function testShouldAllowGetConsumerSetInConstructor()
+    {
+        $consumer = $this->getConsumer();
+        $event = new OnIdleEvent($consumer);
+
+        $this->assertSame($consumer, $event->getConsumer());
+    }
+
+    public function testShouldSetForceStopToTrueInConstructor()
+    {
+        $consumer = $this->getConsumer();
+        $event = new OnIdleEvent($consumer);
+
+        $this->assertTrue($event->isForceStop());
+    }
+
+    public function testShouldReturnPreviouslySetForceStop()
+    {
+        $consumer = $this->getConsumer();
+        $event = new OnIdleEvent($consumer);
+
+        //guard
+        $this->assertTrue($event->isForceStop());
+
+        $event->setForceStop(false);
+        $this->assertFalse($event->isForceStop());
+    }
+}

Tests/RabbitMq/ConsumerTest.php

@@ -5,6 +5,7 @@
 use OldSound\RabbitMqBundle\Event\AfterProcessingMessageEvent;
 use OldSound\RabbitMqBundle\Event\BeforeProcessingMessageEvent;
 use OldSound\RabbitMqBundle\Event\OnConsumeEvent;
+use OldSound\RabbitMqBundle\Event\OnIdleEvent;
 use OldSound\RabbitMqBundle\RabbitMq\Consumer;
 use PhpAmqpLib\Exception\AMQPTimeoutException;
 use PhpAmqpLib\Message\AMQPMessage;
@@ -144,7 +145,7 @@ public function testConsume($data)
         $amqpChannel->callbacks = $consumerCallBacks;
 
         /**
-         * Mock ait method and use a callback to remove one element each time from callbacks
+         * Mock wait method and use a callback to remove one element each time from callbacks
          * This will simulate a basic consumer consume with provided messages count
          */
         $amqpChannel->expects($this->exactly(count($consumerCallBacks)))
@@ -202,4 +203,56 @@ public function testIdleTimeoutExitCode()
 
         $this->assertTrue(2 == $consumer->consume(1));
     }
+
+    public function testShouldAllowContinueConsumptionAfterIdleTimeout()
+    {
+        // set up amqp connection
+        $amqpConnection = $this->prepareAMQPConnection();
+        // set up amqp channel
+        $amqpChannel = $this->prepareAMQPChannel();
+        $amqpChannel->expects($this->atLeastOnce())
+            ->method('getChannelId')
+            ->with()
+            ->willReturn(true);
+        $amqpChannel->expects($this->once())
+            ->method('basic_consume')
+            ->withAnyParameters()
+            ->willReturn(true);
+
+        // set up consumer
+        $consumer = $this->getConsumer($amqpConnection, $amqpChannel);
+        // disable autosetup fabric so we do not mock more objects
+        $consumer->disableAutoSetupFabric();
+        $consumer->setChannel($amqpChannel);
+        $consumer->setIdleTimeout(2);
+        $amqpChannel->callbacks = array('idle_timeout_exit_code');
+
+        $amqpChannel->expects($this->exactly(2))
+            ->method('wait')
+            ->with(null, false, $consumer->getIdleTimeout())
+            ->willThrowException(new AMQPTimeoutException());
+
+        // set up event dispatcher
+        $eventDispatcher = $this->getMockBuilder('Symfony\Component\EventDispatcher\EventDispatcher')
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $eventDispatcher->expects($this->at(1))
+            ->method('dispatch')
+            ->with(OnIdleEvent::NAME, $this->isInstanceOf('OldSound\RabbitMqBundle\Event\OnIdleEvent'))
+            ->willReturnCallback(function($eventName, OnIdleEvent $event) {
+                $event->setForceStop(false);
+            });
+        $eventDispatcher->expects($this->at(3))
+            ->method('dispatch')
+            ->with(OnIdleEvent::NAME, $this->isInstanceOf('OldSound\RabbitMqBundle\Event\OnIdleEvent'))
+            ->willReturn(function($eventName, OnIdleEvent $event) {
+                $event->setForceStop(true);
+        });
+
+        $consumer->setEventDispatcher($eventDispatcher);
+
+        $this->setExpectedException('PhpAmqpLib\Exception\AMQPTimeoutException');
+        $consumer->consume(10);
+    }
 }