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(ec2): naming collisions when using ec2.InitFile.fromAsset() on multiple instances in the same stack #27468

Merged
merged 17 commits into from
Oct 23, 2023

Conversation

sumupitchayan
Copy link
Contributor

@sumupitchayan sumupitchayan commented Oct 9, 2023

Closes #16891

If a user creates more than one EC2 instance in the same stack and defines an InitConfig for each instance using ec2.InitFile.fromAsset(), the user will get an error if they pass in the same targetFilePath or targetDirectory. This bug is due to how the asset is uploaded to S3.

This PR fixes this issue by adding a hash to the targetFileName before being uploaded as an s3 asset.


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

Signed-off-by: Sumu <sumughan@amazon.com>
…still failing

Signed-off-by: Sumu <sumughan@amazon.com>
…n.toString()) -- test now passes successfully

Signed-off-by: Sumu <sumughan@amazon.com>
@github-actions github-actions bot added bug This issue is a bug. effort/small Small work item – less than a day of effort p1 labels Oct 9, 2023
@aws-cdk-automation aws-cdk-automation requested a review from a team October 9, 2023 16:49
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Oct 9, 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.

@sumupitchayan sumupitchayan changed the title fix(aws-ec2): naming collisions when using ec2.InitFile.fromAsset() on multiple instances in the same stack fix(ec2): naming collisions when using ec2.InitFile.fromAsset() on multiple instances in the same stack Oct 9, 2023
@aws-cdk-automation aws-cdk-automation dismissed their stale review October 9, 2023 19:12

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

@sumupitchayan sumupitchayan marked this pull request as ready for review October 10, 2023 17:51
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Oct 10, 2023
@mikewrighton
Copy link
Contributor

nit: typo in the description? when before being uploaded as an s3 asset.

@@ -424,7 +425,7 @@ export abstract class InitFile extends InitElement {
public static fromAsset(targetFileName: string, path: string, options: InitFileAssetOptions = {}): InitFile {
return new class extends InitFile {
protected _doBind(bindOptions: InitBindOptions) {
const asset = new s3_assets.Asset(bindOptions.scope, `${targetFileName}Asset`, {
const asset = new s3_assets.Asset(bindOptions.scope, `${md5hash(bindOptions.scope.node.children.toString())}${targetFileName}Asset`, {
Copy link
Contributor

Choose a reason for hiding this comment

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

Personally I'd find a comment useful here explaining why the hash is being taken this way.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mergify
Copy link
Contributor

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

@mergify mergify bot merged commit fc3be31 into main Oct 23, 2023
12 checks passed
@mergify mergify bot deleted the sumughan/fix-initfiles-with-same-filename branch October 23, 2023 18:05
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/small Small work item – less than a day of effort p1 pr/needs-maintainer-review This PR needs a review from a Core Team Member
Projects
None yet
3 participants