Handle non-utf8 bytes

Author: sentrivana

sentry_sdk/integrations/redis/utils.py

@@ -44,12 +44,23 @@ def _get_safe_command(name, args):
     return command
 
 
+def _safe_decode(key):
+    # type: (Any) -> str
+    if isinstance(key, bytes):
+        try:
+            return key.decode()
+        except UnicodeDecodeError:
+            return ""
+
+    return key
+
+
 def _key_as_string(key):
     # type: (Any) -> str
     if isinstance(key, (dict, list, tuple)):
-        key = ", ".join(x.decode() if isinstance(x, bytes) else x for x in key)
+        key = ", ".join(_safe_decode(x) for x in key)
     elif isinstance(key, bytes):
-        key = key.decode()
+        key = _safe_decode(key)
     elif key is None:
         key = ""
     else:

tests/integrations/django/test_cache_module.py

@@ -1,9 +1,9 @@
-import pytest
 import os
 import random
+import uuid
 
+import pytest
 from django import VERSION as DJANGO_VERSION
-
 from werkzeug.test import Client
 
 try:
@@ -358,6 +358,7 @@ def test_cache_spans_templatetag(
         ("get", None, None, ""),
         ("get", [], {}, ""),
         ("get", ["bla", "blub", "foo"], {}, "bla"),
+        ("get", [uuid.uuid4().bytes], {}, ""),
         (
             "get_many",
             [["bla1", "bla2", "bla3"], "blub", "foo"],

tests/integrations/redis/test_redis_cache_module.py

@@ -1,3 +1,5 @@
+import uuid
+
 import pytest
 
 import fakeredis
@@ -230,6 +232,18 @@ def test_cache_data(sentry_init, capture_events):
             {"key": [b"bla", "blub", "foo"]},
             (b"bla", "blub", "foo"),
         ),
+        (
+            "not-important",
+            None,
+            {"key": b"\x00c\x0f\xeaC\xe1L\x1c\xbff\xcb\xcc\xc1\xed\xc6\t"},
+            (b"\x00c\x0f\xeaC\xe1L\x1c\xbff\xcb\xcc\xc1\xed\xc6\t",),
+        ),
+        (
+            "get",
+            [b"\x00c\x0f\xeaC\xe1L\x1c\xbff\xcb\xcc\xc1\xed\xc6\t"],
+            None,
+            (b"\x00c\x0f\xeaC\xe1L\x1c\xbff\xcb\xcc\xc1\xed\xc6\t",),
+        ),
     ],
 )
 def test_get_safe_key(method_name, args, kwargs, expected_key):
@@ -251,6 +265,7 @@ def test_get_safe_key(method_name, args, kwargs, expected_key):
             "bla",
         ),
         (["bla", "blub", "foo"], "bla, blub, foo"),
+        ([uuid.uuid4().bytes], ""),
     ],
 )
 def test_key_as_string(key, expected_key):