Files
SubMiner/docs/architecture/domains.md
T
sudacode ffbbe698fc fix(overlay): reload imported mpv keys after mpv connects (#278)
* fix(overlay): reload imported mpv keys after mpv connects

The overlay fetched mpv's input-bindings before SubMiner connected to mpv,
cached an empty list, and never refetched because the connect-time refresh
only broadcast session bindings when their compiled signature changed. Keys
from input.conf and mpv defaults (9/0 volume, m mute) then did nothing while
the overlay had focus, most often in mpv.backend x11 mode.

Main now emits mpv-input-bindings:changed whenever the discovered mpv key
set or client changes, and the renderer refreshes its imported keys on it.

* fix(overlay): subscribe to mpv key changes before initial discovery

The renderer registered the mpv-input-bindings:changed listener only after awaiting setupMpvInputForwarding and several other startup calls. If mpv connected in that window, the event was dropped and the imported mpv keys stayed empty.
2026-09-30 23:24:39 -07:00

6.8 KiB

Domain Ownership

Status: active Last verified: 2026-07-15 Owner: Kyle Yasuda Read when: you need to find the owner module for a behavior or test surface

Runtime Domains

  • Desktop app runtime: src/main.ts, src/main/, src/core/services/
  • Overlay renderer: src/renderer/
  • Launcher CLI: launcher/
  • mpv plugin: plugin/subminer/

Product / Integration Domains

  • Config system: src/config/; Anki resolution is composed by src/config/resolve/anki-connect.ts from focused resolvers in src/config/resolve/anki-connect/
  • Overlay/window state: src/core/services/overlay-*, src/main/overlay-*.ts
  • MPV runtime and protocol: src/core/services/mpv*.ts Windows executable lookup and detached process creation are shared in src/main/runtime/mpv-process.ts. The Windows launcher and Jellyfin handlers retain their own playback and connection workflows.
  • Subtitle/token pipeline: src/core/services/subtitle-*.ts, src/core/services/tokenizer*, src/core/services/tokenizer/, src/subsync/
  • Anki workflow: src/anki-integration/, src/core/services/anki-jimaku*.ts
  • Media timing review: src/main/runtime/media-timing-review.ts owns the review and hidden MediaTimingPreviewSession. The session waits for mpv readiness and acknowledges playback commands; its time-pos observations reach the modal through media-timing-review:preview-position. The renderer places the cursor from those timestamps and uses an inactivity timeout instead of timing the clip itself.
  • Immersion tracking: src/core/services/immersion-tracker/ Includes stats storage/query schema such as imm_videos, imm_media_art, and imm_youtube_videos for per-video and YouTube-specific library metadata. Library-entry identity aliases and merge recommendations are persisted alongside this schema; the stats HTTP and SPA layers only expose and present those domain decisions. delete-maintenance-scheduler.ts coalesces and serializes stats deletes; the expensive work runs in delete-maintenance-worker-thread.ts while the tracker queues playback writes. Each batch uses one transaction, lexical update, rollup refresh, and incremental lifetime subtraction (planLifetimeRemovals/applyLifetimeRemovals in lifetime.ts). Merges, moves, AniList reassignments, and stats cleanup -l use repairLifetimeSummariesFromMedia (recompute from the per-video media ledger). The full lifetime rebuild survives only as the empty-table bootstrap; anywhere else it would collapse lifetime totals to the session retention window.
  • Immersion sync: src/core/services/stats-sync/, bound by src/main/sync-cli.ts. snapshot-transfer.ts selects compressed rsync or scp. transfer-cache.ts atomically retains the last successfully received snapshot per hashed peer/database identity under the config directory's sync-transfer-cache/. Cache copies seed isolated transfer directories; rsync verifies reconstructed files before the existing merge engine runs. The --make-temp / --remove-temp helpers accept an internal --transfer-cache key, with a fallback for older peers that do not recognize it.
  • AniList tracking + character dictionary: src/core/services/anilist/, src/main/runtime/composers/anilist-*, src/main/character-dictionary-runtime.ts, src/main/character-dictionary-runtime/
  • TMDB live-action metadata: src/core/services/tmdb/ (client + exact-title resolver), src/core/services/immersion-tracker/live-action-link.ts (links an entry to a TMDB title and merges other holders of the same title). The AniList cover-art fetcher calls the resolver as its fallback; imm_anime.media_kind marks the result and keeps the entry out of AniList season repair.
  • Jellyfin integration: src/core/services/jellyfin*.ts, src/main/runtime/composers/jellyfin-*
  • Window trackers: src/window-trackers/
  • Stats HTTP app: src/core/services/stats-server.ts, with route groups and shared route support in src/core/services/stats-server/
  • Stats SPA: stats/
  • Public docs site: docs-site/

Shared Contract Entry Points

Automatic mpv keyboard discovery uses the get-mpv-input-bindings IPC request and MpvInputBindingsSnapshot in src/types/session-bindings.ts. src/main/runtime/mpv-input-bindings.ts queries the connected player and preserves configured keys, including disabled entries. src/shared/mpv-input-bindings.ts validates discovered keys and translates browser input. The renderer's handlers/mpv-input-forwarding.ts keeps the session lookup, coalesces asynchronous refreshes, and releases held keys on blur or disposal. handlers/keyboard.ts runs this fallback after SubMiner controls and refreshes on startup, a delayed startup pass, focus, binding reload, and the mpv-input-bindings:changed event. Main sends that event from session-bindings-runtime.ts when mpv's discovered key set changes, including the first discovery after connecting, because the overlay often loads before mpv connects and the compiled session bindings may not change. Discovery does not enter compiled session bindings, the plugin artifact, persistent config, or session help.

The subtitle sidebar consumes parsed cues through SubtitleSidebarSnapshot. Its sourceKey identifies the media and subtitle source so renderer selections are invalidated on source changes, including changes whose cue text and timings are identical. Native selection and clean clipboard serialization live in src/renderer/modals/subtitle-sidebar-selection.ts. Electron lets standard Copy input reach the renderer, where sidebar selection takes priority over the live-subtitle binding. The preload bridge writes selections through Electron's clipboard API so copying does not depend on Chromium document focus or require activating the overlay window.

  • Config + app-state contracts: src/types/config.ts
  • Subtitle/token/media annotation contracts: src/types/subtitle.ts
  • Runtime/window/controller/Electron bridge contracts: src/types/runtime.ts
  • Anki-specific contracts: src/types/anki.ts
  • External integration contracts: src/types/integrations.ts
  • Runtime-option contracts: src/types/runtime-options.ts
  • Settings UI contracts: src/types/settings.ts
  • Session-binding contracts: src/types/session-bindings.ts
  • Stats HTTP wire contracts: src/types/stats-wire.ts, src/types/stats-http-contract.ts
  • Compatibility-only barrel: src/types.ts

Ownership Heuristics

  • Runtime wiring or dependency setup: start in src/main/
  • Business logic or service behavior: start in src/core/services/
  • UI interaction or overlay DOM behavior: start in src/renderer/
  • Command parsing or mpv launch flow: start in launcher/
  • Shared contract changes: add or edit the narrowest src/types/<domain>.ts entrypoint; only touch src/types.ts for compatibility exports.
  • User-facing docs: docs-site/
  • Internal process/docs: docs/