Merge 3.x into master

sonata-project · Dec 23, 2016 · a0b95aa · a0b95aa
2 parents 765fa78 + 96eafb2
commit a0b95aa
Show file tree

Hide file tree

Showing 7 changed files with 169 additions and 62 deletions.
diff --git a/Backend/AMQPBackend.php b/Backend/AMQPBackend.php
@@ -57,27 +57,34 @@ class AMQPBackend implements BackendInterface
      */
     protected $deadLetterRoutingKey;
 
+    /**
+     * @var null|int
+     */
+    protected $ttl;
+
     /**
      * @var AMQPBackendDispatcher
      */
     protected $dispatcher = null;
 
     /**
-     * @param string $exchange
-     * @param string $queue
-     * @param string $recover
-     * @param string $key
-     * @param string $deadLetterExchange
-     * @param string $deadLetterRoutingKey
+     * @param string   $exchange
+     * @param string   $queue
+     * @param string   $recover
+     * @param string   $key
+     * @param string   $deadLetterExchange
+     * @param string   $deadLetterRoutingKey
+     * @param null|int $ttl
      */
-    public function __construct($exchange, $queue, $recover, $key, $deadLetterExchange = null, $deadLetterRoutingKey = null)
+    public function __construct($exchange, $queue, $recover, $key, $deadLetterExchange = null, $deadLetterRoutingKey = null, $ttl = null)
     {
         $this->exchange = $exchange;
         $this->queue = $queue;
         $this->recover = $recover;
         $this->key = $key;
         $this->deadLetterExchange = $deadLetterExchange;
         $this->deadLetterRoutingKey = $deadLetterRoutingKey;
+        $this->ttl = $ttl;
 
         if (!class_exists('PhpAmqpLib\Message\AMQPMessage')) {
             throw new \RuntimeException('Please install php-amqplib/php-amqplib dependency');
@@ -107,6 +114,10 @@ public function initialize()
             }
         }
 
