Add 6MB request and response size check #1990

GarrettBeatty · 2025-02-25T16:39:52Z

Issue #, if available: DOTNET-7881

Description of changes:

Add request payload size validation.
Add response size validation.

Screenshots

Lambda (i hardcoded the max size to 1 byte for testing which is why the error message says 1 byte)

Api gateway

Why

This is to mimic lambdas 6MB limit defined here https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html.

How

PostEvent is the main entry point for where we can check the request size. This is invoked when the lambda client does invokeRequest. One thing to note is that I had to update the UI code to use a lambda client, rather than adding to the data store directly in order to reach PostEvent.
PostInvocationResponse is the main entry point for where we can check the response size. This is invoked when the lambda returns its response.
I also updated the code to make the LambdaClient injectable and have it reused across requests (if the endpoint is the same it will reuse it)

Testing real world behavior

First I validated what the real world behavior of lambda/api gateway was for request/responses exceeding the limit.

Lambda Testing for request size

I created an lambda in my AWS account
I sent it a payload greater than 6MB.
Lambda returned back a 413 response saying that the payload size exceeded the limit. (I tried both regular request/response mode and also event type invocation and they both immediately give back 413)

Lambda Testing for response size

I created an lambda in my AWS account
I configured the lambda to return a payload size greater than 6MB.
I invoked the lambda and it returned back a 200 success code with error details populated saying the response size exceeded the limit. Note that this error handling behavior is identical to how other errors in lambda are handled, where a successful status code is returned, but the errors are populated in the body.

Api gateway Testing for request size

