fix: remove mutations of the redux state in reducers #2487
Merged
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
antonbauhofer
commented
Jan 11, 2024
Comment on lines
+605
to
+610
| paths: [...attributionData.resourcesWithAttributedChildren.paths], | ||
| pathsToIndices: { | ||
| ...attributionData.resourcesWithAttributedChildren.pathsToIndices, | ||
| }, | ||
| attributedChildren: { | ||
| ...attributionData.resourcesWithAttributedChildren.attributedChildren, | ||
| }, |
There was a problem hiding this comment.
This is called in several places and not always is every one of these parts mutated. To improve performance, we could just make a shallow copy here and then make copies of the respective parts, where they are mutated.
If we decide to do that, I think we should generally establish that pattern and also fix it at other places, though.
antonbauhofer
commented
Jan 11, 2024
| @@ -19,7 +19,7 @@ export function createAppStore() { | |||
| // TECH DEBT: we should not be putting sets into the store | |||
| // https://redux.js.org/style-guide/#do-not-put-non-serializable-values-in-state-or-actions | |||
| serializableCheck: false, | |||
| // TECH DEBT: we are mutating the redux state inside reducers | |||
| // We set this to false because it significantly reduces performance in development mode. | |||
There was a problem hiding this comment.
Signed-off-by: Anton Bauhofer <anton.bauhofer@tngtech.com>
antonbauhofer
force-pushed
the
fix-avoid-state-mutations
branch
from
9b5a4f2
to
f7396c1
Compare
mstykow
approved these changes
Jan 11, 2024
|
I did a performance test with a large OpossumUI file and the performance does not seem to be significantly impacted by these changes. Also, I loosely checked that no other state mutations, not covered by tests, are present. |
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 of changes
This fixes some of our reducers, so that they don't mutate the state.
Context and reason for change
Before this change, there were a few places in our code, where reducers were mutating the state. This is strongly discouraged according to the Redux guide.
How can the changes be tested
yarn test:unitFixes #2412