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