I did the same steps for the lambda but just configured an api gateway to invoke it
Api gateway returned a 413 response code (with some slight differences in the error message depending on the type (HTTPV1, V2, REST)

Api gateway Testing for response size

I did the same steps for the lambda but just configured an api gateway to invoke it
Api gateway returned a 500/502 internal server error (depending on whether it was HTTPV1, V2, REST)

Testing test tool

1, I ran the test tool locally and manually updated the limit to 1 byte and invoked it with request/responses exceeding the limit (see screenshots above)
2. I created unit test and an integration test to validate the behavior
3. All existing tests pass

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Services/LambdaClient.cs

GarrettBeatty · 2025-02-25T17:17:49Z

...aTestTool-v2/tests/Amazon.Lambda.TestTool.IntegrationTests/ApiGatewayEmulatorProcessTests.cs

    {
        testOutputHelper.WriteLine($"Testing endpoint: http://localhost:{apiGatewayPort}/{routeName}");
        using (var client = new HttpClient())
        {
-            client.Timeout = TimeSpan.FromSeconds(2);
+            client.Timeout = TimeSpan.FromSeconds(60);


this is the part that is having some issues on the pipeline that i am investigating still

normj · 2025-02-25T18:05:39Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Components/Pages/Home.razor.cs

+        {
+            // lambda client automatically adds some extra verbiage: "The service returned an error with Error Code xxxx and HTTP Body: <bodyhere>".
+            // removing the extra verbiage to make the error message smaller and look better on the ui.
+            _errorMessage = e.Message.Split("HTTP Body: ")[1];


In case the error message ever changes can you make the code defensive? If the split returns back a single token then just use that token.

fixed in latest version

normj · 2025-02-25T18:12:53Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Processes/ApiGatewayEmulatorProcess.cs

            {
-                if (settings.ApiGatewayEmulatorMode.Equals(ApiGatewayEmulatorMode.HttpV2))
+                var endpoint = routeConfig.Endpoint ?? $"http://{settings.LambdaEmulatorHost}:{settings.LambdaEmulatorPort}";
+                lambdaClient.SetEndpoint(endpoint);


There could be multiple threads using this method and each changing the endpoint of a singleton could cause problems. We might someday support having multiple Lambda emulators running inside Aspire and there could be different endpoints. Maybe get rid of the SetEndpoint method and overload the InvokeAsync to take in an endpoint since there is no rule it has to match the IAmazonLambda interface. Then in LambdaClient you can get rid of the _currentEndpoint global state.

updated in latest version

normj · 2025-02-25T18:14:47Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Services/LambdaClient.cs

+/// </summary>
+public class LambdaClient : ILambdaClient, IDisposable
+{
+    internal Dictionary<string, IAmazonLambda> Clients => _clients; // used for unit tests only


Since there can be multiple threads using this you need to make access to this dictionary thread safe. Maybe switch to ConcurrentDictionary.

GarrettBeatty · 2025-02-25T22:31:35Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Models/LambdaOptions.cs

+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+namespace Amazon.Lambda.TestTool.Models;


wasnt sure where to put this in models folder or in LambdaClient file/folder

GarrettBeatty · 2025-02-25T22:32:02Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Processes/TestToolProcess.cs

+
+        builder.Services.Configure<LambdaOptions>(options =>
+        {
+            options.Endpoint = $"http://{settings.LambdaEmulatorHost}:{settings.LambdaEmulatorPort}";


this seemed like the simplest way of passing this value in

normj · 2025-02-25T22:39:21Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Components/Pages/Home.razor.cs

+            // removing the extra verbiage to make the error message smaller and look better on the ui.
+            _errorMessage = e.Message.Contains("HTTP Body: ")
+                ? e.Message.Split("HTTP Body: ")[1]
+                : e.Message;        }


nit: Fix the formatting of the }.

normj · 2025-02-25T22:45:23Z

...aTestTool-v2/tests/Amazon.Lambda.TestTool.IntegrationTests/ApiGatewayEmulatorProcessTests.cs

+                };
+            };
+
+            Environment.SetEnvironmentVariable("AWS_LAMBDA_RUNTIME_API", $"localhost:{lambdaPort}/largerequestfunction");


Coordinate with @philasmar PR so that you can set the API via a command line instead of environment variable. #1992

normj · 2025-02-25T22:45:57Z

...aTestTool-v2/tests/Amazon.Lambda.TestTool.IntegrationTests/ApiGatewayEmulatorProcessTests.cs

+
+            var handler = (APIGatewayHttpApiV2ProxyRequest request, ILambdaContext context) =>
+            {
+                var env = Environment.GetEnvironmentVariable("AWS_LAMBDA_RUNTIME_API");


Coordinate with @philasmar PR so that you can set the API via a command line instead of environment variable. #1992

normj · 2025-02-25T22:46:04Z

...aTestTool-v2/tests/Amazon.Lambda.TestTool.IntegrationTests/ApiGatewayEmulatorProcessTests.cs

+                };
+            };
+
+            Environment.SetEnvironmentVariable("AWS_LAMBDA_RUNTIME_API", $"localhost:{lambdaPort}/largerequestfunction");


Coordinate with @philasmar PR so that you can set the API via a command line instead of environment variable. #1992

philasmar · 2025-02-26T14:20:29Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Components/Pages/Home.razor

+                    {
+                        <div class="text-danger ms-2">
+                            <i class="bi bi-exclamation-triangle-fill"></i>
+                            @_errorMessage


The message you are adding will wrap if the screen is smaller than yours. This is what it would look like:

Im thinking instead of displaying a message directly, use that danger icon and align it to the end of that div and when the user hovers over it they see the message as a tooltip?

Or put the error message on a line below "Function Input" if it doesn't fit next to it.

philasmar · 2025-02-26T14:22:52Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Components/Pages/Home.razor.cs

+        {
+            FunctionName = SelectedFunctionName,
+            Payload = payload,
+            InvocationType = InvocationType.Event


why is the invocation type "Event" and not "RequestResponse"?

the original implementation was also set to Event type (When invocated as DataStore.QueueEvent(editorValue, false); , the false was for the isRequestResponse boolean, so kept it the same

Event is what we want here because we just want to queue the event. We don't want to block the UI waiting for the response.

philasmar · 2025-02-26T14:23:48Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Components/Pages/Home.razor.cs

+        }
+        catch (AmazonLambdaException e)
+        {
+            // lambda client automatically adds some extra verbiage: "The service returned an error with Error Code xxxx and HTTP Body: <bodyhere>".


nit: log the entire error using the logger

philasmar · 2025-02-26T14:28:31Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Extensions/InvokeResponseExtensions.cs

+    /// - JSON error message
+    /// - Content-Type header set to application/json
+    /// </returns>
+    public static APIGatewayProxyResponse ToHttpApiRequestTooLargeResponse(ApiGatewayEmulatorMode emulatorMode)


Also, does this not apply to HttpV2? If not, maybe add a note to the method docs.

theres a separate function for httpv2, ill update the docs

philasmar · 2025-02-26T14:29:31Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Extensions/InvokeResponseExtensions.cs

+                IsBase64Encoded = false
+            };
+        }
+        throw new InvalidOperationException();


nit: add a message for why things went wrong

philasmar · 2025-02-26T14:30:22Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Extensions/InvokeResponseExtensions.cs

+    /// - JSON error message
+    /// - Content-Type header set to application/json
+    /// </returns>
+    public static APIGatewayHttpApiV2ProxyResponse ToHttpApiV2RequestTooLargeResponse()


nit: same comment about naming

philasmar · 2025-02-26T14:37:46Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Models/LambdaOptions.cs

+
+namespace Amazon.Lambda.TestTool.Models;
+
+public class LambdaOptions


Add docs for class and members

GarrettBeatty commented Feb 25, 2025

View reviewed changes

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Services/LambdaClient.cs Show resolved Hide resolved

GarrettBeatty requested review from philasmar and normj February 25, 2025 16:54

GarrettBeatty changed the base branch from master to dev February 25, 2025 17:01

GarrettBeatty marked this pull request as ready for review February 25, 2025 17:15

GarrettBeatty commented Feb 25, 2025

View reviewed changes

normj requested changes Feb 25, 2025

View reviewed changes

GarrettBeatty commented Feb 25, 2025

View reviewed changes

GarrettBeatty requested a review from normj February 25, 2025 22:32

normj reviewed Feb 25, 2025

View reviewed changes

philasmar requested changes Feb 26, 2025

View reviewed changes

GarrettBeatty added 18 commits February 26, 2025 10:24

init

8c9f9f7

add di and update ui

3737f07

add docs

c179779

add lambda client tests

c8af00f

add test for lambda runtime api

a7c413d

add lambda emulator process tests

573a0bb

add more tests

82cedef

update docs

cbf3b2a

more updateS

f44b5ef

remove comma

de827ad

fix ui

d94320d

add header

9570368

use constant

1357f86

change name of variable

1c19955

add change file

084b64c

update timeout

57bbd2c

PR comments

9e4e6a0

PR comments

cf39cc7

GarrettBeatty force-pushed the gcbeatty/sizecheck branch from d62319a to cf39cc7 Compare February 26, 2025 16:11

update error ui

8954a44

philasmar approved these changes Feb 26, 2025

View reviewed changes

GarrettBeatty requested a review from normj February 26, 2025 16:21

skip flaky test

ad8d0a7

normj approved these changes Feb 26, 2025

View reviewed changes

GarrettBeatty merged commit 700568a into dev Feb 26, 2025
5 checks passed

GarrettBeatty deleted the gcbeatty/sizecheck branch February 26, 2025 18:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add 6MB request and response size check #1990

Add 6MB request and response size check #1990

GarrettBeatty commented Feb 25, 2025 •

edited

Loading

GarrettBeatty Feb 25, 2025

normj Feb 25, 2025

GarrettBeatty Feb 25, 2025

normj Feb 25, 2025

GarrettBeatty Feb 25, 2025

normj Feb 25, 2025

GarrettBeatty Feb 25, 2025

GarrettBeatty Feb 25, 2025

normj Feb 25, 2025

normj Feb 25, 2025

normj Feb 25, 2025

normj Feb 25, 2025

philasmar Feb 26, 2025

philasmar Feb 26, 2025

GarrettBeatty Feb 26, 2025 •

edited

Loading

normj Feb 26, 2025

philasmar Feb 26, 2025

philasmar Feb 26, 2025

GarrettBeatty Feb 26, 2025 •

edited

Loading

philasmar Feb 26, 2025

philasmar Feb 26, 2025

philasmar Feb 26, 2025


		namespace Amazon.Lambda.TestTool.Models;

		public class LambdaOptions

Add 6MB request and response size check #1990

Add 6MB request and response size check #1990

Conversation

GarrettBeatty commented Feb 25, 2025 • edited Loading

Screenshots

Why

How

Testing real world behavior

Lambda Testing for request size

Lambda Testing for response size

Api gateway Testing for request size

Api gateway Testing for response size

Testing test tool

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GarrettBeatty Feb 26, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GarrettBeatty Feb 26, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GarrettBeatty commented Feb 25, 2025 •

edited

Loading

GarrettBeatty Feb 26, 2025 •

edited

Loading

GarrettBeatty Feb 26, 2025 •

edited

Loading