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

chore(cli): remove legacy compat code to support version reporting in v1 apps #32710

Merged
merged 4 commits into from
Jan 7, 2025

Conversation

mrgrain
Copy link
Contributor

@mrgrain mrgrain commented Jan 2, 2025

Reason for this change

In the first versions of AWS CDK v1 and older, version metadata was injected by the CLI not by the framework.
This changed with the introduction of Cloud Assembly Schema v6.0.0 in AWS CDK v1.65.0 (see changelog).

The CLI kept compatibility code around to ensure the metadata is injected. This code was introduced via #19010 on Feb 17, 2022.

However this code was intended for v1 and kept around because v1 and v2 were initially developed on the same code base. In the meantime, AWS CDK v1 is EOS and we do not need to support v1 features from v2 anymore.

This change will mean that we will stop reporting metadata for users that use the CLI v2 >= 2.174.0 (the release removing the compat code) to deploy a Cloud Assembly developed with framework v1 < 1.65.0. Otherwise these users are not functionally effected by the change.

We therefore decide to now remove the unused compat code.

Description of changes

Remove the unused legacy code and adjusted test cases.

Describe any new or updated permissions being added

n/a

Description of how you validated changes

Run unit test and CLI integ tests.

Checklist


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

@mrgrain mrgrain requested a review from a team as a code owner January 2, 2025 14:13
@aws-cdk-automation aws-cdk-automation requested a review from a team January 2, 2025 14:14
@github-actions github-actions bot added the p2 label Jan 2, 2025
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jan 2, 2025
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.

@aws-cdk-automation aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Jan 2, 2025
Copy link
Contributor

@rix0rrr rix0rrr left a comment

Choose a reason for hiding this comment

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

V2 CLIs can deploy a V1 app... but I'm still fine removing this compat layer. It's ancient now, people should have upgraded past this already.

Copy link

codecov bot commented Jan 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.37%. Comparing base (0486b9c) to head (5183545).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #32710      +/-   ##
==========================================
- Coverage   81.38%   81.37%   -0.02%     
==========================================
  Files         222      222              
  Lines       13750    13693      -57     
  Branches     2424     2412      -12     
==========================================
- Hits        11191    11143      -48     
+ Misses       2279     2271       -8     
+ Partials      280      279       -1     
Flag Coverage Δ
suite.unit 81.37% <100.00%> (-0.02%) ⬇️

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

Components Coverage Δ
packages/aws-cdk 80.68% <100.00%> (-0.03%) ⬇️
packages/aws-cdk-lib/core 82.09% <ø> (ø)

@mrgrain
Copy link
Contributor Author

mrgrain commented Jan 3, 2025

@Mergifyio update

Copy link
Contributor

mergify bot commented Jan 3, 2025

update

✅ Branch has been successfully updated

@mergify mergify bot temporarily deployed to test-pipeline January 3, 2025 12:59 Inactive
@aws-cdk-automation
Copy link
Collaborator

➡️ PR build request submitted to test-main-pipeline ⬅️

A maintainer must now check the pipeline and add the pr-linter/cli-integ-tested label once the pipeline succeeds.

@mrgrain mrgrain added pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested and removed pr/needs-cli-test-run This PR needs CLI tests run against it. labels Jan 6, 2025
@mrgrain
Copy link
Contributor Author

mrgrain commented Jan 6, 2025

Pipeline execution: 3d54620c

@aws-cdk-automation aws-cdk-automation dismissed their stale review January 6, 2025 23:35

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

Copy link
Contributor

mergify bot commented Jan 6, 2025

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
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 5183545
  • 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 Jan 7, 2025

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 946b748 into main Jan 7, 2025
18 of 19 checks passed
@mergify mergify bot deleted the mrgrain/chore/remove-version-reporting-compat-code branch January 7, 2025 00:09
Copy link

github-actions bot commented Jan 7, 2025

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 Jan 7, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
contribution/core This is a PR that came from AWS. p2 pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants