support binary responses

Author: asottile

Diff for: api_gateway_v2_to_wsgi.py

@@ -54,9 +54,18 @@ def __call__(
         return self.body.write
 
     def response(self) -> Dict[str, Any]:
+        body_b = self.body.getvalue()
+        try:
+            body = body_b.decode()
+            is_base64_encoded = False
+        except UnicodeDecodeError:
+            body = base64.b64encode(body_b).decode()
+            is_base64_encoded = True
+
         return {
+            'isBase64Encoded': is_base64_encoded,
             'statusCode': self.status_code,
-            'body': self.body.getvalue().decode(),
+            'body': body,
             'headers': {k: ','.join(v) for k, v in self.headers.items()},
         }
 

Diff for: testing/data/image.json

@@ -0,0 +1,35 @@
+{
+  "version": "2.0",
+  "routeKey": "$default",
+  "rawPath": "/image.gif",
+  "rawQueryString": "",
+  "headers": {
+    "accept": "*/*",
+    "content-length": "0",
+    "host": "kr8spsb5ti.execute-api.us-east-1.amazonaws.com",
+    "user-agent": "curl/7.68.0",
+    "x-amzn-trace-id": "Root=1-5f30b572-3f87b39ad007312beebc1a92",
+    "x-forwarded-for": "76.14.26.166",
+    "x-forwarded-port": "443",
+    "x-forwarded-proto": "https"
+  },
+  "requestContext": {
+    "accountId": "952911408644",
+    "apiId": "kr8spsb5ti",
+    "domainName": "kr8spsb5ti.execute-api.us-east-1.amazonaws.com",
+    "domainPrefix": "kr8spsb5ti",
+    "http": {
+      "method": "GET",
+      "path": "/image.gif",
+      "protocol": "HTTP/1.1",
+      "sourceIp": "76.14.26.166",
+      "userAgent": "curl/7.68.0"
+    },
+    "requestId": "RCFJ1jzyoAMEPMQ=",
+    "routeKey": "$default",
+    "stage": "$default",
+    "time": "10/Aug/2020:02:48:18 +0000",
+    "timeEpoch": 1597027698026
+  },
+  "isBase64Encoded": false
+}

Diff for: testing/example/README.md

@@ -49,9 +49,14 @@ aws_lambda_permission.sample_app_gateway: Creating...
 aws_lambda_permission.sample_app_gateway: Creation complete after 1s [id=terraform-20200810034859413700000003]
 
 Apply complete! Resources: 6 added, 0 changed, 0 destroyed.
+
+Outputs:
+
+api_gateway_address = "https://l45ezct9w4.execute-api.us-east-1.amazonaws.com"
 ```
 
-the important part of this is the `id=l45ezct9w4` portion, we'll be using that later!
+the important part of this is the `api_gateway_address` portion, we'll be
+using that later!
 
 ### trying out the gateway
 

Diff for: testing/example/requirements.txt

@@ -1,2 +1,2 @@
-api-gateway-v2-to-wsgi
+../..
 flask

Diff for: testing/example/sample_app.py

@@ -15,6 +15,16 @@ def profile(username: str) -> str:
     return f'hello hello {username}'
 
 
+@app.route('/image.gif')
+def image_route() -> flask.Response:
+    return flask.Response(
+        b'GIF89a\x01\x00\x01\x00\x80\x00\x00\xff\xff\xff\x00\x00\x00!\xf9'
+        b'\x04\x01\x00\x00\x00\x00,\x00\x00\x00\x00\x01\x00\x01\x00\x00\x02'
+        b'\x02D\x01\x00;',
+        mimetype='image/gif',
+    )
+
+
 lambda_handler = api_gateway_v2_to_wsgi.make_lambda_handler(app)
 
 

Diff for: testing/example/tf/.gitignore

@@ -1,3 +1,4 @@
 /*.tfstate
 /*.tfstate.*
 /.terraform
+/.terraform.lock.hcl

Diff for: testing/example/tf/lambda_sample_app.tf

@@ -38,3 +38,7 @@ resource "aws_lambda_permission" "sample_app_gateway" {
 
   source_arn = "${aws_apigatewayv2_api.sample_app_gateway.execution_arn}/*/*"
 }
+
+output "api_gateway_address" {
+  value = aws_apigatewayv2_api.sample_app_gateway.api_endpoint
+}

Diff for: tests/api_gateway_v2_to_wsgi_test.py

@@ -48,6 +48,16 @@ def cookies_route():
 '''
 
 
+@app.route('/image.gif')
+def image_route():
+    return flask.Response(
+        b'GIF89a\x01\x00\x01\x00\x80\x00\x00\xff\xff\xff\x00\x00\x00!\xf9'
+        b'\x04\x01\x00\x00\x00\x00,\x00\x00\x00\x00\x01\x00\x01\x00\x00\x02'
+        b'\x02D\x01\x00;',
+        mimetype='image/gif',
+    )
+
+
 handler = api_gateway_v2_to_wsgi.make_lambda_handler(app)
 
 
@@ -66,6 +76,7 @@ def test_get_request():
 '''
     assert resp == {
         'statusCode': 200,
+        'isBase64Encoded': False,
         'body': expected_body,
         'headers': {
             'Content-Length': '96',
@@ -82,6 +93,7 @@ def test_post_request():
 '''
     assert resp == {
         'statusCode': 200,
+        'isBase64Encoded': False,
         'body': expected_body,
         'headers': {
             'Content-Length': '17',
@@ -99,6 +111,7 @@ def test_query_string():
 '''
     assert resp == {
         'statusCode': 200,
+        'isBase64Encoded': False,
         'body': expected_body,
         'headers': {
             'Content-Length': '45',
@@ -118,6 +131,7 @@ def test_multi_headers():
 '''
     assert resp == {
         'statusCode': 200,
+        'isBase64Encoded': False,
         'body': expected_body,
         'headers': {
             'Content-Length': '104',
@@ -154,9 +168,23 @@ def test_cookies():
 '''
     assert resp == {
         'statusCode': 200,
+        'isBase64Encoded': False,
         'body': expected_body,
         'headers': {
             'Content-Length': '42',
             'Content-Type': 'text/html; charset=utf-8',
         },
     }
+
+
+def test_binary_reposnse():
+    resp = handler(_event('image'), {})
+    assert resp == {
+        'statusCode': 200,
+        'isBase64Encoded': True,
+        'body': 'R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==',
+        'headers': {
+            'Content-Length': '43',
+            'Content-Type': 'image/gif',
+        },
+    }