feat(apigatewayv2-integrations): http api - support for request parameter mapping #15630

dan-lind · 2021-07-18T06:11:14Z

This is an initial PR as discussed with @nija-at in an attempt to describe the user experience for supporting parameter mapping.
This PR will only support parameter mappings for HTTP APIs without an integration subtypes, but it will provide interfaces that can (and probably should) be reused when adding support for integration subtypes as well. Since it also provides the possibility to provide custom key/value pairs for maximum flexibility, it can support and integration subtype although it requires a bit more work on the user side.

closes #15293

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

gitpod-io · 2021-07-18T06:11:16Z

nija-at

Thanks for submitting this PR. Sorry for the delay.

So nice to review a README change before seeing all the code that implements it.

Some comments below. Let me know what you think.

packages/@aws-cdk/aws-apigatewayv2-integrations/README.md

nija-at · 2021-07-28T17:07:15Z

packages/@aws-cdk/aws-apigatewayv2-integrations/README.md

+        mappingValue: MappingValue.requestHeader('header1'),
+      })
+      .addParameter({
+        mappingKey: HttpMappingKey.removeHeader(),


I suppose you meant to say HttpMappingKey.removeHeader('header1') ?

Yes! I will fix that!

packages/@aws-cdk/aws-apigatewayv2-integrations/README.md

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

Pull request has been modified.

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

dan-lind · 2021-07-30T04:31:52Z

@nija-at I think I have adressed all your comments now, should I go ahead with a first iteration of the implementation?

nija-at

@nija-at I think I have adressed all your comments now, should I go ahead with a first iteration of the implementation?

@dan-lind - Yes, go forth.

Setting the PR status to 'request changes' so our automation knows that the ball is now in your court.

Pull request has been modified.

dan-lind · 2021-08-05T05:54:39Z

@nija-at I've made a first attempt at implementation, only in the base HttpIntegration at this point. Would like some feedback on this before I continue with the higher level construct for the ALB.

Creating the mappings is slightly different from what we discussed, you would now create parameter mappings like this

parameterMapping: new ParameterMapping(
  [
    {
      key: HttpMappingKey.appendHeader('header2'),
      value: MappingValue.requestHeader('header1'),
    },
    {
      key: HttpMappingKey.removeHeader('header1'),
      value: MappingValue.NONE,
    },
  ],
),

The idea was to lay the foundation which can later be reused when adding support for parameter mappings with integration subtypes (not in this PR). The same structure can then be used without much change, maybe it would look something like this for SQS

parameterMapping: new ParameterMapping(
  [
    {
      key: SqsMappingKey.QUEUE_URL,
      value: MappingValue.requestHeader('queueUrl'),
    },
    {
      key: SqsMappingKey.MESSAGE_BODY,
      value: MappingValue.requestBody('message'),
    },
  ],
),

nija-at

Hi @dan-lind. See my comments below.

nija-at · 2021-08-12T13:59:39Z

packages/@aws-cdk/aws-apigatewayv2/lib/http/integration.ts

+  readonly value: IMappingValue,
+};
+
+export class ParameterMapping {


Move all of these classes and interfaces into their own file.

Not sure if I still should? Only one class left

Yes, I think you still should.

These should also move into the base apigateway module.

nija-at · 2021-08-12T14:02:54Z

packages/@aws-cdk/aws-apigatewayv2/lib/http/integration.ts

+export interface IMappingKey {
+  key: string;
+};
+
+export interface IMappingValue {
+  value: string;
+};
+
+export class MappingKey implements IMappingKey {
+  public static custom(mappingKey: string) {return new MappingKey(mappingKey); }
+  protected constructor(public readonly key: string) {}
+}


Not clear why we need these classes and interfaces.

nija-at · 2021-08-12T14:04:20Z

packages/@aws-cdk/aws-apigatewayv2-integrations/README.md

+const httpEndpoint = new HttpApi(stack, 'HttpProxyPrivateApi', {
+  defaultIntegration: new HttpAlbIntegration({
+    listener,
+    requestParameters: new RequestParameters()


Should this be ParameterMapping?

nija-at · 2021-08-12T14:05:27Z

packages/@aws-cdk/aws-apigatewayv2-integrations/README.md

+      .addParameter({
+        mappingKey: MappingKey.custom('new.header'),
+        mappingValue: MappingValue.custom('new.value'),
+    }),


Why not just

new ParameterMapping().custom('new.header', MappingValue.custom('new.value'))?

But it's not fixed though? It's still the same in the README.

EDIT: Ahh, I see you fixed the API but not the README,

nija-at · 2021-08-12T14:07:25Z

packages/@aws-cdk/aws-apigatewayv2/test/http/route.test.ts

@@ -174,6 +175,18 @@ describe('HttpRoute', () => {
          connectionType: HttpConnectionType.VPC_LINK,
          uri: 'some-target-arn',
          secureServerName: 'some-server-name',
+          parameterMapping: new ParameterMapping(


Can you add a separate unit test for parameter mapping instead?

nija-at · 2021-08-12T14:07:42Z

packages/@aws-cdk/aws-apigatewayv2/test/http/route.test.ts

+            [
+              {
+                key: HttpMappingKey.appendHeader('header2'),
+                value: MappingValue.requestHeader('header1'),
+              },
+              {
+                key: HttpMappingKey.removeHeader('header1'),
+                value: MappingValue.NONE,
+              },
+            ],
+          ),


This is not the API we decided, right?

See latest changes

Pull request has been modified.

dan-lind · 2021-08-24T04:34:25Z

@nija-at Haven't been able to look at this for a while, but I've pushed some updates now, let me know if this addresses the concerns you had.

nija-at

Looks pretty good to me @dan-lind

Can you add docs, get the build to succeed and update the PR description? This should be close to shipping with one more iteration.

nija-at · 2021-09-14T10:45:33Z

packages/@aws-cdk/aws-apigatewayv2-integrations/README.md

+      .addParameter({
+        mappingKey: MappingKey.custom('new.header'),
+        mappingValue: MappingValue.custom('new.value'),
+    }),


But it's not fixed though? It's still the same in the README.

EDIT: Ahh, I see you fixed the API but not the README,

nija-at · 2021-09-14T10:45:37Z

packages/@aws-cdk/aws-apigatewayv2-integrations/README.md

+const httpEndpoint = new HttpApi(stack, 'HttpProxyPrivateApi', {
+  defaultIntegration: new HttpAlbIntegration({
+    listener,
+    requestParameters: new RequestParameters()


nija-at · 2021-09-14T10:46:13Z

packages/@aws-cdk/aws-apigatewayv2/lib/http/integration.ts

+  readonly value: IMappingValue,
+};
+
+export class ParameterMapping {


Yes, I think you still should.

nija-at · 2021-09-14T10:47:41Z

packages/@aws-cdk/aws-apigatewayv2/lib/http/integration.ts

+  readonly value: IMappingValue,
+};
+
+export class ParameterMapping {


These should also move into the base apigateway module.

Pull request has been modified.

…ub.com/dan-lind/aws-cdk into add-requestparams-support-apigatewayv2

dan-lind · 2021-10-03T05:38:23Z

Sorry, not a lot of bandwidth currently, but I've tried to address your comments.
Not sure if I moved the new parameter-mappning.ts, let me know if it show move again.

I think what's left is also the actual implementation in the higher level constructs in the apigatewayv2-integrations module, but guess this is only applicable for ALB?

dan-lind · 2021-10-04T04:41:26Z

Couldn't find anything in the docs that suggests that there are any limits to where the parameter mapping is valid, so I've added them for all higher level constructs in the apigatewayv2-integrations module.

I´ve added docs and tests as well. Hopefully close to complete now

nija-at

Looks good.

packages/@aws-cdk/aws-apigatewayv2-integrations/README.md

Pull request has been modified.

dan-lind · 2021-10-13T13:45:49Z

@nija-at Build failed after you approved, probably was too much behind master. I've synced with master now, can you please approve again?

mergify · 2021-10-13T14:07:15Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2021-10-13T15:00:26Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
Commit ID: 69cef43
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2021-10-13T15:01:05Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@nija-at

…eter mapping (aws#15630) ---- This is an initial PR as discussed with @nija-at in an attempt to describe the user experience for supporting parameter mapping. This PR will only support parameter mappings for HTTP APIs _without_ an integration subtypes, but it will provide interfaces that can (and probably should) be reused when adding support for integration subtypes as well. Since it also provides the possibility to provide custom key/value pairs for maximum flexibility, it can support and integration subtype although it requires a bit more work on the user side. closes aws#15293 *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Add parameter mapping support, readme update

1886a8b

peterwoodworth assigned nija-at Jul 20, 2021

peterwoodworth added the @aws-cdk/aws-apigatewayv2-integrations Related to AWS APIGatewayv2 Integrations label Jul 20, 2021

nija-at added effort/medium Medium work item – several days of effort p1 labels Jul 28, 2021

nija-at previously requested changes Jul 28, 2021

View reviewed changes

nija-at changed the title ~~feat(apigatewayv2-integrations): Add option to pass request parameter mappings~~ feat(apigatewayv2-integrations): http api - request parameter mapping Jul 28, 2021

dan-lind and others added 3 commits July 29, 2021 07:40

Update packages/@aws-cdk/aws-apigatewayv2-integrations/README.md

3f2078f

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

Update packages/@aws-cdk/aws-apigatewayv2-integrations/README.md

6703f2c

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

Update packages/@aws-cdk/aws-apigatewayv2-integrations/README.md

1e2c799

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

dan-lind and others added 3 commits July 29, 2021 07:50

Merge branch 'master' into add-requestparams-support-apigatewayv2

6d3aa5f

Update packages/@aws-cdk/aws-apigatewayv2-integrations/README.md

8b36ecc

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

Fix ParameterMapping example

0c81a2a

nija-at previously requested changes Jul 30, 2021

View reviewed changes

Add first unit test

b1f6d15

Remove logging

e5d5374

nija-at previously requested changes Aug 12, 2021

View reviewed changes

Simplyfy API

fbc06b8

Merge branch 'master' into add-requestparams-support-apigatewayv2

4ce0dc6

nija-at previously requested changes Sep 14, 2021

View reviewed changes

RomainMuller force-pushed the master branch from 924c117 to ebfd5f2 Compare September 29, 2021 13:07

Merge branch 'master' into add-requestparams-support-apigatewayv2

97df41e

Daniel Lindberg added 3 commits October 3, 2021 07:33

Fix README, move parameter-mapping to separate class

8856e00

Merge branch 'add-requestparams-support-apigatewayv2' of https://gith…

0dce9a1

…ub.com/dan-lind/aws-cdk into add-requestparams-support-apigatewayv2

Fix README, move parameter-mapping to separate class

ed2c1f3

Implementation for higher level constructs, docs update, unit tests

8da3978

dan-lind changed the title ~~feat(apigatewayv2-integrations): http api - request parameter mapping~~ feat(apigatewayv2-integrations): http api - add support for request parameter mapping Oct 4, 2021

Daniel Lindberg and others added 2 commits October 4, 2021 07:51

Fix imports

b3d1963

Merge branch 'master' into add-requestparams-support-apigatewayv2

8d3abb6

nija-at reviewed Oct 13, 2021

View reviewed changes

packages/@aws-cdk/aws-apigatewayv2-integrations/README.md Outdated Show resolved Hide resolved

packages/@aws-cdk/aws-apigatewayv2-integrations/README.md Outdated Show resolved Hide resolved

packages/@aws-cdk/aws-apigatewayv2-integrations/README.md Outdated Show resolved Hide resolved

Niranjan Jayakar added 2 commits October 13, 2021 16:14

Apply suggestions from code review

42ef243

Apply suggestions from code review

74a4ce1

nija-at previously approved these changes Oct 13, 2021

View reviewed changes

Merge branch 'master' into add-requestparams-support-apigatewayv2

3ddef7d

Merge branch 'master' into add-requestparams-support-apigatewayv2

bc284d5

nija-at changed the title ~~feat(apigatewayv2-integrations): http api - add support for request parameter mapping~~ feat(apigatewayv2-integrations): http api - support for request parameter mapping Oct 13, 2021

nija-at approved these changes Oct 13, 2021

View reviewed changes

Merge branch 'master' into add-requestparams-support-apigatewayv2

69cef43

mergify bot merged commit 0452aed into aws:master Oct 13, 2021

yip-anthony-principal mentioned this pull request Nov 1, 2021

add support for using ParameterMapping in LambdaProxyIntegration #17255

Closed

2 tasks

feat(apigatewayv2-integrations): http api - support for request parameter mapping #15630

feat(apigatewayv2-integrations): http api - support for request parameter mapping #15630

Conversation

dan-lind commented Jul 18, 2021

gitpod-io bot commented Jul 18, 2021

nija-at left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dan-lind commented Jul 30, 2021

nija-at left a comment

Choose a reason for hiding this comment

dan-lind commented Aug 5, 2021

nija-at left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nija-at Sep 14, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dan-lind commented Aug 24, 2021

nija-at left a comment

Choose a reason for hiding this comment

nija-at Sep 14, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dan-lind commented Oct 3, 2021

dan-lind commented Oct 4, 2021

nija-at left a comment

Choose a reason for hiding this comment

dan-lind commented Oct 13, 2021

mergify bot commented Oct 13, 2021

aws-cdk-automation commented Oct 13, 2021

AWS CodeBuild CI Report

mergify bot commented Oct 13, 2021

nija-at Sep 14, 2021 •

edited

Loading

nija-at Sep 14, 2021 •

edited

Loading