APIGW: fix parsing invalid JSON template in MOCK integration #11967
Conversation
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
bentsku
approved these changes
Nov 29, 2024
LocalStack Community integration with Pro 2 files ± 0 2 suites ±0 30m 15s ⏱️ - 1h 18m 44s Results for commit 9962e2e. ± Comparison against base commit 21210ce. This pull request removes 2815 tests. |
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.
Motivation
When deploying a CDK stack with an APIGW REST API with "automatic" CORS management by APIGW, CDK will create an OPTIONS
methodwith a MOCK integration. The problem is that this integration has a request template equal to"application/json": "{statusCode: 200}", which is invalid JSON.From the documentation, nothing lets you think that invalid JSON would be accepted, as it needs the
statusCodefield.But it does, they don't JSON parse but use a custom token parser that we're tried to test the limit off. We're settling now on this basic implementation which still has flaws, but cover quite some ground already, as shown by the unit tests. We also updated an integration test to specifically cover the request template CDK was using.
This custom parser will only be executed if the MOCK integration does not return valid JSON, meaning every existing use case will still work, and only people with very, very esoteric negative testing might be impacted by this new custom parser accepting data AWS wouldn't (but we already covered most of the bad negative cases).
Changes