[TOOLSLIBS-1377] Add Live Activity/Update, new options, backoff on ConnectionError (#203)

* Add Live Activity/Update, new options, backoff on ConnectionError

* update python versions for CI

* rollback python versions

* fixes

* Update test_runner.yaml

* Fix typing

* update tests

* update tests

* add ConnectionFailure class

* add condition for content_state keys

---------

Co-authored-by: customer-engineering <[email protected]>

Author: martin-vct

.github/workflows/test_runner.yaml

@@ -4,8 +4,7 @@ on: [push]
 
 jobs:
   build:
-
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
         python-version: ["3.6", "3.7", "3.8", "3.9"]

docs/index.rst

@@ -82,6 +82,7 @@ Exceptions
 
 .. autoclass:: urbanairship.Unauthorized
 
+.. autoclass:: urbanairship.ConnectionFailure
 
 Development
 ============

docs/push.rst

@@ -97,6 +97,9 @@ attributes, the notification is ready for delivery. Use ``Push.send()`` to send
 If the request is unsuccessful, an :py:class:`AirshipFailure` exception
 will be raised.
 
+If the connection is unsuccessful, an :py:class:`ConnectionFailure` exception
+will be raised.
+
 .. autoclass:: urbanairship.push.core.Push
    :members: send, validate
 

tests/push/test_push.py

@@ -6,12 +6,11 @@
 import requests
 import urbanairship as ua
 from tests import TEST_KEY, TEST_SECRET
-from urbanairship.push.payload import in_app, localization
+from urbanairship.enums import LiveActivityEvent, LiveUpdateEvent
 
 
 class TestPush(unittest.TestCase):
     def test_full_payload(self):
-
         p = ua.Push(None)
         p.audience = ua.all_
         p.notification = ua.notification(alert="Hello")
@@ -547,6 +546,28 @@ def test_ios_overrides(self):
                 interruption_level="critical",
                 relevance_score=0.75,
                 target_content_id="big day coming",
+                media_attachment=ua.media_attachment(
+                    url="https://www.testurl.com",
+                    content={
+                        "title": "Moustache Twirl",
+                        "body": "Have you ever seen a moustache like this?!",
+                    },
+                    options={
+                        "crop": {"height": 0.5, "width": 0.5, "x": 0.25, "y": 0.25},
+                        "time": 15,
+                    },
+                ),
+                live_activity=ua.live_activity(
+                    event=LiveActivityEvent.UPDATE,
+                    alert={"title": "test", "sound": "test", "body": "test"},
+                    name="test",
+                    priority=5,
+                    content_state={"test": "test"},
+                    relevance_score=1.0,
+                    stale_date=1234,
+                    dismissal_date=1234,
+                    timestamp=1234,
+                ),
             )
         )
         p.options = ua.options(10080)
@@ -570,22 +591,49 @@ def test_ios_overrides(self):
                             "summary-arg": "Matmos",
                             "summary-arg-count": 1,
                         },
+                        "badge": 3,
                         "sound": {
                             "name": "Amplified Synapse",
                             "volume": 0.8,
                             "critical": False,
                         },
-                        "thread_id": "plastic minor",
-                        "priority": 10,
-                        "badge": 3,
                         "extra": {"office": "furniture"},
-                        "mutable_content": False,
                         "title": "this is",
+                        "mutable_content": False,
                         "subtitle": "backwards",
+                        "media_attachment": {
+                            "url": "https://www.testurl.com",
+                            "content": {
+                                "title": "Moustache Twirl",
+                                "body": "Have you ever seen a moustache like this?!",
+                            },
+                            "options": {
+                                "crop": {
+                                    "height": 0.5,
+                                    "width": 0.5,
+                                    "x": 0.25,
+                                    "y": 0.25,
+                                },
+                                "time": 15,
+                            },
+                        },
+                        "priority": 10,
                         "collapse_id": "nugent sand",
+                        "thread_id": "plastic minor",
                         "interruption_level": "critical",
                         "relevance_score": 0.75,
                         "target_content_id": "big day coming",
