Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(apigateway): remove deprecated apigatewayv2 from aws-apigateway module #32297

Merged
merged 5 commits into from
Nov 26, 2024

Conversation

GavinZZ
Copy link
Contributor

@GavinZZ GavinZZ commented Nov 26, 2024

Issue # (if applicable)

Closes #32296

Reason for this change

As a summary, CDK aws-apigateway module had a legacy file called apigatewayv2.ts which includes CDK L1 Constructs from API Gateway V2 resource like CfnDomainNameV2. We've already moved everything here to aws-apigatewayv2 module. However, we had to keep the legacy file for backward compatibility issue and every Constructs in the file were marked as deprecated 5 years ago.

Now API Gateway team has released a new AWS resource called DomainNameV2 in API Gateway. The default CDK generated name would be CfnDomainNameV2 in aws-apigateway module but this name collides with the legacy CfnDomainNameV2 Construct from apigatewayv2.ts file (supposedly for APIGatewayV2).

This is causing the L1 generation tool to fail because the new resource by API Gateway is also caused CfnDomainNameV2.

Description of changes

Delete the deprecated apigatewayv2.ts file entirely.

Description of how you validated changes

Existing users on upgrade won't be able to deploy their template without knowing the change because the property for the APIGateway::DomainNameV2 resource is different from APIGatewayV2::DomainName resource, so the template would be non-deployable.

Verified that if existing users who use CfnDomainNameV2 from aws-apigateway module and update to use the same Construct from aws-apigatewayv2 module, it will generate the exact same output CFN template so it won't cause any resource replacement or downtime.

There's only 76 users who used CfnApiV2 from aws-apigateway module based on Analytics. All these users were on CDK V1 so if they choose to upgrade to latest version, they need to fix a bunch of breaking changes anyway.

Checklist

BREAKING CHANGE: We will be removing deprecated APIGatewayV2 constructs from aws-apigateway module.

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

@GavinZZ GavinZZ added the p1 label Nov 26, 2024
@github-actions github-actions bot added the bug This issue is a bug. label Nov 26, 2024
@GavinZZ GavinZZ added pr-linter/exempt-test The PR linter will not require test changes pr-linter/exempt-integ-test The PR linter will not require integ test changes and removed bug This issue is a bug. labels Nov 26, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team November 26, 2024 21:37
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Nov 26, 2024
Copy link

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.46%. Comparing base (7cc5f30) to head (40a5eb9).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #32297   +/-   ##
=======================================
  Coverage   77.46%   77.46%           
=======================================
  Files         105      105           
  Lines        7168     7168           
  Branches     1314     1314           
=======================================
  Hits         5553     5553           
  Misses       1433     1433           
  Partials      182      182           
Flag Coverage Δ
suite.unit 77.46% <ø> (ø)

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

Components Coverage Δ
packages/aws-cdk 77.46% <ø> (ø)

@GavinZZ GavinZZ marked this pull request as ready for review November 26, 2024 23:09
@github-actions github-actions bot added the bug This issue is a bug. label Nov 26, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@GavinZZ GavinZZ changed the title fix: remove deprecated apigatewayv2 from aws-apigateway module fix(apigateway): remove deprecated apigatewayv2 from aws-apigateway module Nov 26, 2024
@moelasmar moelasmar added the pr-linter/exempt-breaking-change The PR linter will not require stability in stable modules label Nov 26, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review November 26, 2024 23:24

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

Copy link
Contributor

mergify bot commented Nov 26, 2024

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 mergify bot merged commit 4db9565 into main Nov 26, 2024
17 checks passed
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

Copy link
Contributor

mergify bot commented Nov 26, 2024

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 mergify bot deleted the yuanhaoz/remove_deprecated_apigatewayv2 branch November 26, 2024 23:57
Copy link

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 github-actions bot locked as resolved and limited conversation to collaborators Nov 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug This issue is a bug. contribution/core This is a PR that came from AWS. p1 pr-linter/exempt-breaking-change The PR linter will not require stability in stable modules pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/exempt-test The PR linter will not require test changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

❗Notice: (apigateway): API Gateway released new resource DomainNameV2 causing conflicts in L1 generation
3 participants