Fix Redis tests for potel (#3838)

* Make sure only spans are created, not transactions
getsentry · Dec 4, 2024 · a05086f · a05086f
1 parent 8b70a66
commit a05086f
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 43 deletions.
diff --git a/sentry_sdk/integrations/redis/_sync_common.py b/sentry_sdk/integrations/redis/_sync_common.py
@@ -88,6 +88,7 @@ def sentry_patched_execute_command(self, name, *args, **kwargs):
                 op=cache_properties["op"],
                 name=cache_properties["description"],
                 origin=SPAN_ORIGIN,
+                only_if_parent=True,
             )
             cache_span.__enter__()
 
@@ -97,6 +98,7 @@ def sentry_patched_execute_command(self, name, *args, **kwargs):
             op=db_properties["op"],
             name=db_properties["description"],
             origin=SPAN_ORIGIN,
+            only_if_parent=True,
         )
         db_span.__enter__()
 

diff --git a/tests/integrations/redis/asyncio/test_redis_asyncio.py b/tests/integrations/redis/asyncio/test_redis_asyncio.py
@@ -1,6 +1,6 @@
 import pytest
 
-from sentry_sdk import capture_message, start_transaction
+import sentry_sdk
 from sentry_sdk.consts import SPANDATA
 from sentry_sdk.integrations.redis import RedisIntegration
 from tests.conftest import ApproxDict
@@ -16,7 +16,7 @@ async def test_async_basic(sentry_init, capture_events):
     connection = FakeRedis()
 
     await connection.get("foobar")
-    capture_message("hi")
+    sentry_sdk.capture_message("hi")
 
     (event,) = events
     (crumb,) = event["breadcrumbs"]["values"]
