Skip to content

Minor self-hosted video refactor #15732

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

Merged
domlander merged 1 commit into from
Apr 21, 2026
+54 −47
Merged

Minor self-hosted video refactor #15732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
57 changes: 35 additions & 22 deletions dotcom-rendering/src/components/SelfHostedVideo.island.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,10 @@ export const SelfHostedVideo = ({

const shouldLoop = isLoop || isCinemagraph;

const showProgressBar = !hideProgressBar && !isCinemagraph;
const showProgressBar =
!hideProgressBar && !isCinemagraph && playerState !== 'NOT_STARTED';

const showIcons = !isCinemagraph && playerState !== 'NOT_STARTED';

const iconSize = isDefault ? 'large' : 'small';

Expand Down Expand Up @@ -454,6 +457,13 @@ export const SelfHostedVideo = ({
}
};

const updateCurrentTime = (newTime: number) => {
if (vidRef.current) {
vidRef.current.currentTime = newTime;
setCurrentTime(newTime);
}
};

const FallbackImageComponent = (
<CardPicture
mainImage={fallbackImage}
Expand Down Expand Up @@ -635,6 +645,7 @@ export const SelfHostedVideo = ({

const track = video.textTracks[0];
if (!track?.cues) return;

const pxFromBottom = space[3];
const videoHeight = video.getBoundingClientRect().height;
const percentFromTop =
Expand Down Expand Up @@ -706,8 +717,8 @@ export const SelfHostedVideo = ({
const handleFullscreenClick = (event: React.SyntheticEvent) => {
void submitClickComponentEvent(event.currentTarget, renderingTarget);
event.stopPropagation(); // Don't pause the video
const video = vidRef.current;

const video = vidRef.current;
if (!video) return;

if (shouldUseWebkitFullscreen(video)) {
Expand Down Expand Up @@ -772,27 +783,31 @@ export const SelfHostedVideo = ({
};

const seekForward = () => {
if (vidRef.current) {
const newTime = Math.min(
vidRef.current.currentTime + 1,
vidRef.current.duration,
);
const video = vidRef.current;
if (!video) return;

vidRef.current.currentTime = newTime;
setCurrentTime(newTime);
}
const increment = 1;
const newTime = Math.min(video.currentTime + increment, video.duration);

updateCurrentTime(newTime);
};

const seekBackward = () => {
if (vidRef.current) {
// Allow the user to cycle to the end of the video using the arrow keys
Copy link
Copy Markdown
Contributor

@SHession SHession Apr 21, 2026

Choose a reason for hiding this comment

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

Small change of behaviour here, although it doesn't seem necessarily worth keeping.

Copy link
Copy Markdown
Contributor Author

@domlander domlander Apr 21, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Ah yes, I did explain the reasoning behind this in the PR to implement a new progress bar, but I forgot to move the comment over when I split this PR out: #15726 (comment)

In short, It's an very minor feature that increase the complexity of the code quite a bit when non-looping (default) video is added, so this is why it's removed.

const newTime =
(((vidRef.current.currentTime - 1) % vidRef.current.duration) +
vidRef.current.duration) %
vidRef.current.duration;
const video = vidRef.current;
if (!video) return;

vidRef.current.currentTime = newTime;
setCurrentTime(newTime);
const increment = 1;
const newTime = Math.max(video.currentTime - increment, 0);

updateCurrentTime(newTime);
};

const handleTimeUpdate = () => {
const video = vidRef.current;
if (!video) return;

if (playerState === 'PLAYING') {
setCurrentTime(video.currentTime);
}
};

Expand Down Expand Up @@ -920,17 +935,15 @@ export const SelfHostedVideo = ({
posterImage={optimisedPosterImage}
FallbackImageComponent={FallbackImageComponent}
currentTime={currentTime}
setCurrentTime={setCurrentTime}
ref={vidRef}
isPlayable={isPlayable}
playerState={playerState}
isMuted={isMuted}
handleLoadedMetadata={handleLoadedMetadata}
handleLoadedData={handleLoadedData}
handleCanPlay={handleCanPlay}
handlePlaying={handlePlaying}
handlePlayPauseClick={handlePlayPauseClick}
handleAudioClick={handleAudioClick}
handleTimeUpdate={handleTimeUpdate}
handleKeyDown={handleKeyDown}
handlePause={handlePause}
handleFullscreenClick={handleFullscreenClick}
Expand All @@ -943,7 +956,7 @@ export const SelfHostedVideo = ({
showSubtitles={!isCinemagraph}
subtitleSource={subtitleSource}
subtitleSize={subtitleSize}
showIcons={!isCinemagraph}
showIcons={showIcons}
controlsPosition={controlsPosition}
activeCue={activeCue}
shouldLoop={shouldLoop}
Expand Down
1 change: 0 additions & 1 deletion dotcom-rendering/src/components/SelfHostedVideo.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ export const Loop: Story = {
sources: loop54Card.mainMedia.sources,
aspectRatio: loop54Card.mainMedia.aspectRatio,
uniqueId: 'test-video-1',
atomId: 'test-atom-1',
videoStyle: 'Loop',
posterImage:
'https://media.guim.co.uk/9bdb802e6da5d3fd249b5060f367b3a817965f0c/0_0_1800_1080/master/1800.jpg',
Expand Down
43 changes: 19 additions & 24 deletions dotcom-rendering/src/components/SelfHostedVideoPlayer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,7 @@ import {
textSans20,
} from '@guardian/source/foundations';
import type { IconProps } from '@guardian/source/react-components';
import type {
Dispatch,
ReactElement,
SetStateAction,
SyntheticEvent,
} from 'react';
import type { ReactElement, SyntheticEvent } from 'react';
import { forwardRef } from 'react';
import type { ActiveCue } from '../lib/useSubtitles';
import type { Source } from '../lib/video';
Expand Down Expand Up @@ -66,12 +61,15 @@ const playIconStyles = css`
padding: 0;
`;

const iconsContainerStyles = (position: ControlsPosition) => css`
const iconsContainerStyles = css`
position: absolute;
display: flex;
flex-direction: column;
gap: ${space[2]}px;
right: ${space[2]}px;
`;

const iconsPositionStyles = (position: ControlsPosition) => css`
/* Take into account the progress bar height */
${position === 'bottom' && `bottom: ${space[3]}px;`}
${position === 'top' && `top: ${space[2]}px;`}
Expand Down Expand Up @@ -106,10 +104,7 @@ export type Props = {
aspectRatio: number;
videoStyle: VideoPlayerFormat;
FallbackImageComponent: ReactElement;
isPlayable: boolean;
playerState: PlayerStates;
currentTime: number;
setCurrentTime: Dispatch<SetStateAction<number>>;
isMuted: boolean;
handleLoadedMetadata: (event: SyntheticEvent) => void;
handleLoadedData: (event: SyntheticEvent) => void;
Expand All @@ -118,6 +113,7 @@ export type Props = {
handlePlayPauseClick: (event: SyntheticEvent) => void;
handleAudioClick: (event: SyntheticEvent) => void;
handleKeyDown: (event: React.KeyboardEvent<HTMLVideoElement>) => void;
handleTimeUpdate: (event: SyntheticEvent<HTMLVideoElement>) => void;
handlePause: (event: SyntheticEvent) => void;
handleFullscreenClick?: (event: SyntheticEvent) => void;
onError: (event: SyntheticEvent<HTMLVideoElement>) => void;
Expand Down Expand Up @@ -160,10 +156,7 @@ export const SelfHostedVideoPlayer = forwardRef(
videoStyle,
FallbackImageComponent,
posterImage,
isPlayable,
playerState,
currentTime,
setCurrentTime,
isMuted,
handleLoadedMetadata,
handleLoadedData,
Expand All @@ -172,6 +165,7 @@ export const SelfHostedVideoPlayer = forwardRef(
handlePlayPauseClick,
handleAudioClick,
handleKeyDown,
handleTimeUpdate,
handlePause,
handleFullscreenClick,
onError,
Expand All @@ -198,7 +192,7 @@ export const SelfHostedVideoPlayer = forwardRef(

const showSubtitles = canShowSubtitles && !!subtitleSource;
const showProgressBar = canShowProgressBar && currentRefExists;
const showIcons = canShowIcons && currentRefExists && isPlayable;
const showIcons = canShowIcons && currentRefExists;

const dataLinkName = `gu-video-${videoStyle}-${
showPlayIcon ? 'play' : 'pause'
Expand Down Expand Up @@ -232,22 +226,18 @@ export const SelfHostedVideoPlayer = forwardRef(
onCanPlay={handleCanPlay}
onCanPlayThrough={handleCanPlay}
onPlaying={handlePlaying}
onTimeUpdate={() => {
if (currentRefExists && playerState === 'PLAYING') {
setCurrentTime(ref.current!.currentTime);
}
}}
onTimeUpdate={handleTimeUpdate}
onPause={handlePause}
onClick={handlePlayPauseClick}
onKeyDown={handleKeyDown}
onError={onError}
>
{sources.map((source) => (
{sources.map(({ src, mimeType }) => (
<source
key={source.mimeType}
key={mimeType}
/* The start time is set to 1ms so that Safari will autoplay the video */
src={`${source.src}#t=0.001`}
type={source.mimeType}
src={`${src}#t=0.001`}
type={mimeType}
/>
))}
{showSubtitles && (
Expand Down Expand Up @@ -287,7 +277,12 @@ export const SelfHostedVideoPlayer = forwardRef(
/>
)}
{showIcons && (
<div css={iconsContainerStyles(controlsPosition)}>
<div
css={[
iconsContainerStyles,
iconsPositionStyles(controlsPosition),
]}
>
{showFullscreenIcon && (
<FullscreenIcon
handleClick={handleFullscreenClick}
Expand Down
Loading