import assert from 'node:assert/strict'; import test from 'node:test'; import { createOverlayVisibilityDiagnostics, readOverlayVisibilitySnapshot, type OverlayVisibilitySnapshot, } from './overlay-visibility-diagnostics'; type SnapshotArgs = Parameters[0]; function snapshotFor( options: { tracking?: boolean; targetPid?: number | null; minimized?: boolean; window?: Record; noTracker?: boolean; } & Pick & { visibleOverlayVisible?: boolean; } = {}, ) { const tracker = { isTracking: () => options.tracking ?? false, getGeometry: () => null, isTargetWindowFocused: () => false, isTargetWindowMinimized: () => options.minimized ?? false, getDiagnosticState: () => ({ targetPid: options.targetPid ?? null, socketPath: '/tmp/mpv' }), }; return readOverlayVisibilitySnapshot({ mainWindow: { isDestroyed: () => false, isVisible: () => false, getOpacity: () => 0, ...options.window, } as unknown as SnapshotArgs['mainWindow'], windowTracker: options.noTracker ? null : (tracker as unknown as SnapshotArgs['windowTracker']), visibleOverlayVisible: options.visibleOverlayVisible ?? true, modalActive: options.modalActive, suspendVisibleOverlay: options.suspendVisibleOverlay, }); } function harness() { let now = 0; let callback: (() => void) | null = null; let delay = 0; const warnings: Array<{ message: string; details: Record }> = []; let snapshot: OverlayVisibilitySnapshot | null = { expectedVisible: true, visible: false, opacity: 0, contentReady: false, tracking: false, targetPid: 4242, pidLookupPending: false, }; const diagnostics = createOverlayVisibilityDiagnostics({ now: () => now, warn: (message, details) => warnings.push({ message, details }), schedule: (fn, ms) => { callback = fn; delay = ms; return { unref() {} } as ReturnType; }, cancel: () => { callback = null; }, }); const update = () => diagnostics.update(() => snapshot); return { warnings, update, setSnapshot: (value: typeof snapshot) => { snapshot = value; }, tick: () => { assert.ok(callback, 'watchdog must be scheduled'); now += delay; callback(); }, scheduled: () => callback !== null, }; } test('visibility watchdog warns without more events and rate limits repeated polls', () => { const h = harness(); h.update(); assert.equal(h.warnings.length, 0); for (let i = 0; i < 100; i += 1) h.update(); h.tick(); assert.equal(h.warnings.length, 1); assert.equal(h.warnings[0]?.details.reason, 'mpv-window-not-tracked'); assert.equal(h.warnings[0]?.details.targetPid, 4242); assert.equal(h.warnings[0]?.details.elapsedMs, 5_000); for (let i = 0; i < 100; i += 1) h.update(); assert.equal(h.warnings.length, 1); h.tick(); assert.equal(h.warnings[1]?.details.elapsedMs, 35_000); }); test('visibility watchdog distinguishes renderer readiness, hidden windows and opacity', () => { for (const [contentReady, visible, opacity, reason] of [ [false, false, 0, 'renderer-not-ready'], [true, false, 0, 'window-hidden'], [true, true, 0, 'window-transparent'], ] as const) { const h = harness(); h.setSnapshot({ expectedVisible: true, tracking: true, contentReady, visible, opacity }); h.update(); h.tick(); assert.equal(h.warnings[0]?.details.reason, reason); } }); test('visibility watchdog reports recovery only after warning and stops', () => { const h = harness(); h.update(); h.tick(); h.setSnapshot({ expectedVisible: true, visible: true, opacity: 1, contentReady: true, tracking: true, }); h.tick(); assert.match(h.warnings[1]!.message, /recovered/); assert.equal(h.scheduled(), false); h.update(); assert.equal(h.warnings.length, 2); }); test('visibility watchdog stays quiet after fast startup, intentional hide or window destruction', () => { for (const snapshot of [ { expectedVisible: true, visible: true, opacity: 1, contentReady: true, tracking: true }, { expectedVisible: false, visible: false, opacity: 0, contentReady: false, tracking: false }, null, ]) { const h = harness(); h.update(); h.setSnapshot(snapshot); h.tick(); assert.deepEqual(h.warnings, []); assert.equal(h.scheduled(), false); } }); test('overlay snapshot expects visibility only once an mpv has been identified', () => { // Requested before any mpv exists: auto_start_overlay, tray or --show-visible-overlay. assert.equal(snapshotFor()?.expectedVisible, false); assert.equal(snapshotFor({ noTracker: true })?.expectedVisible, false); // mpv answered on the socket but its window never matched, so tracking never started. assert.equal(snapshotFor({ targetPid: 4242 })?.expectedVisible, true); // A tracker with no target socket matches windows without ever learning a PID. assert.equal(snapshotFor({ tracking: true })?.expectedVisible, true); }); test('overlay snapshot does not expect an intentionally hidden overlay', () => { const identified = { targetPid: 4242, tracking: true }; assert.equal(snapshotFor(identified)?.expectedVisible, true); assert.equal(snapshotFor({ ...identified, modalActive: true })?.expectedVisible, false); assert.equal(snapshotFor({ ...identified, suspendVisibleOverlay: true })?.expectedVisible, false); assert.equal(snapshotFor({ ...identified, minimized: true })?.expectedVisible, false); assert.equal( snapshotFor({ ...identified, visibleOverlayVisible: false })?.expectedVisible, false, ); }); test('overlay snapshot carries tracker state, defaults opacity and ends with the window', () => { const snapshot = snapshotFor({ targetPid: 4242, window: { getOpacity: undefined } }); assert.equal(snapshot?.targetPid, 4242); assert.equal(snapshot?.socketPath, '/tmp/mpv'); assert.equal(snapshot?.opacity, 1); assert.equal(snapshotFor({ window: { isDestroyed: () => true } }), null); });