feat(sentry): ignore authentication expired errors in Sentry

KK-1396.

Sentry should ignore errors related to expired authentications, since it
is not a system error, but a feature related to JWT usage.

Author: nikomakela

kukkuu/settings.py

@@ -3,12 +3,14 @@
 from datetime import datetime
 
 import environ
+from jose import ExpiredSignatureError
 import sentry_sdk
 from django.core.exceptions import ImproperlyConfigured
 from django.utils.translation import gettext_lazy as _
 from sentry_sdk.integrations.django import DjangoIntegration
 
 from kukkuu.consts import CSP
+from kukkuu.exceptions import AuthenticationExpiredError
 from kukkuu.tests.utils.jwt_utils import is_valid_256_bit_key
 
 checkout_dir = environ.Path(__file__) - 2
@@ -143,11 +145,29 @@
 except Exception:
     REVISION = "n/a"
 
+
+def sentry_before_send(event, hint):
+    """
+    Ignore certain errors from being sent to Sentry.
+    NOTE: The `ignore_errors` option is actually deprecated,
+    nevertheless it's included in the init configuration.
+    See https://github.com/getsentry/sentry-python/issues/149
+    """
+
+    IGNORED_ERRORS_CLASSES = (ExpiredSignatureError, AuthenticationExpiredError)
+    if "exc_info" in hint:
+        exc_type, exc_value, tb = hint["exc_info"]
+        if isinstance(exc_value, IGNORED_ERRORS_CLASSES):
+            return None
+    return event
+
+
 sentry_sdk.init(
     dsn=env.str("SENTRY_DSN"),
     release=REVISION,
     environment=env("SENTRY_ENVIRONMENT"),
     integrations=[DjangoIntegration()],
+    before_send=sentry_before_send,
 )
 sentry_sdk.integrations.logging.ignore_logger("graphql.execution.utils")
 

kukkuu/tests/test_sentry.py

@@ -0,0 +1,27 @@
+import pytest
+from jose import ExpiredSignatureError
+
+from kukkuu.exceptions import AuthenticationExpiredError
+from kukkuu.settings import sentry_before_send
+
+test_cases = [
+    (ExpiredSignatureError("Expired signature"), True),
+    (AuthenticationExpiredError("Authentication expired"), True),
+    (Exception("Some other error"), False),
+]
+
+
+@pytest.mark.parametrize(
+    "exception,should_return_none",
+    test_cases,
+)
+def test_sentry_before_send_ignores_defined_exceptions(exception, should_return_none):
+    hint = {"exc_info": (type(exception), exception, None)}
+    event = {"something": "test event is returned when not ignored"}
+
+    result = sentry_before_send(event, hint)
+
+    if should_return_none:
+        assert result is None  # Ensure the event is dropped
+    else:
+        assert result is not None  # Ensure the event is not dropped