ref(asyncpg): Move query whitespace normalization into integration

Instead of normalizing span descriptions generically in client.py
before calling before_send_transaction, normalize queries at the source
in the asyncpg integration. This is more correct because the
normalization is specific to SQL query formatting, not a general
concern for all span descriptions.

Remove _clean_span_descriptions from _Client and the generic tests.
Add asyncpg-specific tests for normalized descriptions and
before_send_transaction interaction.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: ericapisani

sentry_sdk/client.py

@@ -7,7 +7,7 @@
 from importlib import import_module
 from typing import TYPE_CHECKING, List, Dict, cast, overload
 import warnings
-import re
+
 from sentry_sdk._compat import check_uwsgi_thread_support
 from sentry_sdk._metrics_batcher import MetricsBatcher
 from sentry_sdk._span_batcher import SpanBatcher
@@ -688,7 +688,6 @@ def _prepare_event(
         ):
             new_event = None
             spans_before = len(cast(List[Dict[str, object]], event.get("spans", [])))
-            self._clean_span_descriptions(event)
             with capture_internal_exceptions():
                 new_event = before_send_transaction(event, hint or {})
             if new_event is None:
@@ -713,12 +712,6 @@ def _prepare_event(
 
         return event
 
-    def _clean_span_descriptions(self, event: "Event") -> None:
-        for s in event.get("spans", []):
-            if "description" in s:
-                cleaned_description = re.sub(r"\s+", " ", s["description"]).strip()
-                s["description"] = cleaned_description
-
     def _is_ignored_error(self, event: "Event", hint: "Hint") -> bool:
         exc_info = hint.get("exc_info")
         if exc_info is None:

sentry_sdk/integrations/asyncpg.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 import contextlib
+import re
 from typing import Any, TypeVar, Callable, Awaitable, Iterator
 
 import sentry_sdk
@@ -55,6 +56,10 @@ def setup_once() -> None:
 T = TypeVar("T")
 
 
+def _normalize_query(query: str) -> str:
+    return re.sub(r"\s+", " ", query).strip()
+
+
 def _wrap_execute(f: "Callable[..., Awaitable[T]]") -> "Callable[..., Awaitable[T]]":
     async def _inner(*args: "Any", **kwargs: "Any") -> "T":
         if sentry_sdk.get_client().get_integration(AsyncPGIntegration) is None:
@@ -67,7 +72,7 @@ async def _inner(*args: "Any", **kwargs: "Any") -> "T":
         if len(args) > 2:
             return await f(*args, **kwargs)
 
-        query = args[1]
+        query = _normalize_query(args[1])
         with record_sql_queries(
             cursor=None,
             query=query,
@@ -103,6 +108,7 @@ def _record(
 
     param_style = "pyformat" if params_list else None
 
+    query = _normalize_query(query)
     with record_sql_queries(
         cursor=cursor,
         query=query,

tests/integrations/asyncpg/test_asyncpg.py

@@ -463,10 +463,7 @@ async def test_connection_pool(sentry_init, capture_events) -> None:
         {
             "category": "query",
             "data": {},
-            "message": "SELECT pg_advisory_unlock_all();\n"
-            "CLOSE ALL;\n"
-            "UNLISTEN *;\n"
-            "RESET ALL;",
+            "message": "SELECT pg_advisory_unlock_all(); CLOSE ALL; UNLISTEN *; RESET ALL;",
             "type": "default",
         },
         {
@@ -478,10 +475,7 @@ async def test_connection_pool(sentry_init, capture_events) -> None:
         {
             "category": "query",
             "data": {},
-            "message": "SELECT pg_advisory_unlock_all();\n"
-            "CLOSE ALL;\n"
-            "UNLISTEN *;\n"
-            "RESET ALL;",
+            "message": "SELECT pg_advisory_unlock_all(); CLOSE ALL; UNLISTEN *; RESET ALL;",
             "type": "default",
         },
     ]
@@ -786,3 +780,79 @@ async def test_span_origin(sentry_init, capture_events):
 
     for span in event["spans"]:
         assert span["origin"] == "auto.db.asyncpg"
+
+
+@pytest.mark.asyncio
+async def test_multiline_query_description_normalized(sentry_init, capture_events):
+    sentry_init(
+        integrations=[AsyncPGIntegration()],
+        traces_sample_rate=1.0,
+    )
+    events = capture_events()
+
+    with start_transaction(name="test_transaction"):
+        conn: Connection = await connect(PG_CONNECTION_URI)
+        await conn.execute(
+            """
+            SELECT
+                id,
+                name
+            FROM
+                users
+            WHERE
+                name = 'Alice'
+            """
+        )
+        await conn.close()
+
+    (event,) = events
+
+    spans = [
+        s
+        for s in event["spans"]
+        if s["op"] == "db" and "SELECT" in s.get("description", "")
+    ]
+    assert len(spans) == 1
+    assert spans[0]["description"] == "SELECT id, name FROM users WHERE name = 'Alice'"
+
+
+@pytest.mark.asyncio
+async def test_before_send_transaction_sees_normalized_description(
+    sentry_init, capture_events
+):
+    def before_send_transaction(event, hint):
+        for span in event.get("spans", []):
+            desc = span.get("description", "")
+            if "SELECT id, name FROM users" in desc:
+                span["description"] = "filtered"
+        return event
+
+    sentry_init(
+        integrations=[AsyncPGIntegration()],
+        traces_sample_rate=1.0,
+        before_send_transaction=before_send_transaction,
+    )
+    events = capture_events()
+
+    with start_transaction(name="test_transaction"):
+        conn: Connection = await connect(PG_CONNECTION_URI)
+        await conn.execute(
+            """
+            SELECT
+                id,
+                name
+            FROM
+                users
+            """
+        )
+        await conn.close()
+
+    (event,) = events
+    spans = [
+        s
+        for s in event["spans"]
+        if s["op"] == "db" and "filtered" in s.get("description", "")
+    ]
+
+    assert len(spans) == 1
+    assert spans[0]["description"] == "filtered"

tests/test_basics.py

@@ -185,85 +185,6 @@ def before_send_transaction(event, hint):
     assert event["extra"] == {"before_send_transaction_called": True}
 
 
-def test_before_send_transaction_span_description_contains_newlines(
-    sentry_init, capture_events
-):
-    def before_send_transaction(event, hint):
-        for span in event.get("spans", []):
-            if (
-                span.get("description", "")
-                == "SELECT u.id, u.name, u.email FROM users;"
-            ):
-                span["description"] = "filtered"
-        return event
-
-    sentry_init(
-        before_send_transaction=before_send_transaction,
-        traces_sample_rate=1.0,
-    )
-    events = capture_events()
-
-    description = "SELECT u.id,\n    u.name,\n    u.email\n    FROM users;"
-
-    with start_transaction(name="test_transaction"):
-        with sentry_sdk.start_span(op="db", description=description):
-            pass
-
-    (event,) = events
-    assert event["transaction"] == "test_transaction"
-
-    spans = event["spans"]
-    assert len(spans) == 1
-    assert spans[0]["description"] == "filtered"
-    assert spans[0]["op"] == "db"
-
-
-def test_before_send_transaction_span_description_contains_multiple_lines(
-    sentry_init, capture_events
-):
-    def before_send_transaction(event, hint):
-        for span in event.get("spans", []):
-            if (
-                span.get("description", "")
-                == "SELECT u.id, u.name, u.email, p.title AS post_title, p.created_at AS post_date FROM users u JOIN posts p ON u.id = p.user_id WHERE u.active = true ORDER BY p.created_at DESC"
-            ):
-                span["description"] = "no bueno"
-        return event
-
-    sentry_init(
-        before_send_transaction=before_send_transaction,
-        traces_sample_rate=1.0,
-    )
-    events = capture_events()
-
-    description = """SELECT
-    u.id,
-    u.name,
-    u.email,
-    p.title AS post_title,
-    p.created_at AS post_date
-FROM
-    users u
-JOIN
-    posts p ON u.id = p.user_id
-WHERE
-    u.active = true
-ORDER BY
-    p.created_at DESC"""
-
-    with start_transaction(name="test_transaction"):
-        with sentry_sdk.start_span(op="db", description=description):
-            pass
-
-    (event,) = events
-    assert event["transaction"] == "test_transaction"
-
-    spans = event["spans"]
-    assert len(spans) == 1
-    assert spans[0]["description"] == "no bueno"
-    assert spans[0]["op"] == "db"
-
-
 def test_option_before_send_transaction_discard(sentry_init, capture_events):
     def before_send_transaction_discard(event, hint):
         return None