capture_items

Author: sentrivana

tests/conftest.py

@@ -7,6 +7,7 @@
 import brotli
 import gzip
 import io
+from dataclasses import dataclass
 from threading import Thread
 from contextlib import contextmanager
 from http.server import BaseHTTPRequestHandler, HTTPServer
@@ -320,6 +321,47 @@ def append_envelope(envelope):
     return inner
 
 
+@dataclass
+class UnwrappedItem:
+    type: str
+    payload: dict
+
+
+@pytest.fixture
+def capture_items(monkeypatch):
+    """Capture envelope payload, unfurling individual items."""
+
+    def inner(types=None):
+        telemetry = []
+        test_client = sentry_sdk.get_client()
+        old_capture_envelope = test_client.transport.capture_envelope
+
+        def append_envelope(envelope):
+            for item in envelope:
+                if types is None or item.type not in types:
+                    continue
+
+                if item.type in ("metric", "log", "span"):
+                    for json in item.payload.json["items"]:
+                        t = {k: v for k, v in json.items() if k != "attributes"}
+                        t["attributes"] = {
+                            k: v["value"] for k, v in json["attributes"].items()
+                        }
+                        telemetry.append(UnwrappedItem(type=item.type, payload=t))
+                else:
+                    telemetry.append(
+                        UnwrappedItem(type=item.type, payload=item.payload.json)
+                    )
+
+            return old_capture_envelope(envelope)
+
+        monkeypatch.setattr(test_client.transport, "capture_envelope", append_envelope)
+
+        return telemetry
+
+    return inner
+
+
 @pytest.fixture
 def capture_record_lost_event_calls(monkeypatch):
     def inner():

tests/integrations/asgi/test_asgi.py

@@ -6,7 +6,6 @@
 from sentry_sdk.tracing import TransactionSource
 from sentry_sdk.integrations._asgi_common import _get_ip, _get_headers
 from sentry_sdk.integrations.asgi import SentryAsgiMiddleware, _looks_like_asgi3
-from tests.conftest import envelopes_to_spans
 
 from async_asgi_testclient import TestClient
 
@@ -166,17 +165,18 @@ def test_invalid_transaction_style(asgi3_app):
 
 @pytest.mark.asyncio
 @pytest.mark.parametrize(
-    ("span_streaming"),
-    (True, False),
+    "span_streaming",
+    [True, False],
 )
 async def test_capture_transaction(
     sentry_init,
     asgi3_app,
     capture_events,
-    capture_envelopes,
+    capture_items,
     span_streaming,
 ):
     sentry_init(
+        send_default_pii=True,
         traces_sample_rate=1.0,
         _experiments={
             "trace_lifecycle": "stream" if span_streaming else "static",
@@ -186,17 +186,16 @@ async def test_capture_transaction(
 
     async with TestClient(app) as client:
         if span_streaming:
-            envelopes = capture_envelopes()
+            items = capture_items(["span"])
         else:
             events = capture_events()
         await client.get("/some_url?somevalue=123")
 
     sentry_sdk.flush()
 
     if span_streaming:
-        spans = envelopes_to_spans(envelopes)
-        assert len(spans) == 1
-        (span,) = spans
+        assert len(items) == 1
+        span = items[0].payload
 
         assert span["is_segment"] is True
         assert span["name"] == "/some_url"
@@ -234,24 +233,48 @@ async def test_capture_transaction(
 
 
 @pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "span_streaming",
+    [True, False],
+)
 async def test_capture_transaction_with_error(
     sentry_init,
     asgi3_app_with_error,
     capture_events,
+    capture_items,
     DictionaryContaining,  # noqa: N803
+    span_streaming,
 ):
-    sentry_init(send_default_pii=True, traces_sample_rate=1.0)
+    sentry_init(
+        send_default_pii=True,
+        traces_sample_rate=1.0,
+        _experiments={
+            "trace_lifecycle": "stream" if span_streaming else "static",
+        },
+    )
+
     app = SentryAsgiMiddleware(asgi3_app_with_error)
 
-    events = capture_events()
+    if span_streaming:
+        items = capture_items(["event", "span"])
+    else:
+        events = capture_events()
+
     with pytest.raises(ZeroDivisionError):
         async with TestClient(app) as client:
             await client.get("/some_url")
 
-    (
-        error_event,
-        transaction_event,
-    ) = events
+    sentry_sdk.flush()
+
+    if span_streaming:
+        assert len(items) == 2
+        assert items[0].type == "event"
+        assert items[1].type == "span"
+
+        error_event = items[0].payload
+        span_item = items[1].payload
+    else:
+        (error_event, transaction_event) = events
 
     assert error_event["transaction"] == "/some_url"
     assert error_event["transaction_info"] == {"source": "url"}
@@ -261,13 +284,22 @@ async def test_capture_transaction_with_error(
     assert error_event["exception"]["values"][0]["mechanism"]["handled"] is False
     assert error_event["exception"]["values"][0]["mechanism"]["type"] == "asgi"
 
-    assert transaction_event["type"] == "transaction"
-    assert transaction_event["contexts"]["trace"] == DictionaryContaining(
-        error_event["contexts"]["trace"]
-    )
-    assert transaction_event["contexts"]["trace"]["status"] == "internal_error"
-    assert transaction_event["transaction"] == error_event["transaction"]
-    assert transaction_event["request"] == error_event["request"]
+    if span_streaming:
+        assert span_item["trace_id"] == error_event["contexts"]["trace"]["trace_id"]
+        assert span_item["span_id"] == error_event["contexts"]["trace"]["span_id"]
+        assert span_item.get("parent_span_id") == error_event["contexts"]["trace"].get(
+            "parent_span_id"
+        )
+        assert span_item["status"] == "error"
+
+    else:
+        assert transaction_event["type"] == "transaction"
+        assert transaction_event["contexts"]["trace"] == DictionaryContaining(
+            error_event["contexts"]["trace"]
+        )
+        assert transaction_event["contexts"]["trace"]["status"] == "internal_error"
+        assert transaction_event["transaction"] == error_event["transaction"]
+        assert transaction_event["request"] == error_event["request"]
 
 
 @pytest.mark.asyncio