Skip to content

fix(event_source): Added missing properties in APIGatewayWebSocketEvent class #6411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 7, 2025
Merged

fix(event_source): Added missing properties in APIGatewayWebSocketEvent class #6411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d8e8860
Added 2 new properties for querystring parameters and multi value que…
dave-dotnet-overall Apr 6, 2025
630f324
Merge branch 'develop' into bug/add-missing-websocket-properties
leandrodamascena Apr 6, 2025
6e649e0
Added missing test cases for querystring properties
dave-dotnet-overall Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions aws_lambda_powertools/utilities/data_classes/api_gateway_websocket_event.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,14 @@ def headers(self) -> dict[str, str]:
def multi_value_headers(self) -> dict[str, list[str]]:
return CaseInsensitiveDict(self.get("multiValueHeaders"))

@property
def query_string_parameters(self) -> dict[str, str]:
return CaseInsensitiveDict(self.get("queryStringParameters"))

@property
def multi_value_query_string_parameters(self) -> dict[str, list[str]]:
return CaseInsensitiveDict(self.get("multiValueQueryStringParameters"))

@property
def request_context(self) -> APIGatewayWebSocketEventRequestContext:
return APIGatewayWebSocketEventRequestContext(self["requestContext"])
9 changes: 9 additions & 0 deletions tests/events/apiGatewayWebSocketApiConnect.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,15 @@
"X-Forwarded-Port": ["443"],
"X-Forwarded-Proto": ["https"]
},
"queryStringParameters": {
"userId": "user123",
"token": "abc.def.ghi"
},
"multiValueQueryStringParameters": {
"userId": ["123"],
"token": ["abc.def.ghi"],
"filter": ["new", "unread"]
},
"requestContext": {
"routeKey": "$connect",
"eventType": "CONNECT",
Expand Down
9 changes: 9 additions & 0 deletions tests/events/apiGatewayWebSocketApiDisconnect.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@
"X-Forwarded-For": [""],
"x-restapi": [""]
},
"queryStringParameters": {
"userId": "user123",
"token": "abc.def.ghi"
},
"multiValueQueryStringParameters": {
"userId": ["123"],
"token": ["abc.def.ghi"],
"filter": ["new", "unread"]
},
"requestContext": {
"routeKey": "$disconnect",
"disconnectStatusCode": 1005,
Expand Down
4 changes: 4 additions & 0 deletions tests/unit/data_classes/required_dependencies/test_api_gateway_websocket_event.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ def test_connect_api_gateway_websocket_event():
assert parsed_event.json_body is None
assert parsed_event.headers == raw_event["headers"]
assert parsed_event.multi_value_headers == raw_event["multiValueHeaders"]
assert parsed_event.query_string_parameters == raw_event["queryStringParameters"]
assert parsed_event.multi_value_query_string_parameters == raw_event["multiValueQueryStringParameters"]

request_context = parsed_event.request_context
request_context_raw = raw_event["requestContext"]
Expand Down Expand Up @@ -84,6 +86,8 @@ def test_message_api_gateway_websocket_event():
assert parsed_event.json_body == json.loads(raw_event["body"])
assert parsed_event.headers == {}
assert parsed_event.multi_value_headers == {}
assert parsed_event.query_string_parameters == {}
assert parsed_event.multi_value_query_string_parameters == {}

request_context = parsed_event.request_context
request_context_raw = raw_event["requestContext"]
Expand Down
Loading