fix(breadcrumbs): Fix sorting (#3511)

- best-effort coerce string timestamps into datetimes before sorting
- ignore errors while breadcrumb sorting (better to have unsorted crumbs than breaking anything)

Author: sentrivana

sentry_sdk/scope.py

@@ -30,6 +30,7 @@
     capture_internal_exception,
     capture_internal_exceptions,
     ContextVar,
+    datetime_from_isoformat,
     disable_capture_event,
     event_from_exception,
     exc_info_from_error,
@@ -1307,7 +1308,16 @@ def _apply_breadcrumbs_to_event(self, event, hint, options):
         event.setdefault("breadcrumbs", {}).setdefault("values", []).extend(
             self._breadcrumbs
         )
-        event["breadcrumbs"]["values"].sort(key=lambda crumb: crumb["timestamp"])
+
+        # Attempt to sort timestamps
+        try:
+            for crumb in event["breadcrumbs"]["values"]:
+                if isinstance(crumb["timestamp"], str):
+                    crumb["timestamp"] = datetime_from_isoformat(crumb["timestamp"])
+
+            event["breadcrumbs"]["values"].sort(key=lambda crumb: crumb["timestamp"])
+        except Exception:
+            pass
 
     def _apply_user_to_event(self, event, hint, options):
         # type: (Event, Hint, Optional[Dict[str, Any]]) -> None

sentry_sdk/utils.py

@@ -239,6 +239,15 @@ def format_timestamp(value):
     return utctime.strftime("%Y-%m-%dT%H:%M:%S.%fZ")
 
 
+def datetime_from_isoformat(value):
+    # type: (str) -> datetime
+    try:
+        return datetime.fromisoformat(value)
+    except AttributeError:
+        # py 3.6
+        return datetime.strptime(value, "%Y-%m-%dT%H:%M:%S.%f")
+
+
 def event_hint_with_exc_info(exc_info=None):
     # type: (Optional[ExcInfo]) -> Dict[str, Optional[ExcInfo]]
     """Creates a hint with the exc info filled in."""

tests/test_basics.py

@@ -425,6 +425,37 @@ def test_breadcrumb_ordering(sentry_init, capture_events):
     assert timestamps_from_event == sorted(timestamps)
 
 
+def test_breadcrumb_ordering_different_types(sentry_init, capture_events):
+    sentry_init()
+    events = capture_events()
+
+    timestamps = [
+        datetime.datetime.now() - datetime.timedelta(days=10),
+        datetime.datetime.now() - datetime.timedelta(days=8),
+        datetime.datetime.now() - datetime.timedelta(days=12),
+    ]
+
+    for i, timestamp in enumerate(timestamps):
+        add_breadcrumb(
+            message="Authenticated at %s" % timestamp,
+            category="auth",
+            level="info",
+            timestamp=timestamp if i % 2 == 0 else timestamp.isoformat(),
+        )
+
+    capture_exception(ValueError())
+    (event,) = events
+
+    assert len(event["breadcrumbs"]["values"]) == len(timestamps)
+    timestamps_from_event = [
+        datetime.datetime.strptime(
+            x["timestamp"].replace("Z", ""), "%Y-%m-%dT%H:%M:%S.%f"
+        )
+        for x in event["breadcrumbs"]["values"]
+    ]
+    assert timestamps_from_event == sorted(timestamps)
+
+
 def test_attachments(sentry_init, capture_envelopes):
     sentry_init()
     envelopes = capture_envelopes()