Merge pull request #11 from maykinmedia/issue-10-avoid-runtimeerror

[#10] Avoid raising a RuntimeError when not having notifications conf…

README.rst

@@ -29,7 +29,7 @@ Installation
 Requirements
 ------------
 
-* Python 3.7 or above
+* Python 3.8 or above
 * setuptools 30.3.0 or above
 * Django 3.2 or newer
 * Celery 5.0 or newer setup with one worker deployed

docs/quickstart.rst

@@ -47,6 +47,8 @@ Three additional settings are available:
 
 * ``NOTIFICATIONS_DISABLED``: a boolean, default ``False``. Set to ``True`` to
   completely disable the sending of notifications.
+* ``NOTIFICATIONS_GUARANTEE_DELIVERY``: a boolean, default ``True``. Set to ``False`` to
+  not raise a RuntimeError when the Notifications API is unconfigured.
 * ``IS_HTTPS``: a boolean, default ``True``. Set to ``False`` to indicate that
   no HTTPS is being used.
 

notifications_api_common/settings.py

@@ -7,6 +7,8 @@
 
 IS_HTTPS = True
 
+NOTIFICATIONS_GUARANTEE_DELIVERY = True
+
 
 def get_setting(name: str) -> Any:
     this_module = sys.modules[__name__]

notifications_api_common/viewsets.py

@@ -161,11 +161,16 @@ def notify(
         # build the content of the notification
         message = self.construct_message(data, instance=instance)
 
-        # build the client from the singleton config. This will raise an
-        # exception if the config is not complete. We want this to hard-fail!
+        # build the client from the singleton config.
+        # This will raise an exception if the config is not complete unless
+        # NOTIFICATIONS_GUARANTEE_DELIVERY is explicitly set to False
         client = NotificationsConfig.get_client()
         if client is None:
-            raise RuntimeError("Could not build a client for Notifications API")
+            msg = "Not notifying, Notifications API configuration is broken or absent."
+            logger.warning(msg)
+            if get_setting("NOTIFICATIONS_GUARANTEE_DELIVERY"):
+                raise RuntimeError(msg)
+            return
 
         # We've performed all the work that can raise uncaught exceptions that we can
         # still put inside an atomic transaction block. Next, we schedule the actual

tests/test_send_message.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 from unittest.mock import patch
 
+from django.test import override_settings
 from django.urls import reverse
 
 import pytest
@@ -116,3 +117,30 @@ def test_task_send_notification_catch_500(
 
     with pytest.raises(NotificationException):
         send_notification({"foo": "bar"})
+
+
+@freeze_time("2022-01-01")
+@pytest.mark.django_db(transaction=True)
+def test_api_create_person_unconfigured(api_client, notifications_config):
+    """Test the default behavior of NOTIFICATIONS_GUARANTEE_DELIVERY=True"""
+    notifications_config.delete()
+    url = reverse("person-list")
+    data = {"name": "John", "address_street": "Grotestraat", "address_number": "1"}
+
+    with pytest.raises(RuntimeError):
+        response = api_client.post(url, data)
+
+    assert Person.objects.count() == 0
+
+
+@freeze_time("2022-01-01")
+@pytest.mark.django_db(transaction=True)
+@override_settings(NOTIFICATIONS_GUARANTEE_DELIVERY=False)
+def test_api_create_person_unconfigured(api_client, notifications_config):
+    notifications_config.delete()
+    url = reverse("person-list")
+    data = {"name": "John", "address_street": "Grotestraat", "address_number": "1"}
+
+    response = api_client.post(url, data)
+
+    assert Person.objects.count() == 1