fix: Added support for AWS API Gateway v2 payloads (#2191)

newrelic · May 14, 2024 · 0ccdc6a · 0ccdc6a
1 parent 297bc01
commit 0ccdc6a
Show file tree

Hide file tree

Showing 7 changed files with 1,104 additions and 51 deletions.
diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md
diff --git a/lib/serverless/api-gateway.js b/lib/serverless/api-gateway.js
@@ -16,11 +16,20 @@ class LambdaProxyWebRequest {
 
     this.headers = normalizeHeaders(event)
     this.url = {
-      path: event.path,
+      path: '',
       port: lowerCaseHeaders['x-forwarded-port'],
       requestParameters: normalizeQueryStringParameters(event)
     }
-    this.method = event.httpMethod
+    this.method = ''
+
+    if (isGatewayV1Event(event) === true) {
+      this.url.path = event.path
+      this.method = event.httpMethod
+    } else if (isGatewayV2Event(event) === true) {
+      this.url.path = event.requestContext.http.path
+      this.method = event.requestContext.http.method
+    }
+
     this.transportType = lowerCaseHeaders['x-forwarded-proto']
   }
 }
@@ -94,7 +103,41 @@ function normalizeHeaders(event, lowerCaseKey = false) {
  *                    to create a web transaction.
  */
 function isLambdaProxyEvent(event) {
-  return !!(event.path && (event.headers ?? event.multiValueHeaders) && event.httpMethod)
+  return isGatewayV1Event(event) || isGatewayV2Event(event)
+}
+
+function isGatewayV1Event(event) {
+  let result = false
+
+  if (event?.version === '1.0') {
+    result = true
+  } else if (
+    typeof event?.path === 'string' &&
+    (event.headers ?? event.multiValueHeaders) &&
+    typeof event?.httpMethod === 'string'
+    // eslint-disable-next-line sonarjs/no-duplicated-branches
+  ) {
+    result = true
+  }
+
+  return result
+}
+
+function isGatewayV2Event(event) {
+  let result = false
+
+  if (event?.version === '2.0') {
+    result = true
+  } else if (
+    typeof event?.requestContext?.http?.path === 'string' &&
+    Object.prototype.toString.call(event.headers) === '[object Object]' &&
+    typeof event?.requestContext?.http?.method === 'string'
+    // eslint-disable-next-line sonarjs/no-duplicated-branches
+  ) {
+    result = true
+  }
+
+  return result
 }
 
 /**

diff --git a/lib/serverless/event-sources.json b/lib/serverless/event-sources.json
@@ -7,6 +7,7 @@
             "requestContext.elb"
         ]
     },
+
     "apiGateway": {
         "attributes": {
             "aws.lambda.eventSource.accountId": "requestContext.accountId",
@@ -24,13 +25,32 @@
             "requestContext.stage"
         ]
     },
+
+    "apiGatewayV2": {
+        "attributes": {
+            "aws.lambda.eventSource.accountId": "requestContext.accountId",
+            "aws.lambda.eventSource.apiId": "requestContext.apiId",
+            "aws.lambda.eventSource.stage": "requestContext.stage"
+        },
+        "name": "apiGatewayV2",
+        "required_keys": [
+            "version",
+            "headers",
+            "requestContext.http",
+            "requestContext.http.path",
+            "requestContext.http.method",
+            "requestContext.stage"
+        ]
+    },
+
     "cloudFront": {
         "attributes": {},
         "name": "cloudFront",
         "required_keys": [
             "Records[0].cf"
         ]
     },
+
     "cloudWatchScheduled": {
         "attributes": {
             "aws.lambda.eventSource.account": "account",
@@ -45,6 +65,7 @@
             "source"
         ]
     },
+
     "dynamoStreams": {
         "attributes": {
             "aws.lambda.eventSource.length": "Records.length"
@@ -54,6 +75,7 @@
             "Records[0].dynamodb"
         ]
     },
+
     "firehose": {
         "attributes": {
             "aws.lambda.eventSource.length": "records.length",
@@ -65,6 +87,7 @@
             "records[0].kinesisRecordMetadata"
         ]
     },
+
     "kinesis": {
         "attributes": {
             "aws.lambda.eventSource.length": "Records.length",
@@ -75,6 +98,7 @@
             "Records[0].kinesis"
         ]
     },
+
     "s3": {
         "attributes": {
             "aws.lambda.eventSource.bucketName": "Records[0].s3.bucket.name",
@@ -91,6 +115,7 @@
             "Records[0].s3"
         ]
     },
+
     "ses": {
         "attributes": {
             "aws.lambda.eventSource.date": "Records[0].ses.mail.commonHeaders.date",
@@ -103,6 +128,7 @@
             "Records[0].ses"
         ]
     },
+
     "sns": {
         "attributes": {
             "aws.lambda.eventSource.length": "Records.length",
@@ -116,6 +142,7 @@
             "Records[0].Sns"
         ]
     },
+
     "sqs": {
         "attributes": {
             "aws.lambda.eventSource.length": "Records.length"
@@ -125,4 +152,4 @@
             "Records[0].receiptHandle"
         ]
     }
-}
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -252,6 +252,7 @@
     "proxy": "^2.1.1",
     "proxyquire": "^1.8.0",
     "q": "*",
+    "rfdc": "^1.3.1",
     "rimraf": "^2.6.3",
     "should": "*",
     "sinon": "^4.5.0",