test(tracing): enhance tests for W3C traceparent header handling across integrations

Author: hangy

tests/integrations/asgi/test_asgi.py

@@ -297,11 +297,21 @@ async def test_trace_from_headers_if_performance_enabled(
 
     trace_id = "582b43a4192642f0b136d5159a501701"
     sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)
+    w3c_trace_header = "00-082b43a4192642f0b136d5159a501701-6e8f22c393e68f19-01"
+
+    # If both sentry-trace and traceparent headers are present, sentry-trace takes precedence.
+    # See: https://github.com/getsentry/team-sdks/issues/41
 
     with pytest.raises(ZeroDivisionError):
         async with TestClient(app) as client:
             events = capture_events()
-            await client.get("/", headers={"sentry-trace": sentry_trace_header})
+            await client.get(
+                "/",
+                headers={
+                    "sentry-trace": sentry_trace_header,
+                    "traceparent": w3c_trace_header,
+                },
+            )
 
     msg_event, error_event, transaction_event = events
 
@@ -330,11 +340,21 @@ async def test_trace_from_headers_if_performance_disabled(
 
     trace_id = "582b43a4192642f0b136d5159a501701"
     sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)
+    w3c_trace_header = "00-082b43a4192642f0b136d5159a501701-6e8f22c393e68f19-01"
+
+    # If both sentry-trace and traceparent headers are present, sentry-trace takes precedence.
+    # See: https://github.com/getsentry/team-sdks/issues/41
 
     with pytest.raises(ZeroDivisionError):
         async with TestClient(app) as client:
             events = capture_events()
-            await client.get("/", headers={"sentry-trace": sentry_trace_header})
+            await client.get(
+                "/",
+                headers={
+                    "sentry-trace": sentry_trace_header,
+                    "traceparent": w3c_trace_header,
+                },
+            )
 
     msg_event, error_event = events
 

tests/integrations/aws_lambda/test_aws_lambda.py

@@ -386,9 +386,41 @@ def test_trace_continuation(lambda_client, test_environment):
 
     # We simulate here AWS Api Gateway's behavior of passing HTTP headers
     # as the `headers` dict in the event passed to the Lambda function.
+    # If both sentry-trace and traceparent headers are present, sentry-trace takes precedence.
+    # See: https://github.com/getsentry/team-sdks/issues/41
     payload = {
         "headers": {
             "sentry-trace": sentry_trace_header,
+            "traceparent": "00-071a43a4192642f0b136d5159a501701-6e8f22c393e68f19-01",
+        }
+    }
+
+    lambda_client.invoke(
+        FunctionName="BasicException",
+        Payload=json.dumps(payload),
+    )
+    envelopes = test_environment["server"].envelopes
+
+    (error_event, transaction_event) = envelopes
+
+    assert (
+        error_event["contexts"]["trace"]["trace_id"]
+        == transaction_event["contexts"]["trace"]["trace_id"]
+        == "471a43a4192642f0b136d5159a501701"
+    )
+
+
+def test_trace_continuation_w3c_traceparent(lambda_client, test_environment):
+    trace_id = "471a43a4192642f0b136d5159a501701"
+    parent_span_id = "6e8f22c393e68f19"
+    parent_sampled = "01"
+    w3c_trace_header = "00-{}-{}-{}".format(trace_id, parent_span_id, parent_sampled)
+
+    # We simulate here AWS Api Gateway's behavior of passing HTTP headers
+    # as the `headers` dict in the event passed to the Lambda function.
+    payload = {
+        "headers": {
+            "traceparent": w3c_trace_header,
         }
     }
 
