fix: add debugging statements

Author: heitorlessa

aws_lambda_powertools/event_handler/api_gateway.py

@@ -1,5 +1,6 @@
 import base64
 import json
+import logging
 import re
 import zlib
 from enum import Enum
@@ -10,6 +11,8 @@
 from aws_lambda_powertools.utilities.data_classes.common import BaseProxyEvent
 from aws_lambda_powertools.utilities.typing import LambdaContext
 
+logger = logging.getLogger(__name__)
+
 
 class ProxyEventType(Enum):
     """An enumerations of the supported proxy event types."""
@@ -170,6 +173,7 @@ def _compress(self):
         """Compress the response body, but only if `Accept-Encoding` headers includes gzip."""
         self.response.headers["Content-Encoding"] = "gzip"
         if isinstance(self.response.body, str):
+            logger.debug("Converting string response to bytes before compressing it")
             self.response.body = bytes(self.response.body, "utf-8")
         gzip = zlib.compressobj(9, zlib.DEFLATED, zlib.MAX_WBITS | 16)
         self.response.body = gzip.compress(self.response.body) + gzip.flush()
@@ -190,6 +194,7 @@ def build(self, event: BaseProxyEvent, cors: CORSConfig = None) -> Dict[str, Any
         self._route(event, cors)
 
         if isinstance(self.response.body, bytes):
+            logger.debug("Encoding bytes response with base64")
             self.response.base64_encoded = True
             self.response.body = base64.b64encode(self.response.body).decode()
         return {
@@ -256,7 +261,7 @@ def get(self, rule: str, cors: bool = True, compress: bool = False, cache_contro
         ```python
         from aws_lambda_powertools import Tracer
         from aws_lambda_powertools.event_handler.api_gateway import ApiGatewayResolver
-            >>>
+
         tracer = Tracer()
         app = ApiGatewayResolver()
 
@@ -380,8 +385,10 @@ def route(self, rule: str, method: str, cors: bool = True, compress: bool = Fals
         """Route decorator includes parameter `method`"""
 
         def register_resolver(func: Callable):
+            logger.debug(f"Adding route using rule {rule} and method {method.upper()}")
             self._routes.append(Route(method, self._compile_regex(rule), func, cors, compress, cache_control))
             if cors:
+                logger.debug(f"Registering method {method.upper()} to Allow Methods in CORS")
                 self._cors_methods.add(method.upper())
             return func
 
@@ -417,9 +424,12 @@ def _compile_regex(rule: str):
     def _to_proxy_event(self, event: Dict) -> BaseProxyEvent:
         """Convert the event dict to the corresponding data class"""
         if self._proxy_type == ProxyEventType.APIGatewayProxyEvent:
+            logger.debug("Converting event to API Gateway REST API contract")
             return APIGatewayProxyEvent(event)
         if self._proxy_type == ProxyEventType.APIGatewayProxyEventV2:
+            logger.debug("Converting event to API Gateway HTTP API contract")
             return APIGatewayProxyEventV2(event)
+        logger.debug("Converting event to ALB contract")
         return ALBEvent(event)
 
     def _resolve(self) -> ResponseBuilder:
@@ -431,17 +441,21 @@ def _resolve(self) -> ResponseBuilder:
                 continue
             match: Optional[re.Match] = route.rule.match(path)
             if match:
+                logger.debug("Found a registered route. Calling function")
                 return self._call_route(route, match.groupdict())
 
+        logger.debug(f"No match found for path {path} and method {method}")
         return self._not_found(method)
 
     def _not_found(self, method: str) -> ResponseBuilder:
         """Called when no matching route was found and includes support for the cors preflight response"""
         headers = {}
         if self._cors:
+            logger.debug("CORS is enabled, updating headers.")
             headers.update(self._cors.to_dict())
 
-            if method == "OPTIONS":  # Preflight
+            if method == "OPTIONS":  # Pre-flight
+                logger.debug("Pre-flight request detected. Returning CORS with null response")
                 headers["Access-Control-Allow-Methods"] = ",".join(sorted(self._cors_methods))
                 return ResponseBuilder(Response(status_code=204, content_type=None, headers=headers, body=None))
 
@@ -471,6 +485,7 @@ def _to_response(result: Union[Dict, Response]) -> Response:
         if isinstance(result, Response):
             return result
 
+        logger.debug("Simple response detected, serializing return before constructing final response")
         return Response(
             status_code=200,
             content_type="application/json",