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(spec2cdk): use modern type when building tag type #29389

Merged
merged 3 commits into from
Mar 7, 2024

Conversation

GavinZZ
Copy link
Contributor

@GavinZZ GavinZZ commented Mar 6, 2024

Issue # (if applicable)

Closes #29388

Reason for this change

Some of the modern tags failed to run cdk synth due to type misconfiguration.

Description of changes

Always default to use the latest type for modern tags.

Description of how you validated changes

Fixed for failed resources.

Checklist


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

@github-actions github-actions bot added bug This issue is a bug. p2 labels Mar 6, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team March 6, 2024 23:00
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.

@@ -179,7 +179,7 @@ export class ResourceDecider {

private handleTagPropertyModern(cfnName: string, prop: Property, variant: TagVariant) {
const originalName = propertyNameFromCloudFormation(cfnName);
const originalType = this.converter.typeFromProperty(prop);
const originalType = this.converter.typeFromPropertyForModernTags(prop);
Copy link
Contributor Author

@GavinZZ GavinZZ Mar 6, 2024

Choose a reason for hiding this comment

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

This should be safe and not a breaking change because handleTagPropertyModern is only enabled in version 2.131.0 which is the current CDK version, see this PR https://github.com/aws/aws-cdk/pull/28989/files.

Before version 2.131.0 there would be no way to reach this function call due to HAS_25610 is always set to false (see the PR I linked). And for 2.131.0 there wouldn't be a deployable template since it will fails at deployment step, see description.

@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 labels Mar 6, 2024
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Mar 6, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review March 6, 2024 23:04

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

@GavinZZ GavinZZ marked this pull request as ready for review March 6, 2024 23:30
@github-actions github-actions bot added effort/medium Medium work item – several days of effort p1 and removed p2 labels Mar 7, 2024
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Mar 7, 2024
rix0rrr
rix0rrr previously requested changes Mar 7, 2024
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.

I think your reasoning makes sense. But please add a unit test for the type this was reported against.

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Mar 7, 2024
@GavinZZ GavinZZ removed the pr-linter/exempt-test The PR linter will not require test changes label Mar 7, 2024
@GavinZZ GavinZZ requested a review from rix0rrr March 7, 2024 17:03
@GavinZZ
Copy link
Contributor Author

GavinZZ commented Mar 7, 2024

I think your reasoning makes sense. But please add a unit test for the type this was reported against.

Thanks, I've added unit tests to the AWS::XRay::Group resource.

@GavinZZ GavinZZ dismissed rix0rrr’s stale review March 7, 2024 21:41

dismissing since unit tests are added.

Copy link
Contributor

mergify bot commented Mar 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: 6e45a52
  • 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 3fb0254 into main Mar 7, 2024
12 checks passed
@mergify mergify bot deleted the yuanhaoz/modern_tag_use_new_type branch March 7, 2024 22:10
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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/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.

(xray): Invalid template synthesis for X-Ray resources when using Tags.of()
4 participants