Validate API Gateway Response Keys #1154
Merged
Conversation
This file contains 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 adds a failing test for an example of invalid API Gateway output, and proposes a fix of disallowing missing status codes. Need to investigate possible regressions of this fix before finalizing and merging, may change the fix approach.
sanathkr
previously requested changes
Apr 25, 2019
More explicit definition of the intended behavior.
The empty set is falsy, and we're checking for a non-empty set in this method. Therefore, can return directly as boolean.
sriram-mv
requested changes
Apr 26, 2019
| @@ -63,6 +63,10 @@ def invalid_response_returned(event, context): | |||
| return "This is invalid" | |||
|
|
|||
|
|
|||
| def invalid_hash_response(event, context): | |||
There was a problem hiding this comment.
nit: maybe just json response?
Python 2.7 appears to treat Dictionary's keys() method as an array, and then does not support the `-` operator with a set. Adding an explicit set() casting works in my Python 2.7 local testing.
|
Python 2.7 incompatibility is fixed, so this is ready for review again. |
sriram-mv
reviewed
Apr 26, 2019
| # API Gateway only accepts statusCode, body, headers, and isBase64Encoded in | ||
| # a response shape. | ||
| if LocalApigwService._invalid_apig_response(json_output): | ||
| msg = "Invalid Response: " + str(json_output) |
There was a problem hiding this comment.
do we need to be more explicit in the response about accepted keys?
There was a problem hiding this comment.
we can possibly move log statement up here just before throwing an exception.
There was a problem hiding this comment.
To do this I'd probably want to actually return the invalid keys and then perform the boolean if at this top level. Should we move to that approach?
There was a problem hiding this comment.
Yeah that sounds good, provides more context as well.
There was a problem hiding this comment.
Addressed in most recent change.
| "headers", | ||
| "isBase64Encoded" | ||
| } | ||
| # In Python 2.7, need to explicitly make the Dictionary keys into a set |
Has the checker method return keys instead of a boolean, so that the exception message can be more detailed.
ghost
mentioned this pull request
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
*Issue #, if available: Resolves Issue #522
Description of changes: Per my testing, API Gateway has 4 allowable response keys:
statusCode,body,headers, andisBase64Encoded. None of these keys are required, but any extra keys will result in a 502 error from the service. Currently, the local API Gateway implementation will ignore extra keys, this change will cause those keys to raise an error, matching service behavior.Checklist:
make prpassesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.