Merge pull request #177 from steveYeah/master

Add expect_serialized_response option to RCP Client set up

Author: videlalvaro

CHANGELOG

@@ -1,3 +1,6 @@
+- 2014-02-24
+    * Add a parameter to RPC client configuration to disable auto unserialize when adding call results to results array.
+
 - 2013-01-18
     *  adds an an optional parameter for the AMQP Message Properties for the publish method of the Producer, so they can be set as well. For example, seeting the application_headers is now possible.
 

DependencyInjection/Configuration.php

@@ -79,6 +79,7 @@ public function getConfigTreeBuilder()
                     ->prototype('array')
                         ->children()
                             ->scalarNode('connection')->defaultValue('default')->end()
+                            ->booleanNode('expect_serialized_response')->defaultTrue()->end()
                         ->end()
                     ->end()
                 ->end()

DependencyInjection/OldSoundRabbitMqExtension.php

@@ -226,7 +226,7 @@ protected function loadRpcClients()
             $definition = new Definition('%old_sound_rabbit_mq.rpc_client.class%');
             $definition
                 ->addTag('old_sound_rabbit_mq.rpc_client')
-                ->addMethodCall('initClient');
+                ->addMethodCall('initClient', array($client['expect_serialized_response']));
             $this->injectConnection($definition, $client['connection']);
             if ($this->collectorEnabled) {
                 $this->injectLoggedChannel($definition, $key, $client['connection']);

README.md

@@ -407,6 +407,15 @@ The arguments we are sending are the __min__ and __max__ values for the `rand()`
 
 The final piece is to get the reply. Our PHP script will block till the server returns a value. The __$replies__ variable will be an associative array where each reply from the server will contained in the respective __request\_id__ key.
 
+By default the RCP Client expects the response to be serialized. If the server you are working with returns a non-serialized result then set the RPC client expect_serialized_response option to false. For example, if the integer_store server didn't serialize the result the client would be set as below:
+
+```yaml
+rpc_clients:
+    integer_store:
+        connection: default
+        expect_serialized_response: false
+```
+
 You can also set a expiration for request in seconds, after which message will no longer be handled by server and client request will simply time out. Setting expiration for messages works only for RabbitMQ 3.x and above. Visit http://www.rabbitmq.com/ttl.html#per-message-ttl for more information.
 
 ```php

RabbitMq/RpcClient.php

@@ -10,11 +10,13 @@ class RpcClient extends BaseAmqp
     protected $requests = 0;
     protected $replies = array();
     protected $queueName;
+    protected $expectSerializedResponse;
     protected $timeout = 0;
 
-    public function initClient()
+    public function initClient($expectSerializedResponse = true)
     {
         list($this->queueName, ,) = $this->getChannel()->queue_declare("", false, false, true, true);
+        $this->expectSerializedResponse = $expectSerializedResponse;
     }
 
     public function addRequest($msgBody, $server, $requestId = null, $routingKey = '', $expiration = 0)
@@ -32,7 +34,7 @@ public function addRequest($msgBody, $server, $requestId = null, $routingKey = '
         $this->getChannel()->basic_publish($msg, $server, $routingKey);
 
         $this->requests++;
-		
+
         if ($expiration > $this->timeout) {
             $this->timeout = $expiration;
         }
@@ -56,6 +58,11 @@ public function getReplies()
 
     public function processMessage(AMQPMessage $msg)
     {
-        $this->replies[$msg->get('correlation_id')] = unserialize($msg->body);
+        $messageBody = $msg->body;
+        if ($this->expectSerializedResponse) {
+            $messageBody = unserialize($messageBody);
+        }
+
+        $this->replies[$msg->get('correlation_id')] = $messageBody;
     }
 }

Tests/DependencyInjection/OldSoundRabbitMqExtensionTest.php

@@ -338,7 +338,7 @@ 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())),
+            array(array('initClient', array(true))),
             $definition->getMethodCalls()
         );
         $this->assertEquals('%old_sound_rabbit_mq.rpc_client.class%', $definition->getClass());
@@ -353,7 +353,7 @@ 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())),
+            array(array('initClient', array(true))),
             $definition->getMethodCalls()
         );
         $this->assertEquals('%old_sound_rabbit_mq.rpc_client.class%', $definition->getClass());