@@ -516,9 +548,12 @@ def test_error_has_existing_trace_context(
 
     # We simulate here AWS Api Gateway's behavior of passing HTTP headers
     # as the `headers` dict in the event passed to the Lambda function.
+    # If both sentry-trace and traceparent headers are present, sentry-trace takes precedence.
+    # See: https://github.com/getsentry/team-sdks/issues/41
     payload = {
         "headers": {
             "sentry-trace": sentry_trace_header,
+            "traceparent": "00-071a43a4192642f0b136d5159a501701-6e8f22c393e68f19-01",
         }
     }
 
@@ -548,3 +583,47 @@ def test_error_has_existing_trace_context(
             transaction_event["contexts"]["trace"]["trace_id"]
             == "471a43a4192642f0b136d5159a501701"
         )
+
+
+@pytest.mark.parametrize(
+    "lambda_function_name",
+    ["RaiseErrorPerformanceEnabled", "RaiseErrorPerformanceDisabled"],
+)
+def test_error_has_existing_w3c_trace_context(
+    lambda_client, test_environment, lambda_function_name
+):
+    trace_id = "471a43a4192642f0b136d5159a501701"
+    parent_span_id = "6e8f22c393e68f19"
+    parent_sampled = "01"
+    w3c_trace_header = "00-{}-{}-{}".format(trace_id, parent_span_id, parent_sampled)
+
+    # We simulate here AWS Api Gateway's behavior of passing HTTP headers
+    # as the `headers` dict in the event passed to the Lambda function.
+    payload = {"headers": {"traceparent": w3c_trace_header}}
+
+    lambda_client.invoke(
+        FunctionName=lambda_function_name,
+        Payload=json.dumps(payload),
+    )
+    envelopes = test_environment["server"].envelopes
+
+    if lambda_function_name == "RaiseErrorPerformanceEnabled":
+        (error_event, transaction_event) = envelopes
+    else:
+        (error_event,) = envelopes
+        transaction_event = None
+
+    assert "trace" in error_event["contexts"]
+    assert "trace_id" in error_event["contexts"]["trace"]
+    assert (
+        error_event["contexts"]["trace"]["trace_id"]
+        == "471a43a4192642f0b136d5159a501701"
+    )
+
+    if transaction_event:
+        assert "trace" in transaction_event["contexts"]
+        assert "trace_id" in transaction_event["contexts"]["trace"]
+        assert (
+            transaction_event["contexts"]["trace"]["trace_id"]
+            == "471a43a4192642f0b136d5159a501701"
+        )

tests/integrations/gcp/test_gcp.py

@@ -360,7 +360,7 @@ def _safe_is_equal(x, y):
 
 def test_error_has_new_trace_context_performance_enabled(run_cloud_function):
     """
-    Check if an 'trace' context is added to errros and transactions when performance monitoring is enabled.
+    Check if an 'trace' context is added to errors and transactions when performance monitoring is enabled.
     """
     envelope_items, _ = run_cloud_function(
         dedent(
@@ -401,7 +401,7 @@ def cloud_function(functionhandler, event):
 
 def test_error_has_new_trace_context_performance_disabled(run_cloud_function):
     """
-    Check if an 'trace' context is added to errros and transactions when performance monitoring is disabled.
+    Check if an 'trace' context is added to errors and transactions when performance monitoring is disabled.
     """
     envelope_items, _ = run_cloud_function(
         dedent(
@@ -439,13 +439,123 @@ def cloud_function(functionhandler, event):
 
 def test_error_has_existing_trace_context_performance_enabled(run_cloud_function):
     """
-    Check if an 'trace' context is added to errros and transactions
+    Check if an 'trace' context is added to errors and transactions
     from the incoming 'sentry-trace' header when performance monitoring is enabled.
     """
     trace_id = "471a43a4192642f0b136d5159a501701"
     parent_span_id = "6e8f22c393e68f19"
     parent_sampled = 1
     sentry_trace_header = "{}-{}-{}".format(trace_id, parent_span_id, parent_sampled)
+    w3c_trace_header = "00-971a43a4192642f0b136d5159a501701-6e8f22c393e68f19-00"
+
+    # If both sentry-trace and traceparent headers are present, sentry-trace takes precedence.
+    # See: https://github.com/getsentry/team-sdks/issues/41
+
+    envelope_items, _ = run_cloud_function(
+        dedent(
+            """
+        functionhandler = None
+
+        from collections import namedtuple
+        GCPEvent = namedtuple("GCPEvent", ["headers"])
+        event = GCPEvent(headers={"sentry-trace": "%s", "traceparent": "%s"})
+
+        def cloud_function(functionhandler, event):
+            sentry_sdk.capture_message("hi")
+            x = 3/0
+            return "3"
+        """
+            % sentry_trace_header,
+            w3c_trace_header,
+        )
+        + FUNCTIONS_PRELUDE
+        + dedent(
+            """
+        init_sdk(traces_sample_rate=1.0)
+        gcp_functions.worker_v1.FunctionHandler.invoke_user_function(functionhandler, event)
+        """
+        )
+    )
+    (msg_event, error_event, transaction_event) = envelope_items
+
+    assert "trace" in msg_event["contexts"]
+    assert "trace_id" in msg_event["contexts"]["trace"]
+
+    assert "trace" in error_event["contexts"]
+    assert "trace_id" in error_event["contexts"]["trace"]
+
+    assert "trace" in transaction_event["contexts"]
+    assert "trace_id" in transaction_event["contexts"]["trace"]
+
+    assert (
+        msg_event["contexts"]["trace"]["trace_id"]
+        == error_event["contexts"]["trace"]["trace_id"]
+        == transaction_event["contexts"]["trace"]["trace_id"]
+        == "471a43a4192642f0b136d5159a501701"
+    )
+
+
+def test_error_has_existing_w3c_trace_context_performance_disabled(run_cloud_function):
+    """
+    Check if an 'trace' context is added to errors and transactions
+    from the incoming 'traceparent' header when performance monitoring is disabled.
+    """
+    trace_id = "471a43a4192642f0b136d5159a501701"
+    parent_span_id = "6e8f22c393e68f19"
+    parent_sampled = "01"
+    w3c_trace_header = "00-{}-{}-{}".format(trace_id, parent_span_id, parent_sampled)
+
+    # If both sentry-trace and traceparent headers are present, sentry-trace takes precedence.
+    # See: https://github.com/getsentry/team-sdks/issues/41
+
+    envelope_items, _ = run_cloud_function(
+        dedent(
+            """
+        functionhandler = None
+
+        from collections import namedtuple
+        GCPEvent = namedtuple("GCPEvent", ["headers"])
+        event = GCPEvent(headers={"traceparent": "%s"})
+
+        def cloud_function(functionhandler, event):
+            sentry_sdk.capture_message("hi")
+            x = 3/0
+            return "3"
+        """
+            % w3c_trace_header
+        )
+        + FUNCTIONS_PRELUDE
+        + dedent(
+            """
+        init_sdk(traces_sample_rate=None),  # this is the default, just added for clarity
+        gcp_functions.worker_v1.FunctionHandler.invoke_user_function(functionhandler, event)
+        """
+        )
+    )
+    (msg_event, error_event) = envelope_items
+
+    assert "trace" in msg_event["contexts"]
+    assert "trace_id" in msg_event["contexts"]["trace"]
+
+    assert "trace" in error_event["contexts"]
+    assert "trace_id" in error_event["contexts"]["trace"]
+
+    assert (
+        msg_event["contexts"]["trace"]["trace_id"]
+        == error_event["contexts"]["trace"]["trace_id"]
+        == "471a43a4192642f0b136d5159a501701"
+    )
+
+
+def test_error_has_existing_w3c_trace_context_performance_enabled(run_cloud_function):
+    """
+    Check if an 'trace' context is added to errors and transactions
+    from the incoming 'traceparent' header when performance monitoring is enabled.
+    """
+    trace_id = "471a43a4192642f0b136d5159a501701"
+    parent_span_id = "6e8f22c393e68f19"
+    parent_sampled = "01"
+    w3c_trace_header = "00-{}-{}-{}".format(trace_id, parent_span_id, parent_sampled)
 
     envelope_items, _ = run_cloud_function(
         dedent(
@@ -454,14 +564,14 @@ def test_error_has_existing_trace_context_performance_enabled(run_cloud_function
 
         from collections import namedtuple
         GCPEvent = namedtuple("GCPEvent", ["headers"])
-        event = GCPEvent(headers={"sentry-trace": "%s"})
+        event = GCPEvent(headers={"traceparent": "%s"})
 
         def cloud_function(functionhandler, event):
             sentry_sdk.capture_message("hi")
             x = 3/0
             return "3"
         """
-            % sentry_trace_header
+            % w3c_trace_header
         )
         + FUNCTIONS_PRELUDE
         + dedent(
@@ -492,13 +602,13 @@ def cloud_function(functionhandler, event):
 
 def test_error_has_existing_trace_context_performance_disabled(run_cloud_function):
     """
-    Check if an 'trace' context is added to errros and transactions
+    Check if an 'trace' context is added to errors and transactions
     from the incoming 'sentry-trace' header when performance monitoring is disabled.
     """
     trace_id = "471a43a4192642f0b136d5159a501701"
     parent_span_id = "6e8f22c393e68f19"
-    parent_sampled = 1
-    sentry_trace_header = "{}-{}-{}".format(trace_id, parent_span_id, parent_sampled)
+    parent_sampled = "01"
+    w3c_trace_header = "00-{}-{}-{}".format(trace_id, parent_span_id, parent_sampled)
 
     envelope_items, _ = run_cloud_function(
         dedent(
@@ -507,14 +617,14 @@ def test_error_has_existing_trace_context_performance_disabled(run_cloud_functio
 
         from collections import namedtuple
         GCPEvent = namedtuple("GCPEvent", ["headers"])
-        event = GCPEvent(headers={"sentry-trace": "%s"})
+        event = GCPEvent(headers={"traceparent": "%s"})
 
         def cloud_function(functionhandler, event):
             sentry_sdk.capture_message("hi")
             x = 3/0
             return "3"
         """
-            % sentry_trace_header
+            % w3c_trace_header
         )
         + FUNCTIONS_PRELUDE
         + dedent(

tests/integrations/grpc/test_grpc.py

@@ -152,6 +152,53 @@ def test_grpc_server_continues_transaction(sentry_init, capture_events_forksafe)
     assert span["op"] == "test"
 
 
+@pytest.mark.forked
+def test_grpc_server_continues_transaction_from_w3c_traceparent(
+    sentry_init, capture_events_forksafe
+):
+    sentry_init(traces_sample_rate=1.0, integrations=[GRPCIntegration()])
+    events = capture_events_forksafe()
+
+    server, channel = _set_up()
+
+    # Use the provided channel
+    stub = gRPCTestServiceStub(channel)
+
+    with start_transaction() as transaction:
+        metadata = (
+            (
+                "baggage",
+                "sentry-trace_id={trace_id},sentry-environment=test,"
+                "sentry-transaction=test-transaction,sentry-sample_rate=1.0".format(
+                    trace_id=transaction.trace_id
+                ),
+            ),
+            (
+                "traceparent",
+                "00-{trace_id}-{parent_span_id}-{sampled}".format(
+                    trace_id=transaction.trace_id,
+                    parent_span_id=transaction.span_id,
+                    sampled="01",
+                ),
+            ),
+        )
+        stub.TestServe(gRPCTestMessage(text="test"), metadata=metadata)
+
+    _tear_down(server=server)
+
+    events.write_file.close()
+    event = events.read_event()
+    span = event["spans"][0]
+
+    assert event["type"] == "transaction"
+    assert event["transaction_info"] == {
+        "source": "custom",
+    }
+    assert event["contexts"]["trace"]["op"] == OP.GRPC_SERVER
+    assert event["contexts"]["trace"]["trace_id"] == transaction.trace_id
+    assert span["op"] == "test"
+
+
 @pytest.mark.forked
 def test_grpc_client_starts_span(sentry_init, capture_events_forksafe):
     sentry_init(traces_sample_rate=1.0, integrations=[GRPCIntegration()])