Api gateway response parsing #1903
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,9 @@ | ||
| <Solution> | ||
| <Folder Name="/src/"> | ||
| <Project Path="src\Amazon.Lambda.TestTool\Amazon.Lambda.TestTool.csproj" /> | ||
| </Folder> | ||
| <Folder Name="/tests/"> | ||
| <Project Path="tests\Amazon.Lambda.TestTool.UnitTests\Amazon.Lambda.TestTool.UnitTests.csproj" /> | ||
| <Project Path="tests\Amazon.Lambda.TestTool.IntegrationTests\Amazon.Lambda.TestTool.IntegrationTests.csproj" /> | ||
| </Folder> | ||
| </Solution> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,270 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| using Amazon.Lambda.APIGatewayEvents; | ||
| using Amazon.Lambda.TestTool.Models; | ||
| using Microsoft.Extensions.Primitives; | ||
| using System.Text; | ||
|
|
||
| namespace Amazon.Lambda.TestTool.Extensions; | ||
|
|
||
| /// <summary> | ||
| /// Provides extension methods for converting API Gateway responses to <see cref="HttpResponse"/> objects. | ||
| /// </summary> | ||
| public static class ApiGatewayResponseExtensions | ||
| { | ||
| /// <summary> | ||
| /// Converts an <see cref="APIGatewayProxyResponse"/> to an <see cref="HttpResponse"/>. | ||
| /// </summary> | ||
| /// <param name="apiResponse">The API Gateway proxy response to convert.</param> | ||
| /// <param name="context">The <see cref="HttpContext"/> to use for the conversion.</param> | ||
| /// <param name="emulatorMode">The <see cref="ApiGatewayEmulatorMode"/> to use for the conversion.</param> | ||
| /// <returns>An <see cref="HttpResponse"/> representing the API Gateway response.</returns> | ||
| public static void ToHttpResponse(this APIGatewayProxyResponse apiResponse, HttpContext httpContext, ApiGatewayEmulatorMode emulatorMode) | ||
| { | ||
| var response = httpContext.Response; | ||
| response.Clear(); | ||
|
|
||
| SetResponseHeaders(response, apiResponse.Headers, emulatorMode, apiResponse.MultiValueHeaders); | ||
| SetResponseBody(response, apiResponse.Body, apiResponse.IsBase64Encoded); | ||
| SetContentTypeAndStatusCodeV1(response, apiResponse.Headers, apiResponse.MultiValueHeaders, apiResponse.StatusCode, emulatorMode); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Converts an <see cref="APIGatewayHttpApiV2ProxyResponse"/> to an <see cref="HttpResponse"/>. | ||
| /// </summary> | ||
| /// <param name="apiResponse">The API Gateway HTTP API v2 proxy response to convert.</param> | ||
| /// <param name="context">The <see cref="HttpContext"/> to use for the conversion.</param> | ||
| public static void ToHttpResponse(this APIGatewayHttpApiV2ProxyResponse apiResponse, HttpContext httpContext) | ||
| { | ||
| var response = httpContext.Response; | ||
| response.Clear(); | ||
|
|
||
| SetResponseHeaders(response, apiResponse.Headers, ApiGatewayEmulatorMode.HttpV2); | ||
| SetResponseBody(response, apiResponse.Body, apiResponse.IsBase64Encoded); | ||
| SetContentTypeAndStatusCodeV2(response, apiResponse.Headers, apiResponse.StatusCode); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Sets the response headers on the <see cref="HttpResponse"/>, including default API Gateway headers based on the emulator mode. | ||
| /// </summary> | ||
| /// <param name="response">The <see cref="HttpResponse"/> to set headers on.</param> | ||
| /// <param name="headers">The single-value headers to set.</param> | ||
| /// <param name="emulatorMode">The <see cref="ApiGatewayEmulatorMode"/> determining which default headers to include.</param> | ||
| /// <param name="multiValueHeaders">The multi-value headers to set.</param> | ||
| private static void SetResponseHeaders(HttpResponse response, IDictionary<string, string>? headers, ApiGatewayEmulatorMode emulatorMode, IDictionary<string, IList<string>>? multiValueHeaders = null) | ||
| { | ||
| // Add default API Gateway headers | ||
| var defaultHeaders = GetDefaultApiGatewayHeaders(emulatorMode); | ||
| foreach (var header in defaultHeaders) | ||
| { | ||
| response.Headers[header.Key] = header.Value; | ||
| } | ||
|
|
||
| if (multiValueHeaders != null) | ||
| { | ||
| foreach (var header in multiValueHeaders) | ||
| { | ||
| response.Headers[header.Key] = new StringValues(header.Value.ToArray()); | ||
| } | ||
| } | ||
|
|
||
| if (headers != null) | ||
| { | ||
| foreach (var header in headers) | ||
| { | ||
| if (!response.Headers.ContainsKey(header.Key)) | ||
| { | ||
| response.Headers[header.Key] = header.Value; | ||
| } | ||
| else | ||
| { | ||
| response.Headers.Append(header.Key, header.Value); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Generates default API Gateway headers based on the specified emulator mode. | ||
| /// </summary> | ||
| /// <param name="emulatorMode">The <see cref="ApiGatewayEmulatorMode"/> determining which headers to generate.</param> | ||
| /// <returns>A dictionary of default headers appropriate for the specified emulator mode.</returns> | ||
| private static Dictionary<string, string> GetDefaultApiGatewayHeaders(ApiGatewayEmulatorMode emulatorMode) | ||
| { | ||
| var headers = new Dictionary<string, string> | ||
| { | ||
| { "Date", DateTime.UtcNow.ToString("r") }, | ||
| { "Connection", "keep-alive" } | ||
| }; | ||
|
|
||
| switch (emulatorMode) | ||
| { | ||
| case ApiGatewayEmulatorMode.Rest: | ||
| headers.Add("x-amzn-RequestId", Guid.NewGuid().ToString("D")); | ||
| headers.Add("x-amz-apigw-id", GenerateRequestId()); | ||
| headers.Add("X-Amzn-Trace-Id", GenerateTraceId()); | ||
| break; | ||
| case ApiGatewayEmulatorMode.HttpV1: | ||
| case ApiGatewayEmulatorMode.HttpV2: | ||
| headers.Add("Apigw-Requestid", GenerateRequestId()); | ||
| break; | ||
| } | ||
|
|
||
| return headers; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Generates a random X-Amzn-Trace-Id for REST API mode. | ||
| /// </summary> | ||
| /// <returns>A string representing a random X-Amzn-Trace-Id in the format used by API Gateway for REST APIs.</returns> | ||
| /// <remarks> | ||
| /// The generated trace ID includes: | ||
| /// - A root ID with a timestamp and two partial GUIDs | ||
| /// - A parent ID | ||
| /// - A sampling decision (always set to 0 in this implementation) | ||
| /// - A lineage identifier | ||
| /// </remarks> | ||
| private static string GenerateTraceId() | ||
| { | ||
| var timestamp = DateTimeOffset.UtcNow.ToUnixTimeSeconds().ToString("x"); | ||
| var guid1 = Guid.NewGuid().ToString("N"); | ||
| var guid2 = Guid.NewGuid().ToString("N"); | ||
| return $"Root=1-{timestamp}-{guid1.Substring(0, 12)}{guid2.Substring(0, 12)};Parent={Guid.NewGuid().ToString("N").Substring(0, 16)};Sampled=0;Lineage=1:{Guid.NewGuid().ToString("N").Substring(0, 8)}:0"; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Generates a random API Gateway request ID for HTTP API v1 and v2. | ||
| /// </summary> | ||
| /// <returns>A string representing a random request ID in the format used by API Gateway for HTTP APIs.</returns> | ||
| /// <remarks> | ||
| /// The generated ID is a 15-character string consisting of lowercase letters and numbers, followed by an equals sign. | ||
| /// </remarks> | ||
| private static string GenerateRequestId() | ||
| { | ||
| return Guid.NewGuid().ToString("N").Substring(0, 8) + Guid.NewGuid().ToString("N").Substring(0, 7) + "="; | ||
|
There was a problem hiding this comment. use string interpolation |
||
| } | ||
|
|
||
| /// <summary> | ||
| /// Sets the response body on the <see cref="HttpResponse"/>. | ||
| /// </summary> | ||
| /// <param name="response">The <see cref="HttpResponse"/> to set the body on.</param> | ||
| /// <param name="body">The body content.</param> | ||
| /// <param name="isBase64Encoded">Whether the body is Base64 encoded.</param> | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
| private static void SetResponseBody(HttpResponse response, string? body, bool isBase64Encoded) | ||
| { | ||
| if (!string.IsNullOrEmpty(body)) | ||
|
There was a problem hiding this comment. Since we will update the existing HttpResponse, the body and content length might already have values. You should add an else to clear them out if |
||
| { | ||
| byte[] bodyBytes; | ||
| if (isBase64Encoded) | ||
| { | ||
| bodyBytes = Convert.FromBase64String(body); | ||
| } | ||
| else | ||
| { | ||
| bodyBytes = Encoding.UTF8.GetBytes(body); | ||
| } | ||
|
|
||
| response.Body = new MemoryStream(bodyBytes); | ||
| response.ContentLength = bodyBytes.Length; | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Sets the content type and status code for API Gateway v1 responses. | ||
| /// </summary> | ||
| /// <param name="response">The <see cref="HttpResponse"/> to set the content type and status code on.</param> | ||
| /// <param name="headers">The single-value headers.</param> | ||
| /// <param name="multiValueHeaders">The multi-value headers.</param> | ||
| /// <param name="statusCode">The status code to set.</param> | ||
|
There was a problem hiding this comment. ApiGatewayEmulatorMode emulatorMode does not have a docs param |
||
| /// <param name="emulatorMode">The <see cref="ApiGatewayEmulatorMode"/> being used.</param> | ||
| private static void SetContentTypeAndStatusCodeV1(HttpResponse response, IDictionary<string, string>? headers, IDictionary<string, IList<string>>? multiValueHeaders, int statusCode, ApiGatewayEmulatorMode emulatorMode) | ||
| { | ||
| string? contentType = null; | ||
|
|
||
| if (headers != null && headers.TryGetValue("Content-Type", out var headerContentType)) | ||
|
There was a problem hiding this comment. nit: you could just do: |
||
| { | ||
| contentType = headerContentType; | ||
| } | ||
| else if (multiValueHeaders != null && multiValueHeaders.TryGetValue("Content-Type", out var multiValueContentType)) | ||
| { | ||
| contentType = multiValueContentType.FirstOrDefault(); | ||
| } | ||
|
|
||
| if (contentType != null) | ||
| { | ||
| response.ContentType = contentType; | ||
| } | ||
| else | ||
| { | ||
| if (emulatorMode == ApiGatewayEmulatorMode.HttpV1) | ||
| { | ||
| response.ContentType = "text/plain; charset=utf-8"; | ||
| } | ||
| else if (emulatorMode == ApiGatewayEmulatorMode.Rest) | ||
| { | ||
| response.ContentType = "application/json"; | ||
| } | ||
|
There was a problem hiding this comment. for the sake of completion, add an else and handle the fact that we could mistakenly make this call for V2. Maybe throw an exception as this is dev error and needs to be updated. |
||
| else | ||
| { | ||
| throw new ArgumentException("This function should only be called for ApiGatewayEmulatorMode.HttpV1 or ApiGatewayEmulatorMode.Rest"); | ||
| } | ||
| } | ||
|
|
||
| if (statusCode != 0) | ||
| { | ||
| response.StatusCode = statusCode; | ||
| } | ||
| else | ||
| { | ||
| if (emulatorMode == ApiGatewayEmulatorMode.Rest) // rest api text for this message/error code is slightly different | ||
| { | ||
| response.StatusCode = 502; | ||
| response.ContentType = "application/json"; | ||
| var errorBytes = Encoding.UTF8.GetBytes("{\"message\": \"Internal server error\"}"); | ||
| response.Body = new MemoryStream(errorBytes); | ||
| response.ContentLength = errorBytes.Length; | ||
| response.Headers["x-amzn-ErrorType"] = "InternalServerErrorException"; | ||
| } | ||
| else | ||
| { | ||
| response.StatusCode = 500; | ||
| response.ContentType = "application/json"; | ||
| var errorBytes = Encoding.UTF8.GetBytes("{\"message\":\"Internal Server Error\"}"); | ||
| response.Body = new MemoryStream(errorBytes); | ||
| response.ContentLength = errorBytes.Length; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Sets the content type and status code for API Gateway v2 responses. | ||
| /// </summary> | ||
| /// <param name="response">The <see cref="HttpResponse"/> to set the content type and status code on.</param> | ||
| /// <param name="headers">The headers.</param> | ||
| /// <param name="statusCode">The status code to set.</param> | ||
| private static void SetContentTypeAndStatusCodeV2(HttpResponse response, IDictionary<string, string>? headers, int statusCode) | ||
| { | ||
| if (headers != null && headers.TryGetValue("Content-Type", out var contentType)) | ||
| { | ||
| response.ContentType = contentType; | ||
| } | ||
| else | ||
| { | ||
| response.ContentType = "text/plain; charset=utf-8"; // api gateway v2 defaults to this content type if none is provided | ||
| } | ||
|
|
||
| if (statusCode != 0) | ||
| { | ||
| response.StatusCode = statusCode; | ||
| } | ||
| else | ||
| { | ||
| response.StatusCode = 500; | ||
| response.ContentType = "application/json"; | ||
|
There was a problem hiding this comment. Should you check to see if content type was already set from the headers collection coming back from the Lambda function? There was a problem hiding this comment. ill add an integration test case to confirm what happens in that scenario and update accordingly There was a problem hiding this comment. ive added There was a problem hiding this comment. i updated this logic to just be straightforward - with the results from my manual testing. that if status code is not set, then api gateway http 2.0 will default to application/json There was a problem hiding this comment.
edit: actually i guess my above crossed out comment only applies to the other code up above where i do internal server error. so ill see what happens in that case. i think the user can specify custom response headers in rest api depending on certain error codes There was a problem hiding this comment. so i was thinking about this more with the way the v2 infers things. i think we need another layer before this api gateway response -> http response. i think we need a lambda memory stream -> api gateway response, which will do these inferences There was a problem hiding this comment. i removed the json inference check from here. i think we should add the lambda -> api gateay translation inference in another pr |
||
| var errorBytes = Encoding.UTF8.GetBytes("{\"message\":\"Internal Server Error\"}"); | ||
| response.Body = new MemoryStream(errorBytes); | ||
| response.ContentLength = errorBytes.Length; | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>net8.0</TargetFramework> | ||
| <ImplicitUsings>enable</ImplicitUsings> | ||
| <Nullable>enable</Nullable> | ||
|
|
||
| <IsPackable>false</IsPackable> | ||
| <IsTestProject>true</IsTestProject> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Amazon.Lambda.APIGatewayEvents" Version="2.7.1" /> | ||
| <PackageReference Include="AWSSDK.APIGateway" Version="3.7.401.7" /> | ||
| <PackageReference Include="AWSSDK.CloudFormation" Version="3.7.401.11" /> | ||
| <PackageReference Include="AWSSDK.IdentityManagement" Version="3.7.402" /> | ||
| <PackageReference Include="AWSSDK.ApiGatewayV2" Version="3.7.400.63" /> | ||
| <PackageReference Include="AWSSDK.Lambda" Version="3.7.408.1" /> | ||
| <PackageReference Include="coverlet.collector" Version="6.0.0" /> | ||
| <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" /> | ||
| <PackageReference Include="System.Configuration.ConfigurationManager" Version="9.0.0" /> | ||
| <PackageReference Include="xunit" Version="2.9.2" /> | ||
| <PackageReference Include="xunit.runner.visualstudio" Version="2.5.3" /> | ||
| </ItemGroup> | ||
|
|
||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\src\Amazon.Lambda.TestTool\Amazon.Lambda.TestTool.csproj" /> | ||
| <ProjectReference Include="..\Amazon.Lambda.TestTool.UnitTests\Amazon.Lambda.TestTool.UnitTests.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <EmbeddedResource Include="cloudformation-template-apigateway.yaml" /> | ||
| </ItemGroup> | ||
|
|
||
|
|
||
| <ItemGroup> | ||
| <Using Include="Xunit" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| | ||
| Microsoft Visual Studio Solution File, Format Version 12.00 | ||
| # Visual Studio Version 17 | ||
| VisualStudioVersion = 17.5.002.0 | ||
| MinimumVisualStudioVersion = 10.0.40219.1 | ||
| Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Amazon.Lambda.TestTool.IntegrationTests", "Amazon.Lambda.TestTool.IntegrationTests.csproj", "{94C7903E-A21A-43EC-BB04-C9DA404F1C02}" | ||
| EndProject | ||
| Global | ||
| GlobalSection(SolutionConfigurationPlatforms) = preSolution | ||
| Debug|Any CPU = Debug|Any CPU | ||
| Release|Any CPU = Release|Any CPU | ||
| EndGlobalSection | ||
| GlobalSection(ProjectConfigurationPlatforms) = postSolution | ||
| {94C7903E-A21A-43EC-BB04-C9DA404F1C02}.Debug|Any CPU.ActiveCfg = Debug|Any CPU | ||
| {94C7903E-A21A-43EC-BB04-C9DA404F1C02}.Debug|Any CPU.Build.0 = Debug|Any CPU | ||
| {94C7903E-A21A-43EC-BB04-C9DA404F1C02}.Release|Any CPU.ActiveCfg = Release|Any CPU | ||
| {94C7903E-A21A-43EC-BB04-C9DA404F1C02}.Release|Any CPU.Build.0 = Release|Any CPU | ||
| EndGlobalSection | ||
| GlobalSection(SolutionProperties) = preSolution | ||
| HideSolutionNode = FALSE | ||
| EndGlobalSection | ||
| GlobalSection(ExtensibilityGlobals) = postSolution | ||
| SolutionGuid = {429CE21F-1692-4C50-A9E6-299AB413D027} | ||
| EndGlobalSection | ||
| EndGlobal |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.