mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-03-30 06:12:06 -07:00
* fix: harden preload argv parsing for popup windows * fix: align youtube playback with shared overlay startup * fix: unwrap mpv youtube streams for anki media mining * docs: update docs for youtube subtitle and mining flow * refactor: unify cli and runtime wiring for startup and youtube flow * feat: update subtitle sidebar overlay behavior * chore: add shared log-file source for diagnostics * fix(ci): add changelog fragment for immersion changes * fix: address CodeRabbit review feedback * fix: persist canonical title from youtube metadata * style: format stats library tab * fix: address latest review feedback * style: format stats library files * test: stub launcher youtube deps in CI * test: isolate launcher youtube flow deps * test: stub launcher youtube deps in failing case * test: force x11 backend in launcher ci harness * test: address latest review feedback * fix(launcher): preserve user YouTube ytdl raw options * docs(backlog): update task tracking notes * fix(immersion): special-case youtube media paths in runtime and tracking * feat(stats): improve YouTube media metadata and picker key handling * fix(ci): format stats media library hook * fix: address latest CodeRabbit review items * docs: update youtube release notes and docs * feat: auto-load youtube subtitles before manual picker * fix: restore app-owned youtube subtitle flow * docs: update youtube playback docs and config copy * refactor: remove legacy youtube launcher mode plumbing * fix: refine youtube subtitle startup binding * docs: clarify youtube subtitle startup behavior * fix: address PR #31 latest review follow-ups * fix: address PR #31 follow-up review comments * test: harden youtube picker test harness * udpate backlog * fix: add timeout to youtube metadata probe * docs: refresh youtube and stats docs * update backlog * update backlog * chore: release v0.9.0
539 lines
17 KiB
TypeScript
539 lines
17 KiB
TypeScript
import assert from 'node:assert/strict';
|
|
import test from 'node:test';
|
|
import { createOverlayModalRuntimeService } from './overlay-runtime';
|
|
|
|
type MockWindow = {
|
|
destroyed: boolean;
|
|
visible: boolean;
|
|
focused: boolean;
|
|
ignoreMouseEvents: boolean;
|
|
webContentsFocused: boolean;
|
|
showCount: number;
|
|
hideCount: number;
|
|
sent: unknown[][];
|
|
loading: boolean;
|
|
url: string;
|
|
loadCallbacks: Array<() => void>;
|
|
};
|
|
|
|
function createMockWindow(): MockWindow & {
|
|
isDestroyed: () => boolean;
|
|
isVisible: () => boolean;
|
|
isFocused: () => boolean;
|
|
getURL: () => string;
|
|
setIgnoreMouseEvents: (ignore: boolean, options?: { forward?: boolean }) => void;
|
|
setAlwaysOnTop: (flag: boolean, level?: string, relativeLevel?: number) => void;
|
|
moveTop: () => void;
|
|
getShowCount: () => number;
|
|
getHideCount: () => number;
|
|
show: () => void;
|
|
hide: () => void;
|
|
focus: () => void;
|
|
webContents: {
|
|
focused: boolean;
|
|
isLoading: () => boolean;
|
|
getURL: () => string;
|
|
send: (channel: string, payload?: unknown) => void;
|
|
isFocused: () => boolean;
|
|
once: (event: 'did-finish-load', cb: () => void) => void;
|
|
focus: () => void;
|
|
};
|
|
} {
|
|
const state: MockWindow = {
|
|
destroyed: false,
|
|
visible: false,
|
|
focused: false,
|
|
ignoreMouseEvents: false,
|
|
webContentsFocused: false,
|
|
showCount: 0,
|
|
hideCount: 0,
|
|
sent: [],
|
|
loading: false,
|
|
url: 'file:///overlay/index.html?layer=modal',
|
|
loadCallbacks: [],
|
|
};
|
|
const window = {
|
|
...state,
|
|
isDestroyed: () => state.destroyed,
|
|
isVisible: () => state.visible,
|
|
isFocused: () => state.focused,
|
|
getURL: () => state.url,
|
|
setIgnoreMouseEvents: (ignore: boolean, _options?: { forward?: boolean }) => {
|
|
state.ignoreMouseEvents = ignore;
|
|
},
|
|
setAlwaysOnTop: (_flag: boolean, _level?: string, _relativeLevel?: number) => {},
|
|
moveTop: () => {},
|
|
getShowCount: () => state.showCount,
|
|
getHideCount: () => state.hideCount,
|
|
show: () => {
|
|
state.visible = true;
|
|
state.showCount += 1;
|
|
},
|
|
hide: () => {
|
|
state.visible = false;
|
|
state.hideCount += 1;
|
|
},
|
|
focus: () => {
|
|
state.focused = true;
|
|
},
|
|
webContents: {
|
|
isLoading: () => state.loading,
|
|
getURL: () => state.url,
|
|
send: (channel: string, payload?: unknown) => {
|
|
if (payload === undefined) {
|
|
state.sent.push([channel]);
|
|
return;
|
|
}
|
|
state.sent.push([channel, payload]);
|
|
},
|
|
focused: false,
|
|
isFocused: () => state.webContentsFocused,
|
|
once: (_event: 'did-finish-load', cb: () => void) => {
|
|
state.loadCallbacks.push(cb);
|
|
},
|
|
focus: () => {
|
|
state.webContentsFocused = true;
|
|
},
|
|
},
|
|
};
|
|
|
|
Object.defineProperty(window, 'loading', {
|
|
get: () => state.loading,
|
|
set: (value: boolean) => {
|
|
state.loading = value;
|
|
},
|
|
});
|
|
|
|
Object.defineProperty(window, 'visible', {
|
|
get: () => state.visible,
|
|
set: (value: boolean) => {
|
|
state.visible = value;
|
|
},
|
|
});
|
|
|
|
Object.defineProperty(window, 'focused', {
|
|
get: () => state.focused,
|
|
set: (value: boolean) => {
|
|
state.focused = value;
|
|
},
|
|
});
|
|
|
|
Object.defineProperty(window, 'webContentsFocused', {
|
|
get: () => state.webContentsFocused,
|
|
set: (value: boolean) => {
|
|
state.webContentsFocused = value;
|
|
},
|
|
});
|
|
|
|
Object.defineProperty(window, 'url', {
|
|
get: () => state.url,
|
|
set: (value: string) => {
|
|
state.url = value;
|
|
},
|
|
});
|
|
|
|
Object.defineProperty(window, 'ignoreMouseEvents', {
|
|
get: () => state.ignoreMouseEvents,
|
|
set: (value: boolean) => {
|
|
state.ignoreMouseEvents = value;
|
|
},
|
|
});
|
|
|
|
return window;
|
|
}
|
|
|
|
test('sendToActiveOverlayWindow targets modal window with full geometry and tracks close restore', () => {
|
|
const window = createMockWindow();
|
|
const calls: string[] = [];
|
|
const runtime = createOverlayModalRuntimeService({
|
|
getMainWindow: () => null,
|
|
getModalWindow: () => window as never,
|
|
createModalWindow: () => {
|
|
calls.push('create-modal-window');
|
|
return window as never;
|
|
},
|
|
getModalGeometry: () => ({ x: 10, y: 20, width: 300, height: 200 }),
|
|
setModalWindowBounds: (geometry) => {
|
|
calls.push(`bounds:${geometry.x},${geometry.y},${geometry.width},${geometry.height}`);
|
|
},
|
|
});
|
|
|
|
const sent = runtime.sendToActiveOverlayWindow('runtime-options:open', undefined, {
|
|
restoreOnModalClose: 'runtime-options',
|
|
});
|
|
assert.equal(sent, true);
|
|
assert.equal(runtime.getRestoreVisibleOverlayOnModalClose().has('runtime-options'), true);
|
|
assert.deepEqual(calls, ['bounds:10,20,300,200']);
|
|
assert.equal(window.getShowCount(), 0);
|
|
runtime.notifyOverlayModalOpened('runtime-options');
|
|
assert.equal(window.getShowCount(), 1);
|
|
assert.equal(window.isFocused(), true);
|
|
assert.deepEqual(window.sent, [['runtime-options:open']]);
|
|
});
|
|
|
|
test('sendToActiveOverlayWindow creates modal window lazily when absent', () => {
|
|
const window = createMockWindow();
|
|
let modalWindow: ReturnType<typeof createMockWindow> | null = null;
|
|
const runtime = createOverlayModalRuntimeService({
|
|
getMainWindow: () => null,
|
|
getModalWindow: () => modalWindow as never,
|
|
createModalWindow: () => {
|
|
modalWindow = window;
|
|
return modalWindow as never;
|
|
},
|
|
getModalGeometry: () => ({ x: 0, y: 0, width: 400, height: 300 }),
|
|
setModalWindowBounds: () => {},
|
|
});
|
|
|
|
assert.equal(
|
|
runtime.sendToActiveOverlayWindow('jimaku:open', undefined, { restoreOnModalClose: 'jimaku' }),
|
|
true,
|
|
);
|
|
assert.equal(window.getShowCount(), 0);
|
|
runtime.notifyOverlayModalOpened('jimaku');
|
|
assert.equal(window.getShowCount(), 1);
|
|
assert.deepEqual(window.sent, [['jimaku:open']]);
|
|
});
|
|
|
|
test('sendToActiveOverlayWindow waits for blank modal URL before sending open command', () => {
|
|
const window = createMockWindow();
|
|
window.url = '';
|
|
window.loading = true;
|
|
const runtime = createOverlayModalRuntimeService({
|
|
getMainWindow: () => null,
|
|
getModalWindow: () => window as never,
|
|
createModalWindow: () => {
|
|
throw new Error('modal window should not be created when already present');
|
|
},
|
|
getModalGeometry: () => ({ x: 10, y: 20, width: 300, height: 200 }),
|
|
setModalWindowBounds: () => {},
|
|
});
|
|
|
|
const sent = runtime.sendToActiveOverlayWindow('runtime-options:open', undefined, {
|
|
restoreOnModalClose: 'runtime-options',
|
|
});
|
|
|
|
assert.equal(sent, true);
|
|
assert.deepEqual(window.sent, []);
|
|
|
|
assert.equal(window.loadCallbacks.length, 1);
|
|
window.loading = false;
|
|
window.url = 'file:///overlay/index.html?layer=modal';
|
|
window.loadCallbacks[0]!();
|
|
|
|
runtime.notifyOverlayModalOpened('runtime-options');
|
|
assert.deepEqual(window.sent, [['runtime-options:open']]);
|
|
assert.equal(window.getShowCount(), 1);
|
|
});
|
|
|
|
test('handleOverlayModalClosed hides modal window only after all pending modals close', () => {
|
|
const window = createMockWindow();
|
|
const runtime = createOverlayModalRuntimeService({
|
|
getMainWindow: () => null,
|
|
getModalWindow: () => window as never,
|
|
createModalWindow: () => window as never,
|
|
getModalGeometry: () => ({ x: 0, y: 0, width: 400, height: 300 }),
|
|
setModalWindowBounds: () => {},
|
|
});
|
|
|
|
runtime.sendToActiveOverlayWindow('runtime-options:open', undefined, {
|
|
restoreOnModalClose: 'runtime-options',
|
|
});
|
|
runtime.sendToActiveOverlayWindow(
|
|
'subsync:open-manual',
|
|
{ sourceTracks: [] },
|
|
{
|
|
restoreOnModalClose: 'subsync',
|
|
},
|
|
);
|
|
|
|
runtime.handleOverlayModalClosed('runtime-options');
|
|
assert.equal(window.getHideCount(), 0);
|
|
|
|
runtime.handleOverlayModalClosed('subsync');
|
|
assert.equal(window.getHideCount(), 1);
|
|
});
|
|
|
|
test('sendToActiveOverlayWindow prefers visible main overlay window for modal open', () => {
|
|
const mainWindow = createMockWindow();
|
|
mainWindow.visible = true;
|
|
const runtime = createOverlayModalRuntimeService({
|
|
getMainWindow: () => mainWindow as never,
|
|
getModalWindow: () => null,
|
|
createModalWindow: () => {
|
|
throw new Error('modal window should not be created when main overlay is visible');
|
|
},
|
|
getModalGeometry: () => ({ x: 0, y: 0, width: 400, height: 300 }),
|
|
setModalWindowBounds: () => {},
|
|
});
|
|
|
|
const sent = runtime.sendToActiveOverlayWindow('runtime-options:open', undefined, {
|
|
restoreOnModalClose: 'runtime-options',
|
|
});
|
|
|
|
assert.equal(sent, true);
|
|
assert.deepEqual(mainWindow.sent, [['runtime-options:open']]);
|
|
});
|
|
|
|
test('sendToActiveOverlayWindow can prefer modal window even when main overlay is visible', () => {
|
|
const mainWindow = createMockWindow();
|
|
mainWindow.visible = true;
|
|
const modalWindow = createMockWindow();
|
|
const runtime = createOverlayModalRuntimeService({
|
|
getMainWindow: () => mainWindow as never,
|
|
getModalWindow: () => modalWindow as never,
|
|
createModalWindow: () => modalWindow as never,
|
|
getModalGeometry: () => ({ x: 0, y: 0, width: 400, height: 300 }),
|
|
setModalWindowBounds: () => {},
|
|
});
|
|
|
|
const sent = runtime.sendToActiveOverlayWindow('youtube:picker-open', { sessionId: 'yt-1' }, {
|
|
restoreOnModalClose: 'youtube-track-picker',
|
|
preferModalWindow: true,
|
|
});
|
|
|
|
assert.equal(sent, true);
|
|
assert.deepEqual(mainWindow.sent, []);
|
|
assert.deepEqual(modalWindow.sent, [['youtube:picker-open', { sessionId: 'yt-1' }]]);
|
|
});
|
|
|
|
test('modal window path makes visible main overlay click-through until modal closes', () => {
|
|
const mainWindow = createMockWindow();
|
|
mainWindow.visible = true;
|
|
const modalWindow = createMockWindow();
|
|
const runtime = createOverlayModalRuntimeService({
|
|
getMainWindow: () => mainWindow as never,
|
|
getModalWindow: () => modalWindow as never,
|
|
createModalWindow: () => modalWindow as never,
|
|
getModalGeometry: () => ({ x: 0, y: 0, width: 400, height: 300 }),
|
|
setModalWindowBounds: () => {},
|
|
});
|
|
|
|
const sent = runtime.sendToActiveOverlayWindow('youtube:picker-open', { sessionId: 'yt-1' }, {
|
|
restoreOnModalClose: 'youtube-track-picker',
|
|
preferModalWindow: true,
|
|
});
|
|
runtime.notifyOverlayModalOpened('youtube-track-picker');
|
|
|
|
assert.equal(sent, true);
|
|
assert.equal(mainWindow.ignoreMouseEvents, true);
|
|
assert.equal(modalWindow.ignoreMouseEvents, false);
|
|
|
|
runtime.handleOverlayModalClosed('youtube-track-picker');
|
|
|
|
assert.equal(mainWindow.ignoreMouseEvents, false);
|
|
});
|
|
|
|
test('modal window path hides visible main overlay until modal closes', () => {
|
|
const mainWindow = createMockWindow();
|
|
mainWindow.visible = true;
|
|
const modalWindow = createMockWindow();
|
|
const runtime = createOverlayModalRuntimeService({
|
|
getMainWindow: () => mainWindow as never,
|
|
getModalWindow: () => modalWindow as never,
|
|
createModalWindow: () => modalWindow as never,
|
|
getModalGeometry: () => ({ x: 0, y: 0, width: 400, height: 300 }),
|
|
setModalWindowBounds: () => {},
|
|
});
|
|
|
|
runtime.sendToActiveOverlayWindow('youtube:picker-open', { sessionId: 'yt-1' }, {
|
|
restoreOnModalClose: 'youtube-track-picker',
|
|
preferModalWindow: true,
|
|
});
|
|
runtime.notifyOverlayModalOpened('youtube-track-picker');
|
|
|
|
assert.equal(mainWindow.getHideCount(), 1);
|
|
assert.equal(mainWindow.isVisible(), false);
|
|
|
|
runtime.handleOverlayModalClosed('youtube-track-picker');
|
|
|
|
assert.equal(mainWindow.getShowCount(), 1);
|
|
assert.equal(mainWindow.isVisible(), true);
|
|
});
|
|
|
|
test('modal runtime notifies callers when modal input state becomes active/inactive', () => {
|
|
const window = createMockWindow();
|
|
const state: boolean[] = [];
|
|
const runtime = createOverlayModalRuntimeService(
|
|
{
|
|
getMainWindow: () => null,
|
|
getModalWindow: () => window as never,
|
|
createModalWindow: () => window as never,
|
|
getModalGeometry: () => ({ x: 0, y: 0, width: 400, height: 300 }),
|
|
setModalWindowBounds: () => {},
|
|
},
|
|
{
|
|
onModalStateChange: (active: boolean): void => {
|
|
state.push(active);
|
|
},
|
|
},
|
|
);
|
|
|
|
runtime.sendToActiveOverlayWindow('runtime-options:open', undefined, {
|
|
restoreOnModalClose: 'runtime-options',
|
|
});
|
|
runtime.sendToActiveOverlayWindow(
|
|
'subsync:open-manual',
|
|
{ sourceTracks: [] },
|
|
{
|
|
restoreOnModalClose: 'subsync',
|
|
},
|
|
);
|
|
assert.deepEqual(state, []);
|
|
runtime.notifyOverlayModalOpened('runtime-options');
|
|
assert.deepEqual(state, [true]);
|
|
|
|
runtime.handleOverlayModalClosed('runtime-options');
|
|
assert.deepEqual(state, [true]);
|
|
|
|
runtime.handleOverlayModalClosed('subsync');
|
|
assert.deepEqual(state, [true, false]);
|
|
});
|
|
|
|
test('notifyOverlayModalOpened enables input on visible main overlay window when no modal window exists', () => {
|
|
const mainWindow = createMockWindow();
|
|
mainWindow.visible = true;
|
|
mainWindow.ignoreMouseEvents = true;
|
|
const state: boolean[] = [];
|
|
|
|
const runtime = createOverlayModalRuntimeService(
|
|
{
|
|
getMainWindow: () => mainWindow as never,
|
|
getModalWindow: () => null,
|
|
createModalWindow: () => {
|
|
throw new Error('modal window should not be created when main overlay is visible');
|
|
},
|
|
getModalGeometry: () => ({ x: 0, y: 0, width: 400, height: 300 }),
|
|
setModalWindowBounds: () => {},
|
|
},
|
|
{
|
|
onModalStateChange: (active: boolean): void => {
|
|
state.push(active);
|
|
},
|
|
},
|
|
);
|
|
|
|
const sent = runtime.sendToActiveOverlayWindow('runtime-options:open', undefined, {
|
|
restoreOnModalClose: 'runtime-options',
|
|
});
|
|
runtime.notifyOverlayModalOpened('runtime-options');
|
|
|
|
assert.equal(sent, true);
|
|
assert.deepEqual(state, [true]);
|
|
assert.equal(mainWindow.ignoreMouseEvents, false);
|
|
assert.equal(mainWindow.isFocused(), true);
|
|
assert.equal(mainWindow.webContentsFocused, true);
|
|
});
|
|
|
|
test('handleOverlayModalClosed resets modal state even when modal window does not exist', () => {
|
|
const state: boolean[] = [];
|
|
const runtime = createOverlayModalRuntimeService(
|
|
{
|
|
getMainWindow: () => null,
|
|
getModalWindow: () => null,
|
|
createModalWindow: () => null,
|
|
getModalGeometry: () => ({ x: 0, y: 0, width: 400, height: 300 }),
|
|
setModalWindowBounds: () => {},
|
|
},
|
|
{
|
|
onModalStateChange: (active: boolean): void => {
|
|
state.push(active);
|
|
},
|
|
},
|
|
);
|
|
|
|
runtime.sendToActiveOverlayWindow('runtime-options:open', undefined, {
|
|
restoreOnModalClose: 'runtime-options',
|
|
});
|
|
runtime.notifyOverlayModalOpened('runtime-options');
|
|
runtime.handleOverlayModalClosed('runtime-options');
|
|
|
|
assert.deepEqual(state, [true, false]);
|
|
});
|
|
|
|
test('handleOverlayModalClosed hides modal window for single kiku modal', () => {
|
|
const window = createMockWindow();
|
|
const runtime = createOverlayModalRuntimeService({
|
|
getMainWindow: () => null,
|
|
getModalWindow: () => window as never,
|
|
createModalWindow: () => window as never,
|
|
getModalGeometry: () => ({ x: 0, y: 0, width: 400, height: 300 }),
|
|
setModalWindowBounds: () => {},
|
|
});
|
|
|
|
runtime.sendToActiveOverlayWindow(
|
|
'kiku:field-grouping-open',
|
|
{ test: true },
|
|
{
|
|
restoreOnModalClose: 'kiku',
|
|
},
|
|
);
|
|
runtime.handleOverlayModalClosed('kiku');
|
|
|
|
assert.equal(window.getHideCount(), 1);
|
|
assert.equal(runtime.getRestoreVisibleOverlayOnModalClose().size, 0);
|
|
});
|
|
|
|
test('modal fallback reveal keeps mouse events ignored until modal confirms open', async () => {
|
|
const window = createMockWindow();
|
|
const runtime = createOverlayModalRuntimeService({
|
|
getMainWindow: () => null,
|
|
getModalWindow: () => window as never,
|
|
createModalWindow: () => {
|
|
throw new Error('modal window should not be created when already present');
|
|
},
|
|
getModalGeometry: () => ({ x: 0, y: 0, width: 400, height: 300 }),
|
|
setModalWindowBounds: () => {},
|
|
});
|
|
|
|
window.loading = true;
|
|
window.url = '';
|
|
|
|
const sent = runtime.sendToActiveOverlayWindow('jimaku:open', undefined, {
|
|
restoreOnModalClose: 'jimaku',
|
|
});
|
|
|
|
assert.equal(sent, true);
|
|
assert.equal(window.ignoreMouseEvents, false);
|
|
|
|
await new Promise<void>((resolve) => {
|
|
setTimeout(resolve, 260);
|
|
});
|
|
|
|
assert.equal(window.getShowCount(), 1);
|
|
assert.equal(window.ignoreMouseEvents, false);
|
|
|
|
runtime.notifyOverlayModalOpened('jimaku');
|
|
assert.equal(window.ignoreMouseEvents, false);
|
|
});
|
|
|
|
test('waitForModalOpen resolves true after modal acknowledgement', async () => {
|
|
const runtime = createOverlayModalRuntimeService({
|
|
getMainWindow: () => null,
|
|
getModalWindow: () => null,
|
|
createModalWindow: () => null,
|
|
getModalGeometry: () => ({ x: 0, y: 0, width: 400, height: 300 }),
|
|
setModalWindowBounds: () => {},
|
|
});
|
|
|
|
runtime.sendToActiveOverlayWindow('youtube:picker-open', { sessionId: 'yt-1' }, {
|
|
restoreOnModalClose: 'youtube-track-picker',
|
|
});
|
|
const pending = runtime.waitForModalOpen('youtube-track-picker', 1000);
|
|
runtime.notifyOverlayModalOpened('youtube-track-picker');
|
|
|
|
assert.equal(await pending, true);
|
|
});
|
|
|
|
test('waitForModalOpen resolves false on timeout', async () => {
|
|
const runtime = createOverlayModalRuntimeService({
|
|
getMainWindow: () => null,
|
|
getModalWindow: () => null,
|
|
createModalWindow: () => null,
|
|
getModalGeometry: () => ({ x: 0, y: 0, width: 400, height: 300 }),
|
|
setModalWindowBounds: () => {},
|
|
});
|
|
|
|
assert.equal(await runtime.waitForModalOpen('youtube-track-picker', 5), false);
|
|
});
|