+                        "live_activity": {
+                            "alert": {"title": "test", "sound": "test", "body": "test"},
+                            "event": "update",
+                            "name": "test",
+                            "priority": 5,
+                            "content_state": {"test": "test"},
+                            "relevance_score": 1.0,
+                            "stale_date": 1234,
+                            "dismissal_date": 1234,
+                            "timestamp": 1234,
+                        },
                     }
                 },
                 "device_types": "ios",
@@ -603,7 +651,7 @@ def test_full_scheduled_payload(self):
         p = ua.Push(None)
         p.audience = ua.all_
         p.notification = ua.notification(alert="Hello")
-        p.options = ua.options(10080)
+        p.options = ua.options(expiry=10080)
         p.device_types = ua.all_
         p.message = ua.message(
             title="Title",
@@ -1110,3 +1158,83 @@ def test_localization_raises_no_country_lang(self):
     def testlocalization_raises_no_content(self):
         with self.assertRaises(ValueError):
             ua.localization(country="us", language="en")
+
+    def test_options_expiry_as_int(self):
+        result = ua.options(expiry=300)
+        assert result == {"expiry": 300}
+
+    def test_options_expiry_as_string(self):
+        result = ua.options(expiry="2023-10-19T10:00:00Z")
+        assert result == {"expiry": "2023-10-19T10:00:00Z"}
+
+    def test_options_with_multiple_values(self):
+        result = ua.options(
+            expiry="2023-10-19T10:00:00Z",
+            bypass_frequency_limits=True,
+            bypass_holdout_groups=True,
+            no_throttle=True,
+            omit_from_activity_log=True,
+            personalization=True,
+            redact_payload=True,
+        )
+        expected_result = {
+            "expiry": "2023-10-19T10:00:00Z",
+            "bypass_frequency_limits": True,
+            "bypass_holdout_groups": True,
+            "no_throttle": True,
+            "omit_from_activity_log": True,
+            "personalization": True,
+            "redact_payload": True,
+        }
+        assert result == expected_result
+
+    def test_valid_live_activity(self):
+        result = ua.live_activity(
+            event=LiveActivityEvent.UPDATE,
+            name="TestActivity",
+            alert={"body": "Test body", "sound": "default", "title": "Test Title"},
+            priority=10,
+        )
+        self.assertIn("alert", result)
+        self.assertEqual(result["event"], "update")
+        self.assertEqual(result["name"], "TestActivity")
+        self.assertEqual(result["priority"], 10)
+
+    def test_invalid_alert(self):
+        with self.assertRaises(ValueError):
+            ua.live_activity(
+                event=LiveActivityEvent.UPDATE,
+                name="TestActivity",
+                alert={"other_key": "test", "title": "test"},
+                priority=10,
+            )
+
+    def test_missing_name_live_activity(self):
+        with self.assertRaises(ValueError):
+            ua.live_activity(name=None, event=LiveActivityEvent.END, priority=10)
+
+    def test_valid_live_update(self):
+        result = ua.live_update(
+            event=LiveUpdateEvent.START,
+            name="TestUpdate",
+            content_state={"key": "value"},
+        )
+        self.assertEqual(result["event"], "start")
+        self.assertEqual(result["name"], "TestUpdate")
+        self.assertIn("content_state", result)
+
+    def test_invalid_content_state(self):
+        with self.assertRaises(TypeError):
+            ua.live_update(
+                event=LiveUpdateEvent.UPDATE, name="TestUpdate", content_state="invalid"
+            )
+        with self.assertRaises(TypeError):
+            ua.live_update(
+                event=LiveUpdateEvent.UPDATE,
+                name="TestUpdate",
+                content_state={1: "test"},
+            )
+
+    def test_missing_name_live_update(self):
+        with self.assertRaises(ValueError):
+            ua.live_update(name=None, event=LiveUpdateEvent.END)

urbanairship/__init__.py

@@ -4,7 +4,7 @@
 
 from .core import Airship
 from .automation import Automation, Pipeline
-from .common import AirshipFailure, Unauthorized
+from .common import AirshipFailure, ConnectionFailure, Unauthorized
 from .custom_events import CustomEvent
 from .devices import (
     APIDList,
@@ -65,8 +65,11 @@
     interactive,
     ios,
     ios_channel,
+    live_activity,
+    live_update,
     local_scheduled_time,
     localization,
+    media_attachment,
     merge_data,
     message,
     mms,
@@ -115,6 +118,7 @@
 __all__: List[Any] = [
     Airship,
     AirshipFailure,
+    ConnectionFailure,
     Unauthorized,
     all_,
     Push,
@@ -167,6 +171,9 @@
     static_list,
     subscription_list,
     localization,
+    live_activity,
+    live_update,
+    media_attachment,
     ChannelList,
     ChannelInfo,
     OpenChannel,

urbanairship/common.py

@@ -11,6 +11,10 @@ class Unauthorized(Exception):
     """Raised when we get a 401 from the server"""
 
 
+class ConnectionFailure(Exception):
+    """Raised when there's a connection failure."""
+
+
 class AirshipFailure(Exception):
     """Raised when we get an error response from the server.
 

urbanairship/core.py

@@ -193,7 +193,6 @@ def _request(
         params: Optional[Dict[str, Any]] = None,
         encoding: Optional[str] = None,
     ) -> requests.Response:
-
         headers: Dict[str, str] = {
             "User-agent": "UAPythonLib/{0} {1}".format(__about__.__version__, self.key)
         }
@@ -207,7 +206,9 @@ def _request(
             headers["Content-Encoding"] = encoding
 
         @backoff.on_exception(
-            backoff.expo, common.AirshipFailure, max_tries=(self.retries + 1)
+            backoff.expo,
+            (common.AirshipFailure, common.ConnectionFailure),
+            max_tries=(self.retries + 1),
         )
         def make_retryable_request(
             method: str,
@@ -216,14 +217,17 @@ def make_retryable_request(
             params: Optional[Dict[str, Any]],
             headers: Dict[str, Any],
         ) -> requests.Response:
-            response: requests.Response = self.session.request(
-                method,
-                url,
-                data=body,
-                params=params,
-                headers=headers,
-                timeout=self.timeout,
-            )
+            try:
+                response: requests.Response = self.session.request(
+                    method,
+                    url,
+                    data=body,
+                    params=params,
+                    headers=headers,
+                    timeout=self.timeout,
+                )
+            except requests.exceptions.ConnectionError as err:
+                raise common.ConnectionFailure(str(err))
 
             logger.debug(
                 "Making %s request to %s. Headers:\n\t%s\nBody:\n\t%s",

urbanairship/enums.py

@@ -0,0 +1,12 @@
+from enum import Enum
+
+
+class LiveActivityEvent(Enum):
+    UPDATE = "update"
+    END = "end"
+
+
+class LiveUpdateEvent(Enum):
+    START = "start"
+    UPDATE = "update"
+    END = "end"

urbanairship/push/__init__.py

@@ -48,6 +48,9 @@
     wearable,
     web,
     wns_payload,
+    live_activity,
+    live_update,
+    media_attachment,
 )
 from .schedule import (
     ScheduledList,
@@ -127,4 +130,7 @@
     localization,
     recurring_schedule,
     schedule_exclusion,
+    live_activity,
+    live_update,
+    media_attachment,
 ]

urbanairship/push/core.py

@@ -105,6 +105,7 @@ def send(self) -> PushResponse:
         :raises AirshipFailure: Request failed.
         :raises Unauthorized: Authentication failed.
         :raises ValueError: Required keys missing or incorrect values included.
+        :raises ConnectionFailure: Connection failed.
         """
         if "email" in self.payload["notification"]:
             if self.payload["device_types"] == "all":
@@ -250,6 +251,7 @@ def send(self) -> PushResponse:
             other response data.
         :raises AirshipFailure: Request failed.
         :raises Unauthorized: Authentication failed.
+        :raises ConnectionFailure: Connection failed.
 
         """
         response = self._airship._request(
@@ -366,6 +368,7 @@ def send(self) -> PushResponse:
             other response data.
         :raises AirshipFailure: Request failed.
         :raises Unauthorized: Authentication failed.
+        :raises ConnectionFailure: Connection failed.
 
         """
 
@@ -506,6 +509,8 @@ def send(self) -> PushResponse:
         :raises AirshipFailure: Request failed.
         :raises Unauthorized: Authentication failed.
         :raises ValueError: Required keys missing or incorrect values included.
+        :raises ConnectionFailure: Connection failed.
+
         """
         body = json.dumps(self.payload)
         response = self._airship._request(