Fix API Gateway type guards #165
Merged
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
Codecov Report
@@ Coverage Diff @@
## main #165 +/- ##
==========================================
+ Coverage 86.19% 86.70% +0.50%
==========================================
Files 31 31
Lines 1181 1181
Branches 235 235
==========================================
+ Hits 1018 1024 +6
+ Misses 108 102 -6
Partials 55 55
Continue to review full report at Codecov.
|
hghotra
reviewed
Feb 13, 2021
src/utils/event-type-guards.ts
Outdated
| } | ||
|
|
||
| export function isAPIGatewayEventV2(event: any): event is APIGatewayProxyEventV2 { | ||
| return event.requestContext !== undefined && event.version !== undefined; | ||
| return event.requestContext !== undefined && event.version === "2.0" && event.rawQueryString !== undefined; |
There was a problem hiding this comment.
Small nit: maybe declare "2.0" as a constant in src/trace/constants.ts
hghotra
approved these changes
Feb 13, 2021
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.
What does this PR do?
Fixes the type guards for API Gateway V1 and V2 to look for more unique properties within their respective events.
Motivation
Bug fix where the API Gateway v1 type guard would also apply to v2 events leading us to misidentify the event type and incorrect parse the event object. This should address the issue raised in DataDog/serverless-plugin-datadog#112
Testing Guidelines
Updated the API Gateway v2 event sample used for testing. It was previously incorrectly using a v1 event, hence why this fell through the cracks.
Additional Notes
Types of Changes
Check all that apply