FCM Options Support in WebpushConfig API (firebase#242)

hiranya911 · web-flow · commit 47345a1ecaf5 · 2019-01-04T14:44:18.000-08:00
* Splitting messaging module into 2 files

* Supporing WebpushFcmOptions API

* Updated comment
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Unreleased
 
+- `messaging.WebpushConfig` class now supports configuring additional
+  FCM options for the features supported by the web SDK. A new
+  `messaging.WebpushFcmOptions` type has been introduced for this
+  purpose.
 - `messaging.Aps` class now supports configuring a critical sound. A new
   `messaging.CriticalSound` class has been introduced for this purpose.
 - [changed] Dropped support for Python 3.3.
@@ -24,7 +28,7 @@
   receiving realtime update events from the Firebase Database.
 - [added] The `db.reference()` method now optionally takes a `url`
   parameter. This can be used to access multiple Firebase Databases
-  in the same project more easily. 
+  in the same project more easily.
 - [added] The `messaging.WebpushNotification` type now supports
   additional parameters.
 
diff --git a/firebase_admin/_messaging_utils.py b/firebase_admin/_messaging_utils.py
@@ -150,14 +150,16 @@ class WebpushConfig(object):
         data: A dictionary of data fields (optional). All keys and values in the dictionary must be
             strings. When specified, overrides any data fields set via ``Message.data``.
         notification: A ``messaging.WebpushNotification`` to be included in the message (optional).
+        fcm_options: A ``messaging.WebpushFcmOptions`` to be included in the messsage (optional).
 
     .. _Webpush Specification: https://tools.ietf.org/html/rfc8030#section-5
     """
 
-    def __init__(self, headers=None, data=None, notification=None):
+    def __init__(self, headers=None, data=None, notification=None, fcm_options=None):
         self.headers = headers
         self.data = data
         self.notification = notification
+        self.fcm_options = fcm_options
 
 
 class WebpushNotificationAction(object):
@@ -232,6 +234,18 @@ def __init__(self, title=None, body=None, icon=None, actions=None, badge=None, d
         self.custom_data = custom_data
 
 
+class WebpushFcmOptions(object):
+    """Options for features provided by the FCM SDK for Web.
+
+    Args:
+        link: The link to open when the user clicks on the notification. Must be an HTTPS URL
+            (optional).
+    """
+
+    def __init__(self, link=None):
+        self.link = link
+
+
 class APNSConfig(object):
     """APNS-specific options that can be included in a message.
 
@@ -503,7 +517,7 @@ def encode_android_notification(cls, notification):
 
     @classmethod
     def encode_webpush(cls, webpush):
-        """Encodes an WebpushConfig instance into JSON."""
+        """Encodes a WebpushConfig instance into JSON."""
         if webpush is None:
             return None
         if not isinstance(webpush, WebpushConfig):
@@ -514,12 +528,13 @@ def encode_webpush(cls, webpush):
             'headers': _Validators.check_string_dict(
                 'WebpushConfig.headers', webpush.headers),
             'notification': cls.encode_webpush_notification(webpush.notification),
+            'fcmOptions': cls.encode_webpush_fcm_options(webpush.fcm_options),
         }
         return cls.remove_null_values(result)
 
     @classmethod
     def encode_webpush_notification(cls, notification):
-        """Encodes an WebpushNotification instance into JSON."""
+        """Encodes a WebpushNotification instance into JSON."""
         if notification is None:
             return None
         if not isinstance(notification, WebpushNotification):
@@ -588,6 +603,20 @@ def encode_webpush_notification_actions(cls, actions):
             results.append(cls.remove_null_values(result))
         return results
 
+    @classmethod
+    def encode_webpush_fcm_options(cls, options):
+        """Encodes a WebpushFcmOptions instance into JSON."""
+        if options is None:
+            return None
+        result = {
+            'link': _Validators.check_string('WebpushConfig.fcm_options.link', options.link),
+        }
+        result = cls.remove_null_values(result)
+        link = result.get('link')
+        if link is not None and not link.startswith('https://'):
+            raise ValueError('WebpushFcmOptions.link must be a HTTPS URL.')
+        return result
+
     @classmethod
     def encode_apns(cls, apns):
         """Encodes an APNSConfig instance into JSON."""
diff --git a/firebase_admin/messaging.py b/firebase_admin/messaging.py
@@ -39,6 +39,7 @@
     'Notification',
     'TopicManagementResponse',
     'WebpushConfig',
+    'WebpushFcmOptions',
     'WebpushNotification',
     'WebpushNotificationAction',
 
@@ -58,6 +59,7 @@
 Message = _messaging_utils.Message
 Notification = _messaging_utils.Notification
 WebpushConfig = _messaging_utils.WebpushConfig
+WebpushFcmOptions = _messaging_utils.WebpushFcmOptions
 WebpushNotification = _messaging_utils.WebpushNotification
 WebpushNotificationAction = _messaging_utils.WebpushNotificationAction
 
diff --git a/tests/test_messaging.py b/tests/test_messaging.py
@@ -401,7 +401,7 @@ def test_webpush_config(self):
             topic='topic',
             webpush=messaging.WebpushConfig(
                 headers={'h1': 'v1', 'h2': 'v2'},
-                data={'k1': 'v1', 'k2': 'v2'}
+                data={'k1': 'v1', 'k2': 'v2'},
             )
         )
         expected = {
@@ -420,6 +420,52 @@ def test_webpush_config(self):
         check_encoding(msg, expected)
 
 
+class TestWebpushFcmOptionsEncoder(object):
+
+    @pytest.mark.parametrize('data', NON_OBJECT_ARGS)
+    def test_invalid_webpush_fcm_options(self, data):
+        with pytest.raises(AttributeError):
+            check_encoding(messaging.Message(
+                topic='topic', webpush=messaging.WebpushConfig(fcm_options=data)))
+
+    @pytest.mark.parametrize('data', NON_STRING_ARGS)
+    def test_invalid_link_type(self, data):
+        options = messaging.WebpushFcmOptions(link=data)
+        with pytest.raises(ValueError) as excinfo:
+            check_encoding(messaging.Message(
+                topic='topic', webpush=messaging.WebpushConfig(fcm_options=options)))
+        expected = 'WebpushConfig.fcm_options.link must be a string.'
+        assert str(excinfo.value) == expected
+
+    @pytest.mark.parametrize('data', ['', 'foo', 'http://example'])
+    def test_invalid_link_format(self, data):
+        options = messaging.WebpushFcmOptions(link=data)
+        with pytest.raises(ValueError) as excinfo:
+            check_encoding(messaging.Message(
+                topic='topic', webpush=messaging.WebpushConfig(fcm_options=options)))
+        expected = 'WebpushFcmOptions.link must be a HTTPS URL.'
+        assert str(excinfo.value) == expected
+
+    def test_webpush_notification(self):
+        msg = messaging.Message(
+            topic='topic',
+            webpush=messaging.WebpushConfig(
+                fcm_options=messaging.WebpushFcmOptions(
+                    link='https://example',
+                ),
+            )
+        )
+        expected = {
+            'topic': 'topic',
+            'webpush': {
+                'fcmOptions': {
+                    'link': 'https://example',
+                },
+            },
+        }
+        check_encoding(msg, expected)
+
+
 class TestWebpushNotificationEncoder(object):
 
     def _check_notification(self, notification):
