Skip to content

Take control over your live stream video by running it yourself. Streaming + chat out of the box.

fix(metrics): report web player teardown state

Gabe Kangasadad3c1cf1ca
diff --git a/web/components/video/metrics/playback.js b/web/components/video/metrics/playback.js
index d14e467bf6..3bf6d475e6 100644
--- a/web/components/video/metrics/playback.js
+++ b/web/components/video/metrics/playback.js
@@ -166,6 +166,11 @@ class PlaybackMetrics {
stop() {
clearInterval(this.eventReportTimer);
+ // Component teardown does not reliably emit Video.js's ended event.
+ // Preserve the terminal state while its viewer is still active.
+ if (this.hasStartedPlaying && !this.player.ended()) {
+ this.sendEventReport('ps', { sta: 'e' });
+ }
this.player.off();
}
diff --git a/web/tests/playbackMetrics.test.ts b/web/tests/playbackMetrics.test.ts
new file mode 100644
index 0000000000..15df28c688
--- /dev/null
+++ b/web/tests/playbackMetrics.test.ts
@@ -0,0 +1,59 @@
+import PlaybackMetrics from '../components/video/metrics/playback';
+
+type Listener = () => void;
+
+const makePlayer = () => {
+ const listeners = new Map<string, Listener>();
+ return {
+ buffered: () => [],
+ currentTime: () => 0,
+ ended: () => false,
+ error: () => null,
+ off: jest.fn(),
+ on: jest.fn((event: string, listener: Listener) => listeners.set(event, listener)),
+ paused: () => false,
+ playbackRate: () => 1,
+ seeking: () => false,
+ tech: () => undefined,
+ trigger: (event: string) => listeners.get(event)?.(),
+ };
+};
+
+describe('PlaybackMetrics', () => {
+ beforeEach(() => {
+ global.fetch = jest.fn(() => Promise.resolve({})) as jest.Mock;
+ });
+
+ afterEach(() => {
+ jest.useRealTimers();
+ });
+
+ test('reports ended when a started player is torn down', async () => {
+ jest.useFakeTimers();
+ const player = makePlayer();
+ const videojs = { Vhs: {}, xhr: jest.fn() };
+ const metrics = new PlaybackMetrics(player, videojs);
+
+ player.trigger('playing');
+ await Promise.resolve();
+ metrics.stop();
+ await Promise.resolve();
+
+ const reports = (global.fetch as jest.Mock).mock.calls.map(([, init]) => JSON.parse(init.body));
+ expect(reports.map(report => report.sta)).toEqual(['p', 'e']);
+ });
+
+ test('reports a pause after playback starts', async () => {
+ jest.useFakeTimers();
+ const player = makePlayer();
+ const metrics = new PlaybackMetrics(player, { Vhs: {}, xhr: jest.fn() });
+ expect(metrics).toBeDefined();
+
+ player.trigger('playing');
+ player.trigger('pause');
+ await Promise.resolve();
+
+ const reports = (global.fetch as jest.Mock).mock.calls.map(([, init]) => JSON.parse(init.body));
+ expect(reports.map(report => report.sta)).toEqual(['p', 'a']);
+ });
+});