refactor(apigateway): warn on event_handler_debug deprecation in favour of powertools_dev

Author: heitorlessa

Diff for: aws_lambda_powertools/event_handler/api_gateway.py

@@ -15,7 +15,7 @@
 from aws_lambda_powertools.event_handler import content_types
 from aws_lambda_powertools.event_handler.exceptions import NotFoundError, ServiceError
 from aws_lambda_powertools.shared import constants
-from aws_lambda_powertools.shared.functions import resolve_truthy_env_var_choice
+from aws_lambda_powertools.shared.functions import powertools_dev_is_set, strtobool
 from aws_lambda_powertools.shared.json_encoder import Encoder
 from aws_lambda_powertools.utilities.data_classes import (
     ALBEvent,
@@ -444,9 +444,7 @@ def __init__(
         self._cors = cors
         self._cors_enabled: bool = cors is not None
         self._cors_methods: Set[str] = {"OPTIONS"}
-        self._debug = resolve_truthy_env_var_choice(
-            env=os.getenv(constants.EVENT_HANDLER_DEBUG_ENV, "false"), choice=debug
-        )
+        self._debug = self._has_debug(debug)
         self._strip_prefixes = strip_prefixes
 
         # Allow for a custom serializer or a concise json serialization
@@ -511,6 +509,22 @@ def resolve(self, event, context) -> Dict[str, Any]:
     def __call__(self, event, context) -> Any:
         return self.resolve(event, context)
 
+    @staticmethod
+    def _has_debug(debug: Optional[bool] = None) -> bool:
+        # It might have been explicitly switched off (debug=False)
+        if debug is not None:
+            return debug
+
+        # Maintenance: deprecate EVENT_HANDLER_DEBUG later in V2.
+        env_debug = os.getenv(constants.EVENT_HANDLER_DEBUG_ENV)
+        if env_debug is not None:
+            warnings.warn(
+                "POWERTOOLS_EVENT_HANDLER_DEBUG is set and will be deprecated in V2. Please use POWERTOOLS_DEV instead."
+            )
+            return strtobool(env_debug) or powertools_dev_is_set()
+
+        return powertools_dev_is_set()
+
     @staticmethod
     def _compile_regex(rule: str):
         """Precompile regex pattern

Diff for: tests/functional/event_handler/test_api_gateway.py

@@ -686,6 +686,16 @@ def test_debug_mode_environment_variable(monkeypatch):
     assert app._debug
 
 
+def test_powertools_dev_sets_debug_mode(monkeypatch):
+    # GIVEN a debug mode environment variable is set
+    monkeypatch.setenv(constants.POWERTOOLS_DEV_ENV, "true")
+    app = ApiGatewayResolver()
+
+    # WHEN calling app._debug
+    # THEN the debug mode is enabled
+    assert app._debug
+
+
 def test_debug_json_formatting(json_dump):
     # GIVEN debug is True
     app = ApiGatewayResolver(debug=True)