+        if ($this->ttl !== null) {
+            $args['x-message-ttl'] = array('I', $this->ttl);
+        }
+
         /*
          * name: $queue
          * passive: false

diff --git a/Controller/Api/MessageController.php b/Controller/Api/MessageController.php
@@ -11,6 +11,7 @@
 
 namespace Sonata\NotificationBundle\Controller\Api;
 
+use FOS\RestBundle\Context\Context;
 use FOS\RestBundle\Controller\Annotations\QueryParam;
 use FOS\RestBundle\Controller\Annotations\Route;
 use FOS\RestBundle\Controller\Annotations\View;
@@ -64,7 +65,6 @@ public function __construct(MessageManagerInterface $messageManager, FormFactory
      *
      * @QueryParam(name="page", requirements="\d+", default="1", description="Page for message list pagination")
      * @QueryParam(name="count", requirements="\d+", default="10", description="Number of messages by page")
-     * @QueryParam(name="orderBy", array=true, requirements="ASC|DESC", nullable=true, strict=true, description="Order by array (key is field, value is direction)")
      * @QueryParam(name="type", nullable=true, description="Message type filter")
      * @QueryParam(name="state", requirements="\d+", strict=true, nullable=true, description="Message status filter")
      *
@@ -76,6 +76,20 @@ public function __construct(MessageManagerInterface $messageManager, FormFactory
      */
     public function getMessagesAction(ParamFetcherInterface $paramFetcher)
     {
+        $orderByQueryParam = new QueryParam();
+        $orderByQueryParam->name = 'orderBy';
+        $orderByQueryParam->requirements = 'ASC|DESC';
+        $orderByQueryParam->nullable = true;
+        $orderByQueryParam->strict = true;
+        $orderByQueryParam->description = 'Query groups order by clause (key is field, value is direction)';
+        if (property_exists($orderByQueryParam, 'map')) {
+            $orderByQueryParam->map = true;
+        } else {
+            $orderByQueryParam->array = true;
+        }
+
+        $paramFetcher->addParam($orderByQueryParam);
+
         $supportedCriteria = array(
             'state' => '',
             'type' => '',
@@ -135,10 +149,22 @@ public function postMessageAction(Request $request)
             $this->messageManager->save($message);
 
             $view = FOSRestView::create($message);
-            $serializationContext = SerializationContext::create();
-            $serializationContext->setGroups(array('sonata_api_read'));
-            $serializationContext->enableMaxDepthChecks();
-            $view->setSerializationContext($serializationContext);
+
+            if (class_exists('FOS\RestBundle\Context\Context')) {
+                $serializationContext = new Context();
+                if (method_exists($serializationContext, 'enableMaxDepth')) {
+                    $serializationContext->enableMaxDepth();
+                } else {
+                    $serializationContext->setMaxDepth(10);
+                }
+                $serializationContext->setGroups(array('sonata_api_read'));
+                $view->setContext($serializationContext);
+            } else {
+                $serializationContext = SerializationContext::create();
+                $serializationContext->enableMaxDepthChecks();
+                $serializationContext->setGroups(array('sonata_api_read'));
+                $view->setSerializationContext($serializationContext);
+            }
 
             return $view;
         }

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -213,13 +213,19 @@ protected function getQueueNode()
 If is set, failed messages will be rejected and sent to this exchange
 EOF;
 
-        $deadLetterRoutingKey = <<<'EOF'
+        $deadLetterRoutingKeyInfo = <<<'EOF'
 Only used by RabbitMQ
 
 If set, failed messages will be routed to the queue using this key by dead-letter-exchange,
 otherwise it will be requeued to the original queue if `dead-letter-exchange` is set.
 
 If set, the queue must be configured with this key as `routing_key`.
+EOF;
+
+        $ttlInfo = <<<'EOF'
+Only used by RabbitMQ
+
+Defines the per-queue message time-to-live (milliseconds)
 EOF;
 
         $typesInfo = <<<'EOF'
@@ -260,7 +266,12 @@ protected function getQueueNode()
                     ->defaultValue(null)
                 ->end()
                 ->scalarNode('dead_letter_routing_key')
-                    ->info($deadLetterRoutingKey)
+                    ->info($deadLetterRoutingKeyInfo)
+                    ->defaultValue(null)
+                ->end()
+                ->integerNode('ttl')
+                    ->info($ttlInfo)
+                    ->min(0)
                     ->defaultValue(null)
                 ->end()
 

diff --git a/DependencyInjection/SonataNotificationExtension.php b/DependencyInjection/SonataNotificationExtension.php
@@ -330,6 +330,7 @@ protected function configureRabbitmq(ContainerBuilder $container, array $config)
                 'recover' => false,
                 'dead_letter_exchange' => null,
                 'dead_letter_routing_key' => null,
+                'ttl' => null,
             ));
         }
 
@@ -375,7 +376,8 @@ protected function configureRabbitmq(ContainerBuilder $container, array $config)
                 $queue['recover'],
                 $queue['routing_key'],
                 $queue['dead_letter_exchange'],
-                $queue['dead_letter_routing_key']
+                $queue['dead_letter_routing_key'],
+                $queue['ttl']
             );
 
             $amqBackends[$pos] = array(
@@ -412,10 +414,11 @@ protected function configureRabbitmq(ContainerBuilder $container, array $config)
      * @param string           $key
      * @param string           $deadLetterExchange
      * @param string           $deadLetterRoutingKey
+     * @param int|null         $ttl
      *
      * @return string
      */
-    protected function createAMQPBackend(ContainerBuilder $container, $exchange, $name, $recover, $key = '', $deadLetterExchange = null, $deadLetterRoutingKey = null)
+    protected function createAMQPBackend(ContainerBuilder $container, $exchange, $name, $recover, $key = '', $deadLetterExchange = null, $deadLetterRoutingKey = null, $ttl = null)
     {
         $id = 'sonata.notification.backend.rabbitmq.'.$this->amqpCounter++;
 
@@ -428,6 +431,7 @@ protected function createAMQPBackend(ContainerBuilder $container, $exchange, $na
                 $key,
                 $deadLetterExchange,
                 $deadLetterRoutingKey,
+                $ttl,
             )
         );
         $definition->setPublic(false);

diff --git a/Tests/Backend/AMQPBackendTest.php b/Tests/Backend/AMQPBackendTest.php
@@ -18,6 +18,7 @@ class AMQPBackendTest extends \PHPUnit_Framework_TestCase
     const KEY = 'message.type.foo';
     const DEAD_LETTER_EXCHANGE = 'dlx';
     const DEAD_LETTER_ROUTING_KEY = 'message.type.dl';
+    const TTL = 60000;
 
     protected function setUp()
     {
@@ -32,27 +33,30 @@ public function testInitializeWithNoDeadLetterExchangeAndNoDeadLetterRoutingKey(
 
         $channelMock->expects($this->once())
             ->method('exchange_declare')
-            ->with($this->equalTo(self::EXCHANGE),
-                   $this->equalTo('direct'),
-                   $this->isType('boolean'),
-                   $this->isType('boolean'),
-                   $this->isType('boolean')
+            ->with(
+                $this->equalTo(self::EXCHANGE),
+                $this->equalTo('direct'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean')
              );
         $channelMock->expects($this->once())
             ->method('queue_declare')
-            ->with($this->equalTo(self::QUEUE),
-                   $this->isType('boolean'),
-                   $this->isType('boolean'),
-                   $this->isType('boolean'),
-                   $this->isType('boolean'),
-                   $this->isType('boolean'),
-                   $this->equalTo(array())
+            ->with(
+                $this->equalTo(self::QUEUE),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->equalTo(array())
              );
         $channelMock->expects($this->once())
             ->method('queue_bind')
-            ->with($this->equalTo(self::QUEUE),
-                   $this->equalTo(self::EXCHANGE),
-                   $this->equalTo(self::KEY)
+            ->with(
+                $this->equalTo(self::QUEUE),
+                $this->equalTo(self::EXCHANGE),
+                $this->equalTo(self::KEY)
              );
 
         $backend->initialize();
@@ -82,15 +86,16 @@ public function testInitializeWithDeadLetterExchangeAndNoDeadLetterRoutingKey()
              );
         $channelMock->expects($this->once())
             ->method('queue_declare')
-            ->with($this->equalTo(self::QUEUE),
-                   $this->isType('boolean'),
-                   $this->isType('boolean'),
-                   $this->isType('boolean'),
-                   $this->isType('boolean'),
-                   $this->isType('boolean'),
-                   $this->equalTo(array(
-                       'x-dead-letter-exchange' => array('S', self::DEAD_LETTER_EXCHANGE),
-                   ))
+            ->with(
+                $this->equalTo(self::QUEUE),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->equalTo(array(
+                    'x-dead-letter-exchange' => array('S', self::DEAD_LETTER_EXCHANGE),
+                ))
              );
         $channelMock->expects($this->exactly(2))
             ->method('queue_bind')
@@ -116,39 +121,87 @@ public function testInitializeWithDeadLetterExchangeAndDeadLetterRoutingKey()
 
         $channelMock->expects($this->once())
             ->method('exchange_declare')
-            ->with($this->equalTo(self::EXCHANGE),
-                   $this->equalTo('direct'),
-                   $this->isType('boolean'),
-                   $this->isType('boolean'),
-                   $this->isType('boolean')
+            ->with(
+                $this->equalTo(self::EXCHANGE),
+                $this->equalTo('direct'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean')
              );
         $channelMock->expects($this->once())
             ->method('queue_declare')
-            ->with($this->equalTo(self::QUEUE),
-                   $this->isType('boolean'),
-                   $this->isType('boolean'),
-                   $this->isType('boolean'),
-                   $this->isType('boolean'),
-                   $this->isType('boolean'),
-                   $this->equalTo(array(
-                       'x-dead-letter-exchange' => array('S', self::DEAD_LETTER_EXCHANGE),
-                       'x-dead-letter-routing-key' => array('S', self::DEAD_LETTER_ROUTING_KEY),
-                   ))
+            ->with(
+                $this->equalTo(self::QUEUE),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->equalTo(array(
+                   'x-dead-letter-exchange' => array('S', self::DEAD_LETTER_EXCHANGE),
+                   'x-dead-letter-routing-key' => array('S', self::DEAD_LETTER_ROUTING_KEY),
+                ))
              );
         $channelMock->expects($this->once())
             ->method('queue_bind')
-            ->with($this->equalTo(self::QUEUE),
-                   $this->equalTo(self::EXCHANGE),
-                   $this->equalTo(self::KEY)
+            ->with(
+                $this->equalTo(self::QUEUE),
+                $this->equalTo(self::EXCHANGE),
+                $this->equalTo(self::KEY)
+             );
+
+        $backend->initialize();
+    }
+
+    public function testInitializeWithTTL()
+    {
+        list($backend, $channelMock) = $this->getBackendAndChannelMock(false, null, null, self::TTL);
+
+        $channelMock->expects($this->once())
+            ->method('exchange_declare')
+            ->with(
+                $this->equalTo(self::EXCHANGE),
+                $this->equalTo('direct'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean')
+             );
+        $channelMock->expects($this->once())
+            ->method('queue_declare')
+            ->with(
+                $this->equalTo(self::QUEUE),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->isType('boolean'),
+                $this->equalTo(array(
+                    'x-message-ttl' => array('I', self::TTL),
+                ))
+             );
+        $channelMock->expects($this->once())
+            ->method('queue_bind')
+            ->with(
+                $this->equalTo(self::QUEUE),
+                $this->equalTo(self::EXCHANGE),
+                $this->equalTo(self::KEY)
              );
 
         $backend->initialize();
     }
 
-    protected function getBackendAndChannelMock($recover = false, $deadLetterExchange = null, $deadLetterRoutingKey = null)
+    protected function getBackendAndChannelMock($recover = false, $deadLetterExchange = null, $deadLetterRoutingKey = null, $ttl = null)
     {
         $mock = $this->getMockBuilder('\Sonata\NotificationBundle\Backend\AMQPBackend')
-            ->setConstructorArgs(array(self::EXCHANGE, self::QUEUE, $recover, self::KEY, $deadLetterExchange, $deadLetterRoutingKey))
+            ->setConstructorArgs(array(
+                self::EXCHANGE,
+                self::QUEUE,
+                $recover,
+                self::KEY,
+                $deadLetterExchange,
+                $deadLetterRoutingKey,
+                $ttl,
+            ))
             ->setMethods(array('getIterator'))
             ->getMock();
 

diff --git a/Tests/Controller/Api/MessageControllerTest.php b/Tests/Controller/Api/MessageControllerTest.php
@@ -27,7 +27,9 @@ public function testGetMessagesAction()
         $messageManager = $this->getMock('Sonata\NotificationBundle\Model\MessageManagerInterface');
         $messageManager->expects($this->once())->method('getPager')->will($this->returnValue(array()));
 
-        $paramFetcher = $this->getMock('FOS\RestBundle\Request\ParamFetcherInterface');
+        $paramFetcher = $this->getMockBuilder('FOS\RestBundle\Request\ParamFetcher')
+            ->disableOriginalConstructor()
+            ->getMock();
         $paramFetcher->expects($this->exactly(3))->method('get');
         $paramFetcher->expects($this->once())->method('all')->will($this->returnValue(array()));
 

diff --git a/composer.json b/composer.json
@@ -46,7 +46,7 @@
         "liip/monitor-bundle": "^2.0",
         "symfony/phpunit-bridge": "^2.7 || ^3.0",
         "swiftmailer/swiftmailer": "^4.3 || ^5.0",
-        "friendsofsymfony/rest-bundle": "^1.1",
+        "friendsofsymfony/rest-bundle": "^1.5 || ^2.1",
         "jms/serializer-bundle": "^0.13 || ^1.0",
         "nelmio/api-doc-bundle": "^2.4",
         "sllh/php-cs-fixer-styleci-bridge": "^2.0"