make everything work together and remove annotateddeque

Author: shellmayr

sentry_sdk/_types.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING, Deque, TypeVar, Union
+from typing import TYPE_CHECKING, TypeVar, Union
 
 
 # Re-exported for compat, since code out there in the wild might use this variable.
@@ -34,7 +34,7 @@ def __str__(self):
         return str({"value": str(self.value), "metadata": str(self.metadata)})
 
     def __repr__(self):
-        return str(self)
+        return self
 
     def __len__(self):
         return len(self.value)
@@ -95,52 +95,6 @@ def substituted_because_contains_sensitive_data(cls):
 Annotated = Union[AnnotatedValue, T]
 
 
-class AnnotatedDeque(AnnotatedValue):
-    """
-    Meta information for a data field in the event payload.
-    This is to tell Relay that we have tampered with the fields value.
-    See:
-    https://github.com/getsentry/relay/blob/be12cd49a0f06ea932ed9b9f93a655de5d6ad6d1/relay-general/src/types/meta.rs#L407-L423
-    """
-
-    __slots__ = ("value", "metadata")
-
-    def __init__(self, value, metadata):
-        # type: (Deque[Any], Dict[str, Any]) -> None
-        self.value = value
-        self.metadata = metadata
-
-    def __eq__(self, other):
-        # type: (Any) -> bool
-        if not isinstance(other, AnnotatedValue):
-            return False
-
-        return self.value == other.value and self.metadata == other.metadata
-
-    def append(self, other):
-        # type: (Any) -> None
-        self.value.append(other)
-
-    def extend(self, other):
-        # type: (Any) -> None
-        self.value.extend(other)
-
-    def popleft(self):
-        self.value.popleft()
-
-    def __len__(self):
-        return len(self.value)
-
-    @classmethod
-    def truncated(cls, value, n_truncated):
-        # type: (Deque[Any], int) -> AnnotatedValue
-        """Data was removed because the number of elements exceeded the maximum limit."""
-        return AnnotatedDeque(
-            value=value,
-            metadata={"len": [n_truncated]},  # Remark
-        )
-
-
 if TYPE_CHECKING:
     from collections.abc import Container, MutableMapping, Sequence
 

sentry_sdk/client.py

@@ -530,8 +530,9 @@ def _prepare_event(
                 previous_total_spans = spans_before + dropped_spans
             if scope._n_breadcrumbs_truncated > 0:
                 previous_total_breadcrumbs = (
-                    len(event["breadcrumbs"]) + scope._n_breadcrumbs_truncated
+                    len(event["breadcrumbs"]["values"]) + scope._n_breadcrumbs_truncated
                 )
+                logging.debug(previous_total_breadcrumbs)
 
         if (
             self.options["attach_stacktrace"]

sentry_sdk/scope.py

@@ -10,7 +10,6 @@
 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
@@ -1394,22 +1393,6 @@ def _apply_breadcrumbs_to_event(self, event, hint, options):
             logger.debug("Error when sorting breadcrumbs", exc_info=err)
             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
-            )
-            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):
         # type: (Event, Hint, Optional[Dict[str, Any]]) -> None
         if event.get("user") is None and self._user is not None:

tests/test_scrubber.py

@@ -120,14 +120,13 @@ def test_stack_var_scrubbing(sentry_init, capture_events):
 
 def test_breadcrumb_extra_scrubbing(sentry_init, capture_events):
     sentry_init(max_breadcrumbs=2)
-    breakpoint()
+    # breakpoint()
     events = capture_events()
     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
@@ -139,11 +138,11 @@ def test_breadcrumb_extra_scrubbing(sentry_init, capture_events):
 
     assert event["_meta"]["extra"]["auth"] == {"": {"rem": [["!config", "s"]]}}
     assert event["_meta"]["breadcrumbs"] == {
+        "": {"len": 3},
         "values": {
-            "": {"len": [4]},
             "0": {"data": {"auth": {"": {"rem": [["!config", "s"]]}}}},
             "1": {"data": {"password": {"": {"rem": [["!config", "s"]]}}}},
-        }
+        },
     }