add AnnotatedDeque for better handling

Author: shellmayr

sentry_sdk/_types.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING, TypeVar, Union
+from typing import TYPE_CHECKING, Deque, TypeVar, Union
 
 
 # Re-exported for compat, since code out there in the wild might use this variable.
@@ -81,18 +81,53 @@ 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.
+    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_breadcrumbs(cls, breadcrumbs, n_truncated):
-        # type: (list[Breadcrumb], int) -> AnnotatedValue
-        """Breadcrumbs were removed because the number of breadcrumbs exceeded their maximum limit."""
-        return AnnotatedValue(
-            value=breadcrumbs,
+    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
         )
 
-T = TypeVar("T")
-Annotated = Union[AnnotatedValue, T]
-
 if TYPE_CHECKING:
     from collections.abc import Container, MutableMapping, Sequence
 

sentry_sdk/scope.py

@@ -33,7 +33,7 @@
     Transaction,
 )
 from sentry_sdk.utils import (
-    AnnotatedValue,
+    AnnotatedDeque,
     capture_internal_exception,
     capture_internal_exceptions,
     ContextVar,
@@ -1388,12 +1388,13 @@ def _apply_breadcrumbs_to_event(self, event, hint, options):
             pass
 
         # Add annotation that breadcrumbs were truncated
-        original_length = (
-            len(event["breadcrumbs"]["values"]) + self._n_breadcrumbs_truncated
-        )
-        event["breadcrumbs"]["values"] = AnnotatedValue.truncated_breadcrumbs(
-            event["breadcrumbs"]["values"], original_length
-        )
+        if self._n_breadcrumbs_truncated:
+            original_length = (
+                len(event["breadcrumbs"]["values"]) + self._n_breadcrumbs_truncated
+            )
+            event["breadcrumbs"]["values"] = AnnotatedDeque.truncated_breadcrumbs(
+                event["breadcrumbs"]["values"], original_length
+            )
 
     def _apply_user_to_event(self, event, hint, options):
         # type: (Event, Hint, Optional[Dict[str, Any]]) -> None

sentry_sdk/utils.py

@@ -43,6 +43,7 @@
         Callable,
         cast,
         ContextManager,
+        Deque,
         Dict,
         Iterator,
         List,
@@ -59,7 +60,7 @@
 
     from gevent.hub import Hub
 
-    from sentry_sdk._types import Breadcrumb, Event, ExcInfo
+    from sentry_sdk._types import Event, ExcInfo
 
     P = ParamSpec("P")
     R = TypeVar("R")
@@ -411,7 +412,6 @@ def to_header(self):
             rv.append(("sentry_secret", self.secret_key))
         return "Sentry " + ", ".join("%s=%s" % (key, value) for key, value in rv)
 
-
 def get_type_name(cls):
     # type: (Optional[type]) -> Optional[str]
     return getattr(cls, "__qualname__", None) or getattr(cls, "__name__", None)