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.

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

Don't set state to not-ready if the ready prop is true #81

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

michaelmulley
Copy link

I've encountered a bug with the delay prop which would result in the placeholder showing indefinitely, with {ready: true} in props but {ready: false} in state.

I believe the events which lead to this are, when delay is set to n milliseconds, all of the following happen before n milliseconds is up:

  1. ready prop is set to false, a timeout to set ready state is set and the ID stored in this.timeout
  2. Some detail in props.children is changed, cause componentWillReceiveProps to be called again; this causes another timeout to set ready state to be created, and the ID stored in this.timeout is overwritten
  3. ready prop is set to true, which sets state to {ready: true} and which also deletes the timeout set in step 2 (but, crucially, not the timeout set in step 1)
  4. The timeout set in step 1 fires, setting state incorrectly back to {ready: false}

The pull request is one approach among many to fix this. You could also clear any existing timeout in this.timeout before setting a new one, or change the render method to

return (this.props.ready || this.state.ready) ? this.props.children : this.getFiller();

Thanks!

@nemobot nemobot added the WIP label Mar 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants