From 41a8741b8b8fea7df1bed8952a761fb12b88fa1a Mon Sep 17 00:00:00 2001 From: Adam Johnson Date: Mon, 12 Oct 2020 23:59:58 +0100 Subject: [PATCH] Fix query string parameter encoding (#187) Fixes #186. --- HISTORY.rst | 6 +++++- src/apig_wsgi.py | 14 +++++++------- tests/test_apig_wsgi.py | 26 ++++++++++++++++++++------ 3 files changed, 32 insertions(+), 14 deletions(-) diff --git a/HISTORY.rst b/HISTORY.rst index 724abe9..f4bc806 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -3,6 +3,9 @@ History ======= * Support Python 3.9. +* Fix query string parameter encoding so that symbols are correctly re-encoded + for WSGI, for API Gateway format version 1 + (`Issue #186 `__). 2.9.0 (2020-10-12) ------------------ @@ -11,7 +14,8 @@ History * Always send ``isBase64Encoded`` in responses, as per the AWS documentation. * Support `format version 2 `, - which was introduced by API Gateway for “HTTP API's”. + which was introduced by API Gateway for “HTTP API's” + (`Issue #124 `__).. * ``binary_support`` now defaults to ``None``, which means that it will automatically enable binary support for format version 2 events. diff --git a/src/apig_wsgi.py b/src/apig_wsgi.py index a261c38..424d008 100644 --- a/src/apig_wsgi.py +++ b/src/apig_wsgi.py @@ -2,6 +2,7 @@ from base64 import b64decode, b64encode from collections import defaultdict from io import BytesIO +from urllib.parse import urlencode __all__ = ("make_lambda_handler",) @@ -87,14 +88,13 @@ def get_environ_v1(event, context, binary_support): # Multi-value query strings need explicit activation on ALB if "multiValueQueryStringParameters" in event: - # may be None when testing on console - multi_params = event["multiValueQueryStringParameters"] or {} + environ["QUERY_STRING"] = urlencode( + # may be None when testing on console + event["multiValueQueryStringParameters"] or (), + doseq=True, + ) else: - single_params = event.get("queryStringParameters") or {} - multi_params = {key: [value] for key, value in single_params.items()} - environ["QUERY_STRING"] = "&".join( - "{}={}".format(key, val) for (key, vals) in multi_params.items() for val in vals - ) + environ["QUERY_STRING"] = urlencode(event.get("queryStringParameters") or ()) # Multi-value headers need explicit activation on ALB if "multiValueHeaders" in event: diff --git a/tests/test_apig_wsgi.py b/tests/test_apig_wsgi.py index 6eca17c..2c98ab4 100644 --- a/tests/test_apig_wsgi.py +++ b/tests/test_apig_wsgi.py @@ -328,19 +328,19 @@ def test_querystring_one_single(self, simple_app): assert simple_app.environ["QUERY_STRING"] == "foo=bar" - def test_querystring_encoding_value(self, simple_app): - event = make_v1_event(qs_params={"foo": ["a%20bar"]}) + def test_querystring_encoding_plus_value(self, simple_app): + event = make_v1_event(qs_params={"a": ["b+c"]}, qs_params_multi=False) simple_app.handler(event, None) - assert simple_app.environ["QUERY_STRING"] == "foo=a%20bar" + assert simple_app.environ["QUERY_STRING"] == "a=b%2Bc" - def test_querystring_encoding_key(self, simple_app): - event = make_v1_event(qs_params={"a%20foo": ["bar"]}) + def test_querystring_encoding_plus_key(self, simple_app): + event = make_v1_event(qs_params={"a+b": ["c"]}, qs_params_multi=False) simple_app.handler(event, None) - assert simple_app.environ["QUERY_STRING"] == "a%20foo=bar" + assert simple_app.environ["QUERY_STRING"] == "a%2Bb=c" def test_querystring_multi(self, simple_app): event = make_v1_event(qs_params={"foo": ["bar", "baz"]}) @@ -349,6 +349,20 @@ def test_querystring_multi(self, simple_app): assert simple_app.environ["QUERY_STRING"] == "foo=bar&foo=baz" + def test_querystring_multi_encoding_plus_value(self, simple_app): + event = make_v1_event(qs_params={"a": ["b+c", "d"]}) + + simple_app.handler(event, None) + + assert simple_app.environ["QUERY_STRING"] == "a=b%2Bc&a=d" + + def test_querystring_multi_encoding_plus_key(self, simple_app): + event = make_v1_event(qs_params={"a+b": ["c"]}) + + simple_app.handler(event, None) + + assert simple_app.environ["QUERY_STRING"] == "a%2Bb=c" + def test_plain_header(self, simple_app): event = make_v1_event(headers={"Test-Header": ["foobar"]})