feat(apigatewayv2): add missing `WebSocketIntegration` props #29566

nmussy · 2024-03-21T06:52:50Z

Issue # (if applicable)

None as far as I can tell

Reason for this change

I was looking at the WebSocket integration to get a feel for #29562, and noticed a couple of missing properties

Description of changes

Added support for timeout and contentHandling
Minor copy-pasta fixes in documentation and test description

Description of how you validated changes

I've added unit tests to check these optional properties. I've also updated and verified the following integrations tests:

integ.lambda.ts:
- ContentHandlingStrategy and TimeoutInMillis are both correctly set

$ aws apigatewayv2 get-integration --api-id bu24s9i8t0 --integration-id fxqec8c
{
    "ConnectionType": "INTERNET",
    "ContentHandlingStrategy": "CONVERT_TO_TEXT",
    "IntegrationId": "fxqec8c",
    "IntegrationMethod": "POST",
    "IntegrationType": "AWS_PROXY",
    "IntegrationUri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:637423343434:function:WebSocketApiInteg-DefaultHandler604DF7AC-GSQYxsiaKjkz/invocations",
    "PassthroughBehavior": "WHEN_NO_MATCH",
    "PayloadFormatVersion": "1.0",
    "RequestTemplates": {},
    "TimeoutInMillis": 10000
}

integ.aws.ts:
- ContentHandlingStrategy, TemplateSelectionExpression, TimeoutInMillis, PassthroughBehavior, and RequestParameters are all correctly set

$ aws apigatewayv2 get-integration --api-id qp17tw07w3 --integration-id hycmjxb
{
    "ConnectionType": "INTERNET",
    "ContentHandlingStrategy": "CONVERT_TO_BINARY",
    "CredentialsArn": "arn:aws:iam::637423343434:role/integ-aws-websocket-integrat-ApiGatewayRoleD2518903-i80lztfxo5XI",
    "IntegrationId": "hycmjxb",
    "IntegrationMethod": "POST",
    "IntegrationResponseSelectionExpression": "${integration.response.statuscode}",
    "IntegrationType": "AWS",
    "IntegrationUri": "arn:aws:apigateway:us-east-1:dynamodb:action/PutItem",
    "PassthroughBehavior": "WHEN_NO_TEMPLATES",
    "PayloadFormatVersion": "1.0",
    "RequestParameters": {
        "integration.request.header.Content-Type": "'application/x-www-form-urlencoded'"
    },
    "RequestTemplates": {
        "application/json": "{\"TableName\":\"MyTable\",\"Item\":{\"id\":{\"S\":\"$context.requestId\"}}}"
    },
    "TemplateSelectionExpression": "\\$default",
    "TimeoutInMillis": 10000
}

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

packages/aws-cdk-lib/aws-apigatewayv2/lib/websocket/integration.ts

packages/aws-cdk-lib/aws-apigatewayv2-integrations/lib/websocket/lambda.ts

msambol · 2024-03-21T16:51:42Z

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

+
+You can also set additional properties to change the behavior of your integration, such as `contentHandling`.
+See [Working with binary media types for WebSocket APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-develop-binary-media-types.html).


worth adding timeout here too?

There are already a few existing optional props on top of the two I've added:
https://github.com/nmussy/aws-cdk/blob/58625787bd0027bb375a760271c5fed957ac6966/packages/%40aws-cdk-testing/framework-integ/test/aws-apigatewayv2-integrations/test/websocket/integ.aws.ts#L44-L61

timeout feels pretty minor, especially because its default is already maxed out. Most of them are already shown in the "AWS WebSocket Integration" example, I could add the timeout there?

https://github.com/nmussy/aws-cdk/blob/58625787bd0027bb375a760271c5fed957ac6966/packages/aws-cdk-lib/aws-apigatewayv2-integrations/README.md?plain=1#L289-L305

msambol

LGTM. Thanks @nmussy !

mergify · 2024-03-21T23:20:49Z

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

mergify · 2024-03-21T23:24:41Z

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

mergify · 2024-03-21T23:52:38Z

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

shikha372 · 2024-03-22T23:24:17Z

@Mergifyio update

mergify · 2024-03-22T23:24:52Z

update

✅ Branch has been successfully updated

aws-cdk-automation · 2024-03-22T23:52:55Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 46c0bcf
Result: SUCCEEDED
Build Logs (available for 30 days)

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

mergify · 2024-03-22T23:53:08Z

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

