fix(core): Aspects from symlinked modules are not applied #19491
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When construct libraries are purposely symlinked (as opposed of
collectively `npm install`ed), depending on how this is done they may
end up with multiple copies of `aws-cdk-lib`. If that happens, Aspects
from a different `aws-cdk-lib` copy than the one providing `App` will
not be applied.
The reason is the use of `Symbol('...')` instead of `Symbol.for('...')`
to keep the list of aspects on the construct object.
- The first version creates a unique symbol per library, while adding
a naming hint.
- The second version deduplicates: all symbols with the same naming
hint will receive the same symbol.
The second version is necessary to make sure that different copies
of the `aws-cdk-lib` library store their aspects under the same key.
Fixes #18921, #18778, #19390.
|
|
|
No test as the fault only manifests in situations we cannot test here. |
rix0rrr
added
the
pr-linter/exempt-test
madeline-k
approved these changes
Mar 22, 2022
|
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 CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
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). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When construct libraries are purposely symlinked (as opposed of
collectively
npm installed), depending on how this is done they mayend up with multiple copies of
aws-cdk-lib. If that happens, Aspectsfrom a different
aws-cdk-libcopy than the one providingAppwillnot be applied.
The reason is the use of
Symbol('...')instead ofSymbol.for('...')to keep the list of aspects on the construct object.
a naming hint.
hint will receive the same symbol.
The second version is necessary to make sure that different copies
of the
aws-cdk-liblibrary store their aspects under the same key.Fixes #18921, #18778, #19390, #18914