BlueGit

timfa filemanager

Files

filemanager / tests / share.page.load.test.js

share.page.load.test.js

5fa68aaf History
share.page.load.test.js 14.8 KiB Download Raw
1'use strict';
2
3const express = require('express');
4const http = require('http');
5const path = require('path');
6const { once } = require('events');
7const { webcrypto } = require('crypto');
8
9const SHARE_VIDEO_PREFS_KEY = 'filemanager.share-video-prefs.v1';
10const DEFAULT_VIDEO_TEXT_TRACK_SETTINGS_RAW = JSON.stringify({
11 backgroundOpacity: '0',
12 edgeStyle: 'uniform',
13});
14
15describe('share page video preview', () =>
16{
17 let server;
18 let baseUrl;
19 let JSDOM;
20 let VirtualConsole;
21 let shareInfoFixture;
22 let shareVideoStreamFixture;
23 let initialSharePrefs;
24
25 beforeEach(() =>
26 {
27 shareInfoFixture = {
28 name: 'clip.mkv',
29 isDir: false,
30 expiresAt: Date.now() + (60 * 60 * 1000),
31 };
32
33 shareVideoStreamFixture = {
34 sessionId: 'share-video-session',
35 playlistUrl: '/api/share/video-stream/session/share-video-session/master.m3u8',
36 durationSeconds: 120,
37 subtitleTracks: [
38 { label: 'English', language: 'eng', default: true, src: '/api/share/video-stream/session/share-video-session/subtitle-0.vtt' },
39 { label: 'French', language: 'fra', default: false, src: '/api/share/video-stream/session/share-video-session/subtitle-1.vtt' },
40 ],
41 imageSubtitleTracks: [
42 { label: 'PGS English', language: 'eng', default: false, streamIndex: 0 },
43 ],
44 subtitleSummary: { total: 2, converted: 2, skipped: 0 },
45 };
46
47 initialSharePrefs = null;
48 });
49
50 beforeAll(async () =>
51 {
52 ({ JSDOM, VirtualConsole } = require('jsdom'));
53
54 const app = express();
55 const publicDir = path.join(__dirname, '../public');
56
57 app.use(express.json());
58
59 // Keep the mock `window.videojs` from beforeParse in control during tests.
60 app.get('/vendor/video.js/video.min.js', (req, res) =>
61 {
62 res.type('application/javascript').send('/* mocked in tests */');
63 });
64
65 app.get('/vendor/video.js/video-js.css', (req, res) =>
66 {
67 res.type('text/css').send('/* mocked in tests */');
68 });
69
70 app.use(express.static(publicDir));
71
72 app.get('/api/share/info/:token', (req, res) =>
73 {
74 res.json(shareInfoFixture);
75 });
76
77 app.get('/api/share/video-stream/:token', (req, res) =>
78 {
79 res.json(shareVideoStreamFixture);
80 });
81
82 app.get('/api/share/video-stream-subtitle-frame/:token', (req, res) =>
83 {
84 res.set('X-Subtitle-Frame-Status', 'none').status(204).end();
85 });
86
87 app.delete('/api/share/video-stream/session/:sessionId', (req, res) =>
88 {
89 res.json({ ok: true });
90 });
91
92 app.get('/share/:token', (req, res) =>
93 {
94 res.sendFile(path.join(publicDir, 'share.html'));
95 });
96
97 app.get('*', (req, res) => res.status(404).json({ error: 'Not found' }));
98
99 server = http.createServer(app);
100 server.listen(0);
101 await once(server, 'listening');
102 baseUrl = `http://127.0.0.1:${server.address().port}`;
103 });
104
105 afterAll(() =>
106 {
107 server.close();
108 });
109
110 async function bootSharePage ()
111 {
112 const virtualConsole = new VirtualConsole();
113 const runtimeErrors = [];
114
115 virtualConsole.on('jsdomError', (err) =>
116 {
117 runtimeErrors.push(err);
118 });
119
120 const dom = await JSDOM.fromURL(`${baseUrl}/share/test-token`, {
121 resources: 'usable',
122 runScripts: 'dangerously',
123 pretendToBeVisual: true,
124 virtualConsole,
125 beforeParse: (window) =>
126 {
127 window.crypto = webcrypto;
128 window.fetch = (input, init) =>
129 {
130 const url = typeof input === 'string' ? input : input.url;
131 return fetch(new URL(url, baseUrl).toString(), init);
132 };
133 window.matchMedia = () => ({ matches: false, addListener () { }, removeListener () { }, addEventListener () { }, removeEventListener () { } });
134 window.scrollTo = () => { };
135 window.__lastVideoJsOptions = null;
136 window.__lastVideoJsPlayer = null;
137 window.__lastVideoJsVolumeSet = null;
138 window.__lastVideoJsTextTracks = null;
139 window.__lastVideoJsAudioTracks = null;
140 window.__mockVideoJsAudioTracks = [
141 { label: 'Stereo', enabled: true },
142 { label: 'Director commentary', enabled: false },
143 ];
144 const registeredComponents = new Map();
145
146 if (initialSharePrefs)
147 {
148 window.localStorage.setItem(SHARE_VIDEO_PREFS_KEY, JSON.stringify(initialSharePrefs));
149 }
150
151 function makeEventTarget ()
152 {
153 const listeners = new Map();
154 return {
155 addEventListener (type, fn)
156 {
157 if (!listeners.has(type)) listeners.set(type, new Set());
158 listeners.get(type).add(fn);
159 },
160 removeEventListener (type, fn)
161 {
162 const handlers = listeners.get(type);
163 if (!handlers) return;
164 handlers.delete(fn);
165 },
166 dispatchEvent (type)
167 {
168 const handlers = listeners.get(type);
169 if (!handlers) return;
170 for (const fn of Array.from(handlers)) fn();
171 },
172 };
173 }
174
175 function makeTrackList (tracks)
176 {
177 const eventTarget = makeEventTarget();
178 const list = {
179 length: tracks.length,
180 item (index)
181 {
182 return tracks[index] || null;
183 },
184 addEventListener: eventTarget.addEventListener,
185 removeEventListener: eventTarget.removeEventListener,
186 dispatchEvent: eventTarget.dispatchEvent,
187 };
188
189 for (let i = 0; i < tracks.length; i++)
190 {
191 list[i] = tracks[i];
192 }
193
194 return list;
195 }
196
197 class MockButton
198 {
199 constructor (player)
200 {
201 this._player = player;
202 this._el = null;
203 }
204
205 player ()
206 {
207 return this._player;
208 }
209
210 buildCSSClass ()
211 {
212 return 'vjs-control';
213 }
214
215 createEl ()
216 {
217 const el = window.document.createElement('button');
218 el.className = this.buildCSSClass();
219 return el;
220 }
221
222 el ()
223 {
224 if (!this._el) this._el = this.createEl();
225 return this._el;
226 }
227 }
228
229 registeredComponents.set('Button', MockButton);
230
231 window.videojs = (element, options) =>
232 {
233 window.__lastVideoJsOptions = options;
234
235 let volumeValue = 1;
236 let durationValue = 20;
237 const playerEvents = new Map();
238 const playerElement = element;
239
240 const textTracks = makeTrackList((options?.tracks || []).map((track) => ({
241 kind: track.kind,
242 label: track.label,
243 language: track.srclang,
244 mode: track.default ? 'showing' : 'disabled',
245 })));
246
247 const audioTracks = makeTrackList((window.__mockVideoJsAudioTracks || []).map((track) => ({
248 label: track.label,
249 language: track.language,
250 enabled: !!track.enabled,
251 })));
252
253 window.__lastVideoJsTextTracks = textTracks;
254 window.__lastVideoJsAudioTracks = audioTracks;
255
256 const player = {
257 ready (cb)
258 {
259 if (typeof cb === 'function') cb();
260 },
261 on (type, fn)
262 {
263 if (!playerEvents.has(type)) playerEvents.set(type, new Set());
264 playerEvents.get(type).add(fn);
265 },
266 trigger (type)
267 {
268 const listeners = playerEvents.get(type);
269 if (!listeners) return;
270 for (const fn of Array.from(listeners)) fn();
271 },
272 duration (next)
273 {
274 if (next === undefined) return durationValue;
275 durationValue = Number(next);
276 return durationValue;
277 },
278 volume (next)
279 {
280 if (next === undefined) return volumeValue;
281 volumeValue = Number(next);
282 window.__lastVideoJsVolumeSet = volumeValue;
283 return volumeValue;
284 },
285 textTracks ()
286 {
287 return textTracks;
288 },
289 audioTracks ()
290 {
291 return audioTracks;
292 },
293 currentTime ()
294 {
295 return 0;
296 },
297 el ()
298 {
299 return playerElement;
300 },
301 getChild (name)
302 {
303 if (name !== 'controlBar') return null;
304 return {
305 addChild (componentName)
306 {
307 const Component = registeredComponents.get(componentName);
308 if (!Component) return null;
309 const instance = new Component(player);
310 playerElement.appendChild(instance.el());
311 return instance;
312 },
313 };
314 },
315 dispose ()
316 {
317 const listeners = playerEvents.get('dispose');
318 if (!listeners) return;
319 for (const fn of Array.from(listeners)) fn();
320 },
321 liveTracker: {
322 stopTracking () { },
323 },
324 removeClass () { },
325 };
326
327 window.__lastVideoJsPlayer = player;
328 return player;
329 };
330
331 window.videojs.getComponent = (name) => registeredComponents.get(name);
332 window.videojs.registerComponent = (name, component) =>
333 {
334 registeredComponents.set(name, component);
335 };
336
337 window.videojs.Vhs = {
338 GOAL_BUFFER_LENGTH: 0,
339 MAX_GOAL_BUFFER_LENGTH: 0,
340 };
341 },
342 });
343
344 await new Promise((resolve) => dom.window.addEventListener('load', resolve, { once: true }));
345
346 return { dom, runtimeErrors };
347 }
348
349 async function waitFor (dom, predicate, timeoutMs = 3000)
350 {
351 const startedAt = Date.now();
352 while (Date.now() - startedAt < timeoutMs)
353 {
354 if (predicate()) return true;
355 await new Promise(resolve => dom.window.setTimeout(resolve, 25));
356 }
357 return predicate();
358 }
359
360 test('applies default caption settings for share-page video playback', async () =>
361 {
362 const { dom, runtimeErrors } = await bootSharePage();
363
364 await waitFor(dom, () => !!dom.window.document.querySelector('#preview-wrap .video-js'));
365
366 expect(runtimeErrors).toEqual([]);
367 expect(dom.window.localStorage.getItem('vjs-text-track-settings')).toBe(DEFAULT_VIDEO_TEXT_TRACK_SETTINGS_RAW);
368 expect(dom.window.__lastVideoJsPlayer.imageSubtitleOverlayController).toEqual(expect.any(Object));
369 expect(dom.window.document.querySelector('#preview-wrap [title="Image subtitles"]')).toBeTruthy();
370
371 dom.window.close();
372 });
373
374 test('restores and saves share-page subtitle/audio track preferences by name', async () =>
375 {
376 initialSharePrefs = {
377 subtitleTrackName: 'French',
378 audioTrackName: 'Stereo',
379 volume: 0.35,
380 };
381
382 const { dom, runtimeErrors } = await bootSharePage();
383
384 await waitFor(dom, () => !!dom.window.document.querySelector('#preview-wrap .video-js'));
385
386 expect(runtimeErrors).toEqual([]);
387 expect(dom.window.localStorage.getItem('vjs-text-track-settings')).toBe(DEFAULT_VIDEO_TEXT_TRACK_SETTINGS_RAW);
388 expect(dom.window.__lastVideoJsVolumeSet).toBe(0.35);
389
390 expect(dom.window.__lastVideoJsTextTracks.item(0).mode).toBe('disabled');
391 expect(dom.window.__lastVideoJsTextTracks.item(1).mode).toBe('showing');
392 expect(dom.window.__lastVideoJsAudioTracks.item(0).enabled).toBe(true);
393 expect(dom.window.__lastVideoJsAudioTracks.item(1).enabled).toBe(false);
394
395 dom.window.__lastVideoJsTextTracks.item(0).mode = 'showing';
396 dom.window.__lastVideoJsTextTracks.item(1).mode = 'disabled';
397 dom.window.__lastVideoJsTextTracks.dispatchEvent('change');
398
399 dom.window.__lastVideoJsAudioTracks.item(0).enabled = false;
400 dom.window.__lastVideoJsAudioTracks.item(1).enabled = true;
401 dom.window.__lastVideoJsAudioTracks.dispatchEvent('change');
402
403 const storedPrefs = JSON.parse(dom.window.localStorage.getItem(SHARE_VIDEO_PREFS_KEY));
404 expect(storedPrefs.subtitleTrackName).toBe('English');
405 expect(storedPrefs.audioTrackName).toBe('Director commentary');
406
407 dom.window.close();
408 });
409});