Support a prefix defined during the Blueprint registration

Author: Brian Villemarette

aws_lambda_powertools/event_handler/api_gateway.py

@@ -631,9 +631,13 @@ def _to_response(self, result: Union[Dict, Response]) -> Response:
     def _json_dump(self, obj: Any) -> str:
         return self._serializer(obj)
 
-    def register_blueprint(self, blueprint: "Blueprint") -> None:
+    def register_blueprint(self, blueprint: "Blueprint", prefix: Optional[str] = None) -> None:
         """Adds all routes defined in a blueprint"""
         for route, func in blueprint.api.items():
+            if prefix and route[0] == "/":
+                route = (prefix, *route[1:])
+            elif prefix:
+                route = (f"{prefix}{route[0]}" if prefix else route[0], *route[1:])
             self.route(*route)(func(app=self))
 
 

tests/functional/event_handler/test_api_gateway.py

@@ -903,3 +903,42 @@ def foo(app: ApiGatewayResolver, account_id):
     # THEN process event correctly
     assert result["statusCode"] == 200
     assert result["headers"]["Content-Type"] == content_types.APPLICATION_JSON
+
+
+def test_api_gateway_app_proxy_with_prefix():
+    # GIVEN a Blueprint with registered routes
+    # AND a prefix is defined during the registration
+    app = ApiGatewayResolver()
+    blueprint = Blueprint()
+
+    @blueprint.get(rule="/path")
+    def foo(app: ApiGatewayResolver):
+        return {}
+
+    app.register_blueprint(blueprint, prefix="/my")
+    # WHEN calling the event handler after applying routes from blueprint object
+    result = app(LOAD_GW_EVENT, {})
+
+    # THEN process event correctly
+    assert result["statusCode"] == 200
+    assert result["headers"]["Content-Type"] == content_types.APPLICATION_JSON
+
+
+def test_api_gateway_app_proxy_with_prefix_equals_path():
+    # GIVEN a Blueprint with registered routes
+    # AND a prefix is defined during the registration
+    app = ApiGatewayResolver()
+    blueprint = Blueprint()
+
+    @blueprint.get(rule="/")
+    def foo(app: ApiGatewayResolver):
+        return {}
+
+    app.register_blueprint(blueprint, prefix="/my/path")
+    # WHEN calling the event handler after applying routes from blueprint object
+    # WITH the request path matching the registration prefix
+    result = app(LOAD_GW_EVENT, {})
+
+    # THEN process event correctly
+    assert result["statusCode"] == 200
+    assert result["headers"]["Content-Type"] == content_types.APPLICATION_JSON