fix(391): don't mutate existing config in getConfig #392
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
redonkulus
approved these changes
Jul 8, 2021
lingyan
approved these changes
Jul 8, 2021
| Atomizer.prototype.getConfig = function (classNames/*:string[]*/, config/*:AtomizerConfig*/)/*:AtomizerConfig*/ { | ||
| config = config || { classNames: [] }; | ||
| Atomizer.prototype.getConfig = function (classNames/*:string[]*/, existingConfig/*:AtomizerConfig*/)/*:AtomizerConfig*/ { | ||
| const config = existingConfig && _.cloneDeep(existingConfig) || { classNames: [] }; |
There was a problem hiding this comment.
I was in two minds about this approach, I thought we could avoid a deep clone but actually this is nice because no one consuming this can't mistakenly mutate a reference in the original config via the new one either.
Seems like the right way to go to me 👍
adamdharrington
approved these changes
Jul 12, 2021
src-code
approved these changes
Jul 12, 2021
|
Haven't dig into deep details but it seems like https://github.com/acss-io/webpack-atomizer-loader/blob/master/lib/atomicLoader.ts is kind of doing side effect? tried to upgrade the latest version and the css is not generated correctly |
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.
Fixes: #391
This PR prevents the mutation of the config which is passed into getConfig.
The documentation shows the declaration of
finalConfigas a separate variable fromdefaultConfigso I don't believe this mutation is an intentional part of the API, just an accidental oversight. However, this could potentially cause issues for someone who was (incorrectly / unknowingly) depending on this side effect.