Administrator/Twitch-VOD-Manager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 230 Wiki Activity

fix(queue): isolate process lifecycle per item

Browse Source 
Track Streamlink and FFmpeg resources by queue item so parallel jobs can pause, resume, cancel, retry, and clean up independently. Gate queue scheduling during shutdown, await the active queue owner, retain retry artifacts on ordinary failures, remove partial outputs on cancellation, and flush queue state once after active work settles.
This commit is contained in:
Sucukdeluxe
2026-08-11 22:15:47 +02:00
parent aa53fcf7e8
commit 1140c8526e
3 changed files with 549 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/main.ts
+180 -63
View File
@@ -19,6 +19,7 @@ import { tBackend as tBackendCore, type BackendMessageKey } from './main/domain/
import { watchRendererChanges } from './main/dev-reload';
import { createPausableOutput, type PausableOutput } from './main/domain/pausable-output';
import { PartialDownloadRegistry } from './main/domain/partial-download';
import { QueueProcessRegistry, QueueRunLifecycle } from './main/queue/process-registry';
import type { DbHandle } from './main/infra/db';
import {
normalizeLogin,
@@ -669,6 +670,14 @@ function saveQueue(queue: QueueItem[], force = false): void {
pendingQueueSnapshot = queue;
if (appShutdownStarted && !force) {
if (queueSaveTimer) {
clearTimeout(queueSaveTimer);
queueSaveTimer = null;
}
return;
}
if (force) {
if (queueSaveTimer) {
clearTimeout(queueSaveTimer);
@@ -774,6 +783,14 @@ interface ActiveDownloadTracking {
}
const activeDownloads = new Map<string, ActiveDownloadTracking>();
const cancelledItemIds = new Set<string>();
const queueProcessRegistry = new QueueProcessRegistry();
const queueRunLifecycle = new QueueRunLifecycle(queueProcessRegistry);
function registerQueuePartialFile(itemId: string, filePath: string): void {
queueProcessRegistry.register(itemId, 'post-processing', {
cleanup: () => { try { fs.rmSync(filePath, { force: true }); } catch { } },
});
}
// userId -> login reverse map. Bounded via Map insertion-order eviction so
// a long-running session doesn't grow it unbounded across thousands of
// streamer lookups. Values are short (~20 char each) but accumulate.
@@ -3296,7 +3313,7 @@ async function extractFrame(filePath: string, timeSeconds: number): Promise<stri
// what we want for resumed-recording parts (same streamlink, same codec
// settings, just split across files). Returns false on any error so the
// caller can keep the original parts.
async function concatVideoFiles(inputFiles: string[], outputFile: string): Promise<boolean> {
async function concatVideoFiles(inputFiles: string[], outputFile: string, itemId: string | null = null): Promise<boolean> {
if (inputFiles.length < 2) return false;
const ffmpegReady = await ensureFfmpegInstalled();
if (!ffmpegReady) return false;
@@ -3333,11 +3350,22 @@ async function concatVideoFiles(inputFiles: string[], outputFile: string): Promi
return await new Promise<boolean>((resolve) => {
const proc = spawn(ffmpeg, args, { windowsHide: true });
const registration = itemId
? queueProcessRegistry.register(itemId, 'post-processing', {
kill: () => proc.kill(),
wait: waitForChildProcessClose(proc),
cleanup: () => {
try { fs.rmSync(outputFile, { force: true }); } catch { }
try { fs.rmSync(listFile, { force: true }); } catch { }
},
})
: null;
let stderrBuf = '';
proc.stderr?.on('data', (chunk: Buffer) => { stderrBuf += chunk.toString(); });
proc.on('close', (code) => {
registration?.release();
try { fs.unlinkSync(listFile); } catch { /* ignore */ }
if (code === 0 && fs.existsSync(outputFile) && fs.statSync(outputFile).size > 0) {
if (code === 0 && (!itemId || !queueProcessRegistry.isCancelled(itemId)) && fs.existsSync(outputFile) && fs.statSync(outputFile).size > 0) {
appendDebugLog('concat-ok', { output: outputFile, parts: inputFiles.length });
resolve(true);
} else {
@@ -3349,6 +3377,7 @@ async function concatVideoFiles(inputFiles: string[], outputFile: string): Promi
}
});
proc.on('error', (err) => {
registration?.release();
try { fs.unlinkSync(listFile); } catch { /* ignore */ }
appendDebugLog('concat-spawn-error', String(err));
resolve(false);
@@ -3469,7 +3498,8 @@ async function mergeVideos(
inputFiles: string[],
outputFile: string,
onProgress: (percent: number) => void,
totalDurationSec?: number
totalDurationSec?: number,
itemId: string | null = null
): Promise<boolean> {
const ffmpegReady = await ensureFfmpegInstalled();
if (!ffmpegReady) {
@@ -3557,7 +3587,18 @@ async function mergeVideos(
return await new Promise((resolve) => {
const proc = spawn(ffmpeg, args, { windowsHide: true });
currentEditorProcess = proc;
const registration = itemId
? queueProcessRegistry.register(itemId, 'merge', {
kill: () => proc.kill(),
wait: waitForChildProcessClose(proc),
pause: () => proc.kill(),
cleanup: () => {
try { fs.rmSync(outputFile, { force: true }); } catch { }
try { fs.rmSync(concatFile, { force: true }); } catch { }
},
})
: null;
if (!itemId) currentEditorProcess = proc;
proc.stdout?.on('data', (data) => {
const line = data.toString();
@@ -3573,8 +3614,9 @@ async function mergeVideos(
});
proc.on('close', (code) => {
currentEditorProcess = null;
const success = code === 0 && fs.existsSync(outputFile);
registration?.release();
if (!itemId && currentEditorProcess === proc) currentEditorProcess = null;
const success = code === 0 && (!itemId || !queueProcessRegistry.isCancelled(itemId)) && fs.existsSync(outputFile);
if (success) {
onProgress(100);
}
@@ -3582,7 +3624,8 @@ async function mergeVideos(
});
proc.on('error', () => {
currentEditorProcess = null;
registration?.release();
if (!itemId && currentEditorProcess === proc) currentEditorProcess = null;
resolve(false);
});
});
@@ -3594,12 +3637,21 @@ async function mergeVideos(
return true;
}
if (itemId && (queueProcessRegistry.isCancelled(itemId) || queueProcessRegistry.isPaused(itemId))) {
try { fs.rmSync(outputFile, { force: true }); } catch { }
return false;
}
appendDebugLog('merge-video-copy-failed-fallback-reencode', { outputFile, files: inputFiles.length });
try {
if (fs.existsSync(outputFile)) fs.unlinkSync(outputFile);
} catch { }
return await runMergeAttempt(false);
const reencodeSuccess = await runMergeAttempt(false);
if (!reencodeSuccess) {
try { fs.rmSync(outputFile, { force: true }); } catch { }
}
return reencodeSuccess;
} finally {
try {
fs.unlinkSync(concatFile);
@@ -3652,25 +3704,37 @@ async function splitMergedFile(
const success = await new Promise<boolean>((resolve) => {
const proc = spawn(ffmpeg, args, { windowsHide: true });
currentEditorProcess = proc;
const registration = itemId
? queueProcessRegistry.register(itemId, 'split', {
kill: () => proc.kill(),
wait: waitForChildProcessClose(proc),
pause: () => proc.kill(),
cleanup: () => { try { fs.rmSync(outputFile, { force: true }); } catch { } },
})
: null;
if (!itemId) currentEditorProcess = proc;
proc.on('close', (code) => {
currentEditorProcess = null;
resolve(code === 0 && fs.existsSync(outputFile));
registration?.release();
if (!itemId && currentEditorProcess === proc) currentEditorProcess = null;
resolve(code === 0 && (!itemId || !queueProcessRegistry.isCancelled(itemId)) && fs.existsSync(outputFile));
});
proc.on('error', () => {
currentEditorProcess = null;
registration?.release();
if (!itemId && currentEditorProcess === proc) currentEditorProcess = null;
resolve(false);
});
});
if (!success) {
appendDebugLog('split-merged-part-failed', { part: i + 1, outputFile });
try { fs.rmSync(outputFile, { force: true }); } catch { }
return { success: false, files: splitFiles };
}
splitFiles.push(outputFile);
if (itemId) registerQueuePartialFile(itemId, outputFile);
}
return { success: true, files: splitFiles };
@@ -3740,6 +3804,14 @@ function downloadVODPart(
}
const output = createPausableOutput(proc.stdout, outputStream);
const outputFinished = output.finished.then(() => null, (error) => error);
const processRegistration = queueProcessRegistry.register(itemId, 'streamlink', {
kill: () => proc.kill(),
wait: waitForChildProcessClose(proc),
pause: () => output.pause(),
resume: () => output.resume(),
cancel: () => output.cancel(),
cleanup: () => partialDownloadRegistry.discard(partialFilename),
});
// Register in per-item tracking map for parallel downloads
// (no longer mirrored on a global — currentEditorProcess is editor-only)
@@ -3866,6 +3938,7 @@ function downloadVODPart(
proc.on('close', async (code) => {
clearInterval(progressInterval);
const outputError = await outputFinished;
processRegistration.release();
activeDownloads.delete(itemId);
if (outputError) {
@@ -3948,6 +4021,7 @@ function downloadVODPart(
proc.on('error', async (err) => {
clearInterval(progressInterval);
await output.cancel();
processRegistration.release();
partialDownloadRegistry.discard(partialFilename);
console.error('Process error:', err);
activeDownloads.delete(itemId);
@@ -4053,7 +4127,7 @@ async function runAutoRecordPoll(): Promise<number> {
appendDebugLog('auto-record-triggered', { streamer, title: liveItem.title });
if (!isDownloading) {
void processQueue();
scheduleQueueProcessing();
}
}
} catch (e) {
@@ -4189,7 +4263,7 @@ async function runAutoVodPoll(): Promise<number> {
emitQueueUpdated();
if (!isDownloading && downloadQueue.some((it) => it.status === 'pending')) {
void processQueue();
scheduleQueueProcessing();
}
} catch (e) {
appendDebugLog('auto-vod-poll-failed', String(e));
@@ -5794,7 +5868,7 @@ async function downloadLiveStream(
baseFilename.replace(/\.mp4$/i, '_merged.mp4'),
item.id
);
const mergeOk = await concatVideoFiles(outputs, mergedOutput);
const mergeOk = await concatVideoFiles(outputs, mergedOutput, item.id);
if (mergeOk) {
if (config.delete_parts_after_merge) {
for (const partPath of outputs) {
@@ -6198,6 +6272,7 @@ async function processDownloadMergeGroup(
}
mg.downloadedFiles[i] = tmpFilename;
registerQueuePartialFile(item.id, tmpFilename);
saveQueue(downloadQueue);
}
}
@@ -6242,7 +6317,8 @@ async function processDownloadMergeGroup(
totalParts: 0
});
},
totalDurationSec
totalDurationSec,
item.id
);
if (!mergeSuccess) {
@@ -6250,6 +6326,7 @@ async function processDownloadMergeGroup(
}
mg.mergedFile = mergedFilePath;
registerQueuePartialFile(item.id, mergedFilePath);
saveQueue(downloadQueue);
}
@@ -6346,6 +6423,18 @@ async function processDownloadMergeGroup(
}
async function processOneQueueItem(item: QueueItem): Promise<void> {
queueProcessRegistry.resetItem(item.id);
const itemRegistration = queueProcessRegistry.register(item.id, 'post-processing', {});
if (!itemRegistration.accepted) return;
if (item.mergeGroup) {
for (const filePath of Object.values(item.mergeGroup.downloadedFiles)) {
if (filePath && fs.existsSync(filePath)) registerQueuePartialFile(item.id, filePath);
}
if (item.mergeGroup.mergedFile && fs.existsSync(item.mergeGroup.mergedFile)) {
registerQueuePartialFile(item.id, item.mergeGroup.mergedFile);
}
}
appendDebugLog('queue-item-start', {
itemId: item.id,
title: item.title,
@@ -6370,6 +6459,10 @@ async function processOneQueueItem(item: QueueItem): Promise<void> {
const maxAttempts = getRetryAttemptLimit();
for (let attempt = 1; attempt <= maxAttempts; attempt++) {
if (!isDownloading || cancelledItemIds.has(item.id) || queueProcessRegistry.isCancelled(item.id)) {
finalResult = { success: false, error: tBackend('downloadCancelled') };
break;
}
appendDebugLog('queue-item-attempt', { itemId: item.id, attempt, max: maxAttempts });
const result = item.mergeGroup
@@ -6389,7 +6482,17 @@ async function processOneQueueItem(item: QueueItem): Promise<void> {
finalResult = result;
if (!isDownloading || cancelledItemIds.has(item.id)) {
if (queueProcessRegistry.isPaused(item.id)) {
await queueProcessRegistry.whenResumed(item.id);
if (!isDownloading || cancelledItemIds.has(item.id) || queueProcessRegistry.isCancelled(item.id)) {
finalResult = { success: false, error: tBackend('downloadCancelled') };
break;
}
attempt -= 1;
continue;
}
if (!isDownloading || cancelledItemIds.has(item.id) || queueProcessRegistry.isCancelled(item.id)) {
finalResult = { success: false, error: tBackend('downloadCancelled') };
break;
}
@@ -6423,7 +6526,10 @@ async function processOneQueueItem(item: QueueItem): Promise<void> {
} as DownloadProgress);
saveQueue(downloadQueue);
emitQueueUpdated();
await sleep(retryDelaySeconds * 1000);
await Promise.race([
sleep(retryDelaySeconds * 1000),
queueProcessRegistry.whenCancelled(item.id),
]);
} else {
runtimeMetrics.retriesExhausted += 1;
}
@@ -6541,7 +6647,7 @@ async function processOneQueueItem(item: QueueItem): Promise<void> {
currentPart: 0,
totalParts: 0
} as DownloadProgress);
}, () => cancelledItemIds.has(item.id));
}, () => cancelledItemIds.has(item.id) || queueProcessRegistry.isCancelled(item.id));
const chatPath = chatReplayPathFor(firstOutput);
const payload = {
@@ -6588,8 +6694,9 @@ async function processOneQueueItem(item: QueueItem): Promise<void> {
});
saveQueue(downloadQueue);
emitQueueUpdated();
if (!appShutdownStarted) emitQueueUpdated();
} finally {
queueProcessRegistry.releaseItem(item.id);
activeDownloads.delete(item.id);
cancelledItemIds.delete(item.id);
// Release only THIS item's claimed filenames (other parallel downloads keep their claims)
@@ -6598,8 +6705,15 @@ async function processOneQueueItem(item: QueueItem): Promise<void> {
}
}
function scheduleQueueProcessing(): boolean {
if (appShutdownStarted) return false;
return queueRunLifecycle.schedule(processQueue, (error) => {
appendDebugLog('queue-run-failed', String(error));
});
}
async function processQueue(): Promise<void> {
if (isDownloading || !downloadQueue.some((item) => item.status === 'pending')) return;
if (appShutdownStarted || isDownloading || !downloadQueue.some((item) => item.status === 'pending')) return;
appendDebugLog('queue-start', {
items: downloadQueue.length,
@@ -6655,6 +6769,10 @@ async function processQueue(): Promise<void> {
cancelledItemIds.clear();
saveQueue(downloadQueue);
if (appShutdownStarted) {
appendDebugLog('queue-finished', { items: downloadQueue.length, shutdown: true });
return;
}
emitQueueUpdated();
mainWindow?.webContents.send('download-finished');
try {
@@ -6743,7 +6861,7 @@ function createWindow(): void {
setTimeout(() => {
if (config.auto_resume_queue_on_startup && !isDownloading
&& downloadQueue.some((it) => it.status === 'pending')) {
void processQueue();
scheduleQueueProcessing();
}
}, 5000);
}
@@ -7210,7 +7328,7 @@ ipcMain.handle('start-live-recording', async (_, streamerName: string) => {
downloadQueue.push(liveItem);
saveQueue(downloadQueue);
emitQueueUpdated();
if (!isDownloading) void processQueue();
if (!isDownloading) scheduleQueueProcessing();
appendDebugLog('live-recording-queued', { streamer: login, title: liveItem.title });
return { success: true, streamer: login, title: liveInfo.title || login };
});
@@ -7244,20 +7362,16 @@ ipcMain.handle('add-to-queue', (_, item: Omit<QueueItem, 'id' | 'status' | 'prog
});
ipcMain.handle('remove-from-queue', async (_, id: string) => {
const wasActiveItem = activeQueueItemId === id || activeDownloads.has(id);
const wasActiveItem = activeQueueItemId === id || activeDownloads.has(id) || queueProcessRegistry.activeItemIds().includes(id);
if (wasActiveItem) {
cancelledItemIds.add(id);
const tracking = activeDownloads.get(id);
if (tracking?.process) {
tracking.process.kill();
await tracking.output.cancel();
partialDownloadRegistry.discard(tracking.partialFilename);
}
await queueProcessRegistry.cancelItem(id);
activeDownloads.delete(id);
activeQueueItemId = null;
runtimeMetrics.activeItemId = null;
runtimeMetrics.activeItemTitle = null;
const nextActiveId = queueProcessRegistry.activeItemIds()[0] || null;
activeQueueItemId = nextActiveId;
runtimeMetrics.activeItemId = nextActiveId;
runtimeMetrics.activeItemTitle = nextActiveId ? downloadQueue.find((item) => item.id === nextActiveId)?.title || null : null;
appendDebugLog('queue-item-removed-active-cancelled', { id });
}
@@ -7300,7 +7414,10 @@ ipcMain.handle('reorder-queue', (_, orderIds: string[]) => {
return downloadQueue;
});
ipcMain.handle('retry-failed-downloads', () => {
ipcMain.handle('retry-failed-downloads', async () => {
const failedIds = downloadQueue.filter((item) => item.status === 'error').map((item) => item.id);
await Promise.all(failedIds.map((id) => queueProcessRegistry.cancelItem(id)));
for (const id of failedIds) queueProcessRegistry.resetItem(id);
downloadQueue = downloadQueue.map((item) => {
if (item.status !== 'error') return item;
@@ -7316,19 +7433,22 @@ ipcMain.handle('retry-failed-downloads', () => {
emitQueueUpdated();
if (!isDownloading) {
void processQueue();
scheduleQueueProcessing();
}
return downloadQueue;
});
ipcMain.handle('retry-queue-item', (_, id: string) => {
ipcMain.handle('retry-queue-item', async (_, id: string) => {
if (typeof id !== 'string' || !id) return downloadQueue;
const idx = downloadQueue.findIndex((it) => it.id === id);
if (idx < 0) return downloadQueue;
const item = downloadQueue[idx];
if (item.status !== 'error') return downloadQueue;
await queueProcessRegistry.cancelItem(id);
queueProcessRegistry.resetItem(id);
downloadQueue[idx] = {
...item,
status: 'pending',
@@ -7341,7 +7461,7 @@ ipcMain.handle('retry-queue-item', (_, id: string) => {
appendDebugLog('queue-item-retry-single', { id, title: item.title });
if (!isDownloading) {
void processQueue();
scheduleQueueProcessing();
}
return downloadQueue;
@@ -7430,9 +7550,7 @@ ipcMain.handle('start-download', async () => {
for (const item of downloadQueue) {
if (item.status === 'paused') item.status = 'downloading';
}
for (const [id, tracking] of activeDownloads) {
tracking.output.resume();
}
await Promise.all(queueProcessRegistry.activeItemIds().map((id) => queueProcessRegistry.resumeItem(id)));
saveQueue(downloadQueue);
emitQueueUpdated(true);
mainWindow?.webContents.send('download-started');
@@ -7451,18 +7569,16 @@ ipcMain.handle('start-download', async () => {
emitQueueUpdated();
if (!isDownloading) {
void processQueue();
scheduleQueueProcessing();
}
return true;
});
ipcMain.handle('pause-download', () => {
ipcMain.handle('pause-download', async () => {
if (!isDownloading || queuePaused) return false;
queuePaused = true;
for (const [, tracking] of activeDownloads) {
tracking.output.pause();
}
await Promise.all(queueProcessRegistry.activeItemIds().map((id) => queueProcessRegistry.pauseItem(id)));
for (const item of downloadQueue) {
if (item.status === 'downloading') {
item.status = 'paused';
@@ -7480,14 +7596,9 @@ ipcMain.handle('pause-download', () => {
ipcMain.handle('cancel-download', async () => {
isDownloading = false;
queuePaused = false;
await Promise.all([...activeDownloads].map(async ([id, tracking]) => {
cancelledItemIds.add(id);
if (tracking.process) {
tracking.process.kill();
await tracking.output.cancel();
partialDownloadRegistry.discard(tracking.partialFilename);
}
}));
const activeItemIds = queueProcessRegistry.activeItemIds();
for (const id of activeItemIds) cancelledItemIds.add(id);
await queueProcessRegistry.cancelAll();
return true;
});
@@ -8194,6 +8305,11 @@ async function shutdownCleanup(reason: 'window-all-closed' | 'before-quit'): Pro
if (shutdownCleanupDone) return;
shutdownCleanupDone = true;
appShutdownStarted = true;
if (queueSaveTimer) {
clearTimeout(queueSaveTimer);
queueSaveTimer = null;
}
pendingQueueSnapshot = downloadQueue;
appendDebugLog('shutdown-cleanup', { reason });
@@ -8209,13 +8325,17 @@ async function shutdownCleanup(reason: 'window-all-closed' | 'before-quit'): Pro
// and any in-flight cutter/merger/splitter ffmpeg. before-quit used to
// skip this entirely; window-all-closed did it but only via direct
// kill() (no try/catch around the queue process kill).
await Promise.all([...activeDownloads.values()].map(async (tracking) => {
if (tracking.process) {
try { tracking.process.kill(); } catch { /* already exited */ }
}
try { await tracking.output.cancel(); } catch { }
try { partialDownloadRegistry.discard(tracking.partialFilename); } catch { }
}));
await queueRunLifecycle.shutdown(
() => {
isDownloading = false;
queuePaused = false;
for (const id of queueProcessRegistry.activeItemIds()) cancelledItemIds.add(id);
},
() => {
saveConfig(config);
flushQueueSave();
},
);
activeDownloads.clear();
await Promise.all([...activeClipProcesses.values()].map(async (tracking) => {
@@ -8254,9 +8374,6 @@ async function shutdownCleanup(reason: 'window-all-closed' | 'before-quit'): Pro
currentCutterPartialFile = null;
}
saveConfig(config);
flushQueueSave();
// SQLite-Handle schliessen, falls geoeffnet — WAL-Checkpoint passiert beim
// close, sodass beim naechsten Start keine .wal/.shm orphans bleiben.
if (appDb) {
src/main/queue/process-registry.test.ts
+160
View File
@@ -0,0 +1,160 @@
import { describe, expect, it, vi } from 'vitest';
import { QueueProcessRegistry, QueueRunLifecycle, type QueueProcessResource } from './process-registry';
function deferred(): { promise: Promise<void>; resolve: () => void } {
let resolve!: () => void;
const promise = new Promise<void>((done) => {
resolve = done;
});
return { promise, resolve };
}
function createResource(wait: Promise<void> = Promise.resolve()): QueueProcessResource {
return {
kill: vi.fn(),
wait,
pause: vi.fn(),
resume: vi.fn(),
cancel: vi.fn(async () => undefined),
cleanup: vi.fn(async () => undefined),
};
}
describe('QueueProcessRegistry', () => {
it('keeps parallel queue item process groups independent', async () => {
const registry = new QueueProcessRegistry();
const first = createResource();
const second = createResource();
registry.register('item-a', 'merge', first);
registry.register('item-b', 'split', second);
await registry.cancelItem('item-a');
expect(first.kill).toHaveBeenCalledOnce();
expect(first.cleanup).toHaveBeenCalledOnce();
expect(second.kill).not.toHaveBeenCalled();
expect(second.cleanup).not.toHaveBeenCalled();
expect(registry.activeItemIds()).toEqual(['item-b']);
});
it('pauses and resumes every resource for only the selected item', async () => {
const registry = new QueueProcessRegistry();
const streamlink = createResource();
const postProcessing = createResource();
const unrelated = createResource();
registry.register('item-a', 'streamlink', streamlink);
registry.register('item-a', 'post-processing', postProcessing);
registry.register('item-b', 'streamlink', unrelated);
await registry.pauseItem('item-a');
let resumed = false;
const resumedSignal = registry.whenResumed('item-a').then(() => {
resumed = true;
});
await Promise.resolve();
expect(registry.isPaused('item-a')).toBe(true);
expect(resumed).toBe(false);
await registry.resumeItem('item-a');
await resumedSignal;
expect(streamlink.pause).toHaveBeenCalledOnce();
expect(streamlink.resume).toHaveBeenCalledOnce();
expect(postProcessing.pause).toHaveBeenCalledOnce();
expect(postProcessing.resume).toHaveBeenCalledOnce();
expect(unrelated.pause).not.toHaveBeenCalled();
expect(unrelated.resume).not.toHaveBeenCalled();
expect(registry.isPaused('item-a')).toBe(false);
});
it.each(['merge', 'split'] as const)('waits for %s termination before removing partial output', async (phase) => {
const registry = new QueueProcessRegistry();
const closed = deferred();
const resource = createResource(closed.promise);
registry.register('item-a', phase, resource);
const cancelling = registry.cancelItem('item-a');
await Promise.resolve();
expect(resource.kill).toHaveBeenCalledOnce();
expect(resource.cleanup).not.toHaveBeenCalled();
closed.resolve();
await cancelling;
expect(resource.cancel).toHaveBeenCalledOnce();
expect(resource.cleanup).toHaveBeenCalledOnce();
expect(registry.activeItemIds()).toEqual([]);
});
it('allows an explicitly reset item to retry without affecting another item', async () => {
const registry = new QueueProcessRegistry();
const firstAttempt = createResource();
const other = createResource();
registry.register('item-a', 'streamlink', firstAttempt);
registry.register('item-b', 'streamlink', other);
await registry.cancelItem('item-a');
registry.resetItem('item-a');
const retry = createResource();
const registration = registry.register('item-a', 'streamlink', retry);
expect(registration.accepted).toBe(true);
expect(registry.isCancelled('item-a')).toBe(false);
expect(registry.activeItemIds()).toEqual(['item-b', 'item-a']);
expect(other.kill).not.toHaveBeenCalled();
});
it('releases completed phase artifacts without deleting retry state', () => {
const registry = new QueueProcessRegistry();
const downloadedPart = createResource();
const mergedIntermediate = createResource();
registry.register('item-a', 'post-processing', downloadedPart);
registry.register('item-a', 'post-processing', mergedIntermediate);
registry.releaseItem('item-a');
expect(downloadedPart.cleanup).not.toHaveBeenCalled();
expect(mergedIntermediate.cleanup).not.toHaveBeenCalled();
expect(registry.activeItemIds()).toEqual([]);
});
});
describe('QueueRunLifecycle', () => {
it('latches shutdown, cancels all groups, waits for the queue and persists once', async () => {
const registry = new QueueProcessRegistry();
const lifecycle = new QueueRunLifecycle(registry);
const queueDone = deferred();
const processClosed = deferred();
const resource = createResource(processClosed.promise);
const persist = vi.fn(async () => undefined);
const beforeCancel = vi.fn(async () => undefined);
expect(lifecycle.schedule(async () => queueDone.promise)).toBe(true);
registry.register('item-a', 'merge', resource);
const firstShutdown = lifecycle.shutdown(beforeCancel, persist);
const secondShutdown = lifecycle.shutdown(beforeCancel, persist);
const late = createResource();
const lateRegistration = registry.register('item-late', 'streamlink', late);
expect(lifecycle.schedule(async () => undefined)).toBe(false);
expect(lateRegistration.accepted).toBe(false);
processClosed.resolve();
queueDone.resolve();
await Promise.all([firstShutdown, secondShutdown]);
expect(beforeCancel).toHaveBeenCalledOnce();
expect(resource.kill).toHaveBeenCalledOnce();
expect(resource.cleanup).toHaveBeenCalledOnce();
expect(late.kill).toHaveBeenCalledOnce();
expect(late.cleanup).toHaveBeenCalledOnce();
expect(persist).toHaveBeenCalledOnce();
expect(registry.activeItemIds()).toEqual([]);
});
});
src/main/queue/process-registry.ts
+209
View File
@@ -0,0 +1,209 @@
export type QueueProcessPhase = 'streamlink' | 'merge' | 'split' | 'post-processing';
export interface QueueProcessResource {
kill?: () => unknown;
wait?: Promise<unknown>;
pause?: () => unknown | Promise<unknown>;
resume?: () => unknown | Promise<unknown>;
cancel?: () => unknown | Promise<unknown>;
cleanup?: () => unknown | Promise<unknown>;
}
export interface QueueProcessRegistration {
accepted: boolean;
release: () => void;
}
interface RegisteredResource {
itemId: string;
phase: QueueProcessPhase;
resource: QueueProcessResource;
stopping: Promise<void> | null;
}
export class QueueProcessRegistry {
private readonly groups = new Map<string, Set<RegisteredResource>>();
private readonly cancelledItems = new Set<string>();
private readonly pausedItems = new Set<string>();
private readonly cancellationWaiters = new Map<string, Set<() => void>>();
private readonly resumeWaiters = new Map<string, Set<() => void>>();
private readonly settling = new Set<Promise<void>>();
private shuttingDown = false;
register(itemId: string, phase: QueueProcessPhase, resource: QueueProcessResource): QueueProcessRegistration {
const entry: RegisteredResource = { itemId, phase, resource, stopping: null };
if (this.shuttingDown || this.cancelledItems.has(itemId)) {
this.trackSettlement(this.stopResource(entry));
return { accepted: false, release: () => undefined };
}
let group = this.groups.get(itemId);
if (!group) {
group = new Set();
this.groups.set(itemId, group);
}
group.add(entry);
return {
accepted: true,
release: () => this.release(entry),
};
}
async pauseItem(itemId: string): Promise<void> {
this.pausedItems.add(itemId);
await this.invokeItem(itemId, 'pause');
}
async resumeItem(itemId: string): Promise<void> {
await this.invokeItem(itemId, 'resume');
this.pausedItems.delete(itemId);
this.resolveWaiters(this.resumeWaiters, itemId);
}
async cancelItem(itemId: string): Promise<void> {
this.cancelledItems.add(itemId);
this.pausedItems.delete(itemId);
this.resolveWaiters(this.cancellationWaiters, itemId);
this.resolveWaiters(this.resumeWaiters, itemId);
const entries = [...(this.groups.get(itemId) || [])];
await Promise.all(entries.map((entry) => this.stopResource(entry)));
if ((this.groups.get(itemId)?.size || 0) === 0) this.groups.delete(itemId);
}
releaseItem(itemId: string): void {
this.groups.delete(itemId);
this.cancellationWaiters.delete(itemId);
this.resumeWaiters.delete(itemId);
this.pausedItems.delete(itemId);
}
resetItem(itemId: string): void {
if ((this.groups.get(itemId)?.size || 0) > 0) {
throw new Error(`Queue item ${itemId} still has active resources`);
}
this.cancelledItems.delete(itemId);
this.pausedItems.delete(itemId);
this.cancellationWaiters.delete(itemId);
this.resumeWaiters.delete(itemId);
}
isCancelled(itemId: string): boolean {
return this.cancelledItems.has(itemId);
}
isPaused(itemId: string): boolean {
return this.pausedItems.has(itemId);
}
whenCancelled(itemId: string): Promise<void> {
if (this.cancelledItems.has(itemId)) return Promise.resolve();
return this.waitFor(this.cancellationWaiters, itemId);
}
whenResumed(itemId: string): Promise<void> {
if (!this.pausedItems.has(itemId)) return Promise.resolve();
return this.waitFor(this.resumeWaiters, itemId);
}
beginShutdown(): void {
this.shuttingDown = true;
}
async cancelAll(): Promise<void> {
await Promise.all(this.activeItemIds().map((itemId) => this.cancelItem(itemId)));
}
async waitForIdle(): Promise<void> {
while (this.settling.size > 0) {
await Promise.allSettled([...this.settling]);
}
}
activeItemIds(): string[] {
return [...this.groups.entries()]
.filter(([, entries]) => entries.size > 0)
.map(([itemId]) => itemId);
}
private async invokeItem(itemId: string, operation: 'pause' | 'resume'): Promise<void> {
const entries = [...(this.groups.get(itemId) || [])];
await Promise.allSettled(entries.map(async ({ resource }) => {
await resource[operation]?.();
}));
}
private stopResource(entry: RegisteredResource): Promise<void> {
if (entry.stopping) return entry.stopping;
entry.stopping = (async () => {
try { entry.resource.kill?.(); } catch { }
try { await entry.resource.cancel?.(); } catch { }
try { await entry.resource.wait; } catch { }
try { await entry.resource.cleanup?.(); } catch { }
this.release(entry);
})();
return entry.stopping;
}
private trackSettlement(settlement: Promise<void>): void {
this.settling.add(settlement);
void settlement.finally(() => this.settling.delete(settlement));
}
private release(entry: RegisteredResource): void {
const group = this.groups.get(entry.itemId);
if (!group) return;
group.delete(entry);
if (group.size === 0) this.groups.delete(entry.itemId);
}
private waitFor(waiterMap: Map<string, Set<() => void>>, itemId: string): Promise<void> {
return new Promise((resolve) => {
let waiters = waiterMap.get(itemId);
if (!waiters) {
waiters = new Set();
waiterMap.set(itemId, waiters);
}
waiters.add(resolve);
});
}
private resolveWaiters(waiterMap: Map<string, Set<() => void>>, itemId: string): void {
const waiters = waiterMap.get(itemId);
if (!waiters) return;
waiterMap.delete(itemId);
for (const resolve of waiters) resolve();
}
}
export class QueueRunLifecycle {
private currentRun: Promise<void> | null = null;
private shutdownRun: Promise<void> | null = null;
constructor(private readonly registry: QueueProcessRegistry) { }
schedule(run: () => Promise<void>, onError?: (error: unknown) => void): boolean {
if (this.shutdownRun || this.currentRun) return false;
const pending = Promise.resolve()
.then(run)
.catch((error) => onError?.(error));
const tracked = pending.finally(() => {
if (this.currentRun === tracked) this.currentRun = null;
});
this.currentRun = tracked;
return true;
}
shutdown(beforeCancel: () => unknown | Promise<unknown>, persist: () => unknown | Promise<unknown>): Promise<void> {
if (this.shutdownRun) return this.shutdownRun;
this.registry.beginShutdown();
this.shutdownRun = (async () => {
try { await beforeCancel(); } catch { }
await this.registry.cancelAll();
if (this.currentRun) await this.currentRun;
await this.registry.waitForIdle();
await persist();
})();
return this.shutdownRun;
}
}