feat: Add httpEvent.operationId to the request context (#1325)

dherault · Feb 2, 2022 · e217fcb · e217fcb
1 parent 5df70c8
commit e217fcb
Show file tree

Hide file tree

Showing 7 changed files with 88 additions and 4 deletions.
diff --git a/src/events/http/HttpServer.js b/src/events/http/HttpServer.js
@@ -544,6 +544,11 @@ export default class HttpServer {
       }
     }
 
+    const additionalRequestContext = {}
+    if (httpEvent.operationId) {
+      additionalRequestContext.operationName = httpEvent.operationId
+    }
+
     hapiOptions.tags = ['api']
 
     const hapiHandler = async (request, h) => {
@@ -740,6 +745,7 @@ export default class HttpServer {
                 stage,
                 endpoint.routeKey,
                 stageVariables,
+                additionalRequestContext,
                 this.v3Utils,
               )
             : new LambdaProxyIntegrationEvent(
@@ -748,6 +754,7 @@ export default class HttpServer {
                 requestPath,
                 stageVariables,
                 endpoint.isHttpApi ? endpoint.routeKey : null,
+                additionalRequestContext,
                 this.v3Utils,
               )
 

diff --git a/src/events/http/lambda-events/LambdaProxyIntegrationEvent.js b/src/events/http/lambda-events/LambdaProxyIntegrationEvent.js
@@ -23,13 +23,23 @@ export default class LambdaProxyIntegrationEvent {
   #request = null
   #stage = null
   #stageVariables = null
-
-  constructor(request, stage, path, stageVariables, routeKey = null, v3Utils) {
+  #additionalRequestContext = null
+
+  constructor(
+    request,
+    stage,
+    path,
+    stageVariables,
+    routeKey = null,
+    additionalRequestContext = null,
+    v3Utils,
+  ) {
     this.#path = path
     this.#routeKey = routeKey
     this.#request = request
     this.#stage = stage
     this.#stageVariables = stageVariables
+    this.#additionalRequestContext = additionalRequestContext || {}
     if (v3Utils) {
       this.log = v3Utils.log
       this.progress = v3Utils.progress
@@ -202,6 +212,7 @@ export default class LambdaProxyIntegrationEvent {
           userAgent: _headers['user-agent'] || '',
           userArn: 'offlineContext_userArn',
         },
+        operationName: this.#additionalRequestContext.operationName,
         path: this.#path,
         protocol: 'HTTP/1.1',
         requestId: createUniqueId(),

diff --git a/src/events/http/lambda-events/LambdaProxyIntegrationEventV2.js b/src/events/http/lambda-events/LambdaProxyIntegrationEventV2.js
@@ -17,12 +17,21 @@ export default class LambdaProxyIntegrationEventV2 {
   #request = null
   #stage = null
   #stageVariables = null
-
-  constructor(request, stage, routeKey, stageVariables, v3Utils) {
+  #additionalRequestContext = null
+
+  constructor(
+    request,
+    stage,
+    routeKey,
+    stageVariables,
+    additionalRequestContext,
+    v3Utils,
+  ) {
     this.#routeKey = routeKey
     this.#request = request
     this.#stage = stage
     this.#stageVariables = stageVariables
+    this.#additionalRequestContext = additionalRequestContext || {}
     if (v3Utils) {
       this.log = v3Utils.log
       this.progress = v3Utils.progress
@@ -164,6 +173,7 @@ export default class LambdaProxyIntegrationEventV2 {
           sourceIp: remoteAddress,
           userAgent: _headers['user-agent'] || '',
         },
+        operationName: this.#additionalRequestContext.operationName,
         requestId: 'offlineContext_resourceId',
         routeKey: this.#routeKey,
         stage: this.#stage,

diff --git a/tests/integration/lambda-integration/handler.js b/tests/integration/lambda-integration/handler.js
@@ -14,3 +14,13 @@ exports.lambdaIntegrationStringified =
       foo: 'bar',
     })
   }
+
+exports.lambdaIntegrationWithOperationName =
+  async function lambdaIntegrationWithOperationName(event) {
+    return {
+      body: stringify({
+        operationName: event.requestContext.operationName,
+      }),
+      statusCode: 200,
+    }
+  }
diff --git a/tests/integration/lambda-integration/lambdaIntegration.test.js b/tests/integration/lambda-integration/lambdaIntegration.test.js
@@ -36,6 +36,14 @@ describe('lambda integration tests', () => {
       path: '/dev/lambda-integration-stringified',
       status: 200,
     },
+    {
+      description: 'should return operation name from request context',
+      expected: {
+        operationName: 'getIntegrationWithOperationName',
+      },
+      path: '/dev/lambda-integration-with-operation-name',
+      status: 200,
+    },
   ].forEach(({ description, expected, path, status }) => {
     test(description, async () => {
       const url = joinUrl(TEST_BASE_URL, path)

diff --git a/tests/integration/lambda-integration/serverless.yml b/tests/integration/lambda-integration/serverless.yml
@@ -31,3 +31,11 @@ functions:
           method: get
           path: '/lambda-integration-stringified'
     handler: handler.lambdaIntegrationStringified
+
+  integrationWithOperationName:
+    events:
+      - http:
+          method: get
+          operationId: getIntegrationWithOperationName
+          path: '/lambda-integration-with-operation-name'
+    handler: handler.lambdaIntegrationWithOperationName
diff --git a/tests/old-unit/LambdaProxyIntegrationEvent.test.js b/tests/old-unit/LambdaProxyIntegrationEvent.test.js
@@ -75,6 +75,12 @@ describe('LambdaProxyIntegrationEvent', () => {
     test('should match fixed attributes', () => {
       expectFixedAttributes(lambdaProxyIntegrationEvent)
     })
+
+    test('should not have operation name', () => {
+      expect(lambdaProxyIntegrationEvent.requestContext.operationName).toEqual(
+        undefined,
+      )
+    })
   })
 
   describe('with a GET /fn1 request with headers', () => {
@@ -698,4 +704,28 @@ describe('LambdaProxyIntegrationEvent', () => {
       )
     })
   })
+
+  describe('with operation name', () => {
+    const requestBuilder = new RequestBuilder('GET', '/fn1')
+    const request = requestBuilder.toObject()
+
+    let lambdaProxyIntegrationEvent
+
+    beforeEach(() => {
+      lambdaProxyIntegrationEvent = new LambdaProxyIntegrationEvent(
+        request,
+        stage,
+        null,
+        null,
+        null,
+        { operationName: 'getFunctionOne' },
+      ).create()
+    })
+
+    test('should have operation name', () => {
+      expect(lambdaProxyIntegrationEvent.requestContext.operationName).toEqual(
+        'getFunctionOne',
+      )
+    })
+  })
 })