fix: do not clear dialog state immediately on useDialog unmount #2584
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2584 +/- ##
=======================================
Coverage 81.14% 81.15%
=======================================
Files 448 448
Lines 9460 9470 +10
Branches 2316 2319 +3
=======================================
+ Hits 7676 7685 +9
- Misses 1422 1423 +1
Partials 362 362 ☔ View full report in Codecov by Sentry. |
|
Size Change: +892 B (+0.08%) Total Size: 1.19 MB
ℹ️ View Unchanged
|
myandrienko
commented
Dec 18, 2024
Comment on lines
+171
to
+173
| removalTimeout: setTimeout(() => { | ||
| this.remove(id); | ||
| }, 16), |
Comment on lines
-12
to
+16
| dialogManager.remove(id); | ||
| // Since this cleanup can run even if the component is still mounted | ||
| // and dialog id is unchanged (e.g. in <StrictMode />), it's safer to | ||
| // mark state as unused and only remove it after a timeout, rather than | ||
| // to remove it immediately. | ||
| dialogManager.markForRemoval(id); |
Comment on lines
+7
to
+9
| <StrictMode> | ||
| <App /> | ||
| </StrictMode>, |
There was a problem hiding this comment.
It's good to run demo apps in <StrictMode /> :)
| @@ -257,7 +257,7 @@ | |||
| "react-dom": "^18.1.0", | |||
| "react-test-renderer": "^18.1.0", | |||
| "semantic-release": "^19.0.5", | |||
| "stream-chat": "^8.46.1", | |||
| "stream-chat": "^8.47.1", | |||
There was a problem hiding this comment.
Additionally, bump stream-chat version to incorporate recent <StrictMode />-related fixes in the client (GetStream/stream-chat-js#1421).
MartinCupela
approved these changes
Dec 19, 2024
|
🎉 This PR is included in version 12.8.1 🎉 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.
🎯 Goal
When the
useDialoghook's component unmounts, it immediately clears dialog state in an effect cleanup. However, in some situations an effect cleanup can run even if the hook's component is still mounted and effect's dependencies didn't change - e.g., when<StrictMode />is enabled.So it's safer to keep dialog state for a short time after cleanup runs.
🛠 Implementation details
Instead of immediately removing dialog state, it's marked to be removed after a short timeout. Referencing the dialog again quick cancels state removal.
Fixes #2583.