feat(sentry): setup before_send to ignore global id errors by message

KK-1395.

The ignore_messages option in sentry_sdk would be great, but since the
Graphene raises a general Exception from invalid global ids, we need to
follow the exception message instead of class.

Author: nikomakela

kukkuu/settings.py

@@ -143,11 +143,27 @@
 except Exception:
     REVISION = "n/a"
 
+
+def sentry_before_send(event, hint):
+    """Some Graphene errors are generic Exceptions that are not useful to log.
+    Since they are generic, we cannot use the `ignore_errors` option of
+    `sentry_sdk.init` to ignore those."""
+    IGNORED_ERROR_MESSAGES = [
+        "Unable to parse global ID",
+    ]
+    if "exc_info" in hint:
+        exc_type, exc_value, tb = hint["exc_info"]
+        if any(msg in exc_value.args[0] for msg in IGNORED_ERROR_MESSAGES):
+            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,28 @@
+import pytest
+
+from kukkuu.settings import sentry_before_send
+
+test_case_error_message_with_ignore_status = [
+    ("Unable to parse global ID.", True),
+    ('Unable to parse global ID "some_id".', True),
+    ('Any other error exception message".', False),
+]
+
+
+@pytest.mark.parametrize(
+    "error_message,should_return_none",
+    test_case_error_message_with_ignore_status,
+)
+def test_sentry_before_send_ignores_defined_error_messages(
+    error_message, should_return_none
+):
+    exception = Exception(error_message)
+    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