@@ -54,7 +54,7 @@ async def test_async_redis_pipeline(
     events = capture_events()
 
     connection = FakeRedis()
-    with start_transaction():
+    with sentry_sdk.start_span():
         pipeline = connection.pipeline(transaction=is_transaction)
         pipeline.get("foo")
         pipeline.set("bar", 1)
@@ -92,7 +92,7 @@ async def test_async_span_origin(sentry_init, capture_events):
     events = capture_events()
 
     connection = FakeRedis()
-    with start_transaction(name="custom_transaction"):
+    with sentry_sdk.start_span(name="custom_transaction"):
         # default case
         await connection.set("somekey", "somevalue")
 

diff --git a/tests/integrations/redis/cluster/test_redis_cluster.py b/tests/integrations/redis/cluster/test_redis_cluster.py
@@ -1,7 +1,7 @@
 import pytest
-from sentry_sdk import capture_message
+
+import sentry_sdk
 from sentry_sdk.consts import SPANDATA
-from sentry_sdk.api import start_transaction
 from sentry_sdk.integrations.redis import RedisIntegration
 from tests.conftest import ApproxDict
 
@@ -27,7 +27,7 @@ def test_rediscluster_breadcrumb(sentry_init, capture_events):
 
     rc = redis.RedisCluster(host="localhost", port=6379)
     rc.get("foobar")
-    capture_message("hi")
+    sentry_sdk.capture_message("hi")
 
     (event,) = events
     crumbs = event["breadcrumbs"]["values"]
@@ -68,7 +68,7 @@ def test_rediscluster_basic(sentry_init, capture_events, send_default_pii, descr
     )
     events = capture_events()
 
-    with start_transaction():
+    with sentry_sdk.start_span():
         rc = redis.RedisCluster(host="localhost", port=6379)
         rc.set("bar", 1)
 
@@ -117,7 +117,7 @@ def test_rediscluster_pipeline(
     events = capture_events()
 
     rc = redis.RedisCluster(host="localhost", port=6379)
-    with start_transaction():
+    with sentry_sdk.start_span():
         pipeline = rc.pipeline()
         pipeline.get("foo")
         pipeline.set("bar", 1)
@@ -152,7 +152,7 @@ def test_rediscluster_span_origin(sentry_init, capture_events):
     events = capture_events()
 
     rc = redis.RedisCluster(host="localhost", port=6379)
-    with start_transaction(name="custom_transaction"):
+    with sentry_sdk.start_span(name="custom_transaction"):
         # default case
         rc.set("somekey", "somevalue")
 

diff --git a/tests/integrations/redis/cluster_asyncio/test_redis_cluster_asyncio.py b/tests/integrations/redis/cluster_asyncio/test_redis_cluster_asyncio.py
@@ -1,6 +1,6 @@
 import pytest
 
-from sentry_sdk import capture_message, start_transaction
+import sentry_sdk
 from sentry_sdk.consts import SPANDATA
 from sentry_sdk.integrations.redis import RedisIntegration
 from tests.conftest import ApproxDict
@@ -40,7 +40,7 @@ async def test_async_breadcrumb(sentry_init, capture_events):
     connection = cluster.RedisCluster(host="localhost", port=6379)
 
     await connection.get("foobar")
-    capture_message("hi")
+    sentry_sdk.capture_message("hi")
 
     (event,) = events
     (crumb,) = event["breadcrumbs"]["values"]
@@ -78,7 +78,7 @@ async def test_async_basic(sentry_init, capture_events, send_default_pii, descri
     events = capture_events()
 
     connection = cluster.RedisCluster(host="localhost", port=6379)
-    with start_transaction():
+    with sentry_sdk.start_span():
         await connection.set("bar", 1)
 
     (event,) = events
@@ -120,7 +120,7 @@ async def test_async_redis_pipeline(
     events = capture_events()
 
     connection = cluster.RedisCluster(host="localhost", port=6379)
-    with start_transaction():
+    with sentry_sdk.start_span():
         pipeline = connection.pipeline()
         pipeline.get("foo")
         pipeline.set("bar", 1)
@@ -156,7 +156,7 @@ async def test_async_span_origin(sentry_init, capture_events):
     events = capture_events()
 
     connection = cluster.RedisCluster(host="localhost", port=6379)
-    with start_transaction(name="custom_transaction"):
+    with sentry_sdk.start_span(name="custom_transaction"):
         # default case
         await connection.set("somekey", "somevalue")
 

diff --git a/tests/integrations/redis/test_redis.py b/tests/integrations/redis/test_redis.py
@@ -3,7 +3,7 @@
 import pytest
 from fakeredis import FakeStrictRedis
 
-from sentry_sdk import capture_message, start_transaction
+import sentry_sdk
 from sentry_sdk.consts import SPANDATA
 from sentry_sdk.integrations.redis import RedisIntegration
 
@@ -23,7 +23,7 @@ def test_basic(sentry_init, capture_events):
     connection = FakeStrictRedis()
 
     connection.get("foobar")
-    capture_message("hi")
+    sentry_sdk.capture_message("hi")
 
     (event,) = events
     (crumb,) = event["breadcrumbs"]["values"]
@@ -60,7 +60,7 @@ def test_redis_pipeline(
     events = capture_events()
 
     connection = FakeStrictRedis()
-    with start_transaction():
+    with sentry_sdk.start_span():
         pipeline = connection.pipeline(transaction=is_transaction)
         pipeline.get("foo")
         pipeline.set("bar", 1)
@@ -94,7 +94,7 @@ def test_sensitive_data(sentry_init, capture_events, render_span_tree):
         events = capture_events()
 
         connection = FakeStrictRedis()
-        with start_transaction():
+        with sentry_sdk.start_span():
             connection.get(
                 "this is super secret"
             )  # because fakeredis does not support AUTH we use GET instead
@@ -103,7 +103,7 @@ def test_sensitive_data(sentry_init, capture_events, render_span_tree):
         assert (
             render_span_tree(event)
             == """\
-- op="": description=null
+- op="<unlabeled span>": description=null
   - op="db.redis": description="GET [Filtered]"\
 """
         )
@@ -117,7 +117,7 @@ def test_pii_data_redacted(sentry_init, capture_events, render_span_tree):
     events = capture_events()
 
     connection = FakeStrictRedis()
-    with start_transaction():
+    with sentry_sdk.start_span():
         connection.set("somekey1", "my secret string1")
         connection.set("somekey2", "my secret string2")
         connection.get("somekey2")
@@ -127,7 +127,7 @@ def test_pii_data_redacted(sentry_init, capture_events, render_span_tree):
     assert (
         render_span_tree(event)
         == """\
-- op="": description=null
+- op="<unlabeled span>": description=null
   - op="db.redis": description="SET 'somekey1' [Filtered]"
   - op="db.redis": description="SET 'somekey2' [Filtered]"
   - op="db.redis": description="GET 'somekey2'"
@@ -145,7 +145,7 @@ def test_pii_data_sent(sentry_init, capture_events, render_span_tree):
     events = capture_events()
 
     connection = FakeStrictRedis()
-    with start_transaction():
+    with sentry_sdk.start_span():
         connection.set("somekey1", "my secret string1")
         connection.set("somekey2", "my secret string2")
         connection.get("somekey2")
@@ -155,7 +155,7 @@ def test_pii_data_sent(sentry_init, capture_events, render_span_tree):
     assert (
         render_span_tree(event)
         == """\
-- op="": description=null
+- op="<unlabeled span>": description=null
   - op="db.redis": description="SET 'somekey1' 'my secret string1'"
   - op="db.redis": description="SET 'somekey2' 'my secret string2'"
   - op="db.redis": description="GET 'somekey2'"
@@ -173,7 +173,7 @@ def test_data_truncation(sentry_init, capture_events, render_span_tree):
     events = capture_events()
 
     connection = FakeStrictRedis()
-    with start_transaction():
+    with sentry_sdk.start_span():
         long_string = "a" * 100000
         connection.set("somekey1", long_string)
         short_string = "b" * 10
@@ -183,7 +183,7 @@ def test_data_truncation(sentry_init, capture_events, render_span_tree):
     assert (
         render_span_tree(event)
         == f"""\
-- op="": description=null
+- op="<unlabeled span>": description=null
   - op="db.redis": description="SET 'somekey1' '{long_string[: 1024 - len("...") - len("SET 'somekey1' '")]}..."
   - op="db.redis": description="SET 'somekey2' 'bbbbbbbbbb'"\
 """  # noqa:  E221
@@ -199,7 +199,7 @@ def test_data_truncation_custom(sentry_init, capture_events, render_span_tree):
     events = capture_events()
 
     connection = FakeStrictRedis()
-    with start_transaction():
+    with sentry_sdk.start_span():
         long_string = "a" * 100000
         connection.set("somekey1", long_string)
         short_string = "b" * 10
@@ -209,7 +209,7 @@ def test_data_truncation_custom(sentry_init, capture_events, render_span_tree):
     assert (
         render_span_tree(event)
         == f"""\
-- op="": description=null
+- op="<unlabeled span>": description=null
   - op="db.redis": description="SET 'somekey1' '{long_string[: 30 - len("...") - len("SET 'somekey1' '")]}..."
   - op="db.redis": description="SET 'somekey2' '{short_string}'"\
 """  # noqa:  E221
@@ -230,7 +230,7 @@ def test_breadcrumbs(sentry_init, capture_events):
     short_string = "b" * 10
     connection.set("somekey2", short_string)
 
-    capture_message("hi")
+    sentry_sdk.capture_message("hi")
 
     (event,) = events
     crumbs = event["breadcrumbs"]["values"]
@@ -268,7 +268,7 @@ def test_db_connection_attributes_client(sentry_init, capture_events):
     )
     events = capture_events()
 
-    with start_transaction():
+    with sentry_sdk.start_span():
         connection = FakeStrictRedis(connection_pool=MOCK_CONNECTION_POOL)
         connection.get("foobar")
 
@@ -290,7 +290,7 @@ def test_db_connection_attributes_pipeline(sentry_init, capture_events):
     )
     events = capture_events()
 
-    with start_transaction():
+    with sentry_sdk.start_span():
         connection = FakeStrictRedis(connection_pool=MOCK_CONNECTION_POOL)
         pipeline = connection.pipeline(transaction=False)
         pipeline.get("foo")
@@ -317,7 +317,7 @@ def test_span_origin(sentry_init, capture_events):
     events = capture_events()
 
     connection = FakeStrictRedis()
-    with start_transaction(name="custom_transaction"):
+    with sentry_sdk.start_span(name="custom_transaction"):
         # default case
         connection.set("somekey", "somevalue")
 

diff --git a/tests/integrations/redis/test_redis_cache_module.py b/tests/integrations/redis/test_redis_cache_module.py
@@ -31,7 +31,7 @@ def test_no_cache_basic(sentry_init, capture_events, render_span_tree):
     assert (
         render_span_tree(event)
         == """\
-- op="": description=null
+- op="<unlabeled span>": description=null
   - op="db.redis": description="GET 'mycachekey'"\
 """
     )
@@ -61,7 +61,7 @@ def test_cache_basic(sentry_init, capture_events, render_span_tree):
     assert (
         render_span_tree(event)
         == """\
-- op="": description=null
+- op="<unlabeled span>": description=null
   - op="db.redis": description="HGET 'mycachekey' [Filtered]"
   - op="cache.get": description="mycachekey"
     - op="db.redis": description="GET 'mycachekey'"
@@ -97,7 +97,7 @@ def test_cache_keys(sentry_init, capture_events, render_span_tree):
     assert (
         render_span_tree(event)
         == """\
-- op="": description=null
+- op="<unlabeled span>": description=null
   - op="db.redis": description="GET 'somethingelse'"
   - op="cache.get": description="blub"
     - op="db.redis": description="GET 'blub'"

diff --git a/tests/integrations/redis/test_redis_cache_module_async.py b/tests/integrations/redis/test_redis_cache_module_async.py
@@ -31,14 +31,14 @@ async def test_no_cache_basic(sentry_init, capture_events, render_span_tree):
     events = capture_events()
 
     connection = FakeRedisAsync()
-    with sentry_sdk.start_transaction():
+    with sentry_sdk.start_span():
         await connection.get("myasynccachekey")
 
     (event,) = events
     assert (
         render_span_tree(event)
         == """\
-- op="": description=null
+- op="<unlabeled span>": description=null
   - op="db.redis": description="GET 'myasynccachekey'"\
 """
     )
@@ -57,14 +57,14 @@ async def test_cache_basic(sentry_init, capture_events, render_span_tree):
     events = capture_events()
 
     connection = FakeRedisAsync()
-    with sentry_sdk.start_transaction():
+    with sentry_sdk.start_span():
         await connection.get("myasynccachekey")
 
     (event,) = events
     assert (
         render_span_tree(event)
         == """\
-- op="": description=null
+- op="<unlabeled span>": description=null
   - op="cache.get": description="myasynccachekey"
     - op="db.redis": description="GET 'myasynccachekey'"\
 """
@@ -84,7 +84,7 @@ async def test_cache_keys(sentry_init, capture_events, render_span_tree):
     events = capture_events()
 
     connection = FakeRedisAsync()
-    with sentry_sdk.start_transaction():
+    with sentry_sdk.start_span():
         await connection.get("asomethingelse")
         await connection.get("ablub")
         await connection.get("ablubkeything")
@@ -94,7 +94,7 @@ async def test_cache_keys(sentry_init, capture_events, render_span_tree):
     assert (
         render_span_tree(event)
         == """\
-- op="": description=null
+- op="<unlabeled span>": description=null
   - op="db.redis": description="GET 'asomethingelse'"
   - op="cache.get": description="ablub"
     - op="db.redis": description="GET 'ablub'"
@@ -118,7 +118,7 @@ async def test_cache_data(sentry_init, capture_events):
     events = capture_events()
 
     connection = FakeRedisAsync(host="mycacheserver.io", port=6378)
-    with sentry_sdk.start_transaction():
+    with sentry_sdk.start_span():
         await connection.get("myasynccachekey")
         await connection.set("myasynccachekey", "事实胜于雄辩")
         await connection.get("myasynccachekey")

diff --git a/tox.ini b/tox.ini
@@ -403,7 +403,7 @@ deps =
 
     # Django
     django: psycopg2-binary
-    django-v{1.11,2.0,2.1,2.2,3.0,3.1,3.2}: djangorestframework>=3.0.0,<4.0.0
+    django-v{1.11,2.0,2.2,3.0,3.1,3.2}: djangorestframework>=3.0.0,<4.0.0
     django-v{2.0,2.2,3.0,3.2,4.0,4.1,4.2,5.0,5.1}: channels[daphne]
     django-v{2.2,3.0}: six
     django-v{1.11,2.0,2.2,3.0,3.2}: Werkzeug<2.1.0