Merge branch 'master' into security-scan-pr

Author: jj22ee

.github/workflows/IntegrationTesting.yaml

@@ -26,7 +26,7 @@ jobs:
         run: python setup.py sdist
 
       - name: Upload SDK build artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: sdk-build-artifact
           path: .
@@ -45,7 +45,7 @@ jobs:
           python-version: '3.8'
 
       - name: Download X-Ray SDK build artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: sdk-build-artifact
           path: ./sample-apps/flask
@@ -59,7 +59,7 @@ jobs:
         working-directory: ./sample-apps/flask
 
       - name: Upload WebApp with X-Ray SDK build artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: sdk-flask-build-artifact
           path: ./sample-apps/flask/deploy.zip
@@ -74,7 +74,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Download WebApp with X-Ray SDK build artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: sdk-flask-build-artifact
 
@@ -112,7 +112,7 @@ jobs:
         working-directory: ./terraform
 
       - name: Upload terraform state files for destorying resources
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: terraform-state-artifact
           path: ./terraform
@@ -151,15 +151,14 @@ jobs:
 
     steps:
       - name: Download terraform state artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: terraform-state-artifact
 
       - name: Configure AWS Credentials
-        uses: aws-actions/configure-aws-credentials@v1
+        uses: aws-actions/configure-aws-credentials@v4
         with:
-          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          role-to-assume: ${{ secrets.AWS_INTEG_TEST_ROLE_ARN }}
           aws-region: us-west-2
 
       - name: Setup Terraform

.github/workflows/Release.yaml

@@ -9,6 +9,8 @@ on:
 
 jobs:
   release:
+    permissions:
+      contents: write
     runs-on: ubuntu-latest
     steps:
       - name: Checkout master branch

.github/workflows/UnitTesting.yaml

@@ -1,4 +1,6 @@
 name: Unit Testing
+permissions:
+  contents: read
 on:
   push:
     branches:

CHANGELOG.rst

@@ -5,6 +5,10 @@ CHANGELOG
 Unreleased
 ==========
 
+2.15.0
+==========
+* bugfix: Fix log stack overflow if metadata contains circular reference `https://github.com/aws/aws-xray-sdk-python/pull/464`
+
 2.14.0
 ==========
 * bugfix: Fix warning message condition for subsegment ending `https://github.com/aws/aws-xray-sdk-python/pull/434`

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 {}

aws_xray_sdk/version.py

@@ -1 +1 @@
-VERSION = '2.14.0'
+VERSION = '2.15.0'

docs/conf.py

@@ -62,9 +62,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'2.14.0'
+version = u'2.15.0'
 # The full version, including alpha/beta/rc tags.
-release = u'2.14.0'
+release = u'2.15.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

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)