Merge pull request #464 from wangzlei/master

fix log stack overflow if metadata contains circular reference

Author: wangzlei

aws_xray_sdk/core/utils/conversion.py

@@ -30,6 +30,7 @@ def metadata_to_dict(obj):
             return metadata
         else:
             return obj
-    except Exception:
-        log.exception("Failed to convert metadata to dict")
+    except Exception as e:
+        import pprint
+        log.warning("Failed to convert metadata to dict:\n%s", pprint.pformat(getattr(e, "args", None)))
         return {}

tests/util.py

@@ -4,6 +4,14 @@
 from aws_xray_sdk.core.recorder import AWSXRayRecorder
 from aws_xray_sdk.core.emitters.udp_emitter import UDPEmitter
 from aws_xray_sdk.core.sampling.sampler import DefaultSampler
+from aws_xray_sdk.core.utils.conversion import metadata_to_dict
+
+
+class CircularReferenceClass:
+    """Test class that can create circular references"""
+    def __init__(self, name):
+        self.name = name
+        self.ref = None
 
 
 class StubbedEmitter(UDPEmitter):
@@ -99,3 +107,15 @@ def _search_entity_by_annotation(entity, key, value):
                     if result is not None:
                         return result
     return None
+
+
+def test_metadata_to_dict_self_reference():
+    """Test that self-referencing objects don't cause stack overflow"""
+    obj = CircularReferenceClass("self_ref")
+    obj.ref = obj  # Self reference
+    
+    # This should not cause stack overflow
+    result = metadata_to_dict(obj)
+    
+    # The function should handle the self reference gracefully
+    assert isinstance(result, dict)