BlueGit

timfa filemanager

Release active video stream sessions when preview closes

timfa Tim Falken · pushed by timfa

Authored 2026-05-09 · 6 months ago

Hash
fa069cfa0a597156c27127cd3d706a1842310d8f
Parent
d4646730
3 files changed +79 −3
.github/technical-reference.md +7 −2
@@ -59,6 +59,7 @@
59 59 - POST /api/files/upload - Streams multipart uploads into hidden temp files, unpipes stream writes on abort/failure, cleans temp files, and only exposes final filenames after completion.
60 60 - POST /api/files/move - Moves file/folder; supports conflict strategies: `error` (default), `overwrite`, or `rename` with optional `targetName`.
61 61 - POST /api/files/video-stream - Creates a short-lived HLS session for a video and returns playlistUrl, durationSeconds, subtitleTracks, and subtitleSummary ({total, converted, skipped}).
62 - DELETE /api/files/video-stream/:sessionId - Explicitly releases an active short-lived video stream session and stops backend processing.
62 63 - POST /api/files/watch-progress - Records per-user watch status (`partway` >=10%, `fully` >=70%) for sidebar "Watched by" display.
63 64
64 65 ## server/routes/share.js
@@ -73,9 +74,11 @@
73 74
74 75 ## server/video-stream.js
75 76 - createVideoStreamSession(sourcePath) - Probes the input duration, attempts WebVTT conversion for all subtitle streams (skipping only failed conversions), starts ffmpeg HLS transcoding, and resolves only when HLS assets are present (not subtitle files alone); returns durationSeconds, subtitleTracks, and subtitleSummary {total, converted, skipped}.
76 - sendVideoStreamAsset(sessionId, assetPath, res) - Serves HLS playlists, segments, and extracted subtitle files from an active short-lived stream session.
77 - sendVideoStreamAsset(sessionId, assetPath, req, res) - Serves HLS playlists, segments, and extracted subtitle files, tracks request lifecycle, and stops session processing when clients go idle/disconnect.
78 - releaseVideoStreamSession(sessionId) - Explicitly stops an active stream session, terminates ffmpeg, and removes temporary assets.
77 79 - STREAM_ROOT_DIR - Temporary root directory for active ffmpeg-backed stream sessions.
78 80 - STREAM_SESSION_TTL_MS - Idle lifetime for a stream session before cleanup.
81 - STREAM_IDLE_STOP_MS - Maximum client inactivity window before an active stream session is terminated.
79 82
80 83 ## server/db.js
81 84 - initDb() - Initializes SQLite schema for users, file metadata, auth_sessions, and share_tokens (expires_at index).
@@ -125,7 +128,7 @@
125 128 - disconnectThumbnailObserver() - Clears active IntersectionObserver when the grid is rebuilt.
126 129 - setThumbnailPending(iconEl, pending) - Toggles per-icon pending spinner state while a cached image thumbnail is not ready yet.
127 130 - buildThumbnailSource(item, blob, kind) - Produces thumbnail image source (data/blob URL) for icon injection.
128 - renderStreamedVideoPreview(item, targetEl) - Creates the Video.js player with HLS source/track config, enforces non-live playback UI for file streams, uses container-fill sizing to keep previews within bounds, restores per-user video prefs (volume + subtitle/audio track names when present), forces caption overrides on each open (text background opacity transparent + text edge style uniform), reports watch progress, and warns when subtitle streams exist but none are web-compatible.
131 - renderStreamedVideoPreview(item, targetEl) - Creates the Video.js player with HLS source/track config, enforces non-live playback UI for file streams, uses container-fill sizing to keep previews within bounds, restores per-user video prefs (volume + subtitle/audio track names when present), forces caption overrides on each open (text background opacity transparent + text edge style uniform), reports watch progress, warns when subtitle streams exist but none are web-compatible, and releases the backend stream session on close/unload.
129 132 - closePreview(opts) - Closes expanded previews; video previews ignore backdrop close and require explicit close action.
130 133
131 134 ## tests/thumbnail-cache.test.js
@@ -207,6 +210,7 @@
207 210 - video preview saves subtitle/audio track names per user when selection changes - Verifies subtitle/audio selections are persisted into per-user video preferences.
208 211 - video preview applies caption overrides per open - Verifies requested caption overrides are always loaded into Video.js settings.
209 212 - video preview does not save caption style settings per user on close - Verifies caption style changes are not persisted to per-user video preferences.
213 - video preview releases the backend stream session when closed - Verifies closing a streamed video preview sends an explicit backend release call.
210 214
211 215 ## tests/video-stream.test.js
212 216 - createVideoStreamSession resolves once ffmpeg starts writing stream assets - Verifies session creation no longer waits for the final master playlist before preview can begin.
@@ -220,3 +224,4 @@
220 224
221 225 ## tests/files.routes.test.js
222 226 - POST /api/files/watch-progress stores per-user watched status by thresholds - Verifies watch-status persistence and no downgrade from fully to partway.
227 - DELETE /api/files/video-stream/:sessionId releases an active stream session - Verifies explicit stream session release route wiring.
@@ -59,6 +59,7 @@
59- POST /api/files/upload - Streams multipart uploads into hidden temp files, unpipes stream writes on abort/failure, cleans temp files, and only exposes final filenames after completion.
59- POST /api/files/upload - Streams multipart uploads into hidden temp files, unpipes stream writes on abort/failure, cleans temp files, and only exposes final filenames after completion.
60- POST /api/files/move - Moves file/folder; supports conflict strategies: `error` (default), `overwrite`, or `rename` with optional `targetName`.
60- POST /api/files/move - Moves file/folder; supports conflict strategies: `error` (default), `overwrite`, or `rename` with optional `targetName`.
61- POST /api/files/video-stream - Creates a short-lived HLS session for a video and returns playlistUrl, durationSeconds, subtitleTracks, and subtitleSummary ({total, converted, skipped}).
61- POST /api/files/video-stream - Creates a short-lived HLS session for a video and returns playlistUrl, durationSeconds, subtitleTracks, and subtitleSummary ({total, converted, skipped}).
62- DELETE /api/files/video-stream/:sessionId - Explicitly releases an active short-lived video stream session and stops backend processing.
62- POST /api/files/watch-progress - Records per-user watch status (`partway` >=10%, `fully` >=70%) for sidebar "Watched by" display.
63- POST /api/files/watch-progress - Records per-user watch status (`partway` >=10%, `fully` >=70%) for sidebar "Watched by" display.
63
64
64## server/routes/share.js
65## server/routes/share.js
@@ -73,9 +74,11 @@
73
74
74## server/video-stream.js
75## server/video-stream.js
75- createVideoStreamSession(sourcePath) - Probes the input duration, attempts WebVTT conversion for all subtitle streams (skipping only failed conversions), starts ffmpeg HLS transcoding, and resolves only when HLS assets are present (not subtitle files alone); returns durationSeconds, subtitleTracks, and subtitleSummary {total, converted, skipped}.
76- createVideoStreamSession(sourcePath) - Probes the input duration, attempts WebVTT conversion for all subtitle streams (skipping only failed conversions), starts ffmpeg HLS transcoding, and resolves only when HLS assets are present (not subtitle files alone); returns durationSeconds, subtitleTracks, and subtitleSummary {total, converted, skipped}.
76- sendVideoStreamAsset(sessionId, assetPath, res) - Serves HLS playlists, segments, and extracted subtitle files from an active short-lived stream session.
77- sendVideoStreamAsset(sessionId, assetPath, req, res) - Serves HLS playlists, segments, and extracted subtitle files, tracks request lifecycle, and stops session processing when clients go idle/disconnect.
78- releaseVideoStreamSession(sessionId) - Explicitly stops an active stream session, terminates ffmpeg, and removes temporary assets.
77- STREAM_ROOT_DIR - Temporary root directory for active ffmpeg-backed stream sessions.
79- STREAM_ROOT_DIR - Temporary root directory for active ffmpeg-backed stream sessions.
78- STREAM_SESSION_TTL_MS - Idle lifetime for a stream session before cleanup.
80- STREAM_SESSION_TTL_MS - Idle lifetime for a stream session before cleanup.
81- STREAM_IDLE_STOP_MS - Maximum client inactivity window before an active stream session is terminated.
79
82
80## server/db.js
83## server/db.js
81- initDb() - Initializes SQLite schema for users, file metadata, auth_sessions, and share_tokens (expires_at index).
84- initDb() - Initializes SQLite schema for users, file metadata, auth_sessions, and share_tokens (expires_at index).
@@ -125,7 +128,7 @@
125- disconnectThumbnailObserver() - Clears active IntersectionObserver when the grid is rebuilt.
128- disconnectThumbnailObserver() - Clears active IntersectionObserver when the grid is rebuilt.
126- setThumbnailPending(iconEl, pending) - Toggles per-icon pending spinner state while a cached image thumbnail is not ready yet.
129- setThumbnailPending(iconEl, pending) - Toggles per-icon pending spinner state while a cached image thumbnail is not ready yet.
127- buildThumbnailSource(item, blob, kind) - Produces thumbnail image source (data/blob URL) for icon injection.
130- buildThumbnailSource(item, blob, kind) - Produces thumbnail image source (data/blob URL) for icon injection.
128- renderStreamedVideoPreview(item, targetEl) - Creates the Video.js player with HLS source/track config, enforces non-live playback UI for file streams, uses container-fill sizing to keep previews within bounds, restores per-user video prefs (volume + subtitle/audio track names when present), forces caption overrides on each open (text background opacity transparent + text edge style uniform), reports watch progress, and warns when subtitle streams exist but none are web-compatible.
131- renderStreamedVideoPreview(item, targetEl) - Creates the Video.js player with HLS source/track config, enforces non-live playback UI for file streams, uses container-fill sizing to keep previews within bounds, restores per-user video prefs (volume + subtitle/audio track names when present), forces caption overrides on each open (text background opacity transparent + text edge style uniform), reports watch progress, warns when subtitle streams exist but none are web-compatible, and releases the backend stream session on close/unload.
129- closePreview(opts) - Closes expanded previews; video previews ignore backdrop close and require explicit close action.
132- closePreview(opts) - Closes expanded previews; video previews ignore backdrop close and require explicit close action.
130
133
131## tests/thumbnail-cache.test.js
134## tests/thumbnail-cache.test.js
@@ -207,6 +210,7 @@
207- video preview saves subtitle/audio track names per user when selection changes - Verifies subtitle/audio selections are persisted into per-user video preferences.
210- video preview saves subtitle/audio track names per user when selection changes - Verifies subtitle/audio selections are persisted into per-user video preferences.
208- video preview applies caption overrides per open - Verifies requested caption overrides are always loaded into Video.js settings.
211- video preview applies caption overrides per open - Verifies requested caption overrides are always loaded into Video.js settings.
209- video preview does not save caption style settings per user on close - Verifies caption style changes are not persisted to per-user video preferences.
212- video preview does not save caption style settings per user on close - Verifies caption style changes are not persisted to per-user video preferences.
213- video preview releases the backend stream session when closed - Verifies closing a streamed video preview sends an explicit backend release call.
210
214
211## tests/video-stream.test.js
215## tests/video-stream.test.js
212- createVideoStreamSession resolves once ffmpeg starts writing stream assets - Verifies session creation no longer waits for the final master playlist before preview can begin.
216- createVideoStreamSession resolves once ffmpeg starts writing stream assets - Verifies session creation no longer waits for the final master playlist before preview can begin.
@@ -220,3 +224,4 @@
220
224
221## tests/files.routes.test.js
225## tests/files.routes.test.js
222- POST /api/files/watch-progress stores per-user watched status by thresholds - Verifies watch-status persistence and no downgrade from fully to partway.
226- POST /api/files/watch-progress stores per-user watched status by thresholds - Verifies watch-status persistence and no downgrade from fully to partway.
227- DELETE /api/files/video-stream/:sessionId releases an active stream session - Verifies explicit stream session release route wiring.
public/app.js +31 −1
@@ -50,6 +50,7 @@ const STATE = {
50 50 previewObjectUrl: null,
51 51 previewCleanup: null,
52 52 previewDownloadAction: null,
53 previewVideoStreamSessionId: null,
53 54 previewSourceEl: null, // SVG element that triggered the preview
54 55 previewClosing: false, // guard to prevent double-close during animation
55 56 previewExpandState: null, // in-place expanded tile preview state
@@ -2538,6 +2539,25 @@ async function createVideoStreamSessionForItem (item)
2538 2539 return api('POST', '/files/video-stream', { filePath: item.path });
2539 2540 }
2540 2541
2542 async function releaseVideoStreamSession (sessionId, opts = {})
2543 {
2544 const id = String(sessionId || '').trim();
2545 if (!id) return;
2546
2547 await api('DELETE', `/files/video-stream/${encodeURIComponent(id)}`, null, {
2548 keepalive: !!opts.keepalive,
2549 noAutoLogout: true,
2550 }).catch(() => null);
2551 }
2552
2553 function releaseActivePreviewVideoStreamSession (opts = {})
2554 {
2555 const sessionId = String(STATE.previewVideoStreamSessionId || '').trim();
2556 if (!sessionId) return;
2557 STATE.previewVideoStreamSessionId = null;
2558 void releaseVideoStreamSession(sessionId, opts);
2559 }
2560
2541 2561 async function preparePreviewDownload (item)
2542 2562 {
2543 2563 const blob = await fetchFileBlob(item);
@@ -2556,6 +2576,7 @@ async function renderStreamedVideoPreview (item, targetEl)
2556 2576 {
2557 2577 const videojs = await ensureVideoJsLoaded();
2558 2578 const session = await createVideoStreamSessionForItem(item);
2579 STATE.previewVideoStreamSessionId = String(session.sessionId || '').trim() || null;
2559 2580 const prefs = loadUserVideoPrefs();
2560 2581 applyUserVideoTextTrackPrefs();
2561 2582
@@ -2663,6 +2684,7 @@ async function renderStreamedVideoPreview (item, targetEl)
2663 2684
2664 2685 STATE.previewCleanup = () =>
2665 2686 {
2687 releaseActivePreviewVideoStreamSession();
2666 2688 try { markWatch(); } catch { /* ignore */ }
2667 2689 try { trackPrefs.captureSelectedTracks(); } catch { /* ignore */ }
2668 2690 try { trackPrefs.detach(); } catch { /* ignore */ }
@@ -4386,6 +4408,14 @@ function wireEvents ()
4386 4408 {
4387 4409 wireEvents();
4388 4410 initDragDrop();
4389 window.addEventListener('beforeunload', saveSessionState);
4411 window.addEventListener('beforeunload', () =>
4412 {
4413 saveSessionState();
4414 releaseActivePreviewVideoStreamSession({ keepalive: true });
4415 });
4416 window.addEventListener('pagehide', () =>
4417 {
4418 releaseActivePreviewVideoStreamSession({ keepalive: true });
4419 });
4390 4420 await initAuth();
4391 4421 })();
@@ -50,6 +50,7 @@ const STATE = {
50 previewObjectUrl: null,
50 previewObjectUrl: null,
51 previewCleanup: null,
51 previewCleanup: null,
52 previewDownloadAction: null,
52 previewDownloadAction: null,
53 previewVideoStreamSessionId: null,
53 previewSourceEl: null, // SVG element that triggered the preview
54 previewSourceEl: null, // SVG element that triggered the preview
54 previewClosing: false, // guard to prevent double-close during animation
55 previewClosing: false, // guard to prevent double-close during animation
55 previewExpandState: null, // in-place expanded tile preview state
56 previewExpandState: null, // in-place expanded tile preview state
@@ -2538,6 +2539,25 @@ async function createVideoStreamSessionForItem (item)
2538 return api('POST', '/files/video-stream', { filePath: item.path });
2539 return api('POST', '/files/video-stream', { filePath: item.path });
2539}
2540}
2540
2541
2542async function releaseVideoStreamSession (sessionId, opts = {})
2543{
2544 const id = String(sessionId || '').trim();
2545 if (!id) return;
2546
2547 await api('DELETE', `/files/video-stream/${encodeURIComponent(id)}`, null, {
2548 keepalive: !!opts.keepalive,
2549 noAutoLogout: true,
2550 }).catch(() => null);
2551}
2552
2553function releaseActivePreviewVideoStreamSession (opts = {})
2554{
2555 const sessionId = String(STATE.previewVideoStreamSessionId || '').trim();
2556 if (!sessionId) return;
2557 STATE.previewVideoStreamSessionId = null;
2558 void releaseVideoStreamSession(sessionId, opts);
2559}
2560
2541async function preparePreviewDownload (item)
2561async function preparePreviewDownload (item)
2542{
2562{
2543 const blob = await fetchFileBlob(item);
2563 const blob = await fetchFileBlob(item);
@@ -2556,6 +2576,7 @@ async function renderStreamedVideoPreview (item, targetEl)
2556{
2576{
2557 const videojs = await ensureVideoJsLoaded();
2577 const videojs = await ensureVideoJsLoaded();
2558 const session = await createVideoStreamSessionForItem(item);
2578 const session = await createVideoStreamSessionForItem(item);
2579 STATE.previewVideoStreamSessionId = String(session.sessionId || '').trim() || null;
2559 const prefs = loadUserVideoPrefs();
2580 const prefs = loadUserVideoPrefs();
2560 applyUserVideoTextTrackPrefs();
2581 applyUserVideoTextTrackPrefs();
2561
2582
@@ -2663,6 +2684,7 @@ async function renderStreamedVideoPreview (item, targetEl)
2663
2684
2664 STATE.previewCleanup = () =>
2685 STATE.previewCleanup = () =>
2665 {
2686 {
2687 releaseActivePreviewVideoStreamSession();
2666 try { markWatch(); } catch { /* ignore */ }
2688 try { markWatch(); } catch { /* ignore */ }
2667 try { trackPrefs.captureSelectedTracks(); } catch { /* ignore */ }
2689 try { trackPrefs.captureSelectedTracks(); } catch { /* ignore */ }
2668 try { trackPrefs.detach(); } catch { /* ignore */ }
2690 try { trackPrefs.detach(); } catch { /* ignore */ }
@@ -4386,6 +4408,14 @@ function wireEvents ()
4386{
4408{
4387 wireEvents();
4409 wireEvents();
4388 initDragDrop();
4410 initDragDrop();
4389 window.addEventListener('beforeunload', saveSessionState);
4411 window.addEventListener('beforeunload', () =>
4412 {
4413 saveSessionState();
4414 releaseActivePreviewVideoStreamSession({ keepalive: true });
4415 });
4416 window.addEventListener('pagehide', () =>
4417 {
4418 releaseActivePreviewVideoStreamSession({ keepalive: true });
4419 });
4390 await initAuth();
4420 await initAuth();
4391})();
4421})();
tests/page.load.test.js +41 −0
@@ -28,6 +28,7 @@ describe('page load smoke test', () =>
28 28 let adminConfigFixture;
29 29 let downloadFixture;
30 30 let videoStreamFixture;
31 let releasedVideoStreamSessions;
31 32 let setupNeededFixture;
32 33 const openDoms = [];
33 34
@@ -56,6 +57,7 @@ describe('page load smoke test', () =>
56 57 adminConfigFixture = { port: 3000, paths: ['/data'], effectivePaths: ['/data'] };
57 58 downloadFixture = {};
58 59 videoStreamFixture = {};
60 releasedVideoStreamSessions = [];
59 61 setupNeededFixture = false;
60 62 });
61 63
@@ -132,6 +134,11 @@ describe('page load smoke test', () =>
132 134 }
133 135 res.json(payload);
134 136 });
137 app.delete('/api/files/video-stream/:sessionId', (req, res) =>
138 {
139 releasedVideoStreamSessions.push(String(req.params.sessionId || ''));
140 res.json({ ok: true });
141 });
135 142 app.post('/api/files/watch-progress', (req, res) =>
136 143 {
137 144 res.json({ ok: true, updated: true });
@@ -831,6 +838,40 @@ describe('page load smoke test', () =>
831 838 dom.window.close();
832 839 });
833 840
841 test('video preview releases the backend stream session when closed', async () =>
842 {
843 listFixture['/data'] = [
844 {
845 name: 'clip.mkv',
846 path: '/data/clip.mkv',
847 isDir: false,
848 size: 64,
849 mtime: Date.now(),
850 },
851 ];
852 videoStreamFixture['/data/clip.mkv'] = {
853 sessionId: 'video-session',
854 playlistUrl: '/api/files/video-stream/video-session/master.m3u8',
855 subtitleTracks: [],
856 subtitleSummary: { total: 0, converted: 0, skipped: 0 },
857 };
858
859 const { dom, runtimeErrors } = await bootClient();
860 expect(runtimeErrors).toEqual([]);
861
862 await waitFor(dom, () => !!dom.window.document.querySelector('.file-item[data-path="/data/clip.mkv"]'));
863
864 const tile = dom.window.document.querySelector('.file-item[data-path="/data/clip.mkv"]');
865 tile.dispatchEvent(new dom.window.MouseEvent('dblclick', { bubbles: true }));
866 await waitFor(dom, () => !!dom.window.document.querySelector('.preview-video-js'));
867
868 const closeBtn = dom.window.document.querySelector('.preview-expand-close');
869 closeBtn.dispatchEvent(new dom.window.MouseEvent('click', { bubbles: true }));
870 await waitFor(dom, () => releasedVideoStreamSessions.includes('video-session'));
871
872 dom.window.close();
873 });
874
834 875 test('video preview restores per-user saved volume preference', async () =>
835 876 {
836 877 listFixture['/data'] = [
@@ -28,6 +28,7 @@ describe('page load smoke test', () =>
28 let adminConfigFixture;
28 let adminConfigFixture;
29 let downloadFixture;
29 let downloadFixture;
30 let videoStreamFixture;
30 let videoStreamFixture;
31 let releasedVideoStreamSessions;
31 let setupNeededFixture;
32 let setupNeededFixture;
32 const openDoms = [];
33 const openDoms = [];
33
34
@@ -56,6 +57,7 @@ describe('page load smoke test', () =>
56 adminConfigFixture = { port: 3000, paths: ['/data'], effectivePaths: ['/data'] };
57 adminConfigFixture = { port: 3000, paths: ['/data'], effectivePaths: ['/data'] };
57 downloadFixture = {};
58 downloadFixture = {};
58 videoStreamFixture = {};
59 videoStreamFixture = {};
60 releasedVideoStreamSessions = [];
59 setupNeededFixture = false;
61 setupNeededFixture = false;
60 });
62 });
61
63
@@ -132,6 +134,11 @@ describe('page load smoke test', () =>
132 }
134 }
133 res.json(payload);
135 res.json(payload);
134 });
136 });
137 app.delete('/api/files/video-stream/:sessionId', (req, res) =>
138 {
139 releasedVideoStreamSessions.push(String(req.params.sessionId || ''));
140 res.json({ ok: true });
141 });
135 app.post('/api/files/watch-progress', (req, res) =>
142 app.post('/api/files/watch-progress', (req, res) =>
136 {
143 {
137 res.json({ ok: true, updated: true });
144 res.json({ ok: true, updated: true });
@@ -831,6 +838,40 @@ describe('page load smoke test', () =>
831 dom.window.close();
838 dom.window.close();
832 });
839 });
833
840
841 test('video preview releases the backend stream session when closed', async () =>
842 {
843 listFixture['/data'] = [
844 {
845 name: 'clip.mkv',
846 path: '/data/clip.mkv',
847 isDir: false,
848 size: 64,
849 mtime: Date.now(),
850 },
851 ];
852 videoStreamFixture['/data/clip.mkv'] = {
853 sessionId: 'video-session',
854 playlistUrl: '/api/files/video-stream/video-session/master.m3u8',
855 subtitleTracks: [],
856 subtitleSummary: { total: 0, converted: 0, skipped: 0 },
857 };
858
859 const { dom, runtimeErrors } = await bootClient();
860 expect(runtimeErrors).toEqual([]);
861
862 await waitFor(dom, () => !!dom.window.document.querySelector('.file-item[data-path="/data/clip.mkv"]'));
863
864 const tile = dom.window.document.querySelector('.file-item[data-path="/data/clip.mkv"]');
865 tile.dispatchEvent(new dom.window.MouseEvent('dblclick', { bubbles: true }));
866 await waitFor(dom, () => !!dom.window.document.querySelector('.preview-video-js'));
867
868 const closeBtn = dom.window.document.querySelector('.preview-expand-close');
869 closeBtn.dispatchEvent(new dom.window.MouseEvent('click', { bubbles: true }));
870 await waitFor(dom, () => releasedVideoStreamSessions.includes('video-session'));
871
872 dom.window.close();
873 });
874
834 test('video preview restores per-user saved volume preference', async () =>
875 test('video preview restores per-user saved volume preference', async () =>
835 {
876 {
836 listFixture['/data'] = [
877 listFixture['/data'] = [