handle scope merging for breadcrumb annotations

Author: shellmayr

sentry_sdk/_types.py

@@ -30,6 +30,15 @@ def __eq__(self, other):
 
         return self.value == other.value and self.metadata == other.metadata
 
+    def __str__(self):
+        return str({"value": str(self.value), "metadata": str(self.metadata)})
+
+    def __repr__(self):
+        return str(self)
+
+    def __len__(self):
+        return len(self.value)
+
     @classmethod
     def removed_because_raw_data(cls):
         # type: () -> AnnotatedValue
@@ -81,8 +90,11 @@ def substituted_because_contains_sensitive_data(cls):
             },
         )
 
+
 T = TypeVar("T")
 Annotated = Union[AnnotatedValue, T]
+
+
 class AnnotatedDeque(AnnotatedValue):
     """
     Meta information for a data field in the event payload.
@@ -128,6 +140,7 @@ def truncated(cls, value, n_truncated):
             metadata={"len": [n_truncated]},  # Remark
         )
 
+
 if TYPE_CHECKING:
     from collections.abc import Container, MutableMapping, Sequence
 

sentry_sdk/client.py

@@ -491,6 +491,7 @@ def _prepare_event(
         # type: (...) -> Optional[Event]
 
         previous_total_spans = None  # type: Optional[int]
+        previous_total_breadcrumbs = None  # type: Optional[int]
 
         if event.get("timestamp") is None:
             event["timestamp"] = datetime.now(timezone.utc)
@@ -527,6 +528,10 @@ def _prepare_event(
             dropped_spans = event.pop("_dropped_spans", 0) + spans_delta  # type: int
             if dropped_spans > 0:
                 previous_total_spans = spans_before + dropped_spans
+            if scope._n_breadcrumbs_truncated > 0:
+                previous_total_breadcrumbs = (
+                    len(event["breadcrumbs"]) + scope._n_breadcrumbs_truncated
+                )
 
         if (
             self.options["attach_stacktrace"]
@@ -579,7 +584,10 @@ def _prepare_event(
             event["spans"] = AnnotatedValue(
                 event.get("spans", []), {"len": previous_total_spans}
             )
-
+        if previous_total_breadcrumbs is not None:
+            event["breadcrumbs"] = AnnotatedValue(
+                event.get("breadcrumbs", []), {"len": previous_total_breadcrumbs}
+            )
         # Postprocess the event here so that annotated types do
         # generally not surface in before_send
         if event is not None:

sentry_sdk/scope.py

@@ -1,3 +1,4 @@
+import logging
 import os
 import sys
 import warnings
@@ -9,6 +10,7 @@
 from functools import wraps
 from itertools import chain
 
+from sentry_sdk._types import AnnotatedValue
 from sentry_sdk.attachments import Attachment
 from sentry_sdk.consts import DEFAULT_MAX_BREADCRUMBS, FALSE_VALUES, INSTRUMENTER
 from sentry_sdk.feature_flags import FlagBuffer, DEFAULT_FLAG_CAPACITY
@@ -33,7 +35,6 @@
     Transaction,
 )
 from sentry_sdk.utils import (
-    AnnotatedDeque,
     capture_internal_exception,
     capture_internal_exceptions,
     ContextVar,
@@ -987,8 +988,14 @@ def add_breadcrumb(self, crumb=None, hint=None, **kwargs):
             logger.info("before breadcrumb dropped breadcrumb (%s)", crumb)
 
         while len(self._breadcrumbs) > max_breadcrumbs:
+            logging.debug(
+                f"i am here in the truncation logic before, {self._n_breadcrumbs_truncated}"
+            )
             self._breadcrumbs.popleft()
             self._n_breadcrumbs_truncated += 1
+            logging.debug(
+                f"i am here in the truncation logic after, {self._n_breadcrumbs_truncated}"
+            )
 
     def start_transaction(
         self,
@@ -1388,12 +1395,19 @@ def _apply_breadcrumbs_to_event(self, event, hint, options):
             pass
 
         # Add annotation that breadcrumbs were truncated
+        logging.debug(
+            f"i am here outside of the truncated thing, {self._n_breadcrumbs_truncated} and {len(self._breadcrumbs)}"
+        )
         if self._n_breadcrumbs_truncated:
+            logging.debug("i am here in the truncated thing")
             original_length = (
                 len(event["breadcrumbs"]["values"]) + self._n_breadcrumbs_truncated
             )
-            event["breadcrumbs"]["values"] = AnnotatedDeque.truncated_breadcrumbs(
-                event["breadcrumbs"]["values"], original_length
+            logging.debug(
+                f"in the truncated thing, the original_lenght is {original_length}"
+            )
+            event["breadcrumbs"] = AnnotatedValue(
+                event.get("breadcrumbs", []), {"len": original_length}
             )
 
     def _apply_user_to_event(self, event, hint, options):
@@ -1546,6 +1560,9 @@ def apply_to_event(
 
         if not is_transaction and not is_check_in:
             self._apply_breadcrumbs_to_event(event, hint, options)
+            # logging.debug(event)
+            logging.debug(event["breadcrumbs"])
+            logging.debug(type(event["breadcrumbs"]))
             self._apply_flags_to_event(event, hint, options)
 
         event = self.run_error_processors(event, hint)
@@ -1579,6 +1596,10 @@ def update_from_scope(self, scope):
             self._extras.update(scope._extras)
         if scope._breadcrumbs:
             self._breadcrumbs.extend(scope._breadcrumbs)
+        if scope._n_breadcrumbs_truncated:
+            self._n_breadcrumbs_truncated = (
+                self._n_breadcrumbs_truncated + scope._n_breadcrumbs_truncated
+            )
         if scope._span:
             self._span = scope._span
         if scope._attachments:

sentry_sdk/serializer.py

@@ -1,3 +1,4 @@
+import logging
 import sys
 import math
 from collections.abc import Mapping, Sequence, Set
@@ -230,6 +231,7 @@ def _serialize_node(
     def _flatten_annotated(obj):
         # type: (Any) -> Any
         if isinstance(obj, AnnotatedValue):
+            logging.debug(obj)
             _annotate(**obj.metadata)
             obj = obj.value
         return obj

tests/test_scrubber.py

@@ -119,27 +119,30 @@ def test_stack_var_scrubbing(sentry_init, capture_events):
 
 
 def test_breadcrumb_extra_scrubbing(sentry_init, capture_events):
-    sentry_init()
+    sentry_init(max_breadcrumbs=2)
+    breakpoint()
     events = capture_events()
-
-    logger.info("bread", extra=dict(foo=42, password="secret"))
+    logger.info("breadcrumb 1", extra=dict(foo=1, password="secret"))
+    logger.info("breadcrumb 2", extra=dict(bar=2, auth="secret"))
+    logger.info("breadcrumb 3", extra=dict(foobar=3, password="secret"))
     logger.critical("whoops", extra=dict(bar=69, auth="secret"))
 
+    print(events)
     (event,) = events
 
     assert event["extra"]["bar"] == 69
     assert event["extra"]["auth"] == "[Filtered]"
-
     assert event["breadcrumbs"]["values"][0]["data"] == {
-        "foo": 42,
-        "password": "[Filtered]",
+        "bar": 2,
+        "auth": "[Filtered]",
     }
 
     assert event["_meta"]["extra"]["auth"] == {"": {"rem": [["!config", "s"]]}}
     assert event["_meta"]["breadcrumbs"] == {
         "values": {
-            "": {"len": [1]},
-            "0": {"data": {"password": {"": {"rem": [["!config", "s"]]}}}},
+            "": {"len": [4]},
+            "0": {"data": {"auth": {"": {"rem": [["!config", "s"]]}}}},
+            "1": {"data": {"password": {"": {"rem": [["!config", "s"]]}}}},
         }
     }
 

tests/tracing/test_misc.py

@@ -40,7 +40,7 @@ def test_span_trimming(sentry_init, capture_events):
 def test_span_data_scrubbing_and_trimming(sentry_init, capture_events):
     sentry_init(traces_sample_rate=1.0, _experiments={"max_spans": 3})
     events = capture_events()
-
+    breakpoint()
     with start_transaction(name="hi"):
         with start_span(op="foo", name="bar") as span:
             span.set_data("password", "secret")