fix(ClipboardCopy): clear timer on unmount #6708
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
Signed-off-by: Boaz Shuster <boaz.shuster.github@gmail.com>
nicolethoen
reviewed
Dec 22, 2021
| @@ -111,6 +111,12 @@ export class ClipboardCopy extends React.Component<ClipboardCopyProps, Clipboard | |||
| } | |||
| }; | |||
|
|
|||
| componentWillUnmount = () => { | |||
| if (this.timer) { | |||
| window.clearTimeout(this.timer); | |||
There was a problem hiding this comment.
Great catch!
Does this mean that the this.timer = null; on line 204 and 357 is unnecessary?
There was a problem hiding this comment.
@nicolethoen that's a great question.
These lines were meant for a different case:
- If the user clicked on the copy button we set a timer that on timeout we will close the "copied" popover
- but what happens if the user clicks again on the copy button and the timer didn't timeout. A new timer will be created unnecessarily and we will have a flaky behavior in the popover display (it will be closed after
switchDelayfrom the first click). - So what we did is check if there is a timer. Stop it and release it from the memory. and run a new timer.
In other words, these lines are necessary for a behavior of the popover and not covering the case where the component is unmounted and after the timeout we are changing the component state (we "cannot" change its state because it's not mounted!).
I hope I explained that well.
Thank you for the question - it was fun. 😄
There was a problem hiding this comment.
Fabulous explanation! Thank you so much!
nicolethoen
approved these changes
Dec 23, 2021
wise-king-sullyman
approved these changes
Jan 4, 2022
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.
What: Closes #6649