Merge pull request #238 from igaponov/custom-serializer

Add serialize/unserialize function for rpc

Author: videlalvaro

CHANGELOG

@@ -1,3 +1,6 @@
+- 2015-02-07
+    * Added possibility to set serialize/unserialize function for rpc servers/clients
+
 - 2014-11-27
     * Added interface `OldSound\RabbitMqBundle\Provider\QueuesProviderInterface`
     * Added `queues_provider` configuration for multiple consumer

DependencyInjection/Configuration.php

@@ -185,6 +185,7 @@ protected function addRpcClients(ArrayNodeDefinition $node)
                         ->children()
                             ->scalarNode('connection')->defaultValue('default')->end()
                             ->booleanNode('expect_serialized_response')->defaultTrue()->end()
+                            ->scalarNode('unserializer')->defaultValue('unserialize')->end()
                         ->end()
                     ->end()
                 ->end()
@@ -213,6 +214,7 @@ protected function addRpcServers(ArrayNodeDefinition $node)
                                     ->booleanNode('global')->defaultFalse()->end()
                                 ->end()
                             ->end()
+                            ->scalarNode('serializer')->defaultValue('serialize')->end()
                         ->end()
                     ->end()
                 ->end()

DependencyInjection/OldSoundRabbitMqExtension.php

@@ -312,6 +312,9 @@ protected function loadRpcClients()
             if ($this->collectorEnabled) {
                 $this->injectLoggedChannel($definition, $key, $client['connection']);
             }
+            if (array_key_exists('unserializer', $client)) {
+                $definition->addMethodCall('setUnserializer', array($client['unserializer']));
+            }
 
             $this->container->setDefinition(sprintf('old_sound_rabbit_mq.%s_rpc', $key), $definition);
         }
@@ -340,6 +343,9 @@ protected function loadRpcServers()
             if (array_key_exists('queue_options', $server)) {
                 $definition->addMethodCall('setQueueOptions', array($server['queue_options']));
             }
+            if (array_key_exists('serializer', $server)) {
+                $definition->addMethodCall('setSerializer', array($server['serializer']));
+            }
             $this->container->setDefinition(sprintf('old_sound_rabbit_mq.%s_server', $key), $definition);
         }
     }

README.md

@@ -380,12 +380,14 @@ Let's add a RPC client and server into the configuration:
 rpc_clients:
     integer_store:
         connection: default
+        unserializer: json_decode
 rpc_servers:
     random_int:
         connection: default
         callback:   random_int_server
         qos_options: {prefetch_size: 0, prefetch_count: 1, global: false}
         queue_options: {name: random_int_queue, durable: false, auto_delete: true}
+        serializer: json_encode
 ```
 
 *For a full configuration reference please use the `php app/console config:dump-reference old_sound_rabbit_mq` command.*

RabbitMq/RpcClient.php

@@ -13,6 +13,7 @@ class RpcClient extends BaseAmqp
     protected $timeout = 0;
 
     private $queueName;
+    private $unserializer = 'unserialize';
 
     public function initClient($expectSerializedResponse = true)
     {
@@ -60,7 +61,7 @@ public function processMessage(AMQPMessage $msg)
     {
         $messageBody = $msg->body;
         if ($this->expectSerializedResponse) {
-            $messageBody = unserialize($messageBody);
+            $messageBody = call_user_func($this->unserializer, $messageBody);
         }
 
         $this->replies[$msg->get('correlation_id')] = $messageBody;
@@ -74,4 +75,9 @@ protected function getQueueName()
 
         return $this->queueName;
     }
+
+    public function setUnserializer($unserializer)
+    {
+        $this->unserializer = $unserializer;
+    }
 }

RabbitMq/RpcServer.php

@@ -6,6 +6,8 @@
 
 class RpcServer extends BaseConsumer
 {
+    private $serializer = 'serialize';
+
     public function initServer($name)
     {
         $this->setExchangeOptions(array('name' => $name, 'type' => 'direct'));
@@ -17,7 +19,8 @@ public function processMessage(AMQPMessage $msg)
         try {
             $msg->delivery_info['channel']->basic_ack($msg->delivery_info['delivery_tag']);
             $result = call_user_func($this->callback, $msg);
-            $this->sendReply(serialize($result), $msg->get('reply_to'), $msg->get('correlation_id'));
+            $result = call_user_func($this->serializer, $result);
+            $this->sendReply($result, $msg->get('reply_to'), $msg->get('correlation_id'));
             $this->consumed++;
             $this->maybeStopConsumer();
         } catch (\Exception $e) {
@@ -30,4 +33,9 @@ protected function sendReply($result, $client, $correlationId)
         $reply = new AMQPMessage($result, array('content_type' => 'text/plain', 'correlation_id' => $correlationId));
         $this->getChannel()->basic_publish($reply, '', $client);
     }
+
+    public function setSerializer($serializer)
+    {
+        $this->serializer = $serializer;
+    }
 }

Tests/DependencyInjection/Fixtures/test.yml

@@ -147,13 +147,15 @@ old_sound_rabbit_mq:
     rpc_clients:
         foo_client:
             connection:      foo_connection
+            unserializer:    json_decode
 
         default_client:
 
     rpc_servers:
         foo_server:
             connection:      foo_connection
             callback:        foo_server.callback
+            serializer:      json_encode
 
         default_server:
             callback:        default_server.callback

Tests/DependencyInjection/OldSoundRabbitMqExtensionTest.php

@@ -473,7 +473,10 @@ public function testFooRpcClientDefinition()
         $this->assertEquals((string) $definition->getArgument(0), 'old_sound_rabbit_mq.connection.foo_connection');
         $this->assertEquals((string) $definition->getArgument(1), 'old_sound_rabbit_mq.channel.foo_client');
         $this->assertEquals(
-            array(array('initClient', array(true))),
+            array(
+                array('initClient', array(true)),
+                array('setUnserializer', array('json_decode'))
+            ),
             $definition->getMethodCalls()
         );
         $this->assertEquals('%old_sound_rabbit_mq.rpc_client.class%', $definition->getClass());
@@ -488,7 +491,10 @@ public function testDefaultRpcClientDefinition()
         $this->assertEquals((string) $definition->getArgument(0), 'old_sound_rabbit_mq.connection.default');
         $this->assertEquals((string) $definition->getArgument(1), 'old_sound_rabbit_mq.channel.default_client');
         $this->assertEquals(
-            array(array('initClient', array(true))),
+            array(
+                array('initClient', array(true)),
+                array('setUnserializer', array('unserialize'))
+            ),
             $definition->getMethodCalls()
         );
         $this->assertEquals('%old_sound_rabbit_mq.rpc_client.class%', $definition->getClass());
@@ -505,6 +511,7 @@ public function testFooRpcServerDefinition()
         $this->assertEquals(array(
                 array('initServer', array('foo_server')),
                 array('setCallback', array(array(new Reference('foo_server.callback'), 'execute'))),
+                array('setSerializer', array('json_encode')),
             ),
             $definition->getMethodCalls()
         );
@@ -522,6 +529,7 @@ public function testDefaultRpcServerDefinition()
         $this->assertEquals(array(
                 array('initServer', array('default_server')),
                 array('setCallback', array(array(new Reference('default_server.callback'), 'execute'))),
+                array('setSerializer', array('serialize')),
             ),
             $definition->getMethodCalls()
         );
@@ -550,6 +558,7 @@ public function testRpcServerWithQueueOptionsDefinition()
                     'ticket'       => null,
                     'routing_keys' => array(),
                 ))),
+                array('setSerializer', array('serialize')),
             ),
             $definition->getMethodCalls()
         );

Tests/RabbitMq/RpcClientTest.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace OldSound\RabbitMqBundle\Tests\RabbitMq;
+
+use OldSound\RabbitMqBundle\RabbitMq\RpcClient;
+
+class RpcClientTest extends \PHPUnit_Framework_TestCase
+{
+    public function testProcessMessageWithCustomUnserializer()
+    {
+        /** @var RpcClient $client */
+        $client = $this->getMockBuilder('\OldSound\RabbitMqBundle\RabbitMq\RpcClient')
+            ->setMethods(array('sendReply', 'maybeStopConsumer'))
+            ->disableOriginalConstructor()
+            ->getMock();
+        $message = $this->getMock('\PhpAmqpLib\Message\AMQPMessage', array('get'), array('message'));
+        $serializer = $this->getMock('\Symfony\Component\Serializer\SerializerInterface', array('serialize', 'deserialize'));
+        $serializer->expects($this->once())->method('deserialize')->with('message', 'json', null);
+        $client->initClient(true);
+        $client->setUnserializer(function($data) use ($serializer) {
+            $serializer->deserialize($data, 'json', null);
+        });
+        $client->processMessage($message);
+    }
+}

Tests/RabbitMq/RpcServerTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace OldSound\RabbitMqBundle\Tests\RabbitMq;
+
+use OldSound\RabbitMqBundle\RabbitMq\RpcServer;
+use PhpAmqpLib\Message\AMQPMessage;
+
+class RpcServerTest extends \PHPUnit_Framework_TestCase
+{
+    public function testProcessMessageWithCustomSerializer()
+    {
+        /** @var RpcServer $server */
+        $server = $this->getMockBuilder('\OldSound\RabbitMqBundle\RabbitMq\RpcServer')
+            ->setMethods(array('sendReply', 'maybeStopConsumer'))
+            ->disableOriginalConstructor()
+            ->getMock();
+        $message = $this->getMock('\PhpAmqpLib\Message\AMQPMessage', array('get'));
+        $message->delivery_info = array(
+            'channel' => $this->getMock('\PhpAmqpLib\Channel\AMQPChannel', array(), array(), '', false),
+            'delivery_tag' => null
+        );
+        $server->setCallback(function() {
+            return 'message';
+        });
+        $serializer = $this->getMock('\Symfony\Component\Serializer\SerializerInterface', array('serialize', 'deserialize'));
+        $serializer->expects($this->once())->method('serialize')->with('message', 'json');
+        $server->setSerializer(function($data) use ($serializer) {
+            $serializer->serialize($data, 'json');
+        });
+        $server->processMessage($message);
+    }
+}