Addressing Heitor's feedback

Author: leandrodamascena

aws_lambda_powertools/shared/powertools_warnings.py

@@ -0,0 +1,18 @@
+class PowertoolsWarning(UserWarning):
+    """
+    This class provides a custom Warning tailored for better clarity when certain situations occur.
+    It offers more informative and relevant warning messages, allowing customers to easily suppress
+    or handle this specific warning type as needed.
+
+    Parameters
+    ----------
+    message: str
+         The warning message to be displayed.
+    """
+
+    def __init__(self, message):
+        self.message = message
+        super().__init__(message)
+
+    def __str__(self):
+        return self.message

aws_lambda_powertools/utilities/idempotency/idempotency.py

@@ -5,12 +5,14 @@
 import functools
 import logging
 import os
+import warnings
 from inspect import isclass
 from typing import Any, Callable, Dict, Optional, Type, Union, cast
 
 from aws_lambda_powertools.middleware_factory import lambda_handler_decorator
 from aws_lambda_powertools.shared import constants
-from aws_lambda_powertools.shared.functions import strtobool
+from aws_lambda_powertools.shared.functions import powertools_dev_is_set, strtobool
+from aws_lambda_powertools.shared.powertools_warnings import PowertoolsWarning
 from aws_lambda_powertools.shared.types import AnyCallableT
 from aws_lambda_powertools.utilities.idempotency.base import IdempotencyHandler
 from aws_lambda_powertools.utilities.idempotency.config import IdempotencyConfig
@@ -67,9 +69,16 @@ def idempotent(
         >>>     return {"StatusCode": 200}
     """
 
-    # Check if the IDEMPOTENCY_DISABLED_ENV environment variable is set to True
-    # If IDEMPOTENCY_DISABLED_ENV is not set or set to any false value, the function will be idempotent by default
+    # Skip idempotency controls when POWERTOOLS_IDEMPOTENCY_DISABLED has a truthy value
+    # Raises a warning if not running in development mode
     if strtobool(os.getenv(constants.IDEMPOTENCY_DISABLED_ENV, "false")):
+        if not powertools_dev_is_set():
+            warnings.warn(
+                message="Disabling idempotency is intended for development environments only "
+                "and should not be used in production.",
+                category=PowertoolsWarning,
+                stacklevel=2,
+            )
         return handler(event, context, **kwargs)
 
     config = config or IdempotencyConfig()
@@ -153,9 +162,16 @@ def process_order(customer_id: str, order: dict, **kwargs):
 
     @functools.wraps(function)
     def decorate(*args, **kwargs):
-        # Check if the IDEMPOTENCY_DISABLED_ENV environment variable is set to True
-        # If IDEMPOTENCY_DISABLED_ENV is not set or set to any false value, the function will be idempotent by default
-        if strtobool(os.getenv(constants.IDEMPOTENCY_DISABLED_ENV, "0")):
+        # Skip idempotency controls when POWERTOOLS_IDEMPOTENCY_DISABLED has a truthy value
+        # Raises a warning if not running in development mode
+        if strtobool(os.getenv(constants.IDEMPOTENCY_DISABLED_ENV, "false")):
+            if not powertools_dev_is_set():
+                warnings.warn(
+                    message="Disabling idempotency is intended for development environments only "
+                    "and should not be used in production.",
+                    category=PowertoolsWarning,
+                    stacklevel=2,
+                )
             return function(*args, **kwargs)
 
         if data_keyword_argument not in kwargs:

tests/functional/idempotency/test_idempotency.py

@@ -12,6 +12,7 @@
 from pytest import FixtureRequest
 from pytest_mock import MockerFixture
 
+from aws_lambda_powertools.shared.powertools_warnings import PowertoolsWarning
 from aws_lambda_powertools.utilities.data_classes import (
     APIGatewayProxyEventV2,
     event_source,
@@ -1668,7 +1669,7 @@ def dummy(payload):
 
 
 @pytest.mark.parametrize("idempotency_disabled_value", ["1", "y", "yes", "t", "true", "on"])
-def test_idempotency_enabled_envvar(
+def test_idempotency_enabled_envvar_in_dev_environment(
     monkeypatch,
     lambda_context,
     persistence_store: DynamoDBPersistenceLayer,
@@ -1680,6 +1681,7 @@ def test_idempotency_enabled_envvar(
     persistence_store.client = MagicMock()
 
     monkeypatch.setenv("POWERTOOLS_IDEMPOTENCY_DISABLED", str(idempotency_disabled_value))
+    monkeypatch.setenv("POWERTOOLS_DEV", "true")
 
     @idempotent_function(data_keyword_argument="data", persistence_store=persistence_store)
     def dummy(data):
@@ -1695,6 +1697,35 @@ def dummy_handler(event, context):
     assert len(persistence_store.client.method_calls) == 0
 
 
+@pytest.mark.parametrize("idempotency_disabled_value", ["1", "y", "yes", "t", "true", "on"])
+def test_idempotency_enabled_envvar_in_non_dev_environment(
+    monkeypatch,
+    lambda_context,
+    persistence_store: DynamoDBPersistenceLayer,
+    idempotency_disabled_value,
+):
+    # Scenario to validate no requests sent to dynamodb table when 'POWERTOOLS_IDEMPOTENCY_DISABLED' is set
+    mock_event = {"data": "value"}
+
+    persistence_store.client = MagicMock()
+
+    monkeypatch.setenv("POWERTOOLS_IDEMPOTENCY_DISABLED", str(idempotency_disabled_value))
+
+    @idempotent_function(data_keyword_argument="data", persistence_store=persistence_store)
+    def dummy(data):
+        return {"message": "hello"}
+
+    @idempotent(persistence_store=persistence_store)
+    def dummy_handler(event, context):
+        return {"message": "hi"}
+
+    with pytest.warns(PowertoolsWarning, match="Disabling idempotency is intended for development environments*"):
+        dummy(data=mock_event)
+        dummy_handler(mock_event, lambda_context)
+
+        assert len(persistence_store.client.method_calls) == 0
+
+
 @pytest.mark.parametrize("idempotency_disabled_value", ["0", "n", "no", "f", "false", "off"])
 def test_idempotency_disabled_envvar(
     monkeypatch,