Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add exposed headers to gateway responses #852

Merged
merged 1 commit into from
Jul 6, 2021
Merged

Add exposed headers to gateway responses #852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions ...rc/main/java/software/amazon/smithy/aws/apigateway/openapi/AddCorsToGatewayResponses.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,22 +109,30 @@ private Node updateGatewayResponses(
}

return gatewayResponses.getMembers().entrySet().stream()
.collect(ObjectNode.collect(
Map.Entry::getKey,
entry -> updateGatewayResponse(corsHeaders, entry.getValue().expectObjectNode())));
.collect(ObjectNode.collect(Map.Entry::getKey, entry -> {
return updateGatewayResponse(context, trait, corsHeaders, entry.getValue().expectObjectNode());
}));
}

private ObjectNode updateGatewayResponse(Map<CorsHeader, String> sharedHeaders, ObjectNode gatewayResponse) {
private ObjectNode updateGatewayResponse(
Context<? extends Trait> context,
CorsTrait trait,
Map<CorsHeader, String> sharedHeaders,
ObjectNode gatewayResponse
) {
ObjectNode responseParameters = gatewayResponse
.getObjectMember(RESPONSE_PARAMETERS_KEY)
.orElse(Node.objectNode());

// Track all CORS headers of the gateway response.
Map<CorsHeader, String> headers = new TreeMap<>(sharedHeaders);

// Add the modeled additional headers. These could potentially be added by an
// apigateway feature, so they need to be present.
Set<String> exposedHeaders = new TreeSet<>(trait.getAdditionalExposedHeaders());

// Find all headers exposed already in the response. These need to be added to the
// Access-Control-Expose-Headers header if any are found.
Set<String> exposedHeaders = new TreeSet<>();
for (String key : responseParameters.getStringMap().keySet()) {
if (key.startsWith(HEADER_PREFIX)) {
exposedHeaders.add(key.substring(HEADER_PREFIX.length()));
Expand Down
6 changes: 4 additions & 2 deletions .../src/test/resources/software/amazon/smithy/aws/apigateway/openapi/cors-model.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,15 +420,17 @@
"application/json": "{\"message\":$context.error.messageString}"
},
"responseParameters": {
"gatewayresponse.header.Access-Control-Allow-Origin": "'https://www.example.com'"
"gatewayresponse.header.Access-Control-Allow-Origin": "'https://www.example.com'",
"gatewayresponse.header.Access-Control-Expose-Headers": "'X-Service-Output-Metadata'"
}
},
"DEFAULT_5XX": {
"responseTemplates": {
"application/json": "{\"message\":$context.error.messageString}"
},
"responseParameters": {
"gatewayresponse.header.Access-Control-Allow-Origin": "'https://www.example.com'"
"gatewayresponse.header.Access-Control-Allow-Origin": "'https://www.example.com'",
"gatewayresponse.header.Access-Control-Expose-Headers": "'X-Service-Output-Metadata'"
}
}
}
Expand Down
6 changes: 4 additions & 2 deletions ...s/software/amazon/smithy/aws/apigateway/openapi/cors-with-additional-headers.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,15 +420,17 @@
"application/json": "{\"message\":$context.error.messageString}"
},
"responseParameters": {
"gatewayresponse.header.Access-Control-Allow-Origin": "'https://www.example.com'"
"gatewayresponse.header.Access-Control-Allow-Origin": "'https://www.example.com'",
"gatewayresponse.header.Access-Control-Expose-Headers": "'X-Service-Output-Metadata'"
}
},
"DEFAULT_5XX": {
"responseTemplates": {
"application/json": "{\"message\":$context.error.messageString}"
},
"responseParameters": {
"gatewayresponse.header.Access-Control-Allow-Origin": "'https://www.example.com'"
"gatewayresponse.header.Access-Control-Allow-Origin": "'https://www.example.com'",
"gatewayresponse.header.Access-Control-Expose-Headers": "'X-Service-Output-Metadata'"
}
}
}
Expand Down