Remove event listeners for Location on unmount #2489
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
|
Looks good, can you add a changelog entry? |
|
Sure, done! |
Currently, if the component is not mounted (e.g. because on a different page),
the component will still receive the change event and the `onLocationChange`
callback changes its props via `this.props.setProps` with the itempath from
('_dashprivate_path') in the DOM. The object, however, is
not on the dom and a random other DOM element is assigned the changed props.
The PR deregisters the event listeners of the component is unmounted. They will
be added again via `componentDidMount` anyways if the component is mounted again.
fixes plotly#1346
jowlo
force-pushed
the
fix/remove-location-listeners-on-unmount
branch
from
be88385
to
eda1a31
Compare
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.
Currently, if the
Locationcomponent is not mounted anymore after it had been mounted (e.g. because it is on a different page), the component will have it's event handler for the custom_dashprivate_pushstateevent registered.When changing pages, this triggers the
onLocationChangecallback which changes its props viathis.props.setPropswith the itempath (from_dashprivate_path) in the DOM. The object, however, is not on the DOM and the path may lead to some other DOM element which is assigned the changed props forhrefandpathname. This leads to the error described in #1346 and breaks subsequent navigation with Links because of the error in the event handler.The PR deregisters the event listeners if the component is unmounted. They will be added again via
componentDidMountanyways if the component is mounted again.In #2068 (comment) one of the limitations of using the pages feature is that none of the pages can contain a
Locationcomponent. This limitation is lifted with the PR.Fixes #1346 (all the way at the bottom)
Contributor Checklist