Add send_badge_counts option for GCM pushkin (#421)

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

Author: jmartinesp

changelog.d/421.feature

@@ -0,0 +1 @@
+Add `send_badge_counts` option for FCM/GCM pushkin.

sygnal.yaml.sample

@@ -212,6 +212,15 @@ apps:
   #  project_id: project-id
   #  service_account_file: /path/to/service_account.json
   #
+  #  # This enables sending the unread message, notification and missed call
+  #  # counts in the push notification data. While this value is useful for non-
+  #  # encrypted contexts, when the user is part of encrypted rooms these
+  #  # count values won't be accurate due to the homeserver being unable
+  #  # to decrypt user and keyword mentions. So there's no point in sending them.
+  #  # If the associated app supports encryption then this should probably be
+  #  # false. Defaults to true.
+  #  #send_badge_counts: false
+  #
   #  # This is the maximum number of connections to GCM servers at any one time
   #  # the default is 20.
   #  #max_connections: 20

sygnal/gcmpushkin.py

@@ -126,6 +126,7 @@ class GcmPushkin(ConcurrencyLimitedPushkin):
         "max_connections",
         "project_id",
         "service_account_file",
+        "send_badge_counts",
     } | ConcurrencyLimitedPushkin.UNDERSTOOD_CONFIG_FIELDS
 
     def __init__(self, name: str, sygnal: "Sygnal", config: Dict[str, Any]) -> None:
@@ -538,7 +539,10 @@ async def _dispatch_notification_unlimited(
             # TODO: Implement collapse_key to queue only one message per room.
             failed: List[str] = []
 
-            data = GcmPushkin._build_data(n, device, self.api_version)
+            send_badge_counts = self.get_config("send_badge_counts", bool, True)
+            data = GcmPushkin._build_data(
+                n, device, self.api_version, send_badge_counts
+            )
 
             # Reject pushkey(s) if default_payload is misconfigured
             if data is None:
@@ -651,13 +655,16 @@ def _build_data(
         n: Notification,
         device: Device,
         api_version: APIVersion,
+        send_badge_counts: bool,
     ) -> Optional[Dict[str, Any]]:
         """
         Build the payload data to be sent.
         Args:
             n: Notification to build the payload for.
             device: Device information to which the constructed payload
             will be sent.
+            api_version: API version used by Firebase/GCM.
+            send_badge_counts: If set to `True`, will send the unread and missed_call counts.
 
         Returns:
             JSON-compatible dict or None if the default_payload is misconfigured
@@ -714,13 +721,15 @@ def _build_data(
         if n.prio == "low":
             data["prio"] = "normal"
 
-        if getattr(n, "counts", None):
+        if send_badge_counts and getattr(n, "counts", None):
             if api_version is APIVersion.Legacy:
                 data["unread"] = n.counts.unread
                 data["missed_calls"] = n.counts.missed_calls
             elif api_version is APIVersion.V1:
-                data["unread"] = str(n.counts.unread)
-                data["missed_calls"] = str(n.counts.missed_calls)
+                if n.counts.unread:
+                    data["unread"] = str(n.counts.unread)
+                if n.counts.missed_calls:
+                    data["missed_calls"] = str(n.counts.missed_calls)
 
         if overflow_fields > MAX_NOTIFICATION_OVERFLOW_FIELDS:
             logger.warning(

tests/test_gcm.py

@@ -161,6 +161,13 @@ def config_setup(self, config: Dict[str, Any]) -> None:
             "api_key": "kii",
             "fcm_options": {"content_available": True, "mutable_content": True},
         }
+        config["apps"]["fcm-with-disabled-badge-count"] = {
+            "type": "tests.test_gcm.TestGcmPushkin",
+            "api_key": "kii",
+            "fcm_options": {"content_available": True, "mutable_content": True},
+            # This pusher is specifically testing that this field is `False`.
+            "send_badge_counts": False,
+        }
         self.service_account_file = tempfile.NamedTemporaryFile()
         self.service_account_file.write(FAKE_SERVICE_ACCOUNT_FILE)
         self.service_account_file.flush()
@@ -542,6 +549,52 @@ def test_fcm_options(self) -> None:
         self.assertEqual(gcm.last_request_body["mutable_content"], True)
         self.assertEqual(gcm.last_request_body["content_available"], True)
 
+    def test_send_badge_counts(self) -> None:
+        """
+        Tests that the config option `send_badge_counts` being disabled
+        actually removes the unread and missed call count from notifications
+        """
+        gcm = self.get_test_pushkin("fcm-with-disabled-badge-count")
+        gcm.preload_with_response(
+            200, {"results": [{"registration_id": "spqr_new", "message_id": "msg42"}]}
+        )
+
+        resp = self._request(
+            self._make_dummy_notification(
+                [
+                    {
+                        "app_id": "fcm-with-disabled-badge-count",
+                        "pushkey": "spqr",
+                        "pushkey_ts": 42,
+                    }
+                ]
+            )
+        )
+
+        self.assertEqual(resp, {"rejected": []})
+        assert gcm.last_request_body is not None
+
+        # No 'unread' or 'missed_call' fields are present
+        self.assertEqual(
+            gcm.last_request_body["data"],
+            {
+                "content": {
+                    "body": "I'm floating in a most peculiar way.",
+                    "msgtype": "m.text",
+                    "other": 1,
+                },
+                "event_id": "$qTOWWTEL48yPm3uT-gdNhFcoHxfKbZuqRVnnWWSkGBs",
+                "membership": None,
+                "prio": "high",
+                "room_alias": "#exampleroom:matrix.org",
+                "room_id": "!slw48wfj34rtnrf:example.com",
+                "room_name": "Mission Control",
+                "sender": "@exampleuser:matrix.org",
+                "sender_display_name": "Major Tom",
+                "type": "m.room.message",
+            },
+        )
+
     def test_api_v1_large_fields(self) -> None:
         """
         Tests the gcm pushkin truncates unusually large fields. Includes large