chore: Some refactoring

Author: Michael Brewer

aws_lambda_powertools/utilities/idempotency/idempotency.py

@@ -52,7 +52,7 @@ def idempotent(
     --------
     **Processes Lambda's event in an idempotent manner**
         >>> from aws_lambda_powertools.utilities.idempotency import (
-        >>>    idempotent, DynamoDBPersistenceLayer
+        >>>    idempotent, DynamoDBPersistenceLayer, IdempotencyConfig
         >>> )
         >>>
         >>> persistence_layer = DynamoDBPersistenceLayer(table_name="idempotency_store")
@@ -62,7 +62,7 @@ def idempotent(
         >>>     return {"StatusCode": 200}
     """
 
-    idempotency_handler = IdempotencyHandler(handler, event, context, config, persistence_store)
+    idempotency_handler = IdempotencyHandler(handler, event, context, config or IdempotencyConfig(), persistence_store)
 
     # IdempotencyInconsistentStateError can happen under rare but expected cases when persistent state changes in the
     # small time between put & get requests. In most cases we can retry successfully on this exception.
@@ -105,7 +105,7 @@ def __init__(
         persistence_store : BasePersistenceLayer
             Instance of persistence layer to store idempotency records
         """
-        persistence_store.configure(config)
+        persistence_store._configure(config)
         self.persistence_store = persistence_store
         self.context = context
         self.event = event

aws_lambda_powertools/utilities/idempotency/persistence/base.py

@@ -109,32 +109,33 @@ class BasePersistenceLayer(ABC):
     """
 
     def __init__(self):
+        """Initialize the defaults """
         self.configured = False
-
         self.event_key_jmespath: Optional[str] = None
         self.event_key_compiled_jmespath = None
         self.jmespath_options: Optional[dict] = None
         self.payload_validation_enabled = False
         self.validation_key_jmespath = None
         self.raise_on_no_idempotency_key = False
-        self.expires_after_seconds = None
+        self.expires_after_seconds: int = 60 * 60  # 1 hour default
         self.use_local_cache = False
         self._cache: Optional[LRUDict] = None
         self.hash_function = None
 
-    def configure(self, config: IdempotencyConfig,) -> None:
+    def _configure(self, config: IdempotencyConfig) -> None:
         """
-        Initialize the base persistence layer
+        Initialize the base persistence layer from the configuration settings
 
         Parameters
         ----------
         config: IdempotencyConfig
-            Configuration settings
+            Idempotency configuration settings
         """
         if self.configured:
-            # Temp hack to prevent being reconfigured.
+            # Prevent being reconfigured.
             return
         self.configured = True
+
         self.event_key_jmespath = config.event_key_jmespath
         if config.event_key_jmespath:
             self.event_key_compiled_jmespath = jmespath.compile(config.event_key_jmespath)
@@ -174,9 +175,9 @@ def _get_hashed_idempotency_key(self, lambda_event: Dict[str, Any]) -> str:
             )
 
         if self.is_missing_idempotency_key(data):
-            warnings.warn(f"No value found for idempotency_key. jmespath: {self.event_key_jmespath}")
             if self.raise_on_no_idempotency_key:
                 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 self._generate_hash(data)
 

examples/__init__.py

@@ -225,7 +225,7 @@ def test_idempotent_lambda_first_execution_cached(
     Test idempotent decorator when lambda is executed with an event with a previously unknown event key. Ensure
     result is cached locally on the persistence store instance.
     """
-    persistence_store.configure(idempotency_config)
+    persistence_store._configure(idempotency_config)
     save_to_cache_spy = mocker.spy(persistence_store, "_save_to_cache")
     retrieve_from_cache_spy = mocker.spy(persistence_store, "_retrieve_from_cache")
     stubber = stub.Stubber(persistence_store.table.meta.client)
@@ -625,7 +625,7 @@ def test_data_record_invalid_status_value():
 def test_in_progress_never_saved_to_cache(idempotency_config, persistence_store):
     # GIVEN a data record with status "INPROGRESS"
     # and persistence_store has use_local_cache = True
-    persistence_store.configure(idempotency_config)
+    persistence_store._configure(idempotency_config)
     data_record = DataRecord("key", status="INPROGRESS")
 
     # WHEN saving to local cache
@@ -638,7 +638,7 @@ def test_in_progress_never_saved_to_cache(idempotency_config, persistence_store)
 @pytest.mark.parametrize("idempotency_config", [{"use_local_cache": False}], indirect=True)
 def test_user_local_disabled(idempotency_config, persistence_store):
     # GIVEN a persistence_store with use_local_cache = False
-    persistence_store.configure(idempotency_config)
+    persistence_store._configure(idempotency_config)
 
     # WHEN calling any local cache options
     data_record = DataRecord("key", status="COMPLETED")
@@ -658,7 +658,7 @@ def test_user_local_disabled(idempotency_config, persistence_store):
 @pytest.mark.parametrize("idempotency_config", [{"use_local_cache": True}], indirect=True)
 def test_delete_from_cache_when_empty(idempotency_config, persistence_store):
     # GIVEN use_local_cache is True AND the local cache is empty
-    persistence_store.configure(idempotency_config)
+    persistence_store._configure(idempotency_config)
 
     try:
         # WHEN we _delete_from_cache
@@ -692,7 +692,7 @@ def test_is_missing_idempotency_key():
 )
 def test_default_no_raise_on_missing_idempotency_key(idempotency_config, persistence_store):
     # GIVEN a persistence_store with use_local_cache = False and event_key_jmespath = "body"
-    persistence_store.configure(idempotency_config)
+    persistence_store._configure(idempotency_config)
     assert persistence_store.use_local_cache is False
     assert "body" in persistence_store.event_key_jmespath
 
@@ -708,7 +708,7 @@ def test_default_no_raise_on_missing_idempotency_key(idempotency_config, persist
 )
 def test_raise_on_no_idempotency_key(idempotency_config, persistence_store):
     # GIVEN a persistence_store with raise_on_no_idempotency_key and no idempotency key in the request
-    persistence_store.configure(idempotency_config)
+    persistence_store._configure(idempotency_config)
     persistence_store.raise_on_no_idempotency_key = True
     assert persistence_store.use_local_cache is False
     assert "body" in persistence_store.event_key_jmespath
@@ -724,7 +724,7 @@ def test_raise_on_no_idempotency_key(idempotency_config, persistence_store):
 def test_jmespath_with_powertools_json(persistence_store):
     # GIVEN an event_key_jmespath with powertools_json custom function
     config = IdempotencyConfig(event_key_jmespath="[requestContext.authorizer.claims.sub, powertools_json(body).id]")
-    persistence_store.configure(config)
+    persistence_store._configure(config)
     sub_attr_value = "cognito_user"
     key_attr_value = "some_key"
     expected_value = [sub_attr_value, key_attr_value]
@@ -744,7 +744,7 @@ def test_jmespath_with_powertools_json(persistence_store):
 def test_custom_jmespath_function_overrides_builtin_functions(config_with_jmespath_options, persistence_store):
     # GIVEN an persistence store with a custom jmespath_options
     # AND use a builtin powertools custom function
-    persistence_store.configure(config_with_jmespath_options)
+    persistence_store._configure(config_with_jmespath_options)
     with pytest.raises(jmespath.exceptions.UnknownFunctionError, match="Unknown function: powertools_json()"):
         # WHEN calling _get_hashed_idempotency_key
         # THEN raise unknown function