feat(overlay): run session help commands with Enter or double-click (#275)

This commit is contained in:
2026-09-29 18:48:56 -07:00
committed by GitHub
parent 4e43c5c6e1
commit 0bbd8617f4
16 changed files with 701 additions and 49 deletions
@@ -0,0 +1,27 @@
import assert from 'node:assert/strict';
import test from 'node:test';
import { IPC_CHANNELS } from '../../shared/ipc/contracts';
import { openSessionHelpModal } from './session-help-open';
test('session help open tells the renderer whether commands can run', async () => {
for (const playing of [true, false]) {
const sent: Array<{ channel: string; payload: unknown }> = [];
const opened = await openSessionHelpModal({
ensureOverlayStartupPrereqs: () => {},
ensureOverlayWindowsReadyForVisibilityActions: () => {},
sendToActiveOverlayWindow: (channel, payload) => {
sent.push({ channel, payload });
return true;
},
waitForModalOpen: async () => true,
logWarn: () => {},
isMediaPlaybackActive: () => playing,
});
assert.equal(opened, true);
assert.deepEqual(sent, [
{ channel: IPC_CHANNELS.event.sessionHelpOpen, payload: { commandsEnabled: playing } },
]);
}
});
+11 -3
View File
@@ -1,5 +1,6 @@
import type { OverlayHostedModal } from '../../shared/ipc/contracts';
import { IPC_CHANNELS } from '../../shared/ipc/contracts';
import type { SessionHelpOpenPayload } from '../../types/runtime';
import { openOverlayHostedModal, retryOverlayModalOpen } from './overlay-hosted-modal-open';
const SESSION_HELP_MODAL: OverlayHostedModal = 'session-help';
@@ -18,6 +19,8 @@ export async function openSessionHelpModal(deps: {
) => boolean;
waitForModalOpen: (modal: OverlayHostedModal, timeoutMs: number) => Promise<boolean>;
logWarn: (message: string) => void;
/** True when mpv has a video loaded; gates running commands from help rows. */
isMediaPlaybackActive: () => boolean;
}): Promise<boolean> {
return await retryOverlayModalOpen(
{
@@ -29,8 +32,11 @@ export async function openSessionHelpModal(deps: {
timeoutMs: SESSION_HELP_OPEN_TIMEOUT_MS,
retryWarning:
'Session help modal did not acknowledge modal open on first attempt; retrying dedicated modal window.',
sendOpen: () =>
openOverlayHostedModal(
sendOpen: () => {
const payload: SessionHelpOpenPayload = {
commandsEnabled: deps.isMediaPlaybackActive(),
};
return openOverlayHostedModal(
{
ensureOverlayStartupPrereqs: deps.ensureOverlayStartupPrereqs,
ensureOverlayWindowsReadyForVisibilityActions:
@@ -40,9 +46,11 @@ export async function openSessionHelpModal(deps: {
{
channel: IPC_CHANNELS.event.sessionHelpOpen,
modal: SESSION_HELP_MODAL,
payload,
preferModalWindow: true,
},
),
);
},
},
);
}