feat(apigatewayv2-integrations): `WebSocketMockIntegration` props #30622

nmussy · 2024-06-22T08:18:55Z

Issue # (if applicable)

None

Reason for this change

Unlike the other integrations, WebSocketMockIntegration did not have a props interface, and was missing a few properties. This PR does not include integration responses, they are already being implemented in #29661

Description of changes

Added requestTemplates and templateSelectionExpression to the newly created WebSocketMockIntegrationProps

Description of how you validated changes

Unit and integration tests were updated

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

nmussy · 2024-06-22T08:20:35Z

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

+  /**
+   * A map of Apache Velocity templates that are applied on the request
+   * payload.
+   *
+   * ```
+   *   { "application/json": "{ \"statusCode\": 200 }" }
+   * ```
+   *
+   * @default - No request template provided to the integration.
+   * @see https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-mapping-template-reference.html
+   */
+  readonly requestTemplates?: { [contentType: string]: string };


Previous discussion: https://github.com/aws/aws-cdk/pull/29661/files#r1649290535

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.

nmussy · 2024-06-22T08:23:17Z

Exemption Request: WebSocketMockIntegration is currently not mentioned in any README file

msambol · 2024-06-27T20:47:46Z

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

+   * A map of Apache Velocity templates that are applied on the request
+   * payload.
+   *
+   * ```


need @example ?

msambol

LGTM

GavinZZ

nit comment: Can you update the integ test file name to be more descriptive? something like websocket-mock-integration or anything align the line.

GavinZZ · 2024-08-28T16:20:04Z

Exemption Request: WebSocketMockIntegration is currently not mentioned in any README file

I don't think this is a good enough reasoning. Some documentation should have been added when this construct is initially added. Would you please add somethiing to the README to explain the usage and what this is for? Appreciate it.

…ock-props

nmussy · 2024-12-09T15:21:06Z

Sorry for the late reply, catching up on my notifications. I've added a section in the README for mock integrations.

nit comment: Can you update the integ test file name to be more descriptive? something like websocket-mock-integration or anything align the line.

I understand the possible source for confusion here, but the existing integration files for the response types follow the same naming pattern:

$ tree packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2-integrations/test/websocket/ -L 1 -I '*/' --gitignore
packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2-integrations/test/websocket/
├── integ.aws.ts
├── integ.lambda-connect-disconnect-trigger.ts
├── integ.lambda.ts
├── integ.mock.ts
├── integ.route-response.ts
└── integ.sqs.ts

$ tree packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2-integrations/test/http/ -L 1 -I '*/' --gitignore
packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2-integrations/test/http/
├── integ.add-subroute-integration.ts
├── integ.alb.ts
├── integ.http-proxy.ts
├── integ.lambda-proxy.ts
├── integ.nlb.ts
├── integ.service-discovery.ts
└── integ.stepfunctions.ts

Let me know how you want to handle this, but only renaming integ.mock.ts would make it look out of place. I also think there is enough context in the relative file path, adding more would be a bit repetitive (aws-apigatewayv2-integrations/test/websocket/integ.mock.ts)

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

codecov · 2024-12-09T15:31:06Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.40%. Comparing base (3fbc785) to head (e77f094).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #30622   +/-   ##
=======================================
  Coverage   81.40%   81.40%           
=======================================
  Files         223      223           
  Lines       13727    13727           
  Branches     2411     2411           
=======================================
  Hits        11175    11175           
  Misses       2274     2274           
  Partials      278      278

Flag	Coverage Δ
suite.unit	`81.40% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`80.74% <ø> (ø)`
packages/aws-cdk-lib/core	`82.10% <ø> (ø)`

aws-cdk-automation · 2025-01-08T00:10:45Z

This PR has been in the CHANGES REQUESTED state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week.

mergify · 2025-01-14T21:52:09Z

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).

kaizencc · 2025-01-15T16:57:19Z

@Mergifyio refresh

mergify · 2025-01-15T16:57:28Z

refresh

✅ Pull request refreshed

kaizencc · 2025-01-15T17:03:09Z

@Mergifyio update

mergify · 2025-01-15T17:03:18Z

update

✅ Branch has been successfully updated

mergify · 2025-01-15T17:36:53Z

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).

aws-cdk-automation · 2025-01-15T18:42:58Z

AWS CodeBuild CI Report

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

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

mergify · 2025-01-15T18:43:22Z

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).

github-actions · 2025-01-15T18:43:44Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

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

