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

Feature detect setTimeout in auto setup for SSR #7247

Merged
merged 1 commit into from Jun 2, 2021

Conversation

tf
Copy link
Contributor

@tf tf commented May 25, 2021

In some server side rendering environments (e.g., execjs since
version 2.8.0 [1]) setTimeout is not available. Since
autoSetupTimeout runs when Video.js is imported and tries to
schedule autoSetup, this can lead to errors of the following form in
server side rendering:

TypeError: scheduler is not a function

autoSetup already bailed out if run outside of a browser environment
or if globally disabled. To prevent calling setTimeout, we already
perform the Dom.isReal check in autoSetupTimeout. Checking
options.autoSetup has to remain in autoSetup to preserve backwards
compatiblity with apps that set the option after Video.js has loaded
but before the next tick.

[1] rails/execjs#43

Requirements Checklist

  • Feature implemented / Bug fixed
  • If necessary, more likely in a feature request than a bug fix
    • Change has been verified in an actual browser (Chrome, Firefox, IE)
    • Unit Tests updated or fixed
    • Docs/guides updated
    • Example created (starter template on JSBin)
  • Reviewed by Two Core Contributors

In some server side rendering environments (e.g., `execjs` since
version 2.8.0 [1]) `setTimeout` is not available. Since
`autoSetupTimeout` runs when Video.js is imported and tries to
schedule `autoSetup`, this can lead to errors of the following form in
server side rendering:

    TypeError: scheduler is not a function

`autoSetup` already bailed out if run outside of a browser environment
or if globally disabled. To prevent calling `setTimeout`, we already
perform the `Dom.isReal` check in `autoSetupTimeout`. Checking
`options.autoSetup` has to remain in `autoSetup` to preserve backwards
compatiblity with apps that set the option after Video.js has loaded
but before the next tick.

[1] rails/execjs#43
@welcome
Copy link

welcome bot commented May 25, 2021

💖 Thanks for opening this pull request! 💖

Things that will help get your PR across the finish line:

  • Run npm run lint -- --errors locally to catch formatting errors earlier.
  • Include tests when adding/changing behavior.
  • Include screenshots and animated GIFs whenever possible.

We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can.

tf added a commit to tf/pageflow that referenced this pull request May 25, 2021
@tf tf marked this pull request as ready for review May 27, 2021 12:15
Copy link
Member

@gkatsev gkatsev left a comment

Choose a reason for hiding this comment

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

Works for me. Thanks.

@gkatsev gkatsev added the needs: LGTM Needs an additional approval label Jun 2, 2021
@misteroneill misteroneill removed the needs: LGTM Needs an additional approval label Jun 2, 2021
@gkatsev gkatsev merged commit 8082c5a into videojs:main Jun 2, 2021
@welcome
Copy link

welcome bot commented Jun 2, 2021

Congrats on merging your first pull request! 🎉🎉🎉

@tf tf deleted the ssr-auto-setup-fix branch June 7, 2021 10:47
UsmanMuhammad pushed a commit to UsmanMuhammad/pageflow that referenced this pull request Aug 12, 2022
edirub pushed a commit to edirub/video.js that referenced this pull request Jun 8, 2023
…ojs#7247)

Some JavaScript environments don't implement setTimeout, which causes Video.js to fail on require. Instead, move our Dom.isReal() check earlier to before we call setTimeout.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants