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(cli): asset not uploaded with different synthesizer configs #26910

Merged
merged 8 commits into from
Aug 29, 2023

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Aug 28, 2023

If the same asset is used in 2 stacks that use different synthesizer configurations for publishing (for example, by using a different prefix) the asset will only be uploaded once instead of twice.

We used to make the assumption that it was okay to use the destination ID as token of uniqueness. This is true inside a single manifest, but does not hold when there is more than stack that each have a manifest: both may have the destination ID current_account:current_region, but have different parameters for each destination.

Instead, we calculate a content hash over the destination definition itself. That way, if the definitions are different we will create different nodes for each of them.

Fixes #25927.


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

If the same asset is used in 2 stacks that use different synthesizer
configurations for publishing (for example, by using a different prefix)
the asset will only be uploaded once instead of twice.

We used to make the assumption that it was okay to use the destination
ID as token of uniqueness. This is true inside a single manifest, but
does not hold when there is more than stack that each have a manifest:
both may have the destination ID `current_account:current_region`, but
have different parameters for each destination.

Instead, we calculate a content hash over the destination definition
itself. That way, if the definitions are different we will create
different nodes for each of them.

Fixes #25927.
@rix0rrr rix0rrr requested a review from a team August 28, 2023 13:06
@aws-cdk-automation aws-cdk-automation requested a review from a team August 28, 2023 13:07
@github-actions github-actions bot added bug This issue is a bug. effort/medium Medium work item – several days of effort p1 labels Aug 28, 2023
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Aug 28, 2023
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 Aug 28, 2023
@rix0rrr rix0rrr added pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested labels Aug 28, 2023
@aws-cdk-automation aws-cdk-automation dismissed their stale review August 28, 2023 13:23

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

@aws-cdk-automation aws-cdk-automation removed the pr/needs-cli-test-run This PR needs CLI tests run against it. label Aug 28, 2023
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Aug 29, 2023
@rix0rrr rix0rrr requested a review from a team August 29, 2023 10:06

const buildId = `${this.idPrefix}${assetId}-build`;
const publishNodeId = `${this.idPrefix}${assetDestinationId}-publish`;
const buildId = `build-${assetId}-${contentHashAny([assetId, asset.genericSource]).substring(0, 10)}`;
Copy link
Contributor

Choose a reason for hiding this comment

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

  • Why no longer consider this.idPrefix? was it not needed here in the first place?
  • Why substringing?
  • Would this trigger a re upload of basically all assets everywhere? thus doubling the amount of assets in the user's account?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why no longer consider this.idPrefix? was it not needed here in the first place?

It was an attempt to prevent false sharing between assets in subassemblies and top level assemblies. Because of the hash, this is now no longer necessary (and in fact hampers legitimate sharing).

Why substringing?

Just to keep the id somewhat reasonable.

Would this trigger a re upload of basically all assets everywhere? thus doubling the amount of assets in the user's account?

No effect there.

@mergify
Copy link
Contributor

mergify bot commented Aug 29, 2023

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 aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Aug 29, 2023
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 2dd856d
  • 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 b06a38f into main Aug 29, 2023
10 of 11 checks passed
@mergify mergify bot deleted the huijbers/dupe-assets branch August 29, 2023 13:59
@mergify
Copy link
Contributor

mergify bot commented Aug 29, 2023

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/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
3 participants