adding backward compatibility support

Author: ahmedkhan847

pkg/gps/GpsConnectionFactory.php

@@ -80,7 +80,9 @@ public function createContext(): Context
             });
         }
 
-        return new GpsContext($this->establishConnection());
+        return new GpsContext($this->establishConnection(), [
+            'serilalizeToJson' => $this->config['serilalizeToJson'],
+        ]);
     }
 
     private function parseDsn(string $dsn): array
@@ -105,6 +107,7 @@ private function parseDsn(string $dsn): array
             'emulatorHost' => $emulatorHost,
             'hasEmulator' => $hasEmulator,
             'lazy' => $dsn->getBool('lazy'),
+            'serilalizeToJson' => $dsn->getBool('serilalizeToJson'),
         ]), function ($value) { return null !== $value; });
     }
 
@@ -121,6 +124,7 @@ private function defaultConfig(): array
     {
         return [
             'lazy' => true,
+            'serilalizeToJson' => true
         ];
     }
 }

pkg/gps/GpsConsumer.php

@@ -110,7 +110,14 @@ private function getSubscription(): Subscription
 
     private function convertMessage(GoogleMessage $message): GpsMessage
     {
-        $gpsMessage = new GpsMessage($message->data(), $message->attributes(),[]);
+        $options = $this->context->getOptions();
+
+        if ($options['serilalizeToJson']) {
+            $gpsMessage = GpsMessage::jsonUnserialize($message->data());
+        } else {
+            $gpsMessage = new GpsMessage($message->data(), $message->attributes());
+        }
+
         $gpsMessage->setNativeMessage($message);
 
         return $gpsMessage;

pkg/gps/GpsContext.php

@@ -160,4 +160,9 @@ public function getClient(): PubSubClient
 
         return $this->client;
     }
+
+    public function getOptions(): array
+    {
+        return $this->options;
+    }
 }

pkg/gps/Tests/GpsConnectionFactoryConfigTest.php

@@ -58,20 +58,23 @@ public static function provideConfigs()
             null,
             [
                 'lazy' => true,
+                'serilalizeToJson' => true,
             ],
         ];
 
         yield [
             'gps:',
             [
                 'lazy' => true,
+                'serilalizeToJson' => true,
             ],
         ];
 
         yield [
             [],
             [
                 'lazy' => true,
+                'serilalizeToJson' => true,
             ],
         ];
 
@@ -83,6 +86,7 @@ public static function provideConfigs()
                 'emulatorHost' => 'http://google-pubsub:8085',
                 'hasEmulator' => true,
                 'lazy' => true,
+                'serilalizeToJson' => true,
             ],
         ];
 
@@ -94,6 +98,7 @@ public static function provideConfigs()
                 'emulatorHost' => 'http://google-pubsub:8085',
                 'hasEmulator' => true,
                 'lazy' => true,
+                'serilalizeToJson' => true,
             ],
         ];
 
@@ -104,6 +109,19 @@ public static function provideConfigs()
                 'projectId' => 'mqdev',
                 'emulatorHost' => 'http://Fgoogle-pubsub:8085',
                 'lazy' => false,
+                'serilalizeToJson' => true,
+            ],
+        ];
+
+        yield [
+            ['dsn' => 'gps:?foo=fooVal&projectId=mqdev&emulatorHost=http%3A%2F%2Fgoogle-pubsub%3A8085&serilalizeToJson=false'],
+            [
+                'foo' => 'fooVal',
+                'projectId' => 'mqdev',
+                'emulatorHost' => 'http://google-pubsub:8085',
+                'hasEmulator' => true,
+                'lazy' => true,
+                'serilalizeToJson' => false,
             ],
         ];
     }

pkg/gps/Tests/GpsConsumerTest.php

@@ -179,16 +179,11 @@ public function testShouldReceiveMessage()
         $this->assertSame('the body', $message->getBody());
     }
 
-    public function testShouldReceiveMessageProtobufFormat()
+    public function testShouldReceiveMessageUnSerialize()
     {
-        $body = '2test+customer_6115118118117248@example.com"4test+customer_611511118118117248@example.com*&App\Tests\Entity\Entity497709';
-        $attributes = [
-            'ce-datacontenttype' => 'application/protobuf',
-        ];
-        
+        $message = new GpsMessage('the body');
         $nativeMessage = new Message([
-            'data' => $body,
-            'attributes' => $attributes,
+            'data' => json_encode($message),
         ], []);
 
         $subscription = $this->createSubscriptionMock();
@@ -212,14 +207,64 @@ public function testShouldReceiveMessageProtobufFormat()
             ->expects($this->once())
             ->method('getClient')
             ->willReturn($client);
+        $context
+            ->expects($this->once())
+            ->method('getOptions')
+            ->willReturn(['serilalizeToJson' => false]);
+
+        $consumer = new GpsConsumer($context, new GpsQueue('queue-name'));
+
+        $message = $consumer->receive(12345);
+
+        $this->assertInstanceOf(GpsMessage::class, $message);
+        $this->assertSame($nativeMessage->data(), $message->getBody());
+        $this->assertSame($nativeMessage->attributes(), $message->getProperties());
+    }
+
+    public function testShouldReceiveMessageUnSerializeWithAttributes()
+    {
+        $message = new GpsMessage('the body');
+        $nativeMessage = new Message([
+            'data' => json_encode($message),
+            'attributes' => [
+                'foo' => 'fooVal',
+                'bar' => 'barVal',
+            ],
+        ], []);
+
+        $subscription = $this->createSubscriptionMock();
+        $subscription
+            ->expects($this->once())
+            ->method('pull')
+            ->with($this->identicalTo([
+                'maxMessages' => 1,
+                'requestTimeout' => 12.345,
+            ]))
+            ->willReturn([$nativeMessage]);
+
+        $client = $this->createPubSubClientMock();
+        $client
+            ->expects($this->once())
+            ->method('subscription')
+            ->willReturn($subscription);
+
+        $context = $this->createContextMock();
+        $context
+            ->expects($this->once())
+            ->method('getClient')
+            ->willReturn($client);
+        $context
+            ->expects($this->once())
+            ->method('getOptions')
+            ->willReturn(['serilalizeToJson' => false]);
 
         $consumer = new GpsConsumer($context, new GpsQueue('queue-name'));
 
         $message = $consumer->receive(12345);
 
         $this->assertInstanceOf(GpsMessage::class, $message);
-        $this->assertSame($body, $message->getBody());
-        $this->assertSame($attributes, $message->getProperties());
+        $this->assertSame($nativeMessage->data(), $message->getBody());
+        $this->assertSame($nativeMessage->attributes(), $message->getProperties());
     }
 
     /**

pkg/gps/Tests/GpsContextTest.php

@@ -86,6 +86,13 @@ public function testCreateConsumerShouldThrowExceptionIfInvalidDestination()
         $context->createConsumer(new GpsTopic(''));
     }
 
+    public function testShouldReturnOptions()
+    {
+        $context = new GpsContext($this->createPubSubClientMock(), ['foo' => 'fooVal']);
+
+        $this->assertSame(['ackDeadlineSeconds' => 10, 'foo' => 'fooVal'], $context->getOptions());
+    }
+
     /**
      * @return PubSubClient|\PHPUnit\Framework\MockObject\MockObject|PubSubClient
      */