### Issue # (if applicable) None as far as I can tell ### Reason for this change I was looking at the WebSocket integration to get a feel for aws#29562, and noticed a couple of missing properties ### Description of changes * Added support for `timeout` and `contentHandling` * Minor copy-pasta fixes in documentation and test description ### Description of how you validated changes I've added unit tests to check these optional properties. I've also updated and verified the following integrations tests: * `integ.lambda.ts`: * `ContentHandlingStrategy` and `TimeoutInMillis` are both correctly set ```sh $ aws apigatewayv2 get-integration --api-id bu24s9i8t0 --integration-id fxqec8c { "ConnectionType": "INTERNET", "ContentHandlingStrategy": "CONVERT_TO_TEXT", "IntegrationId": "fxqec8c", "IntegrationMethod": "POST", "IntegrationType": "AWS_PROXY", "IntegrationUri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:637423343434:function:WebSocketApiInteg-DefaultHandler604DF7AC-GSQYxsiaKjkz/invocations", "PassthroughBehavior": "WHEN_NO_MATCH", "PayloadFormatVersion": "1.0", "RequestTemplates": {}, "TimeoutInMillis": 10000 } ``` * `integ.aws.ts`: * `ContentHandlingStrategy`, `TemplateSelectionExpression`, `TimeoutInMillis`, `PassthroughBehavior`, and `RequestParameters` are all correctly set ```sh $ aws apigatewayv2 get-integration --api-id qp17tw07w3 --integration-id hycmjxb { "ConnectionType": "INTERNET", "ContentHandlingStrategy": "CONVERT_TO_BINARY", "CredentialsArn": "arn:aws:iam::637423343434:role/integ-aws-websocket-integrat-ApiGatewayRoleD2518903-i80lztfxo5XI", "IntegrationId": "hycmjxb", "IntegrationMethod": "POST", "IntegrationResponseSelectionExpression": "${integration.response.statuscode}", "IntegrationType": "AWS", "IntegrationUri": "arn:aws:apigateway:us-east-1:dynamodb:action/PutItem", "PassthroughBehavior": "WHEN_NO_TEMPLATES", "PayloadFormatVersion": "1.0", "RequestParameters": { "integration.request.header.Content-Type": "'application/x-www-form-urlencoded'" }, "RequestTemplates": { "application/json": "{\"TableName\":\"MyTable\",\"Item\":{\"id\":{\"S\":\"$context.requestId\"}}}" }, "TemplateSelectionExpression": "\\$default", "TimeoutInMillis": 10000 } ``` ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

nmussy added 2 commits March 21, 2024 07:41

feat(apigatewayv2): add missing WebSocketIntegration props

ceba418

chore: fix prop order

3527eed

aws-cdk-automation requested a review from a team March 21, 2024 06:53

github-actions bot added p2 distinguished-contributor [Pilot] contributed 50+ PRs to the CDK labels Mar 21, 2024

aws-cdk-automation previously requested changes Mar 21, 2024

View reviewed changes

nmussy added 4 commits March 21, 2024 08:57

chore: lambda integ

3c3b2b9

chore: aws integ

6f34074

feat: add contentHandling support for WebSocketLambdaIntegration

5458ee7

chore: update README

861b612

nmussy marked this pull request as ready for review March 21, 2024 09:07

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Mar 21, 2024

msambol reviewed Mar 21, 2024

View reviewed changes

packages/aws-cdk-lib/aws-apigatewayv2/lib/websocket/integration.ts Show resolved Hide resolved

msambol reviewed Mar 21, 2024

View reviewed changes

packages/aws-cdk-lib/aws-apigatewayv2-integrations/lib/websocket/lambda.ts Outdated Show resolved Hide resolved

chore: remove newline

5862578

msambol reviewed Mar 21, 2024

View reviewed changes

msambol approved these changes Mar 21, 2024

View reviewed changes

aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Mar 21, 2024

shikha372 self-assigned this Mar 21, 2024

shikha372 approved these changes Mar 21, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Mar 21, 2024

Merge branch 'main' into feat-apigatewayv2-missing-websocket-props

decf4ef

Merge branch 'main' into feat-apigatewayv2-missing-websocket-props

46c0bcf

mergify bot merged commit 7534dcd into aws:main Mar 22, 2024
9 checks passed

nmussy deleted the feat-apigatewayv2-missing-websocket-props branch March 23, 2024 14:27

github-actions bot mentioned this pull request Mar 25, 2024

Weekly PR metrics report #29602

Closed

github-actions bot mentioned this pull request Apr 1, 2024

Monthly PR metrics report #29668

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(apigatewayv2): add missing `WebSocketIntegration` props #29566

feat(apigatewayv2): add missing `WebSocketIntegration` props #29566

nmussy commented Mar 21, 2024 •

edited

aws-cdk-automation left a comment

msambol Mar 21, 2024

nmussy Mar 21, 2024

msambol left a comment

mergify bot commented Mar 21, 2024

mergify bot commented Mar 21, 2024

mergify bot commented Mar 21, 2024

shikha372 commented Mar 22, 2024

mergify bot commented Mar 22, 2024

aws-cdk-automation commented Mar 22, 2024

mergify bot commented Mar 22, 2024


		You can also set additional properties to change the behavior of your integration, such as `contentHandling`.
		See [Working with binary media types for WebSocket APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-develop-binary-media-types.html).

feat(apigatewayv2): add missing WebSocketIntegration props #29566

feat(apigatewayv2): add missing WebSocketIntegration props #29566

Conversation

nmussy commented Mar 21, 2024 • edited

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

aws-cdk-automation left a comment

Choose a reason for hiding this comment

msambol Mar 21, 2024

Choose a reason for hiding this comment

nmussy Mar 21, 2024

Choose a reason for hiding this comment

msambol left a comment

Choose a reason for hiding this comment

mergify bot commented Mar 21, 2024

mergify bot commented Mar 21, 2024

mergify bot commented Mar 21, 2024

shikha372 commented Mar 22, 2024

mergify bot commented Mar 22, 2024

✅ Branch has been successfully updated

aws-cdk-automation commented Mar 22, 2024

AWS CodeBuild CI Report

mergify bot commented Mar 22, 2024

feat(apigatewayv2): add missing `WebSocketIntegration` props #29566

feat(apigatewayv2): add missing `WebSocketIntegration` props #29566

nmussy commented Mar 21, 2024 •

edited