Skip to content

Commit 717968f

Browse files
goya813monkutrehanhwr
authored
fixed conflict(Feature: Handle V2 Event #1182) (#1377)
* 🔧 migrate #971 to lastest master * 🎨 run black/isort * ♻️ refactor to allow for other binary ignore types based on mimetype. (currently openapi schema can't be passed as text. * 🎨 run black/fix flake8 * 🔧 add EXCEPTION_HANDLER setting * 🐛 fix zappa_returndict["body"] assignment * 📝 add temp debug info * 🔥 delete unnecessary print statements * ♻️ Update comments and minor refactor for clarity * ♻️ refactor for ease of testing and clarity * 🎨 fix flake8 * ✨ add `additional_text_mimetypes` setting ✅ add testcases for additional_text_mimetypes handling * 🔧 Expand default text mimetypes mentioned in #1023 ♻️ define "DEFAULT_TEXT_MIMETYPES" and move to utilities.py * 🎨 run black/isort * 🎨 run black/isort * feat: implement handler for event with format version 2.0 * refactor: getting processed response body from new method * fix: lint error * chore: move variable initialization before initial if condition * refactor: abstract implementations to two processing methods * fix: determine payload version based on value in the event itself * fixed lint --------- Co-authored-by: monkut <shane.cousins@gmail.com> Co-authored-by: Rehan Hawari <rehan.hawari10@gmail.com>
1 parent 99c8fbb commit 717968f

4 files changed

Lines changed: 357 additions & 37 deletions

File tree

‎tests/test_handler.py‎

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,6 @@ def test_wsgi_script_binary_support_without_content_encoding_edgecases(
285285
"""
286286
Ensure zappa response bodies are NOT base64 encoded when BINARY_SUPPORT is enabled and the mimetype is "application/json" or starts with "text/".
287287
"""
288-
289288
lh = LambdaHandler("tests.test_binary_support_settings")
290289

291290
text_plain_event = {
@@ -320,7 +319,6 @@ def test_wsgi_script_binary_support_without_content_encoding(
320319
"""
321320
Ensure zappa response bodies are base64 encoded when BINARY_SUPPORT is enabled and Content-Encoding is absent.
322321
"""
323-
324322
lh = LambdaHandler("tests.test_binary_support_settings")
325323

326324
text_plain_event = {
@@ -577,3 +575,35 @@ def test_cloudwatch_subscription_event(self):
577575
response = lh.handler(event, None)
578576

579577
self.assertEqual(response, True)
578+
579+
def test_wsgi_script_name_on_v2_formatted_event(self):
580+
"""
581+
Ensure that requests with payload format version 2.0 succeed
582+
"""
583+
lh = LambdaHandler("tests.test_wsgi_script_name_settings")
584+
585+
event = {
586+
"version": "2.0",
587+
"routeKey": "$default",
588+
"rawPath": "/",
589+
"rawQueryString": "",
590+
"headers": {
591+
"host": "1234567890.execute-api.us-east-1.amazonaws.com",
592+
},
593+
"requestContext": {
594+
"http": {
595+
"method": "GET",
596+
"path": "/return/request/url",
597+
},
598+
},
599+
"isBase64Encoded": False,
600+
"body": "",
601+
"cookies": ["Cookie_1=Value1; Expires=21 Oct 2021 07:48 GMT", "Cookie_2=Value2; Max-Age=78000"],
602+
}
603+
response = lh.handler(event, None)
604+
605+
self.assertEqual(response["statusCode"], 200)
606+
self.assertEqual(
607+
response["body"],
608+
"https://1234567890.execute-api.us-east-1.amazonaws.com/dev/return/request/url",
609+
)

‎tests/tests.py‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1192,6 +1192,158 @@ def test_wsgi_from_apigateway_testbutton(self):
11921192
response_tuple = collections.namedtuple("Response", ["status_code", "content"])
11931193
response = response_tuple(200, "hello")
11941194

1195+
def test_wsgi_from_v2_event(self):
1196+
event = {
1197+
"version": "2.0",
1198+
"routeKey": "ANY /{proxy+}",
1199+
"rawPath": "/",
1200+
"rawQueryString": "",
1201+
"headers": {
1202+
"accept": "*/*",
1203+
"accept-encoding": "gzip, deflate, br",
1204+
"accept-language": "en-US,en;q=0.9",
1205+
"cache-control": "no-cache",
1206+
"content-length": "0",
1207+
"dnt": "1",
1208+
"host": "qw8klxioji.execute-api.eu-west-1.amazonaws.com",
1209+
"pragma": "no-cache",
1210+
"upgrade-insecure-requests": "1",
1211+
"user-agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36",
1212+
"x-forwarded-for": "50.191.225.98",
1213+
"x-forwarded-port": "443",
1214+
"x-forwarded-proto": "https",
1215+
},
1216+
"requestContext": {
1217+
"accountId": "724336686645",
1218+
"apiId": "qw8klxioji",
1219+
"domainName": "qw8klxioji.execute-api.eu-west-1.amazonaws.com",
1220+
"domainPrefix": "qw8klxioji",
1221+
"http": {
1222+
"method": "GET",
1223+
"path": "/",
1224+
"protocol": "HTTP/1.1",
1225+
"sourceIp": "50.191.225.98",
1226+
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36",
1227+
},
1228+
"requestId": "xTG4wqXdSQ0RHpA=",
1229+
"routeKey": "ANY /{proxy+}",
1230+
"stage": "$default",
1231+
"time": "16/Oct/2022:11:17:12 +0000",
1232+
"timeEpoch": 1665919032135,
1233+
},
1234+
"pathParameters": {"proxy": ""},
1235+
"isBase64Encoded": False,
1236+
}
1237+
environ = create_wsgi_request(event)
1238+
self.assertTrue(environ)
1239+
1240+
def test_wsgi_from_v2_event_with_lambda_authorizer(self):
1241+
principal_id = "user|a1b2c3d4"
1242+
authorizer = {"lambda": {"bool": True, "key": "value", "number": 1, "principalId": principal_id}}
1243+
event = {
1244+
"version": "2.0",
1245+
"routeKey": "ANY /{proxy+}",
1246+
"rawPath": "/",
1247+
"rawQueryString": "",
1248+
"headers": {
1249+
"accept": "*/*",
1250+
"accept-encoding": "gzip, deflate, br",
1251+
"authorization": "Bearer 1232314343",
1252+
"content-length": "28",
1253+
"content-type": "application/json",
1254+
"host": "qw8klxioji.execute-api.eu-west-1.amazonaws.com",
1255+
"user-agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36",
1256+
"x-forwarded-for": "50.191.225.98",
1257+
"x-forwarded-port": "443",
1258+
"x-forwarded-proto": "https",
1259+
},
1260+
"requestContext": {
1261+
"accountId": "724336686645",
1262+
"apiId": "qw8klxioji",
1263+
"authorizer": authorizer,
1264+
"domainName": "qw8klxioji.execute-api.eu-west-1.amazonaws.com",
1265+
"domainPrefix": "qw8klxioji",
1266+
"http": {
1267+
"method": "POST",
1268+
"path": "/",
1269+
"protocol": "HTTP/1.1",
1270+
"sourceIp": "50.191.225.98",
1271+
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36",
1272+
},
1273+
"requestId": "aJ6Rqi93zQ0GPng=",
1274+
"routeKey": "ANY /{proxy+}",
1275+
"stage": "$default",
1276+
"time": "17/Oct/2022:14:58:44 +0000",
1277+
"timeEpoch": 1666018724000,
1278+
},
1279+
"pathParameters": {"proxy": ""},
1280+
"body": "{'data':'0123456789'}",
1281+
"isBase64Encoded": False,
1282+
}
1283+
environ = create_wsgi_request(event)
1284+
self.assertEqual(environ["API_GATEWAY_AUTHORIZER"], authorizer)
1285+
self.assertEqual(environ["REMOTE_USER"], principal_id)
1286+
1287+
def test_wsgi_from_v2_event_with_iam_authorizer(self):
1288+
user_arn = "arn:aws:sts::724336686645:assumed-role/SAMLUSER/user.name"
1289+
authorizer = {
1290+
"iam": {
1291+
"accessKey": "AWSACCESSKEYID",
1292+
"accountId": "724336686645",
1293+
"callerId": "KFDJSURSUC8FU3ITCWEDJ:user.name",
1294+
"cognitoIdentity": None,
1295+
"principalOrgId": "aws:PrincipalOrgID",
1296+
"userArn": user_arn,
1297+
"userId": "KFDJSURSUC8FU3ITCWEDJ:user.name",
1298+
}
1299+
}
1300+
event = {
1301+
"version": "2.0",
1302+
"routeKey": "ANY /{proxy+}",
1303+
"rawPath": "/",
1304+
"rawQueryString": "",
1305+
"headers": {
1306+
"accept": "*/*",
1307+
"accept-encoding": "gzip, deflate",
1308+
"authorization": "AWS4-HMAC-SHA256 Credential=AWSACCESSKEYID/20221017/eu-west-1/execute-api/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=foosignature",
1309+
"content-length": "17",
1310+
"content-type": "application/json",
1311+
"host": "qw8klxioji.execute-api.eu-west-1.amazonaws.com",
1312+
"user-agent": "python-requests/2.28.1",
1313+
"x-amz-content-sha256": "foobar",
1314+
"x-amz-date": "20221017T150616Z",
1315+
"x-amz-security-token": "footoken",
1316+
"x-forwarded-for": "50.191.225.98",
1317+
"x-forwarded-port": "443",
1318+
"x-forwarded-proto": "https",
1319+
},
1320+
"requestContext": {
1321+
"accountId": "724336686645",
1322+
"apiId": "qw8klxioji",
1323+
"authorizer": authorizer,
1324+
"domainName": "qw8klxioji.execute-api.eu-west-1.amazonaws.com",
1325+
"domainPrefix": "qw8klxioji",
1326+
"http": {
1327+
"method": "POST",
1328+
"path": "/",
1329+
"protocol": "HTTP/1.1",
1330+
"sourceIp": "50.191.225.98",
1331+
"userAgent": "python-requests/2.28.1",
1332+
},
1333+
"requestId": "aJ5ZZgeYiQ0Rz-A=",
1334+
"routeKey": "ANY /{proxy+}",
1335+
"stage": "$default",
1336+
"time": "17/Oct/2022:15:06:16 +0000",
1337+
"timeEpoch": 1666019176656,
1338+
},
1339+
"pathParameters": {"proxy": ""},
1340+
"body": "{'data': '12345'}",
1341+
"isBase64Encoded": False,
1342+
}
1343+
environ = create_wsgi_request(event)
1344+
self.assertEqual(environ["API_GATEWAY_AUTHORIZER"], authorizer)
1345+
self.assertEqual(environ["REMOTE_USER"], user_arn)
1346+
11951347
##
11961348
# Handler
11971349
##

‎zappa/handler.py‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -517,6 +517,118 @@ def handler(self, event, context):
517517
logger.error("Cannot find a function to process the triggered event.")
518518
return result
519519

520+
# This is an HTTP-protocol API Gateway event or Lambda url event with payload format version 2.0
521+
elif "version" in event and event["version"] == "2.0":
522+
try:
523+
time_start = datetime.datetime.now()
524+
525+
script_name = ""
526+
host = event.get("headers", {}).get("host")
527+
if host:
528+
if "amazonaws.com" in host:
529+
logger.debug("amazonaws found in host")
530+
# The path provided in th event doesn't include the
531+
# stage, so we must tell Flask to include the API
532+
# stage in the url it calculates. See https://github.com/Miserlou/Zappa/issues/1014
533+
script_name = f"/{settings.API_STAGE}"
534+
else:
535+
# This is a test request sent from the AWS console
536+
if settings.DOMAIN:
537+
# Assume the requests received will be on the specified
538+
# domain. No special handling is required
539+
pass
540+
else:
541+
# Assume the requests received will be to the
542+
# amazonaws.com endpoint, so tell Flask to include the
543+
# API stage
544+
script_name = f"/{settings.API_STAGE}"
545+
546+
base_path = getattr(settings, "BASE_PATH", None)
547+
environ = create_wsgi_request(
548+
event,
549+
script_name=script_name,
550+
base_path=base_path,
551+
trailing_slash=self.trailing_slash,
552+
binary_support=settings.BINARY_SUPPORT,
553+
context_header_mappings=settings.CONTEXT_HEADER_MAPPINGS,
554+
)
555+
556+
# We are always on https on Lambda, so tell our wsgi app that.
557+
environ["HTTPS"] = "on"
558+
environ["wsgi.url_scheme"] = "https"
559+
environ["lambda.context"] = context
560+
environ["lambda.event"] = event
561+
562+
# Execute the application
563+
with Response.from_app(self.wsgi_app, environ) as response:
564+
response_body = None
565+
response_is_base_64_encoded = False
566+
if response.data:
567+
response_body, response_is_base_64_encoded = self._process_response_body(response, settings=settings)
568+
569+
response_status_code = response.status_code
570+
571+
cookies = []
572+
response_headers = {}
573+
for key, value in response.headers:
574+
if key.lower() == "set-cookie":
575+
cookies.append(value)
576+
else:
577+
if key in response_headers:
578+
updated_value = f"{response_headers[key]},{value}"
579+
response_headers[key] = updated_value
580+
else:
581+
response_headers[key] = value
582+
583+
# Calculate the total response time,
584+
# and log it in the Common Log format.
585+
time_end = datetime.datetime.now()
586+
delta = time_end - time_start
587+
response_time_ms = delta.total_seconds() * 1000
588+
response.content = response.data
589+
common_log(environ, response, response_time=response_time_ms)
590+
591+
return {
592+
"cookies": cookies,
593+
"isBase64Encoded": response_is_base_64_encoded,
594+
"statusCode": response_status_code,
595+
"headers": response_headers,
596+
"body": response_body,
597+
}
598+
except Exception as e:
599+
# Print statements are visible in the logs either way
600+
print(e)
601+
exc_info = sys.exc_info()
602+
message = (
603+
"An uncaught exception happened while servicing this request. "
604+
"You can investigate this with the `zappa tail` command."
605+
)
606+
607+
# If we didn't even build an app_module, just raise.
608+
if not settings.DJANGO_SETTINGS:
609+
try:
610+
self.app_module
611+
except NameError as ne:
612+
message = "Failed to import module: {}".format(ne.message)
613+
614+
# Call exception handler for unhandled exceptions
615+
exception_handler = self.settings.EXCEPTION_HANDLER
616+
self._process_exception(
617+
exception_handler=exception_handler,
618+
event=event,
619+
context=context,
620+
exception=e,
621+
)
622+
623+
# Return this unspecified exception as a 500, using template that API Gateway expects.
624+
content = collections.OrderedDict()
625+
content["statusCode"] = 500
626+
body = {"message": message}
627+
if settings.DEBUG: # only include traceback if debug is on.
628+
body["traceback"] = traceback.format_exception(*exc_info) # traceback as a list for readability.
629+
content["body"] = json.dumps(str(body), sort_keys=True, indent=4)
630+
return content
631+
520632
# Normal web app flow
521633
try:
522634
# Timing

0 commit comments

Comments
 (0)