Merge pull request #42 from ds762/apns-collapse-id

add apns-collapse-id for Apple devices
mcfedr · Aug 17, 2022 · 58b631e · 58b631e
2 parents b56d558 + b08823a
commit 58b631e
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 4 deletions.
diff --git a/src/Mcfedr/AwsPushBundle/Message/Message.php b/src/Mcfedr/AwsPushBundle/Message/Message.php
@@ -264,7 +264,8 @@ class Message implements \JsonSerializable
     private $gcmData;
 
     /**
-     * GCM, FCM and ADM only.
+     * The collapseKey will be sent for GCM, FCM and ADM
+     * and if set, apns-collapse-id is sent for APNS.
      *
      * @var string
      */

diff --git a/src/Mcfedr/AwsPushBundle/Service/Messages.php b/src/Mcfedr/AwsPushBundle/Service/Messages.php
@@ -85,14 +85,20 @@ public function send($message, string $endpointArn): void
             $message->setPlatforms($this->platforms);
         }
 
+        $messageAttributes = [
+            'AWS.SNS.MOBILE.APNS.PUSH_TYPE' => ['DataType' => 'String', 'StringValue' => $message->getPushType()],
+        ];
+
+        if ($message->getCollapseKey() != Message::NO_COLLAPSE) {
+            $messageAttributes['AWS.SNS.MOBILE.APNS.COLLAPSE_ID'] = ['DataType' => 'String', 'StringValue' => $message->getCollapseKey()];
+        }
+
         $this->sns->publish(
             [
                 'TargetArn' => $endpointArn,
                 'Message' => json_encode($message, JSON_UNESCAPED_UNICODE),
                 'MessageStructure' => 'json',
-                'MessageAttributes' => [
-                    'AWS.SNS.MOBILE.APNS.PUSH_TYPE' => ['DataType' => 'String', 'StringValue' => $message->getPushType()],
-                ],
+                'MessageAttributes' => $messageAttributes,
             ]
         );
     }

diff --git a/tests/Mcfedr/AwsPushBundle/Tests/Service/MessagesTest.php b/tests/Mcfedr/AwsPushBundle/Tests/Service/MessagesTest.php
@@ -48,6 +48,10 @@ public function testSend()
             ->method('jsonSerialize')
             ->willReturn('data');
 
+        $message->expects($this->once())
+            ->method('getCollapseKey')
+            ->willReturn(Message::NO_COLLAPSE);
+
         $message->expects($this->once())
             ->method('getPushType')
             ->willReturn(Message::PUSH_TYPE_ALERT);
@@ -83,6 +87,10 @@ public function testSendPlatforms()
             ->method('isPlatformsCustomized')
             ->willReturn(false);
 
+        $message->expects($this->once())
+            ->method('getCollapseKey')
+            ->willReturn(Message::NO_COLLAPSE);
+
         $message->expects($this->once())
             ->method('getPushType')
             ->willReturn(Message::PUSH_TYPE_ALERT);
@@ -122,6 +130,10 @@ public function testSendPlatformsCustomized()
             ->method('isPlatformsCustomized')
             ->willReturn(true);
 
+        $message->expects($this->once())
+            ->method('getCollapseKey')
+            ->willReturn(Message::NO_COLLAPSE);
+
         $message->expects($this->once())
             ->method('getPushType')
             ->willReturn(Message::PUSH_TYPE_ALERT);
@@ -156,10 +168,53 @@ public function testSendBackground()
             ->method('jsonSerialize')
             ->willReturn('data');
 
+        $message->expects($this->once())
+            ->method('getCollapseKey')
+            ->willReturn(Message::NO_COLLAPSE);
+
         $message->expects($this->once())
             ->method('getPushType')
             ->willReturn(Message::PUSH_TYPE_BACKGROUND);
 
         $messages->send($message, 'arn');
     }
+
+    public function testSendWithCollapseKey()
+    {
+        $messages = new Messages($this->client, []);
+
+        $collapseKey = uniqid();
+
+        $this->client
+            ->expects($this->once())
+            ->method('publish')
+            ->with([
+                'TargetArn' => 'arn',
+                'Message' => '"data"',
+                'MessageStructure' => 'json',
+                'MessageAttributes' => [
+                    'AWS.SNS.MOBILE.APNS.PUSH_TYPE' => ['DataType' => 'String', 'StringValue' => 'alert'],
+                    'AWS.SNS.MOBILE.APNS.COLLAPSE_ID' => ['DataType' => 'String', 'StringValue' => $collapseKey],
+                ],
+            ]);
+
+        $message = $this->getMockBuilder(Message::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $message->expects($this->any())
+            ->method('getCollapseKey')
+            ->willReturn($collapseKey);
+
+        $message->expects($this->once())
+            ->method('jsonSerialize')
+            ->willReturn('data');
+
+        $message->expects($this->once())
+            ->method('getPushType')
+            ->willReturn('alert');
+
+        $messages->send($message, 'arn');
+    }
+
 }