fix: don't mutate data in fromData, clone instead
#602
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
- in the clear case, `fromData` would set `this._data = pointGroups`,
which made the pointer the same as the one for the parameter
- as `this._data` is internally mutated, this would cause the input
parameter to also be mutated as a side-effect
- this input mutation side-effect is likely unintended, so patched it so
that the data is cloned in _all_ cases, not only in the append case
- in the clear case, `this._data` is set to an empty array by
`this.clear()`, so this is equivalent to `[].concat(pointGroups)`,
which will result in them all being cloned
|
@UziTech just following up here as you approved this a month ago but never merged |
|
Sorry about that. This totally slipped through the cracks. Thanks for pinging me on this! |
github-actions bot
pushed a commit
that referenced
this pull request
Apr 3, 2022
## [4.0.4](v4.0.3...v4.0.4) (2022-04-03) ### Bug Fixes * clone data in fromData ([#602](#602)) ([e5057c5](e5057c5))
|
🎉 This PR is included in version 4.0.4 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Summary
always clone the input data in
fromDataso that the input is not mutatedDescription
in the clear case,
fromDatawould setthis._data = pointGroups,which made the pointer the same as the one for the parameter
this._datais internally mutated, this would cause the inputparameter to also be mutated as a side-effect
this input mutation side-effect is likely unintended, so patched it so
that the data is cloned in all cases, not only in the append case
this._datais set to an empty array bythis.clear(), so this is equivalent to[].concat(pointGroups),which will result in them all being cloned
Misc Notes
Fixes agilgur5/react-signature-canvas#56
Credits to @Zwyx for discovering this in the above issue
Can see that issue for some manual testing I did around this cloning as well as how I found the bug here