feat(client-reports): Record event_processor client reports (getsentry#1281)

sl0thentr0py · web-flow · commit c64a1a4c779f · 2021-12-17T12:36:57.000+01:00
diff --git a/sentry_sdk/client.py b/sentry_sdk/client.py
@@ -145,9 +145,18 @@ def _prepare_event(
             event["timestamp"] = datetime.utcnow()
 
         if scope is not None:
+            is_transaction = event.get("type") == "transaction"
             event_ = scope.apply_to_event(event, hint)
+
+            # one of the event/error processors returned None
             if event_ is None:
+                if self.transport:
+                    self.transport.record_lost_event(
+                        "event_processor",
+                        data_category=("transaction" if is_transaction else "error"),
+                    )
                 return None
+
             event = event_
 
         if (
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -243,6 +243,25 @@ def append_envelope(envelope):
     return inner
 
 
+@pytest.fixture
+def capture_client_reports(monkeypatch):
+    def inner():
+        reports = []
+        test_client = sentry_sdk.Hub.current.client
+
+        def record_lost_event(reason, data_category=None, item=None):
+            if data_category is None:
+                data_category = item.data_category
+            return reports.append((reason, data_category))
+
+        monkeypatch.setattr(
+            test_client.transport, "record_lost_event", record_lost_event
+        )
+        return reports
+
+    return inner
+
+
 @pytest.fixture
 def capture_events_forksafe(monkeypatch, capture_events, request):
     def inner():
diff --git a/tests/integrations/gcp/test_gcp.py b/tests/integrations/gcp/test_gcp.py
@@ -81,6 +81,9 @@ def init_sdk(timeout_warning=False, **extra_init_args):
         transport=TestTransport,
         integrations=[GcpIntegration(timeout_warning=timeout_warning)],
         shutdown_timeout=10,
+        # excepthook -> dedupe -> event_processor client report gets added
+        # which we don't really care about for these tests
+        send_client_reports=False,
         **extra_init_args
     )
 
diff --git a/tests/test_basics.py b/tests/test_basics.py
@@ -1,4 +1,5 @@
 import os
+import sys
 import logging
 
 import pytest
@@ -10,13 +11,19 @@
     capture_event,
     capture_exception,
     capture_message,
+    start_transaction,
     add_breadcrumb,
     last_event_id,
     Hub,
 )
 
+from sentry_sdk._compat import reraise
 from sentry_sdk.integrations import _AUTO_ENABLING_INTEGRATIONS
 from sentry_sdk.integrations.logging import LoggingIntegration
+from sentry_sdk.scope import (  # noqa: F401
+    add_global_event_processor,
+    global_event_processors,
+)
 
 
 def test_processors(sentry_init, capture_events):
@@ -371,3 +378,56 @@ def test_capture_event_with_scope_kwargs(sentry_init, capture_events):
     (event,) = events
     assert event["level"] == "info"
     assert event["extra"]["foo"] == "bar"
+
+
+def test_dedupe_event_processor_drop_records_client_report(
+    sentry_init, capture_events, capture_client_reports
+):
+    """
+    DedupeIntegration internally has an event_processor that filters duplicate exceptions.
+    We want a duplicate exception to be captured only once and the drop being recorded as
+    a client report.
+    """
+    sentry_init()
+    events = capture_events()
+    reports = capture_client_reports()
+
+    try:
+        raise ValueError("aha!")
+    except Exception:
+        try:
+            capture_exception()
+            reraise(*sys.exc_info())
+        except Exception:
+            capture_exception()
+
+    (event,) = events
+    (report,) = reports
+
+    assert event["level"] == "error"
+    assert "exception" in event
+    assert report == ("event_processor", "error")
+
+
+def test_event_processor_drop_records_client_report(
+    sentry_init, capture_events, capture_client_reports
+):
+    sentry_init(traces_sample_rate=1.0)
+    events = capture_events()
+    reports = capture_client_reports()
+
+    global global_event_processors
+
+    @add_global_event_processor
+    def foo(event, hint):
+        return None
+
+    capture_message("dropped")
+
+    with start_transaction(name="dropped"):
+        pass
+
+    assert len(events) == 0
+    assert reports == [("event_processor", "error"), ("event_processor", "transaction")]
+
+    global_event_processors.pop()

Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,9 @@ def init_sdk(timeout_warning=False, **extra_init_args):`
`81`	`81`	`transport=TestTransport,`
`82`	`82`	`integrations=[GcpIntegration(timeout_warning=timeout_warning)],`
`83`	`83`	`shutdown_timeout=10,`
	`84`	`+ # excepthook -> dedupe -> event_processor client report gets added`
	`85`	`+ # which we don't really care about for these tests`
	`86`	`+ send_client_reports=False,`
`84`	`87`	`**extra_init_args`
`85`	`88`	`)`
`86`	`89`