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): asset hash is different between linux and windows #16945

Merged
merged 3 commits into from Oct 13, 2021

Conversation

jogold
Copy link
Contributor

@jogold jogold commented Oct 13, 2021

The hash for a specific file in a directory include its relative path.
This gives different results on Linux vs Windows because of the
different path separator. The solution is to normalize the relative path
using forward slashes.

Affects directory assets with subdirectories.

Closes #14555
Closes #16928


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

The hash for a specific file in a directory include its relative path.
This gives different results on Linux vs Windows because of the
different path separator. The solution is to normalize the relative path
using forward slashes.

Affects directory assets with subdirectories.

Closes aws#14555
Closes aws#16928
@gitpod-io
Copy link

gitpod-io bot commented Oct 13, 2021

@jogold
Copy link
Contributor Author

jogold commented Oct 13, 2021

@eladb

(see also #16928 (comment) for explanation on why it affects the AwsCustomResource only for versions >= 1.123.0)

@jogold jogold changed the title fix(core): asset hash is different on linux vs windows fix(core): asset hash is different between linux and windows Oct 13, 2021
eladb
eladb previously requested changes Oct 13, 2021
@@ -53,7 +53,8 @@ export function fingerprint(fileOrDirectory: string, options: FingerprintOptions
return hash.digest('hex');

function _processFileOrDirectory(symbolicPath: string, isRootDir: boolean = false, realPath = symbolicPath) {
const relativePath = path.relative(fileOrDirectory, symbolicPath);
// Normalize relative path with forward slashes to ensure same hash on Windows and Linux
const relativePath = path.relative(fileOrDirectory, symbolicPath).replace(/\\/g, '/');
Copy link
Contributor

Choose a reason for hiding this comment

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

seems like this value is only used as a hash component and not passed into file system operations, correct?

If that is indeed the case, let's rename to hashComponent.

@mergify mergify bot dismissed eladb’s stale review October 13, 2021 12:16

Pull request has been modified.

@jogold jogold requested a review from eladb October 13, 2021 12:16
@mergify
Copy link
Contributor

mergify bot commented Oct 13, 2021

Thank you for contributing! Your pull request will be updated from master 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: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: 5eda8e3
  • 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 59950dd into aws:master Oct 13, 2021
@mergify
Copy link
Contributor

mergify bot commented Oct 13, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@jogold jogold deleted the hash-rel-path-normalize branch October 13, 2021 14:16
TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this pull request Feb 21, 2022
The hash for a specific file in a directory include its relative path.
This gives different results on Linux vs Windows because of the
different path separator. The solution is to normalize the relative path
using forward slashes.

Affects directory assets with subdirectories.

Closes aws#14555
Closes aws#16928


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants