chore: add text/html content types

Author: Michael Brewer

aws_lambda_powertools/event_handler/api_gateway.py

@@ -32,43 +32,46 @@ class ProxyEventType(Enum):
 class CORSConfig(object):
     """CORS Config
 
-
     Examples
     --------
 
     Simple cors example using the default permissive cors, not this should only be used during early prototyping
 
-        from aws_lambda_powertools.event_handler.api_gateway import ApiGatewayResolver
+    ```python
+    from aws_lambda_powertools.event_handler.api_gateway import ApiGatewayResolver
 
-        app = ApiGatewayResolver()
+    app = ApiGatewayResolver()
 
-        @app.get("/my/path", cors=True)
-        def with_cors():
-            return {"message": "Foo"}
+    @app.get("/my/path", cors=True)
+    def with_cors():
+        return {"message": "Foo"}
+    ```
 
     Using a custom CORSConfig where `with_cors` used the custom provided CORSConfig and `without_cors`
     do not include any cors headers.
 
-        from aws_lambda_powertools.event_handler.api_gateway import (
-            ApiGatewayResolver, CORSConfig
-        )
-
-        cors_config = CORSConfig(
-            allow_origin="https://wwww.example.com/",
-            expose_headers=["x-exposed-response-header"],
-            allow_headers=["x-custom-request-header"],
-            max_age=100,
-            allow_credentials=True,
-        )
-        app = ApiGatewayResolver(cors=cors_config)
-
-        @app.get("/my/path")
-        def with_cors():
-            return {"message": "Foo"}
+    ```python
+    from aws_lambda_powertools.event_handler.api_gateway import (
+        ApiGatewayResolver, CORSConfig
+    )
+
+    cors_config = CORSConfig(
+        allow_origin="https://wwww.example.com/",
+        expose_headers=["x-exposed-response-header"],
+        allow_headers=["x-custom-request-header"],
+        max_age=100,
+        allow_credentials=True,
+    )
+    app = ApiGatewayResolver(cors=cors_config)
+
+    @app.get("/my/path")
+    def with_cors():
+        return {"message": "Foo"}
 
-        @app.get("/another-one", cors=False)
-        def without_cors():
-            return {"message": "Foo"}
+    @app.get("/another-one", cors=False)
+    def without_cors():
+        return {"message": "Foo"}
+    ```
     """
 
     _REQUIRED_HEADERS = ["Authorization", "Content-Type", "X-Amz-Date", "X-Api-Key", "X-Amz-Security-Token"]
@@ -512,7 +515,7 @@ def _call_route(self, route: Route, args: Dict[str, str]) -> ResponseBuilder:
                 return ResponseBuilder(
                     Response(
                         status_code=500,
-                        content_type="text/plain",
+                        content_type=content_types.TEXT_PLAIN,
                         body="".join(traceback.format_exc()),
                     )
                 )

aws_lambda_powertools/event_handler/content_types.py

@@ -1,4 +1,5 @@
 # use mimetypes library to be certain, e.g., mimetypes.types_map[".json"]
 
 APPLICATION_JSON = "application/json"
-PLAIN_TEXT = "text/plain"
+TEXT_PLAIN = "text/plain"
+TEXT_HTML = "text/html"

tests/functional/event_handler/test_api_gateway.py

@@ -34,7 +34,6 @@ def read_media(file_name: str) -> bytes:
 
 
 LOAD_GW_EVENT = load_event("apiGatewayProxyEvent.json")
-TEXT_HTML = "text/html"
 
 
 def test_alb_event():
@@ -45,15 +44,15 @@ def test_alb_event():
     def foo():
         assert isinstance(app.current_event, ALBEvent)
         assert app.lambda_context == {}
-        return Response(200, TEXT_HTML, "foo")
+        return Response(200, content_types.TEXT_HTML, "foo")
 
     # WHEN calling the event handler
     result = app(load_event("albEvent.json"), {})
 
     # THEN process event correctly
     # AND set the current_event type as ALBEvent
     assert result["statusCode"] == 200
-    assert result["headers"]["Content-Type"] == TEXT_HTML
+    assert result["headers"]["Content-Type"] == content_types.TEXT_HTML
     assert result["body"] == "foo"
 
 
@@ -83,15 +82,15 @@ def test_api_gateway():
     @app.get("/my/path")
     def get_lambda() -> Response:
         assert isinstance(app.current_event, APIGatewayProxyEvent)
-        return Response(200, TEXT_HTML, "foo")
+        return Response(200, content_types.TEXT_HTML, "foo")
 
     # WHEN calling the event handler
     result = app(LOAD_GW_EVENT, {})
 
     # THEN process event correctly
     # AND set the current_event type as APIGatewayProxyEvent
     assert result["statusCode"] == 200
-    assert result["headers"]["Content-Type"] == TEXT_HTML
+    assert result["headers"]["Content-Type"] == content_types.TEXT_HTML
     assert result["body"] == "foo"
 
 
@@ -103,15 +102,15 @@ def test_api_gateway_v2():
     def my_path() -> Response:
         assert isinstance(app.current_event, APIGatewayProxyEventV2)
         post_data = app.current_event.json_body
-        return Response(200, content_types.PLAIN_TEXT, post_data["username"])
+        return Response(200, content_types.TEXT_PLAIN, post_data["username"])
 
     # WHEN calling the event handler
     result = app(load_event("apiGatewayProxyV2Event.json"), {})
 
     # THEN process event correctly
     # AND set the current_event type as APIGatewayProxyEventV2
     assert result["statusCode"] == 200
-    assert result["headers"]["Content-Type"] == content_types.PLAIN_TEXT
+    assert result["headers"]["Content-Type"] == content_types.TEXT_PLAIN
     assert result["body"] == "tom"
 
 
@@ -122,14 +121,14 @@ def test_include_rule_matching():
     @app.get("/<name>/<my_id>")
     def get_lambda(my_id: str, name: str) -> Response:
         assert name == "my"
-        return Response(200, TEXT_HTML, my_id)
+        return Response(200, content_types.TEXT_HTML, my_id)
 
     # WHEN calling the event handler
     result = app(LOAD_GW_EVENT, {})
 
     # THEN
     assert result["statusCode"] == 200
-    assert result["headers"]["Content-Type"] == TEXT_HTML
+    assert result["headers"]["Content-Type"] == content_types.TEXT_HTML
     assert result["body"] == "path"
 
 
@@ -190,11 +189,11 @@ def test_cors():
 
     @app.get("/my/path", cors=True)
     def with_cors() -> Response:
-        return Response(200, TEXT_HTML, "test")
+        return Response(200, content_types.TEXT_HTML, "test")
 
     @app.get("/without-cors")
     def without_cors() -> Response:
-        return Response(200, TEXT_HTML, "test")
+        return Response(200, content_types.TEXT_HTML, "test")
 
     def handler(event, context):
         return app.resolve(event, context)
@@ -205,7 +204,7 @@ def handler(event, context):
     # THEN the headers should include cors headers
     assert "headers" in result
     headers = result["headers"]
-    assert headers["Content-Type"] == TEXT_HTML
+    assert headers["Content-Type"] == content_types.TEXT_HTML
     assert headers["Access-Control-Allow-Origin"] == "*"
     assert "Access-Control-Allow-Credentials" not in headers
     assert headers["Access-Control-Allow-Headers"] == ",".join(sorted(CORSConfig._REQUIRED_HEADERS))
@@ -271,7 +270,7 @@ def test_compress_no_accept_encoding():
 
     @app.get("/my/path", compress=True)
     def return_text() -> Response:
-        return Response(200, content_types.PLAIN_TEXT, expected_value)
+        return Response(200, content_types.TEXT_PLAIN, expected_value)
 
     # WHEN calling the event handler
     result = app({"path": "/my/path", "httpMethod": "GET", "headers": {}}, None)
@@ -287,7 +286,7 @@ def test_cache_control_200():
 
     @app.get("/success", cache_control="max-age=600")
     def with_cache_control() -> Response:
-        return Response(200, TEXT_HTML, "has 200 response")
+        return Response(200, content_types.TEXT_HTML, "has 200 response")
 
     def handler(event, context):
         return app.resolve(event, context)
@@ -298,7 +297,7 @@ def handler(event, context):
 
     # THEN return the set Cache-Control
     headers = result["headers"]
-    assert headers["Content-Type"] == TEXT_HTML
+    assert headers["Content-Type"] == content_types.TEXT_HTML
     assert headers["Cache-Control"] == "max-age=600"
 
 
@@ -308,7 +307,7 @@ def test_cache_control_non_200():
 
     @app.delete("/fails", cache_control="max-age=600")
     def with_cache_control_has_500() -> Response:
-        return Response(503, TEXT_HTML, "has 503 response")
+        return Response(503, content_types.TEXT_HTML, "has 503 response")
 
     def handler(event, context):
         return app.resolve(event, context)
@@ -319,7 +318,7 @@ def handler(event, context):
 
     # THEN return a Cache-Control of "no-cache"
     headers = result["headers"]
-    assert headers["Content-Type"] == TEXT_HTML
+    assert headers["Content-Type"] == content_types.TEXT_HTML
     assert headers["Cache-Control"] == "no-cache"
 
 
@@ -482,7 +481,7 @@ def test_custom_preflight_response():
     def custom_preflight():
         return Response(
             status_code=200,
-            content_type=TEXT_HTML,
+            content_type=content_types.TEXT_HTML,
             body="Foo",
             headers={"Access-Control-Allow-Methods": "CUSTOM"},
         )
@@ -498,7 +497,7 @@ def custom_method():
     assert result["statusCode"] == 200
     assert result["body"] == "Foo"
     headers = result["headers"]
-    assert headers["Content-Type"] == TEXT_HTML
+    assert headers["Content-Type"] == content_types.TEXT_HTML
     assert "Access-Control-Allow-Origin" in result["headers"]
     assert headers["Access-Control-Allow-Methods"] == "CUSTOM"
 
@@ -522,7 +521,7 @@ def raises_error():
     assert result["statusCode"] == 500
     assert "Traceback (most recent call last)" in result["body"]
     headers = result["headers"]
-    assert headers["Content-Type"] == "text/plain"
+    assert headers["Content-Type"] == content_types.TEXT_PLAIN
 
 
 def test_unhandled_exceptions_debug_off():