sudacode/SubMiner
1
0
Fork 0
mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-04-09 16:19:25 -07:00
Code Issues Packages Projects Releases Wiki Activity

feat: add app-owned YouTube subtitle flow with absPlayer-style parsing (#31)

Browse Source 
* 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
This commit is contained in:
Kyle Yasuda
2026-03-24 00:01:24 -07:00
committed by GitHub
parent c17f0a4080
commit 5feed360ca
219 changed files with 12778 additions and 1052 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
src/renderer/handlers/keyboard.test.ts
View File

@@ -332,6 +332,7 @@ function createKeyboardHandlerHarness() {
return true;
},
handleControllerDebugKeydown: () => false,
handleYoutubePickerKeydown: () => false,
handleSessionHelpKeydown: () => false,
openSessionHelpModal: () => {},
appendClipboardVideoToQueue: () => {},
@@ -489,6 +490,34 @@ test('keyboard mode: repeated popup navigation keys are forwarded while popup is
}
});
test('popup-visible mpv keybindings still fire for bound keys', async () => {
const { ctx, handlers, testGlobals } = createKeyboardHandlerHarness();
try {
await handlers.setupMpvInputForwarding();
handlers.updateKeybindings([
{
key: 'Space',
command: ['cycle', 'pause'],
},
{
key: 'KeyQ',
command: ['quit'],
},
] as never);
ctx.state.yomitanPopupVisible = true;
testGlobals.setPopupVisible(true);
testGlobals.dispatchKeydown({ key: ' ', code: 'Space' });
testGlobals.dispatchKeydown({ key: 'q', code: 'KeyQ' });
assert.deepEqual(testGlobals.mpvCommands.slice(-2), [['cycle', 'pause'], ['quit']]);
} finally {
testGlobals.restore();
}
});
test('keyboard mode: controller helpers dispatch popup audio play/cycle and scroll bridge commands', async () => {
const { ctx, handlers, testGlobals } = createKeyboardHandlerHarness();
@@ -590,6 +619,33 @@ test('keyboard mode: configured stats toggle works even while popup is open', as
}
});
test('youtube picker: unhandled keys still dispatch mpv keybindings', async () => {
const { ctx, handlers, testGlobals } = createKeyboardHandlerHarness();
try {
await handlers.setupMpvInputForwarding();
handlers.updateKeybindings([
{
key: 'Space',
command: ['cycle', 'pause'],
},
{
key: 'KeyQ',
command: ['quit'],
},
] as never);
ctx.state.youtubePickerModalOpen = true;
testGlobals.dispatchKeydown({ key: ' ', code: 'Space' });
testGlobals.dispatchKeydown({ key: 'q', code: 'KeyQ' });
assert.deepEqual(testGlobals.mpvCommands.slice(-2), [['cycle', 'pause'], ['quit']]);
} finally {
testGlobals.restore();
}
});
test('keyboard mode: h moves left when popup is closed', async () => {
const { ctx, handlers, testGlobals } = createKeyboardHandlerHarness();
@@ -817,6 +873,22 @@ test('keyboard mode: closing lookup clears yomitan active text source so same to
}
});
test('subtitle refresh outside keyboard mode clears yomitan active text source', async () => {
const { handlers, testGlobals } = createKeyboardHandlerHarness();
try {
handlers.handleSubtitleContentUpdated();
await wait(0);
const clearCommands = testGlobals.commandEvents.filter(
(event) => event.type === 'clearActiveTextSource',
);
assert.deepEqual(clearCommands, [{ type: 'clearActiveTextSource' }]);
} finally {
testGlobals.restore();
}
});
test('keyboard mode: lookup toggle closes popup when DOM visibility is the source of truth', async () => {
const { ctx, handlers, testGlobals } = createKeyboardHandlerHarness();

15
src/renderer/handlers/keyboard.ts
View File

@@ -15,6 +15,7 @@ export function createKeyboardHandlers(
handleSubsyncKeydown: (e: KeyboardEvent) => boolean;
handleKikuKeydown: (e: KeyboardEvent) => boolean;
handleJimakuKeydown: (e: KeyboardEvent) => boolean;
handleYoutubePickerKeydown: (e: KeyboardEvent) => boolean;
handleControllerSelectKeydown: (e: KeyboardEvent) => boolean;
handleControllerDebugKeydown: (e: KeyboardEvent) => boolean;
handleSessionHelpKeydown: (e: KeyboardEvent) => boolean;
@@ -479,6 +480,8 @@ export function createKeyboardHandlers(
function handleSubtitleContentUpdated(): void {
if (!ctx.state.keyboardDrivenModeEnabled) {
dispatchYomitanFrontendClearActiveTextSource();
clearNativeSubtitleSelection();
return;
}
if (pendingSelectionAnchorAfterSubtitleSeek) {
@@ -678,6 +681,11 @@ export function createKeyboardHandlers(
]);
if (modifierOnlyCodes.has(e.code)) return false;
const keyString = keyEventToString(e);
if (ctx.state.keybindingsMap.has(keyString)) {
return false;
}
if (!e.ctrlKey && !e.metaKey && !e.altKey && e.code === 'KeyM') {
if (e.repeat) return false;
dispatchYomitanPopupMineSelected();
@@ -834,6 +842,11 @@ export function createKeyboardHandlers(
options.handleJimakuKeydown(e);
return;
}
if (ctx.state.youtubePickerModalOpen) {
if (options.handleYoutubePickerKeydown(e)) {
return;
}
}
if (ctx.state.controllerSelectModalOpen) {
options.handleControllerSelectKeydown(e);
return;
@@ -871,8 +884,8 @@ export function createKeyboardHandlers(
) {
if (handleYomitanPopupKeybind(e)) {
e.preventDefault();
return;
}
return;
}
if (ctx.state.keyboardDrivenModeEnabled && handleKeyboardDrivenModeNavigation(e)) {

239
src/renderer/handlers/mouse.test.ts
View File

@@ -3,7 +3,10 @@ import test from 'node:test';
import type { SubtitleSidebarConfig } from '../../types';
import { createMouseHandlers } from './mouse.js';
import { YOMITAN_POPUP_HIDDEN_EVENT, YOMITAN_POPUP_SHOWN_EVENT } from '../yomitan-popup.js';
import {
YOMITAN_POPUP_HIDDEN_EVENT,
YOMITAN_POPUP_SHOWN_EVENT,
} from '../yomitan-popup.js';
function createClassList() {
const classes = new Set<string>();
@@ -18,6 +21,22 @@ function createClassList() {
classes.delete(token);
}
},
toggle: (token: string, force?: boolean) => {
if (force === undefined) {
if (classes.has(token)) {
classes.delete(token);
return false;
}
classes.add(token);
return true;
}
if (force) {
classes.add(token);
return true;
}
classes.delete(token);
return false;
},
contains: (token: string) => classes.has(token),
};
}
@@ -314,6 +333,74 @@ test('subtitle leave restores passthrough while embedded sidebar is open but not
}
});
test('restorePointerInteractionState reapplies the secondary hover class from pointer location', async () => {
const ctx = createMouseTestContext();
ctx.platform.shouldToggleMouseIgnore = true;
const documentListeners = new Map<string, Array<(event: MouseEvent | PointerEvent) => void>>();
const originalDocument = (globalThis as { document?: unknown }).document;
const originalWindow = (globalThis as { window?: unknown }).window;
const secondarySubContainer = ctx.dom.secondarySubContainer as unknown as object;
const overlay = ctx.dom.overlay as unknown as { classList: ReturnType<typeof createClassList> };
Object.defineProperty(globalThis, 'document', {
configurable: true,
value: {
addEventListener: (type: string, listener: (event: MouseEvent | PointerEvent) => void) => {
const listeners = documentListeners.get(type) ?? [];
listeners.push(listener);
documentListeners.set(type, listeners);
},
elementFromPoint: () => secondarySubContainer,
},
});
Object.defineProperty(globalThis, 'window', {
configurable: true,
value: {
electronAPI: {
setIgnoreMouseEvents: () => {},
},
innerHeight: 1000,
getSelection: () => ({ rangeCount: 0, isCollapsed: true }),
},
});
try {
const handlers = createMouseHandlers(ctx as never, {
modalStateReader: {
isAnySettingsModalOpen: () => false,
isAnyModalOpen: () => false,
},
applyYPercent: () => {},
getCurrentYPercent: () => 10,
persistSubtitlePositionPatch: () => {},
getSubtitleHoverAutoPauseEnabled: () => false,
getYomitanPopupAutoPauseEnabled: () => false,
getPlaybackPaused: async () => false,
sendMpvCommand: () => {},
});
handlers.setupPointerTracking();
await handlers.handleSecondaryMouseEnter({
clientX: 10,
clientY: 20,
} as unknown as MouseEvent);
handlers.restorePointerInteractionState();
overlay.classList.add('interactive');
const mousemove = documentListeners.get('mousemove')?.[0];
assert.ok(mousemove);
mousemove?.({ clientX: 10, clientY: 20 } as MouseEvent);
assert.equal(ctx.state.isOverSubtitle, true);
assert.equal(ctx.dom.secondarySubContainer.classList.contains('secondary-sub-hover-active'), true);
} finally {
Object.defineProperty(globalThis, 'document', { configurable: true, value: originalDocument });
Object.defineProperty(globalThis, 'window', { configurable: true, value: originalWindow });
}
});
test('pending hover pause check is ignored when mouse leaves before pause state resolves', async () => {
const ctx = createMouseTestContext();
const mpvCommands: Array<(string | number)[]> = [];
@@ -612,3 +699,153 @@ test('popup open pauses and popup close resumes when yomitan popup auto-pause is
Object.defineProperty(globalThis, 'Node', { configurable: true, value: previousNode });
}
});
test('restorePointerInteractionState re-enables subtitle hover when pointer is already over subtitles', () => {
const ctx = createMouseTestContext();
const originalWindow = globalThis.window;
const originalDocument = globalThis.document;
const ignoreCalls: Array<{ ignore: boolean; forward?: boolean }> = [];
const documentListeners = new Map<string, Array<(event: unknown) => void>>();
ctx.platform.shouldToggleMouseIgnore = true;
Object.defineProperty(globalThis, 'window', {
configurable: true,
value: {
electronAPI: {
setIgnoreMouseEvents: (ignore: boolean, options?: { forward?: boolean }) => {
ignoreCalls.push({ ignore, forward: options?.forward });
},
},
getComputedStyle: () => ({
visibility: 'hidden',
display: 'none',
opacity: '0',
}),
focus: () => {},
},
});
Object.defineProperty(globalThis, 'document', {
configurable: true,
value: {
addEventListener: (type: string, listener: (event: unknown) => void) => {
const bucket = documentListeners.get(type) ?? [];
bucket.push(listener);
documentListeners.set(type, bucket);
},
elementFromPoint: () => ctx.dom.subtitleContainer,
querySelectorAll: () => [],
body: {},
},
});
try {
const handlers = createMouseHandlers(ctx as never, {
modalStateReader: {
isAnySettingsModalOpen: () => false,
isAnyModalOpen: () => false,
},
applyYPercent: () => {},
getCurrentYPercent: () => 10,
persistSubtitlePositionPatch: () => {},
getSubtitleHoverAutoPauseEnabled: () => false,
getYomitanPopupAutoPauseEnabled: () => false,
getPlaybackPaused: async () => false,
sendMpvCommand: () => {},
});
handlers.setupPointerTracking();
for (const listener of documentListeners.get('mousemove') ?? []) {
listener({ clientX: 120, clientY: 240 });
}
handlers.restorePointerInteractionState();
assert.equal(ctx.state.isOverSubtitle, true);
assert.equal(ctx.dom.overlay.classList.contains('interactive'), true);
assert.deepEqual(ignoreCalls, [{ ignore: false, forward: undefined }]);
} finally {
Object.defineProperty(globalThis, 'window', { configurable: true, value: originalWindow });
Object.defineProperty(globalThis, 'document', { configurable: true, value: originalDocument });
}
});
test('restorePointerInteractionState keeps overlay interactive until first real pointer move can resync hover', () => {
const ctx = createMouseTestContext();
const originalWindow = globalThis.window;
const originalDocument = globalThis.document;
const ignoreCalls: Array<{ ignore: boolean; forward?: boolean }> = [];
const documentListeners = new Map<string, Array<(event: unknown) => void>>();
let hoveredElement: unknown = null;
ctx.platform.shouldToggleMouseIgnore = true;
Object.defineProperty(globalThis, 'window', {
configurable: true,
value: {
electronAPI: {
setIgnoreMouseEvents: (ignore: boolean, options?: { forward?: boolean }) => {
ignoreCalls.push({ ignore, forward: options?.forward });
},
},
getComputedStyle: () => ({
visibility: 'hidden',
display: 'none',
opacity: '0',
}),
focus: () => {},
},
});
Object.defineProperty(globalThis, 'document', {
configurable: true,
value: {
addEventListener: (type: string, listener: (event: unknown) => void) => {
const bucket = documentListeners.get(type) ?? [];
bucket.push(listener);
documentListeners.set(type, bucket);
},
elementFromPoint: () => hoveredElement,
querySelectorAll: () => [],
body: {},
},
});
try {
const handlers = createMouseHandlers(ctx as never, {
modalStateReader: {
isAnySettingsModalOpen: () => false,
isAnyModalOpen: () => false,
},
applyYPercent: () => {},
getCurrentYPercent: () => 10,
persistSubtitlePositionPatch: () => {},
getSubtitleHoverAutoPauseEnabled: () => false,
getYomitanPopupAutoPauseEnabled: () => false,
getPlaybackPaused: async () => false,
sendMpvCommand: () => {},
});
handlers.setupPointerTracking();
handlers.restorePointerInteractionState();
assert.equal(ctx.state.isOverSubtitle, false);
assert.equal(ctx.dom.overlay.classList.contains('interactive'), true);
assert.deepEqual(ignoreCalls, [
{ ignore: true, forward: true },
{ ignore: false, forward: undefined },
]);
hoveredElement = null;
for (const listener of documentListeners.get('mousemove') ?? []) {
listener({ clientX: 24, clientY: 48 });
}
assert.equal(ctx.state.isOverSubtitle, false);
assert.equal(ctx.dom.overlay.classList.contains('interactive'), false);
assert.deepEqual(ignoreCalls, [
{ ignore: true, forward: true },
{ ignore: false, forward: undefined },
{ ignore: true, forward: true },
]);
} finally {
Object.defineProperty(globalThis, 'window', { configurable: true, value: originalWindow });
Object.defineProperty(globalThis, 'document', { configurable: true, value: originalDocument });
}
});

81
src/renderer/handlers/mouse.ts
View File

@@ -25,6 +25,74 @@ export function createMouseHandlers(
let popupPauseRequestId = 0;
let pausedBySubtitleHover = false;
let pausedByYomitanPopup = false;
let lastPointerPosition: { clientX: number; clientY: number } | null = null;
let pendingPointerResync = false;
function isElementWithinContainer(element: Element | null, container: HTMLElement): boolean {
if (!element) {
return false;
}
if (element === container) {
return true;
}
return typeof container.contains === 'function' ? container.contains(element) : false;
}
function updatePointerPosition(event: MouseEvent | PointerEvent): void {
lastPointerPosition = {
clientX: event.clientX,
clientY: event.clientY,
};
}
function syncHoverStateFromPoint(clientX: number, clientY: number): boolean {
const hoveredElement =
typeof document.elementFromPoint === 'function'
? document.elementFromPoint(clientX, clientY)
: null;
const overPrimarySubtitle = isElementWithinContainer(hoveredElement, ctx.dom.subtitleContainer);
const overSecondarySubtitle = isElementWithinContainer(
hoveredElement,
ctx.dom.secondarySubContainer,
);
ctx.state.isOverSubtitle = overPrimarySubtitle || overSecondarySubtitle;
ctx.dom.secondarySubContainer.classList.toggle(
'secondary-sub-hover-active',
overSecondarySubtitle,
);
return ctx.state.isOverSubtitle;
}
function restorePointerInteractionState(): void {
const pointerPosition = lastPointerPosition;
pendingPointerResync = false;
if (pointerPosition) {
syncHoverStateFromPoint(pointerPosition.clientX, pointerPosition.clientY);
} else {
ctx.state.isOverSubtitle = false;
ctx.dom.secondarySubContainer.classList.remove('secondary-sub-hover-active');
}
syncOverlayMouseIgnoreState(ctx);
if (!ctx.platform.shouldToggleMouseIgnore || ctx.state.isOverSubtitle) {
return;
}
pendingPointerResync = true;
ctx.dom.overlay.classList.add('interactive');
window.electronAPI.setIgnoreMouseEvents(false);
}
function maybeResyncPointerHoverState(event: MouseEvent | PointerEvent): void {
if (!pendingPointerResync) {
return;
}
pendingPointerResync = false;
syncHoverStateFromPoint(event.clientX, event.clientY);
syncOverlayMouseIgnoreState(ctx);
}
function isWithinOtherSubtitleContainer(
relatedTarget: EventTarget | null,
@@ -222,6 +290,17 @@ export function createMouseHandlers(
});
}
function setupPointerTracking(): void {
document.addEventListener('mousemove', (event: MouseEvent) => {
updatePointerPosition(event);
maybeResyncPointerHoverState(event);
});
document.addEventListener('pointermove', (event: PointerEvent) => {
updatePointerPosition(event);
maybeResyncPointerHoverState(event);
});
}
function setupSelectionObserver(): void {
document.addEventListener('selectionchange', () => {
const selection = window.getSelection();
@@ -283,7 +362,9 @@ export function createMouseHandlers(
handleSecondaryMouseLeave: (event?: MouseEvent) => handleMouseLeave(event, true),
handleMouseEnter,
handleMouseLeave,
restorePointerInteractionState,
setupDragging,
setupPointerTracking,
setupResizeHandler,
setupSelectionObserver,
setupYomitanObserver,