Skip to content

Commit 2f58434

Browse files
fix(event_handler): preserve commas in scalar query and header parameters (#8509)
fix(event-handler): preserve commas in scalar query and header parameters Co-authored-by: DYNOSuprovo <DYNOSuprovo@users.noreply.github.com>
1 parent f259a77 commit 2f58434

2 files changed

Lines changed: 430 additions & 9 deletions

File tree

‎aws_lambda_powertools/event_handler/middlewares/openapi_validation.py‎

Lines changed: 63 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
import json
66
import logging
77
import warnings
8-
from typing import TYPE_CHECKING, Any, Callable, Mapping, MutableMapping, Sequence, Union, cast
9-
from urllib.parse import parse_qs
8+
from typing import TYPE_CHECKING, Any, Callable, Collection, Mapping, MutableMapping, Sequence, Union, cast
9+
from urllib.parse import parse_qs, unquote
1010

1111
from pydantic import BaseModel
1212
from typing_extensions import get_args, get_origin
@@ -29,6 +29,9 @@
2929
)
3030
from aws_lambda_powertools.event_handler.openapi.params import Param, UploadFile
3131
from aws_lambda_powertools.event_handler.openapi.types import UnionType
32+
from aws_lambda_powertools.utilities.data_classes.alb_event import ALBEvent
33+
from aws_lambda_powertools.utilities.data_classes.common import CaseInsensitiveDict
34+
from aws_lambda_powertools.utilities.data_classes.vpc_lattice import VPCLatticeEventV2
3235

3336
if TYPE_CHECKING:
3437
from pydantic.fields import FieldInfo
@@ -39,6 +42,7 @@
3942
from aws_lambda_powertools.event_handler.openapi.compat import ModelField
4043
from aws_lambda_powertools.event_handler.openapi.types import IncEx
4144
from aws_lambda_powertools.event_handler.types import EventHandlerInstance
45+
from aws_lambda_powertools.utilities.data_classes.common import BaseProxyEvent
4246

4347
logger = logging.getLogger(__name__)
4448

@@ -79,6 +83,7 @@ def handler(self, app: EventHandlerInstance, next_middleware: NextMiddleware) ->
7983
query_string = _normalize_multi_params(
8084
app.current_event.resolved_query_string_parameters,
8185
route.dependant.query_params,
86+
multi_value_params=_get_multi_value_query_params(app.current_event),
8287
)
8388

8489
# Process query values
@@ -91,6 +96,7 @@ def handler(self, app: EventHandlerInstance, next_middleware: NextMiddleware) ->
9196
headers = _normalize_multi_params(
9297
app.current_event.resolved_headers_field,
9398
route.dependant.header_params,
99+
multi_value_params=CaseInsensitiveDict(app.current_event.get("multiValueHeaders")),
94100
)
95101

96102
# Process header values
@@ -583,9 +589,31 @@ def _get_embed_body(
583589
return received_body, field_alias_omitted
584590

585591

592+
def _get_multi_value_query_params(event: BaseProxyEvent) -> Collection[str]:
593+
"""Identify native repeated parameters so they are not mistaken for split scalar strings."""
594+
if raw_query := event.get("rawQueryString"):
595+
return {name for name, values in parse_qs(raw_query, keep_blank_values=True).items() if len(values) > 1}
596+
597+
if isinstance(event, VPCLatticeEventV2):
598+
return {
599+
name
600+
for name, values in (event.get("queryStringParameters") or {}).items()
601+
if isinstance(values, list) and len(values) > 1
602+
}
603+
604+
params = event.multi_value_query_string_parameters
605+
if isinstance(event, ALBEvent) and event.decode_query_parameters:
606+
# Follow the same merge and decoding order as ALBEvent, including decoded key collisions.
607+
decoded_sources = {unquote(name): name in params for name in {**event.query_string_parameters, **params}}
608+
return {name for name, is_multi_value in decoded_sources.items() if is_multi_value}
609+
return params.keys()
610+
611+
586612
def _normalize_multi_params(
587613
input_dict: MutableMapping[str, Any],
588614
params: Sequence[ModelField],
615+
*,
616+
multi_value_params: Collection[str] = (),
589617
) -> MutableMapping[str, Any]:
590618
"""
591619
Extract and normalize query string or header parameters with Pydantic model support.
@@ -596,6 +624,8 @@ def _normalize_multi_params(
596624
A dictionary containing the initial query string or header parameters.
597625
params: Sequence[ModelField]
598626
A sequence of ModelField objects representing parameters.
627+
multi_value_params: Collection[str]
628+
Names supplied as native multiple values rather than comma-separated strings.
599629
600630
Returns
601631
-------
@@ -604,23 +634,44 @@ def _normalize_multi_params(
604634
"""
605635
for param in params:
606636
if is_scalar_field(param):
607-
_process_scalar_param(input_dict, param)
637+
_process_scalar_param(input_dict, param, multi_value_params)
608638
elif lenient_issubclass(param.field_info.annotation, BaseModel):
609-
_process_model_param(input_dict, param)
639+
_process_model_param(input_dict, param, multi_value_params)
610640
return input_dict
611641

612642

613-
def _process_scalar_param(input_dict: MutableMapping[str, Any], param: ModelField) -> None:
614-
"""Process a scalar parameter by normalizing single-item lists."""
643+
def _restore_scalar_parameter(value: Any, name: str, multi_value_params: Collection[str]) -> Any:
644+
"""Reconstruct a scalar string split by the event, leaving native multiple values intact."""
645+
if (
646+
isinstance(value, list)
647+
and len(value) > 1
648+
and name not in multi_value_params
649+
and all(isinstance(item, str) for item in value)
650+
):
651+
return ",".join(value)
652+
return value
653+
654+
655+
def _process_scalar_param(
656+
input_dict: MutableMapping[str, Any],
657+
param: ModelField,
658+
multi_value_params: Collection[str],
659+
) -> None:
660+
"""Restore scalar strings and unwrap single-item lists."""
615661
try:
616-
value = input_dict[param.alias]
662+
value = _restore_scalar_parameter(input_dict[param.alias], param.alias, multi_value_params)
617663
if isinstance(value, list) and len(value) == 1:
618-
input_dict[param.alias] = value[0]
664+
value = value[0]
665+
input_dict[param.alias] = value
619666
except KeyError:
620667
pass
621668

622669

623-
def _process_model_param(input_dict: MutableMapping[str, Any], param: ModelField) -> None:
670+
def _process_model_param(
671+
input_dict: MutableMapping[str, Any],
672+
param: ModelField,
673+
multi_value_params: Collection[str],
674+
) -> None:
624675
"""Process a Pydantic model parameter by extracting model fields."""
625676
model_class = cast(type[BaseModel], param.field_info.annotation)
626677

@@ -630,6 +681,9 @@ def _process_model_param(input_dict: MutableMapping[str, Any], param: ModelField
630681
value = _get_param_value(input_dict, field_alias, field_name, model_class)
631682

632683
if value is not None:
684+
if not _is_or_contains_sequence(field_info.annotation):
685+
source_name = field_alias if input_dict.get(field_alias) is not None else field_name
686+
value = _restore_scalar_parameter(value, source_name, multi_value_params)
633687
model_data[field_alias] = _normalize_field_value(value=value, field_info=field_info)
634688

635689
input_dict[param.alias] = model_data

0 commit comments

Comments
 (0)