fix: Improved AWS Lambda event detection #2496
There are no files selected for viewing
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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,181 @@ | ||
| /* | ||
| * Copyright 2024 New Relic Corporation. All rights reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| 'use strict' | ||
|
|
||
| // https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html | ||
| const gatewayV1Event = { | ||
| version: '1.0', | ||
| resource: '/my/path', | ||
| path: '/my/path', | ||
| httpMethod: 'GET', | ||
| headers: { | ||
| header1: 'value1', | ||
| header2: 'value2' | ||
| }, | ||
| multiValueHeaders: { | ||
| header1: ['value1'], | ||
| header2: ['value1', 'value2'] | ||
| }, | ||
| queryStringParameters: { | ||
| parameter1: 'value1', | ||
| parameter2: 'value' | ||
| }, | ||
| multiValueQueryStringParameters: { | ||
| parameter1: ['value1', 'value2'], | ||
| parameter2: ['value'] | ||
| }, | ||
| requestContext: { | ||
| accountId: '123456789012', | ||
| apiId: 'id', | ||
| authorizer: { | ||
| claims: null, | ||
| scopes: null | ||
| }, | ||
| domainName: 'id.execute-api.us-east-1.amazonaws.com', | ||
| domainPrefix: 'id', | ||
| extendedRequestId: 'request-id', | ||
| httpMethod: 'GET', | ||
| identity: { | ||
| accessKey: null, | ||
| accountId: null, | ||
| caller: null, | ||
| cognitoAuthenticationProvider: null, | ||
| cognitoAuthenticationType: null, | ||
| cognitoIdentityId: null, | ||
| cognitoIdentityPoolId: null, | ||
| principalOrgId: null, | ||
| sourceIp: '192.0.2.1', | ||
| user: null, | ||
| userAgent: 'user-agent', | ||
| userArn: null, | ||
| clientCert: { | ||
| clientCertPem: 'CERT_CONTENT', | ||
| subjectDN: 'www.example.com', | ||
| issuerDN: 'Example issuer', | ||
| serialNumber: 'a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1', | ||
| validity: { | ||
| notBefore: 'May 28 12:30:02 2019 GMT', | ||
| notAfter: 'Aug 5 09:36:04 2021 GMT' | ||
| } | ||
| } | ||
| }, | ||
| path: '/my/path', | ||
| protocol: 'HTTP/1.1', | ||
| requestId: 'id=', | ||
| requestTime: '04/Mar/2020:19:15:17 +0000', | ||
| requestTimeEpoch: 1583349317135, | ||
| resourceId: null, | ||
| resourcePath: '/my/path', | ||
| stage: '$default' | ||
| }, | ||
| pathParameters: null, | ||
| stageVariables: null, | ||
| body: 'Hello from Lambda!', | ||
| isBase64Encoded: false | ||
| } | ||
|
|
||
| // https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html | ||
| const gatewayV2Event = { | ||
| version: '2.0', | ||
| routeKey: '$default', | ||
| rawPath: '/my/path', | ||
| rawQueryString: 'parameter1=value1¶meter1=value2¶meter2=value', | ||
| cookies: ['cookie1', 'cookie2'], | ||
| headers: { | ||
| header1: 'value1', | ||
| header2: 'value1,value2', | ||
| accept: 'application/json' | ||
| }, | ||
| queryStringParameters: { | ||
| parameter1: 'value1,value2', | ||
| parameter2: 'value', | ||
| name: 'me', | ||
| team: 'node agent' | ||
| }, | ||
| requestContext: { | ||
| accountId: '123456789012', | ||
| apiId: 'api-id', | ||
| authentication: { | ||
| clientCert: { | ||
| clientCertPem: 'CERT_CONTENT', | ||
| subjectDN: 'www.example.com', | ||
| issuerDN: 'Example issuer', | ||
| serialNumber: 'a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1', | ||
| validity: { | ||
| notBefore: 'May 28 12:30:02 2019 GMT', | ||
| notAfter: 'Aug 5 09:36:04 2021 GMT' | ||
| } | ||
| } | ||
| }, | ||
| authorizer: { | ||
| jwt: { | ||
| claims: { | ||
| claim1: 'value1', | ||
| claim2: 'value2' | ||
| }, | ||
| scopes: ['scope1', 'scope2'] | ||
| } | ||
| }, | ||
| domainName: 'id.execute-api.us-east-1.amazonaws.com', | ||
| domainPrefix: 'id', | ||
| http: { | ||
| method: 'POST', | ||
| path: '/my/path', | ||
| protocol: 'HTTP/1.1', | ||
| sourceIp: '192.0.2.1', | ||
| userAgent: 'agent' | ||
| }, | ||
| requestId: 'id', | ||
| routeKey: '$default', | ||
| stage: '$default', | ||
| time: '12/Mar/2020:19:03:58 +0000', | ||
| timeEpoch: 1583348638390 | ||
| }, | ||
| body: 'Hello from Lambda', | ||
| pathParameters: { | ||
| parameter1: 'value1' | ||
| }, | ||
| isBase64Encoded: false, | ||
| stageVariables: { | ||
| stageVariable1: 'value1', | ||
| stageVariable2: 'value2' | ||
| } | ||
| } | ||
|
|
||
| // Event used when one Lambda directly invokes another Lambda. | ||
| // https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-async-destinations | ||
| const lambaV1InvocationEvent = { | ||
|
There was a problem hiding this comment. I'm not completely convinced this is the only payload shape that Lambda sends with direct invocations. But I can't find any other documentation to prove that. |
||
| version: '1.0', | ||
| timestamp: '2019-11-14T18:16:05.568Z', | ||
| requestContext: { | ||
| requestId: 'e4b46cbf-b738-xmpl-8880-a18cdf61200e', | ||
| functionArn: 'arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST', | ||
| condition: 'RetriesExhausted', | ||
| approximateInvokeCount: 3 | ||
| }, | ||
| requestPayload: { | ||
| ORDER_IDS: [ | ||
| '9e07af03-ce31-4ff3-xmpl-36dce652cb4f', | ||
| '637de236-e7b2-464e-xmpl-baf57f86bb53', | ||
| 'a81ddca6-2c35-45c7-xmpl-c3a03a31ed15' | ||
| ] | ||
| }, | ||
| responseContext: { | ||
| statusCode: 200, | ||
| executedVersion: '$LATEST', | ||
| functionError: 'Unhandled' | ||
| }, | ||
| responsePayload: { | ||
| errorMessage: | ||
| 'RequestId: e4b46cbf-b738-xmpl-8880-a18cdf61200e Process exited before completing request' | ||
| } | ||
| } | ||
|
|
||
| module.exports = { | ||
| gatewayV1Event, | ||
| gatewayV2Event, | ||
| lambaV1InvocationEvent | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /* | ||
| * Copyright 2024 New Relic Corporation. All rights reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| 'use strict' | ||
|
|
||
| const test = require('node:test') | ||
| const assert = require('node:assert') | ||
|
|
||
| const { isGatewayV1Event, isGatewayV2Event } = require('../../../lib/serverless/api-gateway') | ||
| const { gatewayV1Event, gatewayV2Event, lambaV1InvocationEvent } = require('./fixtures') | ||
|
|
||
| test('isGatewayV1Event', () => { | ||
| assert.equal(isGatewayV1Event(gatewayV1Event), true) | ||
| assert.equal(isGatewayV1Event(gatewayV2Event), false) | ||
| assert.equal(isGatewayV1Event(lambaV1InvocationEvent), false) | ||
| }) | ||
|
|
||
| test('isGatewayV2Event', () => { | ||
| assert.equal(isGatewayV2Event(gatewayV1Event), false) | ||
| assert.equal(isGatewayV2Event(gatewayV2Event), true) | ||
| assert.equal(isGatewayV2Event(lambaV1InvocationEvent), false) | ||
| }) |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't find any information on what AWS does when some field from this list is not included in the payload. Does it send with
field: null? Or does it completely omit the field. We are assuming that it sendsfield: nullwith this implementation, because the v1 example shows some such fields.