aws-cdk-automation requested a review from a team June 22, 2024 08:19

nmussy commented Jun 22, 2024

View reviewed changes

aws-cdk-automation previously requested changes Jun 22, 2024

View reviewed changes

nmussy mentioned this pull request Jun 22, 2024

feat(apigateway): WebSocketIntegrationResponse implementation #29661

Open

1 task

aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Jun 22, 2024

github-actions bot mentioned this pull request Jun 24, 2024

Weekly PR metrics report #30637

Closed

feat(apigatewayv2-integrations): WebSocketMockIntegration props

24dde44

nmussy force-pushed the feat-apigatewayv2-mock-props branch from 989beee to 24dde44 Compare June 24, 2024 20:18

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

msambol reviewed Jun 27, 2024

View reviewed changes

msambol approved these changes Jun 27, 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 Jun 27, 2024

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

Monthly PR metrics report #30715

Closed

GavinZZ requested changes Aug 28, 2024

View reviewed changes

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

nmussy added 2 commits December 9, 2024 15:57

Merge remote-tracking branch 'upstream/main' into feat-apigatewayv2-m…

14f2a42

…ock-props

chore: add WebSocketMockIntegration to README

e75d6c5

nmussy requested a review from GavinZZ December 9, 2024 15:21

gracelu0 removed the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Jan 7, 2025

kaizencc added the pr-linter/do-not-close The PR linter will not close this PR while this label is present label Jan 14, 2025

GavinZZ approved these changes Jan 14, 2025

View reviewed changes

Merge branch 'main' into feat-apigatewayv2-mock-props

cc487a1

Merge branch 'main' into feat-apigatewayv2-mock-props

e77f094

mergify bot merged commit a5a0168 into aws:main Jan 15, 2025
19 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Jan 15, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(apigatewayv2-integrations): `WebSocketMockIntegration` props #30622

feat(apigatewayv2-integrations): `WebSocketMockIntegration` props #30622

nmussy commented Jun 22, 2024

nmussy Jun 22, 2024

aws-cdk-automation left a comment

nmussy commented Jun 22, 2024

msambol Jun 27, 2024

msambol left a comment

GavinZZ left a comment •

edited

Loading

GavinZZ commented Aug 28, 2024 •

edited

Loading

nmussy commented Dec 9, 2024

codecov bot commented Dec 9, 2024 •

edited

Loading

aws-cdk-automation commented Jan 8, 2025

mergify bot commented Jan 14, 2025

kaizencc commented Jan 15, 2025

mergify bot commented Jan 15, 2025

kaizencc commented Jan 15, 2025

mergify bot commented Jan 15, 2025

mergify bot commented Jan 15, 2025

aws-cdk-automation commented Jan 15, 2025

mergify bot commented Jan 15, 2025

github-actions bot commented Jan 15, 2025

feat(apigatewayv2-integrations): WebSocketMockIntegration props #30622

feat(apigatewayv2-integrations): WebSocketMockIntegration props #30622

Conversation

nmussy commented Jun 22, 2024

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

nmussy Jun 22, 2024

Choose a reason for hiding this comment

aws-cdk-automation left a comment

Choose a reason for hiding this comment

nmussy commented Jun 22, 2024

msambol Jun 27, 2024

Choose a reason for hiding this comment

msambol left a comment

Choose a reason for hiding this comment

GavinZZ left a comment • edited Loading

Choose a reason for hiding this comment

GavinZZ commented Aug 28, 2024 • edited Loading

nmussy commented Dec 9, 2024

codecov bot commented Dec 9, 2024 • edited Loading

Codecov Report

aws-cdk-automation commented Jan 8, 2025

mergify bot commented Jan 14, 2025

kaizencc commented Jan 15, 2025

mergify bot commented Jan 15, 2025

✅ Pull request refreshed

kaizencc commented Jan 15, 2025

mergify bot commented Jan 15, 2025

✅ Branch has been successfully updated

mergify bot commented Jan 15, 2025

aws-cdk-automation commented Jan 15, 2025

AWS CodeBuild CI Report

mergify bot commented Jan 15, 2025

github-actions bot commented Jan 15, 2025

feat(apigatewayv2-integrations): `WebSocketMockIntegration` props #30622

feat(apigatewayv2-integrations): `WebSocketMockIntegration` props #30622

GavinZZ left a comment •

edited

Loading

GavinZZ commented Aug 28, 2024 •

edited

Loading

codecov bot commented Dec 9, 2024 •

edited

Loading