feat(idempotent): Add include_function_name option

Author: michaelbrewer

aws_lambda_powertools/utilities/idempotency/config.py

@@ -12,6 +12,7 @@ def __init__(
         use_local_cache: bool = False,
         local_cache_max_items: int = 256,
         hash_function: str = "md5",
+        include_function_name: bool = True,
     ):
         """
         Initialize the base persistence layer
@@ -32,6 +33,8 @@ def __init__(
             Max number of items to store in local cache, by default 1024
         hash_function: str, optional
             Function to use for calculating hashes, by default md5.
+        include_function_name: bool, optional
+            Whether to include the function name in the idempotent key
         """
         self.event_key_jmespath = event_key_jmespath
         self.payload_validation_jmespath = payload_validation_jmespath
@@ -41,3 +44,4 @@ def __init__(
         self.use_local_cache = use_local_cache
         self.local_cache_max_items = local_cache_max_items
         self.hash_function = hash_function
+        self.include_function_name = include_function_name

aws_lambda_powertools/utilities/idempotency/persistence/base.py

@@ -122,6 +122,7 @@ def __init__(self):
         self.use_local_cache = False
         self._cache: Optional[LRUDict] = None
         self.hash_function = None
+        self.include_function_name = True
 
     def configure(self, config: IdempotencyConfig) -> None:
         """
@@ -152,6 +153,7 @@ def configure(self, config: IdempotencyConfig) -> None:
         if self.use_local_cache:
             self._cache = LRUDict(max_items=config.local_cache_max_items)
         self.hash_function = getattr(hashlib, config.hash_function)
+        self.include_function_name = config.include_function_name
 
     def _get_hashed_idempotency_key(self, event: Dict[str, Any], context: LambdaContext) -> str:
         """
@@ -180,7 +182,11 @@ def _get_hashed_idempotency_key(self, event: Dict[str, Any], context: LambdaCont
                 raise IdempotencyKeyError("No data found to create a hashed idempotency_key")
             warnings.warn(f"No value found for idempotency_key. jmespath: {self.event_key_jmespath}")
 
-        return f"{context.function_name}#{self._generate_hash(data)}"
+        generated_hard = self._generate_hash(data)
+        if self.include_function_name:
+            return f"{context.function_name}#{generated_hard}"
+        else:
+            return generated_hard
 
     @staticmethod
     def is_missing_idempotency_key(data) -> bool:

tests/functional/idempotency/test_idempotency.py

@@ -828,3 +828,16 @@ def lambda_handler(event, context):
     stubber.assert_no_pending_responses()
     stubber.deactivate()
     assert "Failed to save in progress record to idempotency store" == e.value.args[0]
+
+
+def test_include_function_name_false(persistence_store: DynamoDBPersistenceLayer):
+    # GIVEN include_function_name=False
+    persistence_store.configure(IdempotencyConfig(event_key_jmespath="body", include_function_name=False))
+    value = "true"
+    api_gateway_proxy_event = {"body": value}
+
+    # WHEN
+    result = persistence_store._get_hashed_idempotency_key(api_gateway_proxy_event, None)
+
+    # THEN
+    assert result == persistence_store._generate_hash(value)