feat(capture_method): addressing PR feedback

Author: leandrodamascena

aws_lambda_powertools/tracing/tracer.py

@@ -354,7 +354,8 @@ def capture_method(
         """Decorator to create subsegment for arbitrary functions
 
         It also captures both response and exceptions as metadata
-        and creates a subsegment named `## <method_name>`
+        and creates a subsegment named `## <method_module.method_qualifiedname>`
+        # see here: [Qualified name for classes and functions](https://peps.python.org/pep-3155/)
 
         When running [async functions concurrently](https://docs.python.org/3/library/asyncio-task.html#id6),
         methods may impact each others subsegment, and can trigger

tests/e2e/tracer/handlers/same_function_name.py

@@ -1,3 +1,4 @@
+from abc import ABC, abstractmethod
 from uuid import uuid4
 
 from aws_lambda_powertools import Tracer
@@ -6,13 +7,22 @@
 tracer = Tracer()
 
 
-class Comments:
+class MainAbstractClass(ABC):
+    def __init__(self):
+        super().__init__()
+
+    @abstractmethod
+    def get_all(self):
+        raise NotImplementedError
+
+
+class Comments(MainAbstractClass):
     @tracer.capture_method
     def get_all(self):
         return [{"id": f"{uuid4()}", "completed": False} for _ in range(5)]
 
 
-class Todos:
+class Todos(MainAbstractClass):
     @tracer.capture_method
     def get_all(self):
         return [{"id": f"{uuid4()}", "completed": False} for _ in range(5)]

tests/e2e/tracer/test_tracer.py

@@ -63,27 +63,26 @@ def test_lambda_handler_trace_is_visible(basic_handler_fn_arn: str, basic_handle
 
 def test_lambda_handler_trace_multiple_functions_same_name(same_function_name_arn: str, same_function_name_fn: str):
     # GIVEN
-    method_name_1 = "same_function_name.Todos.get_all"
-    method_subsegment_1 = f"## {method_name_1}"
-    method_metadata_key_1 = f"{method_name_1} response"
+    method_name_todos = "same_function_name.Todos.get_all"
+    method_subsegment_todos = f"## {method_name_todos}"
+    method_metadata_key_todos = f"{method_name_todos} response"
 
-    method_name_2 = "same_function_name.Comments.get_all"
-    method_subsegment_2 = f"## {method_name_2}"
-    method_metadata_key_2 = f"{method_name_2} response"
+    method_name_comments = "same_function_name.Comments.get_all"
+    method_subsegment_comments = f"## {method_name_comments}"
+    method_metadata_key_comments = f"{method_name_comments} response"
 
     trace_query = data_builder.build_trace_default_query(function_name=same_function_name_fn)
 
     # WHEN
     _, execution_time = data_fetcher.get_lambda_response(lambda_arn=same_function_name_arn)
-    data_fetcher.get_lambda_response(lambda_arn=same_function_name_arn)
 
     # THEN
     trace = data_fetcher.get_traces(start_date=execution_time, filter_expression=trace_query)
 
-    assert len(trace.get_metadata(key=method_metadata_key_1, namespace=TracerStack.SERVICE_NAME)) == 1
-    assert len(trace.get_metadata(key=method_metadata_key_2, namespace=TracerStack.SERVICE_NAME)) == 1
-    assert len(trace.get_subsegment(name=method_subsegment_1)) == 1
-    assert len(trace.get_subsegment(name=method_subsegment_2)) == 1
+    assert len(trace.get_metadata(key=method_metadata_key_todos, namespace=TracerStack.SERVICE_NAME)) == 1
+    assert len(trace.get_metadata(key=method_metadata_key_comments, namespace=TracerStack.SERVICE_NAME)) == 1
+    assert len(trace.get_subsegment(name=method_subsegment_todos)) == 1
+    assert len(trace.get_subsegment(name=method_subsegment_comments)) == 1
 
 
 def test_async_trace_is_visible(async_fn_arn: str, async_fn: str):

tests/unit/test_tracing.py

@@ -10,6 +10,8 @@
 
 # Maintenance: This should move to Functional tests and use Fake over mocks.
 
+__MODULE_PREFIX__ = "unit.test_tracing"
+
 
 @pytest.fixture
 def dummy_response():
@@ -126,10 +128,12 @@ def greeting(name, message):
     # and use service name as a metadata namespace
     assert in_subsegment_mock.in_subsegment.call_count == 1
     assert in_subsegment_mock.in_subsegment.call_args == mocker.call(
-        name="## unit.test_tracing.test_tracer_method.<locals>.greeting"
+        name=f"## {__MODULE_PREFIX__}.test_tracer_method.<locals>.greeting"
     )
     assert in_subsegment_mock.put_metadata.call_args == mocker.call(
-        key="unit.test_tracing.test_tracer_method.<locals>.greeting response", value=dummy_response, namespace="booking"
+        key=f"{__MODULE_PREFIX__}.test_tracer_method.<locals>.greeting response",
+        value=dummy_response,
+        namespace="booking",
     )
 
 
@@ -257,7 +261,7 @@ def greeting(name, message):
     put_metadata_mock_args = in_subsegment_mock.put_metadata.call_args[1]
     assert (
         put_metadata_mock_args["key"]
-        == "unit.test_tracing.test_tracer_method_exception_metadata.<locals>.greeting error"
+        == f"{__MODULE_PREFIX__}.test_tracer_method_exception_metadata.<locals>.greeting error"
     )
     assert put_metadata_mock_args["namespace"] == "booking"
 
@@ -311,20 +315,20 @@ async def greeting(name, message):
     # THEN we should add metadata for each response like we would for a sync decorated method
     assert in_subsegment_mock.in_subsegment.call_count == 2
     assert in_subsegment_greeting_call_args == mocker.call(
-        name="## unit.test_tracing.test_tracer_method_nested_async.<locals>.greeting"
+        name=f"## {__MODULE_PREFIX__}.test_tracer_method_nested_async.<locals>.greeting"
     )
     assert in_subsegment_greeting2_call_args == mocker.call(
-        name="## unit.test_tracing.test_tracer_method_nested_async.<locals>.greeting_2"
+        name=f"## {__MODULE_PREFIX__}.test_tracer_method_nested_async.<locals>.greeting_2"
     )
 
     assert in_subsegment_mock.put_metadata.call_count == 2
     assert put_metadata_greeting2_call_args == mocker.call(
-        key="unit.test_tracing.test_tracer_method_nested_async.<locals>.greeting_2 response",
+        key=f"{__MODULE_PREFIX__}.test_tracer_method_nested_async.<locals>.greeting_2 response",
         value=dummy_response,
         namespace="booking",
     )
     assert put_metadata_greeting_call_args == mocker.call(
-        key="unit.test_tracing.test_tracer_method_nested_async.<locals>.greeting response",
+        key=f"{__MODULE_PREFIX__}.test_tracer_method_nested_async.<locals>.greeting response",
         value=dummy_response,
         namespace="booking",
     )
@@ -370,7 +374,7 @@ async def greeting(name, message):
     put_metadata_mock_args = in_subsegment_mock.put_metadata.call_args[1]
     assert (
         put_metadata_mock_args["key"]
-        == "unit.test_tracing.test_tracer_method_exception_metadata_async.<locals>.greeting error"
+        == f"{__MODULE_PREFIX__}.test_tracer_method_exception_metadata_async.<locals>.greeting error"
     )
     assert put_metadata_mock_args["namespace"] == "booking"
 
@@ -404,7 +408,7 @@ def handler(event, context):
     assert in_subsegment_mock.in_subsegment.call_count == 2
     assert handler_trace == mocker.call(name="## handler")
     assert yield_function_trace == mocker.call(
-        name="## unit.test_tracing.test_tracer_yield_from_context_manager.<locals>.yield_with_capture"
+        name=f"## {__MODULE_PREFIX__}.test_tracer_yield_from_context_manager.<locals>.yield_with_capture"
     )
     assert "test result" in result
 
@@ -431,7 +435,7 @@ def yield_with_capture():
     put_metadata_mock_args = in_subsegment_mock.put_metadata.call_args[1]
     assert (
         put_metadata_mock_args["key"]
-        == "unit.test_tracing.test_tracer_yield_from_context_manager_exception_metadata.<locals>.yield_with_capture error"  # noqa E501
+        == f"{__MODULE_PREFIX__}.test_tracer_yield_from_context_manager_exception_metadata.<locals>.yield_with_capture error"  # noqa E501
     )
     assert isinstance(put_metadata_mock_args["value"], ValueError)
     assert put_metadata_mock_args["namespace"] == "booking"
@@ -475,7 +479,7 @@ def handler(event, context):
     assert in_subsegment_mock.in_subsegment.call_count == 2
     assert handler_trace == mocker.call(name="## handler")
     assert yield_function_trace == mocker.call(
-        name="## unit.test_tracing.test_tracer_yield_from_nested_context_manager.<locals>.yield_with_capture"
+        name=f"## {__MODULE_PREFIX__}.test_tracer_yield_from_nested_context_manager.<locals>.yield_with_capture"
     )
     assert "test result" in result
 
@@ -507,7 +511,7 @@ def handler(event, context):
     assert in_subsegment_mock.in_subsegment.call_count == 2
     assert handler_trace == mocker.call(name="## handler")
     assert generator_fn_trace == mocker.call(
-        name="## unit.test_tracing.test_tracer_yield_from_generator.<locals>.generator_fn"
+        name=f"## {__MODULE_PREFIX__}.test_tracer_yield_from_generator.<locals>.generator_fn"
     )
     assert "test result" in result
 
@@ -533,7 +537,7 @@ def generator_fn():
     put_metadata_mock_args = in_subsegment_mock.put_metadata.call_args[1]
     assert (
         put_metadata_mock_args["key"]
-        == "unit.test_tracing.test_tracer_yield_from_generator_exception_metadata.<locals>.generator_fn error"
+        == f"{__MODULE_PREFIX__}.test_tracer_yield_from_generator_exception_metadata.<locals>.generator_fn error"
     )
     assert put_metadata_mock_args["namespace"] == "booking"
     assert isinstance(put_metadata_mock_args["value"], ValueError)