feat(event_sources): add support for Lambda Function URL events

Author: rubenfonseca

aws_lambda_powertools/utilities/data_classes/__init__.py

@@ -12,6 +12,7 @@
 from .event_bridge_event import EventBridgeEvent
 from .event_source import event_source
 from .kinesis_stream_event import KinesisStreamEvent
+from .lambda_function_url_event import LambdaFunctionUrlEvent
 from .s3_event import S3Event
 from .ses_event import SESEvent
 from .sns_event import SNSEvent
@@ -28,6 +29,7 @@
     "DynamoDBStreamEvent",
     "EventBridgeEvent",
     "KinesisStreamEvent",
+    "LambdaFunctionUrlEvent",
     "S3Event",
     "SESEvent",
     "SNSEvent",

aws_lambda_powertools/utilities/data_classes/api_gateway_proxy_event.py

@@ -127,19 +127,22 @@ def caller_id(self) -> Optional[str]:
     def cognito_amr(self) -> Optional[List[str]]:
         """This represents how the user was authenticated.
         AMR stands for  Authentication Methods References as per the openid spec"""
-        return self["cognitoIdentity"].get("amr")
+        cognito_identity = self["cognitoIdentity"] or {}
+        return cognito_identity.get("amr")
 
     @property
     def cognito_identity_id(self) -> Optional[str]:
         """The Amazon Cognito identity ID of the caller making the request.
         Available only if the request was signed with Amazon Cognito credentials."""
-        return self["cognitoIdentity"].get("identityId")
+        cognito_identity = self.get("cognitoIdentity") or {}
+        return cognito_identity.get("identityId")
 
     @property
     def cognito_identity_pool_id(self) -> Optional[str]:
         """The Amazon Cognito identity pool ID of the caller making the request.
         Available only if the request was signed with Amazon Cognito credentials."""
-        return self["cognitoIdentity"].get("identityPoolId")
+        cognito_identity = self.get("cognitoIdentity") or {}
+        return cognito_identity.get("identityPoolId")
 
     @property
     def principal_org_id(self) -> Optional[str]:
@@ -159,12 +162,14 @@ def user_id(self) -> Optional[str]:
 
 class RequestContextV2Authorizer(DictWrapper):
     @property
-    def jwt_claim(self) -> Dict[str, Any]:
-        return self["jwt"]["claims"]
+    def jwt_claim(self) -> Optional[Dict[str, Any]]:
+        jwt = self.get("jwt") or {}
+        return jwt.get("claims")
 
     @property
-    def jwt_scopes(self) -> List[str]:
-        return self["jwt"]["scopes"]
+    def jwt_scopes(self) -> Optional[List[str]]:
+        jwt = self.get("jwt") or {}
+        return jwt.get("scopes")
 
     @property
     def get_lambda(self) -> Optional[Dict[str, Any]]:

aws_lambda_powertools/utilities/data_classes/common.py

@@ -395,5 +395,6 @@ def time_epoch(self) -> int:
     @property
     def authentication(self) -> Optional[RequestContextClientCert]:
         """Optional when using mutual TLS authentication"""
-        client_cert = self["requestContext"].get("authentication", {}).get("clientCert")
+        authentication = self["requestContext"].get("authentication") or {}
+        client_cert = authentication.get("clientCert")
         return None if client_cert is None else RequestContextClientCert(client_cert)

docs/utilities/data_classes.md

@@ -3,6 +3,8 @@ title: Event Source Data Classes
 description: Utility
 ---
 
+<!-- markdownlint-disable MD043 -->
+
 Event Source Data Classes utility provides classes self-describing Lambda event sources.
 
 ## Key Features
@@ -73,6 +75,7 @@ Event Source | Data_class
 [DynamoDB streams](#dynamodb-streams) | `DynamoDBStreamEvent`, `DynamoDBRecordEventName`
 [EventBridge](#eventbridge) | `EventBridgeEvent`
 [Kinesis Data Stream](#kinesis-streams) | `KinesisStreamEvent`
+[Lambda Function URL](#lambda-function-url) | `LambdaFunctionUrlEvent`
 [Rabbit MQ](#rabbit-mq) | `RabbitMQEvent`
 [S3](#s3) | `S3Event`
 [S3 Object Lambda](#s3-object-lambda) | `S3ObjectLambdaEvent`
@@ -837,6 +840,18 @@ or plain text, depending on the original payload.
         do_something_with(data)
     ```
 
+### Lambda Function URL
+
+=== "app.py"
+
+    ```python
+    from aws_lambda_powertools.utilities.data_classes import event_source, LambdaFunctoinUrlEvent
+
+    @event_source(data_class=LambdaFunctionUrlEvent)
+    def lambda_handler(event: LambdaFunctionUrlEvent, context):
+        do_something_with(event.body)
+    ```
+
 ### Rabbit MQ
 
 It is used for [Rabbit MQ payloads](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html){target="_blank"}, also see

tests/events/lambdaFunctionUrlEvent.json

@@ -0,0 +1,52 @@
+{
+  "version": "2.0",
+  "routeKey": "$default",
+  "rawPath": "/my/path",
+  "rawQueryString": "parameter1=value1&parameter1=value2&parameter2=value",
+  "cookies": [
+    "cookie1",
+    "cookie2"
+  ],
+  "headers": {
+    "header1": "value1",
+    "header2": "value1,value2"
+  },
+  "queryStringParameters": {
+    "parameter1": "value1,value2",
+    "parameter2": "value"
+  },
+  "requestContext": {
+    "accountId": "123456789012",
+    "apiId": "<urlid>",
+    "authentication": null,
+    "authorizer": {
+        "iam": {
+                "accessKey": "AKIA...",
+                "accountId": "111122223333",
+                "callerId": "AIDA...",
+                "cognitoIdentity": null,
+                "principalOrgId": null,
+                "userArn": "arn:aws:iam::111122223333:user/example-user",
+                "userId": "AIDA..."
+        }
+    },
+    "domainName": "<url-id>.lambda-url.us-west-2.on.aws",
+    "domainPrefix": "<url-id>",
+    "http": {
+      "method": "POST",
+      "path": "/my/path",
+      "protocol": "HTTP/1.1",
+      "sourceIp": "123.123.123.123",
+      "userAgent": "agent"
+    },
+    "requestId": "id",
+    "routeKey": "$default",
+    "stage": "$default",
+    "time": "12/Mar/2020:19:03:58 +0000",
+    "timeEpoch": 1583348638390
+  },
+  "body": "Hello from client!",
+  "pathParameters": null,
+  "isBase64Encoded": false,
+  "stageVariables": null
+}

tests/functional/data_classes/test_lambda_function_url.py

@@ -0,0 +1,67 @@
+from aws_lambda_powertools.utilities.data_classes import LambdaFunctionUrlEvent
+from tests.functional.utils import load_event
+
+
+def test_lambda_function_url_event():
+    event = LambdaFunctionUrlEvent(load_event("lambdaFunctionUrlEvent.json"))
+
+    assert event.version == "2.0"
+    assert event.route_key == "$default"
+
+    assert event.path == "/my/path"
+    assert event.raw_query_string == "parameter1=value1&parameter1=value2&parameter2=value"
+
+    cookies = event.cookies
+    assert len(cookies) == 2
+    assert cookies[0] == "cookie1"
+
+    headers = event.headers
+    assert len(headers) == 2
+
+    query_string_parameters = event.query_string_parameters
+    assert len(query_string_parameters) == 2
+    assert query_string_parameters.get("parameter2") == "value"
+
+    assert event.is_base64_encoded is False
+    assert event.body == "Hello from client!"
+    assert event.decoded_body == event.body
+    assert event.path_parameters is None
+    assert event.stage_variables is None
+    assert event.http_method == "POST"
+
+    request_context = event.request_context
+
+    assert request_context.account_id == "123456789012"
+    assert request_context.api_id is not None
+    assert request_context.domain_name == "<url-id>.lambda-url.us-west-2.on.aws"
+    assert request_context.domain_prefix == "<url-id>"
+    assert request_context.request_id == "id"
+    assert request_context.route_key == "$default"
+    assert request_context.stage == "$default"
+    assert request_context.time is not None
+    assert request_context.time_epoch == 1583348638390
+    assert request_context.authentication is None
+
+    http = request_context.http
+    assert http.method == "POST"
+    assert http.path == "/my/path"
+    assert http.protocol == "HTTP/1.1"
+    assert http.source_ip == "123.123.123.123"
+    assert http.user_agent == "agent"
+
+    authorizer = request_context.authorizer
+    assert authorizer is not None
+    assert authorizer.jwt_claim is None
+    assert authorizer.jwt_scopes is None
+    assert authorizer.get_lambda is None
+
+    iam = authorizer.iam
+    assert iam is not None
+    assert iam.access_key is not None
+    assert iam.account_id == "111122223333"
+    assert iam.caller_id is not None
+    assert iam.cognito_identity_id is None
+    assert iam.cognito_identity_pool_id is None
+    assert iam.principal_org_id is None
+    assert iam.user_id is not None
+    assert iam.user_arn == "arn:aws:iam::111122223333:user/example-user"