FCM: Mark invalid FCM tokens as invalid endpoints

Reviewed at https://reviews.lunr.nl/r/1165/
lunr-php · Jun 10, 2024 · 74ec724 · 74ec724
1 parent 1acf4ae
commit 74ec724
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 9 deletions.
diff --git a/src/Lunr/Vortex/FCM/FCMBatchResponse.php b/src/Lunr/Vortex/FCM/FCMBatchResponse.php
@@ -169,8 +169,15 @@ private function report_endpoint_error(string $endpoint, Response $response): vo
         switch ($response->status_code)
         {
             case 400:
-                $status          = PushNotificationStatus::Error;
-                $error_message ??= 'Invalid parameter';
+                if ($error_message == 'The registration token is not a valid FCM registration token')
+                {
+                    $status = PushNotificationStatus::InvalidEndpoint;
+                }
+                else
+                {
+                    $status          = PushNotificationStatus::Error;
+                    $error_message ??= 'Invalid argument';
+                }
                 break;
             case 401:
                 $status          = PushNotificationStatus::Error;

diff --git a/src/Lunr/Vortex/FCM/Tests/FCMBatchResponseBasePushTest.php b/src/Lunr/Vortex/FCM/Tests/FCMBatchResponseBasePushTest.php
@@ -75,7 +75,7 @@ public function testPushSuccessWithPreconditionFailWithSingle(): void
 
         $context = [
             'endpoint' => 'endpoint1',
-            'error'    => 'Invalid parameter',
+            'error'    => 'Invalid argument',
         ];
 
         $this->logger->expects($this->once())
@@ -107,7 +107,7 @@ public function testPushSuccessWithPreconditionFailWithMultiple(): void
 
         $context = [
             'endpoint' => 'endpoint1',
-            'error'    => 'Invalid parameter',
+            'error'    => 'Invalid argument',
         ];
 
         $context1 = [ 'endpoint' => 'endpoint2' ] + $context;
@@ -583,6 +583,39 @@ public function testPushErrorBadRequestError(): void
 
         parent::baseSetUp($this->class);
 
+        $this->assertPropertySame('logger', $this->logger);
+        $this->assertPropertySame('endpoints', $endpoints);
+        $this->assertPropertyEquals('statuses', [ 'endpoint1' => PushNotificationStatus::InvalidEndpoint ]);
+        $this->assertPropertySame('responses', $responses);
+    }
+
+    /**
+     * Test constructor behavior for error of push notification in case of bad request error.
+     *
+     * @covers Lunr\Vortex\FCM\FCMBatchResponse::__construct
+     */
+    public function testPushErrorGenericBadRequestError(): void
+    {
+        $http_code = 400;
+        $content   = file_get_contents(TEST_STATICS . '/Vortex/fcm/response_generic_error.json');
+        $endpoints = [ 'endpoint1' ];
+
+        $this->response->status_code = $http_code;
+        $this->response->body        = $content;
+
+        $responses = [ 'endpoint1' => $this->response ];
+
+        $this->logger->expects($this->once())
+                     ->method('warning')
+                     ->with(
+                         'Dispatching FCM notification failed for endpoint {endpoint}: {error}',
+                         [ 'endpoint' => 'endpoint1', 'error' => 'Invalid Argument' ]
+                     );
+
+        $this->class = new FCMBatchResponse($responses, $this->logger, $endpoints);
+
+        parent::baseSetUp($this->class);
+
         $this->assertPropertySame('logger', $this->logger);
         $this->assertPropertySame('endpoints', $endpoints);
         $this->assertPropertyEquals('statuses', [ 'endpoint1' => PushNotificationStatus::Error ]);
@@ -598,7 +631,7 @@ public function errorDataProvider(): array
     {
         $data = [];
 
-        $data[] = [ 'Invalid parameter', 400, PushNotificationStatus::Error ];
+        $data[] = [ 'Invalid argument', 400, PushNotificationStatus::Error ];
         $data[] = [ 'Error with authentication', 401, PushNotificationStatus::Error ];
         $data[] = [ 'Mismatched sender', 403, PushNotificationStatus::InvalidEndpoint ];
         $data[] = [ 'Unregistered or missing token', 404, PushNotificationStatus::InvalidEndpoint ];

diff --git a/src/Lunr/Vortex/FCM/Tests/FCMDispatcherPushTest.php b/src/Lunr/Vortex/FCM/Tests/FCMDispatcherPushTest.php
@@ -152,7 +152,7 @@ public function testPushWhenProjectIdIsNullSingleEndpoint(): void
                         [ 'Tried to push FCM notification but project id is not provided.' ],
                         [
                             'Dispatching FCM notification failed for endpoint {endpoint}: {error}',
-                            [ 'endpoint' => 'endpoint', 'error' => 'Invalid parameter' ]
+                            [ 'endpoint' => 'endpoint', 'error' => 'Invalid argument' ]
                         ]
                     );
 
@@ -179,15 +179,15 @@ public function testPushWhenProjectIdIsNullMultipleEndpoints(): void
                         [ 'Tried to push FCM notification but project id is not provided.' ],
                         [
                             'Dispatching FCM notification failed for endpoint {endpoint}: {error}',
-                            [ 'endpoint' => 'endpoint', 'error' => 'Invalid parameter' ]
+                            [ 'endpoint' => 'endpoint', 'error' => 'Invalid argument' ]
                         ],
                         [
                             'Dispatching FCM notification failed for endpoint {endpoint}: {error}',
-                            [ 'endpoint' => 'endpoint1', 'error' => 'Invalid parameter' ]
+                            [ 'endpoint' => 'endpoint1', 'error' => 'Invalid argument' ]
                         ],
                         [
                             'Dispatching FCM notification failed for endpoint {endpoint}: {error}',
-                            [ 'endpoint' => 'endpoint2', 'error' => 'Invalid parameter' ]
+                            [ 'endpoint' => 'endpoint2', 'error' => 'Invalid argument' ]
                         ],
                     );
 

diff --git a/tests/statics/Vortex/fcm/response_generic_error.json b/tests/statics/Vortex/fcm/response_generic_error.json
@@ -0,0 +1,14 @@
+{
+    "error": {
+        "code": 400,
+        "message": "Invalid Argument",
+        "status": "INVALID_ARGUMENT",
+        "details": [
+            {
+                "@type": "type.googleapis.com/google.firebase.fcm.v1.FcmError",
+                "errorCode": "INVALID_ARGUMENT"
+            }
+        ]
+    }
+}
+