fix: use hex formatted ChannelID strings for bridged connections (#709)

closes #708
mozilla-services · Oct 14, 2016 · 8aa1a7e · 8aa1a7e
1 parent e564a97
commit 8aa1a7e
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 4 deletions.
diff --git a/autopush/router/apnsrouter.py b/autopush/router/apnsrouter.py
@@ -109,8 +109,10 @@ def _route(self, notification, router_data):
         rel_channel = router_data["rel_channel"]
         config = self._config[rel_channel]
         apns_client = self.apns[rel_channel]
+        # chid MUST MATCH THE CHANNELID GENERATED BY THE REGISTRATION SERVICE
+        # Currently this value is in hex form.
         payload = {
-            "chid": str(notification.channel_id),
+            "chid": notification.channel_id.hex,
             "ver": notification.version,
         }
         if notification.data:

diff --git a/autopush/router/fcm.py b/autopush/router/fcm.py
@@ -151,7 +151,9 @@ def route_notification(self, notification, uaid_data):
 
     def _route(self, notification, router_data):
         """Blocking FCM call to route the notification"""
-        data = {"chid": str(notification.channel_id)}
+        # THIS MUST MATCH THE CHANNELID GENERATED BY THE REGISTRATION SERVICE
+        # Currently this value is in hex form.
+        data = {"chid": notification.channel_id.hex}
         if not router_data.get("token"):
             raise self._error("No registration token found. "
                               "Rejecting message.",

diff --git a/autopush/router/gcm.py b/autopush/router/gcm.py
@@ -75,7 +75,9 @@ def route_notification(self, notification, uaid_data):
     def _route(self, notification, uaid_data):
         """Blocking GCM call to route the notification"""
         router_data = uaid_data["router_data"]
-        data = {"chid": str(notification.channel_id)}
+        # THIS MUST MATCH THE CHANNELID GENERATED BY THE REGISTRATION SERVICE
+        # Currently this value is in hex form.
+        data = {"chid": notification.channel_id.hex}
         # Payload data is optional. The endpoint handler validates that the
         # correct encryption headers are included with the data.
         if notification.data:

diff --git a/autopush/tests/test_router.py b/autopush/tests/test_router.py
@@ -65,7 +65,9 @@ def init(self, settings, router_conf):
         assert_raises(NotImplementedError, ir.amend_msg, {})
 
 
-dummy_chid = str(uuid.uuid4())
+# FOR LEGACY REASONS, CHANNELID MUST BE IN HEX FORMAT FOR BRIDGE PUBLICATION
+# AND REGISTRATION
+dummy_chid = uuid.uuid4().hex
 dummy_uaid = str(uuid.uuid4())
 
 

diff --git a/autopush/web/registration.py b/autopush/web/registration.py
@@ -139,6 +139,8 @@ def post(self, *args, **kwargs):
         params = self.valid_input['params']
         # If the client didn't provide a CHID, make one up.
         # Note, valid_input may explicitly set "chid" to None
+        # THIS VALUE MUST MATCH WHAT'S SPECIFIED IN THE BRIDGE CONNECTIONS.
+        # currently hex formatted.
         self.chid = params["channelID"] = (self.valid_input["chid"] or
                                            uuid.uuid4().hex)
         self.ap_settings.metrics.increment("updates.client.register",