test(tracing): TODO

Author: rominf

sentry_sdk/tracing_utils.py

@@ -170,6 +170,14 @@ def maybe_create_breadcrumbs_from_span(scope, span):
         )
 
 
+def _get_frame_module_abs_path(frame):
+    # type: (FrameType) -> str
+    try:
+        return frame.f_code.co_filename
+    except Exception:
+        return ""
+
+
 def add_query_source(span):
     # type: (sentry_sdk.tracing.Span) -> None
     """
@@ -200,10 +208,7 @@ def add_query_source(span):
     # Find the correct frame
     frame = sys._getframe()  # type: Union[FrameType, None]
     while frame is not None:
-        try:
-            abs_path = frame.f_code.co_filename
-        except Exception:
-            abs_path = ""
+        abs_path = _get_frame_module_abs_path(frame)
 
         try:
             namespace = frame.f_globals.get("__name__")  # type: Optional[str]
@@ -250,10 +255,7 @@ def add_query_source(span):
         if namespace is not None:
             span.set_data(SPANDATA.CODE_NAMESPACE, namespace)
 
-        try:
-            filepath = frame.f_code.co_filename
-        except Exception:
-            filepath = None
+        filepath = _get_frame_module_abs_path(frame)
         if filepath is not None:
             if namespace is not None:
                 in_app_path = filename_for_module(namespace, filepath)

tests/integrations/django/test_db_query_data.py

@@ -1,7 +1,10 @@
+import contextlib
 import os
+import sys
 
 import pytest
 from datetime import datetime
+from pathlib import Path
 from unittest import mock
 
 from django import VERSION as DJANGO_VERSION
@@ -17,7 +20,8 @@
 from sentry_sdk import start_transaction
 from sentry_sdk.consts import SPANDATA
 from sentry_sdk.integrations.django import DjangoIntegration
-from sentry_sdk.tracing_utils import record_sql_queries
+from sentry_sdk.tracing_utils import _get_frame_module_abs_path, record_sql_queries
+from sentry_sdk.utils import _module_in_list
 
 from tests.conftest import unpack_werkzeug_response
 from tests.integrations.django.utils import pytest_mark_django_db_decorator
@@ -283,7 +287,10 @@ def test_query_source_with_in_app_exclude(sentry_init, client, capture_events):
 
 @pytest.mark.forked
 @pytest_mark_django_db_decorator(transaction=True)
-def test_query_source_with_in_app_include(sentry_init, client, capture_events):
+@pytest.mark.parametrize("django_outside_of_project_root", [False, True])
+def test_query_source_with_in_app_include(
+    sentry_init, client, capture_events, django_outside_of_project_root
+):
     sentry_init(
         integrations=[DjangoIntegration()],
         send_default_pii=True,
@@ -301,8 +308,35 @@ def test_query_source_with_in_app_include(sentry_init, client, capture_events):
 
     events = capture_events()
 
-    _, status, _ = unpack_werkzeug_response(client.get(reverse("postgres_select_orm")))
-    assert status == "200 OK"
+    # Simulate Django installation outside of the project root
+    original_get_frame_module_abs_path = _get_frame_module_abs_path
+
+    def patched_get_frame_module_abs_path_function(frame):
+        result = original_get_frame_module_abs_path(frame)
+        namespace = frame.f_globals.get("__name__")
+        print(f"{namespace=}")
+        print(f"{_module_in_list(namespace, ["django"])=}")
+        if _module_in_list(namespace, ["django"]):
+            print(f"{frame.f_code.co_filename=}")
+            result = str(
+                Path("/outside-of-project-root") / frame.f_code.co_filename[1:]
+            )
+        return result
+
+    patched_get_frame_module_abs_path = (
+        mock.patch(
+            "sentry_sdk.tracing_utils._get_frame_module_abs_path",
+            patched_get_frame_module_abs_path_function,
+        )
+        if django_outside_of_project_root
+        else contextlib.suppress()
+    )
+
+    with patched_get_frame_module_abs_path:
+        _, status, _ = unpack_werkzeug_response(
+            client.get(reverse("postgres_select_orm"))
+        )
+        assert status == "200 OK"
 
     (event,) = events
     for span in event["spans"]: