chore: tests + coverage + documentation

Author: leandrodamascena

aws_lambda_powertools/utilities/data_classes/vpc_lattice.py

@@ -3,7 +3,7 @@
 
 from aws_lambda_powertools.utilities.data_classes.common import (
     DictWrapper,
-    get_header_value
+    get_header_value,
 )
 
 
@@ -89,4 +89,3 @@ def get_header_value(
             Header value
         """
         return get_header_value(self.headers, name, default_value, case_sensitive)
-

docs/utilities/data_classes.md

@@ -1124,69 +1124,22 @@ This example is based on the AWS Blog post [Introducing Amazon S3 Object Lambda
 
 ### VPC Lattice
 
-The VPC Lattice service supports Lambda invocation for requests over both HTTP and HTTPS. The service sends an event in JSON format, and adds the `X-Forwarded-For` header to every request. The service also adds the X-Forwarded-Proto header to requests over HTTPS.
+You can register your Lambda functions as targets within an Amazon VPC Lattice service network. By doing this, your Lambda function becomes a service within the network, and clients that have access to the VPC Lattice service network can call your service.
 
-The service Base64 encodes the body and sets isBase64Encoded to true, if the content-encoding header is present, and the content type is not one of the following:
-
-* `text/*`
-* `application/json`
-* `application/xml`
-* `application/javascript`
-
-If the content-encoding header is not present, Base64 encoding depends on the content type. For the content types, `text/*`, `application/json`, `application/xml`, and `application/javascript`, the service sends the body as is and sets `is_base64_encoded` to `false`.
+[Click here](https://docs.aws.amazon.com/lambda/latest/dg/services-vpc-lattice.html){target="_blank"} for more information about using AWS Lambda with Amazon VPC Lattice.
 
 === "app.py"
 
     ```python
-    from aws_lambda_powertools.utilities.data_classes import event_source, VPCLatticeEvent
-
-    @event_source(data_class=VPCLatticeEvent)
-    def lambda_handler(event: VPCLatticeEvent, context):
-        do_something_with(event.body)
-
+    --8<-- "examples/event_sources/src/vpc_lattice.py"
     ```
 
 === "Lattice Example Event"
 
-    ```json
-    {
-        "raw_path": "/testpath",
-        "method": "GET",
-        "headers": {
-            "user_agent": "curl/7.64.1",
-            "x-forwarded-for": "10.213.229.10",
-            "host": "test-lambda-service-3908sdf9u3u.dkfjd93.vpc-lattice-svcs.us-east-2.on.aws",
-            "accept": "*/*"
-        },
-        "query_string_parameters": {
-            "key": "value"
-        },
-        "body": "...",
-        "is_base64_encoded": false
-    }
-    ```
-
-=== "Lattice Return Object"
-
     ```python
-    response = {
-        "isBase64Encoded": False,
-        "statusCode": 200,
-        headers: {
-            "Content-Type": "application/text"
-        },
-        body: "Event Response to VPC Lattice 🔥🚀🔥"
-    }
-
-    return response
+    --8<-- "examples/event_sources/src/vpc_lattice_payload.json"
     ```
 
-The response from your Lambda function must include the Base64 encoding status, status code, and headers. You can omit the body.
-
-To include a binary content in the body of the response, you must Base64 encode the content and set `isBase64Encoded` to `True`. The service decodes the content to retrieve the binary content and sends it to the client in the body of the HTTP response.
-
-The VPC Lattice service does not honor hop-by-hop headers, such as `Connection` or `Transfer-Encoding`. You can omit the `Content-Length` header because the service computes it before sending responses to clients.
-
 ## Advanced
 
 ### Debugging

examples/event_sources/src/vpc_lattice.py

@@ -0,0 +1,19 @@
+from aws_lambda_powertools import Logger
+from aws_lambda_powertools.utilities.data_classes import VPCLatticeEvent, event_source
+from aws_lambda_powertools.utilities.typing import LambdaContext
+
+logger = Logger()
+
+
+@event_source(data_class=VPCLatticeEvent)
+def lambda_handler(event: VPCLatticeEvent, context: LambdaContext):
+    logger.info(event.body)
+
+    response = {
+        "isBase64Encoded": False,
+        "statusCode": 200,
+        "headers": {"Content-Type": "application/text"},
+        "body": "Event Response to VPC Lattice 🔥🚀🔥",
+    }
+
+    return response

examples/event_sources/src/vpc_lattice_payload.json

@@ -0,0 +1,15 @@
+{
+    "raw_path": "/testpath",
+    "method": "GET",
+    "headers": {
+      "user_agent": "curl/7.64.1",
+      "x-forwarded-for": "10.213.229.10",
+      "host": "test-lambda-service-3908sdf9u3u.dkfjd93.vpc-lattice-svcs.us-east-2.on.aws",
+      "accept": "*/*"
+    },
+    "query_string_parameters": {
+      "order-id": "1"
+    },
+    "body": "eyJ0ZXN0IjogImV2ZW50In0=",
+    "is_base64_encoded": true
+  }

tests/events/vpcLatticeEvent.json

@@ -7,7 +7,9 @@
     "host": "test-lambda-service-3908sdf9u3u.dkfjd93.vpc-lattice-svcs.us-east-2.on.aws",
     "accept": "*/*"
   },
-  "query_string_parameters": {},
-  "body": "",
-  "is_base64_encoded": false
+  "query_string_parameters": {
+    "order-id": "1"
+  },
+  "body": "eyJ0ZXN0IjogImV2ZW50In0=",
+  "is_base64_encoded": true
 }

tests/functional/test_data_classes.py

@@ -25,7 +25,7 @@
     SESEvent,
     SNSEvent,
     SQSEvent,
-    VPCLatticeEvent
+    VPCLatticeEvent,
 )
 from aws_lambda_powertools.utilities.data_classes.api_gateway_authorizer_event import (
     APIGatewayAuthorizerEventV2,
@@ -2048,6 +2048,10 @@ def test_vpc_lattice_event():
     event = VPCLatticeEvent(load_event("vpcLatticeEvent.json"))
 
     assert event.raw_path == event["raw_path"]
+    assert event.get_query_string_value("order-id") == "1"
+    assert event.get_header_value("user_agent") == "curl/7.64.1"
+    assert event.decoded_body == '{"test": "event"}'
+    assert event.json_body == {"test": "event"}
     assert event.method == event["method"]
     assert event.headers == event["headers"]
     assert event.query_string_parameters == event["query_string_parameters"]