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(core): cdk diff on large templates fails when passing in toolkitStackName and qualifier #31636

Merged

Conversation

sumupitchayan
Copy link
Contributor

@sumupitchayan sumupitchayan commented Oct 3, 2024

Closes #29179

Reason for this change

If your account is bootstrapped with a custom toolkitStackName or qualifier, then running cdk diff does not work for large diff templates of over 50 KiB in size.

Description of changes

The toolkitStackName was not passed down all the way through the cdk diff code path - this PR fixes the issue by adding the optional toolkitStackName property to the DiffOptions interface in cdk-toolkit.ts and passing that value all the way through the diff code path to the uploadBodyParameterAndCreateChangeSet function in cloudformation.ts, where the template asset is built and published.

Description of how you validated changes

I created a CDK app locally and ran the commands (exactly following the reproduction steps from the original issue) using the CLI build from this PR and was able to successfully run cdk diff without needing to pass in the --toolkit-stack-name flag.

Checklist


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

@aws-cdk-automation aws-cdk-automation requested a review from a team October 3, 2024 15:39
@github-actions github-actions bot added the p2 label Oct 3, 2024
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Oct 3, 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.

@aws-cdk-automation aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Oct 3, 2024
@github-actions github-actions bot added bug This issue is a bug. effort/medium Medium work item – several days of effort p1 and removed p2 labels Oct 3, 2024
@sumupitchayan sumupitchayan added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Oct 3, 2024
Signed-off-by: Sumu <[email protected]>
…ier' of https://github.com/aws/aws-cdk into sumughan/fix/diff-with-custom-bootstrap-name-and-qualifier
@sumupitchayan sumupitchayan changed the title fix(core): cdk diff fails when using custom toolkitStackName and qualifier fix(core): cdk diff on large templates fails when passing in toolkitStackName and qualifier Oct 3, 2024
@sumupitchayan sumupitchayan marked this pull request as ready for review October 4, 2024 16:00
@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.

@sumupitchayan sumupitchayan 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 Oct 7, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review October 7, 2024 03:23

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

Copy link
Contributor

mergify bot commented Oct 7, 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).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mergify mergify bot merged commit f603c97 into main Oct 7, 2024
11 of 12 checks passed
@mergify mergify bot deleted the sumughan/fix/diff-with-custom-bootstrap-name-and-qualifier branch October 7, 2024 03:56
Copy link
Contributor

mergify bot commented Oct 7, 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).

Copy link

github-actions bot commented Oct 7, 2024

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 Oct 7, 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. effort/medium Medium work item – several days of effort p1 pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested pr-linter/exempt-integ-test The PR linter will not require integ test changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cdk diff: when a custom stack name and qualifier are used, the diff action falls back to the CDKToolkit stack for templates larger than 50KiB
3 participants