When sending a gcm notification, if the server responds with error

NotRegistered or InvalidRegistration set active=0 for the device
instead of raising a NotificationError.  The Notification error
will be raised for all other errors returned.

Author: jamaalscarlett

push_notifications/gcm.py

@@ -6,6 +6,8 @@
 """
 
 import json
+from .models import GCMDevice
+
 
 try:
 	from urllib.request import Request, urlopen
@@ -23,6 +25,8 @@
 class GCMError(NotificationError):
 	pass
 
+device_errors = ["NotRegistered", "InvalidRegistration"]
+
 
 def _chunks(l, n):
 	"""
@@ -71,6 +75,11 @@ def _gcm_send_plain(registration_id, data, **kwargs):
 
 	result = _gcm_send(data, "application/x-www-form-urlencoded;charset=UTF-8")
 	if result.startswith("Error="):
+		for error in device_errors:
+			if error in result:
+				device = GCMDevice.objects.filter(registration_id=values["registration_id"])
+				device.update(active=0)
+				return result
 		raise GCMError(result)
 	return result
 
@@ -95,7 +104,18 @@ def _gcm_send_json(registration_ids, data, **kwargs):
 
 	result = json.loads(_gcm_send(data, "application/json"))
 	if result["failure"]:
-		raise GCMError(result)
+		ids_to_remove = []
+		throw_error = 0
+		for index, er in enumerate(result["results"]):
+			if er.get("error", "none") in device_errors:
+				ids_to_remove.append(values["registration_ids"][index])
+			elif er.get("error", "none") is not "none":
+				throw_error = 1
+		if ids_to_remove:
+			removed = GCMDevice.objects.filter(registration_id__in=ids_to_remove)
+			removed.update(active=0)
+		if throw_error:
+			raise GCMError(result)
 	return result
 
 

tests/mock_responses.py

@@ -1,3 +1,6 @@
 GCM_PLAIN_RESPONSE = 'id=1:08'
 GCM_JSON_RESPONSE = '{"multicast_id":108,"success":1,"failure":0,"canonical_ids":0,"results":[{"message_id":"1:08"}]}'
 GCM_MULTIPLE_JSON_RESPONSE = '{"multicast_id":108,"success":2,"failure":0,"canonical_ids":0,"results":[{"message_id":"1:08"}, {"message_id": "1:09"}]}'
+GCM_PLAIN_RESPONSE_ERROR = ['Error=NotRegistered', 'Error=InvalidRegistration']
+GCM_PLAIN_RESPONSE_ERROR_B = 'Error=MismatchSenderId'
+GCM_JSON_RESPONSE_ERROR = '{"failure": 3, "canonical_ids": 0, "cast_id": 6358665107659088804, "results": [{"error": "NotRegistered"}, {"message_id": "0:1433830664381654%3449593ff9fd7ecd"}, {"error": "InvalidRegistration"}]}'

tests/test_models.py

@@ -3,8 +3,10 @@
 from django.test import TestCase
 from django.utils import timezone
 from push_notifications.models import GCMDevice, APNSDevice
-from tests.mock_responses import GCM_PLAIN_RESPONSE, GCM_MULTIPLE_JSON_RESPONSE
-
+from tests.mock_responses import GCM_PLAIN_RESPONSE, \
+    GCM_MULTIPLE_JSON_RESPONSE, GCM_PLAIN_RESPONSE_ERROR, \
+    GCM_JSON_RESPONSE_ERROR, GCM_PLAIN_RESPONSE_ERROR_B
+from push_notifications.gcm import GCMError
 
 class ModelTestCase(TestCase):
     def test_can_save_gcm_device(self):
@@ -105,6 +107,46 @@ def test_gcm_send_message_collapse_to_multiple_devices(self):
                     "registration_ids": ["abc", "abc1"]
                 }, separators=(",", ":"), sort_keys=True).encode("utf-8"), "application/json")
 
+    def test_gcm_send_message_to_single_device_with_error(self):
+        # these errors are device specific, device.active will be set false
+        device_list = ['abc', 'abc1']
+        self.create_devices(device_list)
+        for index, error in enumerate(GCM_PLAIN_RESPONSE_ERROR):
+            with mock.patch("push_notifications.gcm._gcm_send",
+                            return_value=error) as p:
+                device = GCMDevice.objects. \
+                    get(registration_id=device_list[index])
+                device.send_message("Hello World!")
+                assert GCMDevice.objects.get(registration_id=device_list[index]) \
+                           .active is False
+
+    def test_gcm_send_message_to_single_device_with_error_b(self):
+        # these errors are not device specific, GCMError should be thrown
+        device_list = ['abc']
+        self.create_devices(device_list)
+        with mock.patch("push_notifications.gcm._gcm_send",
+                        return_value=GCM_PLAIN_RESPONSE_ERROR_B) as p:
+            device = GCMDevice.objects. \
+                get(registration_id=device_list[0])
+            with self.assertRaises(GCMError):
+                device.send_message("Hello World!")
+            assert GCMDevice.objects.get(registration_id=device_list[0]) \
+                            .active is True
+
+    def test_gcm_send_message_to_multiple_devices_with_error(self):
+        device_list = ['abc', 'abc1', 'abc2']
+        self.create_devices(device_list)
+        with mock.patch("push_notifications.gcm._gcm_send",
+                        return_value=GCM_JSON_RESPONSE_ERROR) as p:
+            devices = GCMDevice.objects.all()
+            devices.send_message("Hello World")
+            assert GCMDevice.objects.get(registration_id=device_list[0]) \
+                       .active is False
+            assert GCMDevice.objects.get(registration_id=device_list[1]) \
+                       .active is True
+            assert GCMDevice.objects.get(registration_id=device_list[2]) \
+                       .active is False
+
     def test_apns_send_message(self):
         device = APNSDevice.objects.create(
             registration_id="abc",
@@ -122,3 +164,9 @@ def test_apns_send_message_extra(self):
         with mock.patch("push_notifications.apns._apns_pack_frame") as p:
             device.send_message("Hello world", extra={"foo": "bar"}, socket=socket, identifier=1, expiration=2, priority=5)
             p.assert_called_once_with("abc", b'{"aps":{"alert":"Hello world"},"foo":"bar"}', 1, 2, 5)
+
+    def create_devices(self, devices):
+        for device in devices:
+            GCMDevice.objects.create(
+                registration_id=device,
+            )