Merge pull request #166 from honeybadger-io/ignore-tuple-keys

Fix filtering of dictionaries with tuple keys

honeybadger/tests/test_utils.py

@@ -13,3 +13,9 @@ def test_filter_dict_with_nested_dict():
     expected = {'foo': 'bar', 'bar': 'baz', 'nested': {'password': '[FILTERED]'}}
     filter_keys = ['password']
     assert filter_dict(data, filter_keys) == expected
+
+def test_ignores_dict_with_tuple_key():
+    data = {('foo', 'bar'): 'baz', "key": "value"}
+    expected = {"key": "value"}
+    filter_keys = ['foo']
+    assert filter_dict(data, filter_keys) == expected

honeybadger/utils.py

@@ -1,3 +1,4 @@
+import copy
 import json
 
 
@@ -14,7 +15,16 @@ def filter_dict(data, filter_keys):
     if type(data) != dict:
         return data
 
-    for key, value in data.items():
+    data_copy = copy.deepcopy(data)
+
+    for key, value in data_copy.items():
+        # While tuples are considered valid dictionary keys,
+        # they are not json serializable
+        # so we remove them from the dictionary
+        if type(key) == tuple:
+            data.pop(key)
+            continue
+
         if key in filter_keys:
             data[key] = "[FILTERED]"