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

Jump to bottom

fix: await player to be destroyed before re-creating it #357

Merged
merged 2 commits into from
May 25, 2022
Merged

fix: await player to be destroyed before re-creating it #357

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b920e5
fix: await player to be destroyed before re-creating it
victoragnez May 23, 2022
575e8cd
chore: address CR comments
victoragnez May 23, 2022
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
40 changes: 32 additions & 8 deletions packages/react-youtube/src/YouTube.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,18 @@ class YouTube extends React.Component<YouTubeProps> {
this.internalPlayer = null;
}

/**
* Note: The `youtube-player` package that is used promisifies all YouTube
* Player API calls, which introduces a delay of a tick before it actually
* gets destroyed.
*
* The promise to destroy the player is stored here so we can make sure to
* only re-create the Player after it's been destroyed.
*
* See: https://github.com/tjallingt/react-youtube/issues/355
*/
destroyPlayerPromise: Promise<void> | undefined = undefined;

componentDidMount() {
this.createPlayer();
}
Expand All @@ -243,13 +255,7 @@ class YouTube extends React.Component<YouTubeProps> {
}

componentWillUnmount() {
/**
* Note: The `youtube-player` package that is used promisifies all YouTube
* Player API calls, which introduces a delay of a tick before it actually
* gets destroyed. Since React attempts to remove the element instantly
* this method isn't quick enough to reset the container element.
*/
this.internalPlayer?.destroy();
this.destroyPlayer();
}

/**
Expand Down Expand Up @@ -300,12 +306,30 @@ class YouTube extends React.Component<YouTubeProps> {
*/
onPlayerPlaybackQualityChange = (event: YouTubeEvent<string>) => this.props.onPlaybackQualityChange?.(event);

/**
* Destroy the YouTube Player using its async API and store the promise so we
* can await before re-creating it.
*/
destroyPlayer = () => {
if (this.internalPlayer) {
this.destroyPlayerPromise = this.internalPlayer.destroy().then(() => (this.destroyPlayerPromise = undefined));
return this.destroyPlayerPromise;
}
return Promise.resolve();
};

/**
* Initialize the YouTube Player API on the container and attach event handlers
*/
createPlayer = () => {
// do not attempt to create a player server-side, it won't work
if (typeof document === 'undefined') return;
if (this.destroyPlayerPromise) {
// We need to first await the existing player to be destroyed before
// we can re-create it.
this.destroyPlayerPromise.then(this.createPlayer);
return;
}
// create player
const playerOpts: Options = {
...this.props.opts,
Expand All @@ -330,7 +354,7 @@ class YouTube extends React.Component<YouTubeProps> {
/**
* Shorthand for destroying and then re-creating the YouTube Player
*/
resetPlayer = () => this.internalPlayer?.destroy().then(this.createPlayer);
resetPlayer = () => this.destroyPlayer().then(this.createPlayer);

/**
* Method to update the id and class of the YouTube Player iframe.
Expand Down