diff --git a/aws_lambda_powertools/utilities/parser/models/alb.py b/aws_lambda_powertools/utilities/parser/models/alb.py index 13d203d972b..fd733b6fe9b 100644 --- a/aws_lambda_powertools/utilities/parser/models/alb.py +++ b/aws_lambda_powertools/utilities/parser/models/alb.py @@ -30,17 +30,35 @@ class AlbModel(BaseModel): description="The request body. Can be a string or a parsed model if content-type allows parsing.", ) isBase64Encoded: bool = Field(description="Indicates whether the body is base64-encoded.", examples=[False, True]) + # ALB sends either headers and queryStringParameters, or the two multi-value fields, depending on + # the target group's multi-value headers setting. The ones it leaves out are empty dicts, like in ALBEvent. headers: dict[str, str] = Field( - description="The request headers as key-value pairs.", + default_factory=dict, + description="The request headers as key-value pairs. Empty when multi-value headers are enabled.", examples=[ {"host": "example.com", "user-agent": "Mozilla/5.0"}, {"content-type": "application/json", "authorization": "Bearer token123"}, ], ) queryStringParameters: dict[str, str] = Field( - description="The query string parameters as key-value pairs.", + default_factory=dict, + description="The query string parameters as key-value pairs. Empty when multi-value headers are enabled.", examples=[{"page": "1", "limit": "10"}, {"filter": "active", "sort": "name"}], ) + multiValueHeaders: dict[str, list[str]] = Field( + default_factory=dict, + description="The request headers with all their values. Only sent when multi-value headers are enabled.", + examples=[ + {"host": ["example.com"], "cookie": ["name1=value1", "name2=value2"]}, + ], + ) + multiValueQueryStringParameters: dict[str, list[str]] = Field( + default_factory=dict, + description=( + "The query string parameters with all their values. Only sent when multi-value headers are enabled." + ), + examples=[{"myKey": ["val1", "val2"]}], + ) requestContext: AlbRequestContext = Field( description="Contains information about the request context, including the load balancer details.", ) diff --git a/tests/unit/parser/_pydantic/test_alb.py b/tests/unit/parser/_pydantic/test_alb.py index 6cd109941e9..3105dc899e8 100644 --- a/tests/unit/parser/_pydantic/test_alb.py +++ b/tests/unit/parser/_pydantic/test_alb.py @@ -1,6 +1,6 @@ import pytest -from aws_lambda_powertools.utilities.parser import ValidationError +from aws_lambda_powertools.utilities.parser import ValidationError, parse from aws_lambda_powertools.utilities.parser.models import AlbModel from tests.functional.utils import load_event @@ -18,6 +18,29 @@ def test_alb_trigger_event(): assert not parsed_event.isBase64Encoded +def test_alb_trigger_event_with_multi_value_headers(): + raw_event = load_event("albMultiValueQueryStringEvent.json") + parsed_event: AlbModel = parse(event=raw_event, model=AlbModel) + + assert parsed_event.requestContext.elb.targetGroupArn == raw_event["requestContext"]["elb"]["targetGroupArn"] + assert parsed_event.httpMethod == raw_event["httpMethod"] + assert parsed_event.path == raw_event["path"] + assert parsed_event.multiValueQueryStringParameters == raw_event["multiValueQueryStringParameters"] + assert parsed_event.multiValueHeaders == raw_event["multiValueHeaders"] + assert parsed_event.queryStringParameters == {} + assert parsed_event.headers == {} + assert parsed_event.body == raw_event["body"] + assert not parsed_event.isBase64Encoded + + +def test_alb_trigger_event_with_multi_value_headers_and_no_query_string(): + raw_event = load_event("albMultiValueHeadersEvent.json") + parsed_event: AlbModel = parse(event=raw_event, model=AlbModel) + + assert parsed_event.multiValueHeaders == raw_event["multiValueHeaders"] + assert parsed_event.multiValueQueryStringParameters == {} + + def test_validate_event_does_not_conform_with_model(): event = {"invalid": "event"} with pytest.raises(ValidationError):