Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prevent calling setState on an unmounted WindowScroller component #689

Merged
merged 2 commits into from
Jun 10, 2017
Merged

Prevent calling setState on an unmounted WindowScroller component #689

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e725d30
Prevent calling setState on unmounted WindowScroller component
liorbrauer May 29, 2017
cbbacc2
fix code style
liorbrauer May 29, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions source/WindowScroller/WindowScroller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ export default class WindowScroller extends PureComponent {
registerScrollListener(this, scrollElement)

window.addEventListener('resize', this._onResize, false)

this._isMounted = true
}

componentWillReceiveProps (nextProps) {
Expand All @@ -106,6 +108,8 @@ export default class WindowScroller extends PureComponent {
unregisterScrollListener(this, this.props.scrollElement || window)

window.removeEventListener('resize', this._onResize, false)

this._isMounted = false
}

render () {
Expand All @@ -127,6 +131,8 @@ export default class WindowScroller extends PureComponent {

// Referenced by utils/onScroll
__handleWindowScrollEvent (event) {
if (!this._isMounted) return
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@liorbrauer I think ideally we should determine why the mountedInstances array is not accurate, rather than fixing it with a flag

https://github.com/bvaughn/react-virtualized/blob/master/source/WindowScroller/utils/onScroll.js

Copy link
Contributor Author

@liorbrauer liorbrauer May 31, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mking-clari Good point, though looking at the code and playing around with it I couldn't pin point why it isn't accurate. New WindowScrollers are added to mountedInstances array on mount and are removed on unmount - so that logic is sound. My best guess is that there's a race condition since scroll events are fired rapidly. If that's the case, I'm not sure what the best course of action is, perhaps debounce the scroll event handler?

Alternatively, I can move the check to see if the instance is mounted to the onScroll.js helper, changing line 47 to:

if (instance._isMounted && instance.scrollElement === event.currentTarget) {

though that still requires using a flag. Any other thoughts?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm willing to accept this fix, but I'd like to know more about the case that it's fixing so I can determine if there's a better fix. Can you provide a Plnkr (or similar) repro @liorbrauer ?

Copy link
Contributor Author

@liorbrauer liorbrauer Jun 4, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bvaughn here's a plnkr with the problematic setup:

http://plnkr.co/edit/lquCfWiYbNnypf6JrvgW?p=preview

Just open the console and scroll fast in the preview pane (or simply drag the scrollbar fast) to see the setState warnings. Let me know what you think :)

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Thanks!


const { onScroll } = this.props

const scrollElement = this.props.scrollElement || window
Expand Down