mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-04-04 06:12:06 -07:00
Compare commits
7 Commits
refactor-m
...
v0.11.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
09d8b52fbf
|
|||
|
0edd566904
|
|||
|
6eb1b0f197
|
|||
|
e4137d9760
|
|||
|
864f4124ae
|
|||
| 7514985feb | |||
| d6c72806bb |
52
CHANGELOG.md
52
CHANGELOG.md
@@ -1,9 +1,57 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## Unreleased
|
## v0.11.0 (2026-04-03)
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Overlay: Added a playlist browser overlay modal for browsing sibling video files and the live mpv queue during playback.
|
||||||
|
- Overlay: Added the default `Ctrl+Alt+P` keybinding to open the playlist browser and manage queue order without leaving playback.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Setup: Made mpv plugin installation mandatory in the first-run setup flow, removed the skip path, and kept Finish disabled until the plugin is installed.
|
||||||
|
- Setup: Clarified that the mpv plugin requirement applies to setup on every platform, while the optional `SubMiner mpv` shortcut remains the recommended Windows playback entry point.
|
||||||
|
- Launcher: Streamlined Windows setup and config by making the `SubMiner mpv` shortcut self-contained and keeping `mpv.executablePath` as the simple fallback when `mpv.exe` is not on `PATH`.
|
||||||
|
- Overlay: Changed fresh-install default config to keep texthooker and stats from auto-opening browser tabs.
|
||||||
|
- Overlay: Changed fresh-install default config to enable AnkiConnect, Discord Rich Presence, subtitle-sidebar, and Yomitan-popup auto-pause by default, while disabling controller input by default.
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- AniList: Stopped post-watch tracking from sending a second progress update when the current episode was already satisfied by a ready retry item in the same watch-completion pass.
|
- Main: Resolve the YouTube playback socket path lazily so startup honors CLI and config overrides.
|
||||||
|
- Main: Add regression coverage for the lazy socket-path lookup during Windows mpv startup.
|
||||||
|
- Main: Keep integrated `--start --texthooker` launches on the full app-ready startup path so the texthooker page and websocket servers start together during normal playback startup.
|
||||||
|
- Main: Stop the mpv/plugin auto-start flow from spawning a separate standalone texthooker helper during normal `subminer <video>` launches.
|
||||||
|
- Overlay: Keep tracked macOS visible overlays click-through by default so subtitle sidebar passthrough works immediately without requiring a subtitle hover cycle first.
|
||||||
|
- Overlay: Add regression coverage for the macOS visible-overlay passthrough default.
|
||||||
|
- Anilist: Stop AniList post-watch from sending a second progress update when the current episode was already satisfied by a ready retry item in the same watch-completion pass.
|
||||||
|
- Anilist: Add regression coverage for the retry-queue plus live-update duplicate path.
|
||||||
|
- Overlay: Fixed Kiku duplicate grouping to reuse duplicate note IDs from both generic sentence-card creation and Yomitan popup mining instead of running extra duplicate scans after add.
|
||||||
|
- Overlay: Fixed the Yomitan popup mining flow to add cards in the background while keeping the stock popup progress feedback, then pause playback and close the lookup popup before the Kiku merge modal opens.
|
||||||
|
- Overlay: Fixed configured subtitle-jump keybindings so backward and forward subtitle seeks keep playback paused when invoked from a paused state.
|
||||||
|
- Launcher: Fixed the Windows `SubMiner mpv` shortcut and `SubMiner.exe --launch-mpv` flow to launch mpv with SubMiner's required default args directly instead of requiring an `mpv.conf` profile named `subminer`.
|
||||||
|
- Launcher: Clarified the Windows install and usage docs so the shortcut path is documented as self-contained, while the optional `subminer` mpv profile remains available for manual mpv launches.
|
||||||
|
- Launcher: Hardened the first-run setup blocker copy and stale custom-scheme handling so setup messages stay aligned with config, plugin, and dictionary readiness.
|
||||||
|
- Launcher: Fixed the Windows `SubMiner mpv` shortcut idle launch so loading a video after opening the shortcut keeps mpv in the expected SubMiner-managed session, auto-starts the overlay, and re-arms subtitle auto-selection for the newly opened file.
|
||||||
|
- Launcher: Removed the redundant `.` subtitle search path from the Windows shortcut launch args and deduped repeated subtitle source tracks in the manual sync picker so duplicate external subtitle entries no longer appear from the shortcut path.
|
||||||
|
- Playback: Fixed managed local playback so duplicate startup-ready retries no longer unpause media after a later manual pause on the same file.
|
||||||
|
- Playback: Fixed managed local subtitle auto-selection so local files reuse configured primary and secondary subtitle language priorities instead of staying on mpv's initial `sid=auto` guess.
|
||||||
|
- Launcher: Added a blank-by-default `mpv.executablePath` override for Windows playback so users can point SubMiner at `mpv.exe` when it is not on `PATH`.
|
||||||
|
- Launcher: Kept the Windows shortcut and `--launch-mpv` flow simple by preserving PATH auto-discovery as the default and exposing the override in first-run setup.
|
||||||
|
- Launcher: Added `windows` as a recognized launcher backend option and auto-detection target on Windows.
|
||||||
|
- Launcher: Honored `SUBMINER_YTDLP_BIN` consistently across YouTube playback URL resolution, track probing, subtitle downloads, and metadata probing.
|
||||||
|
- Launcher: Kept the first-run setup window from navigating away on unexpected URLs.
|
||||||
|
- Launcher: Made Windows mpv honor an explicitly configured executable path instead of silently falling back to PATH.
|
||||||
|
- Launcher: Hardened `--launch-mpv` parsing and Windows binary resolution so valueless flags do not swallow media targets and symlinked launcher installs do not short-circuit PATH lookup.
|
||||||
|
- Launcher: Fixed first-run setup blocking playback on macOS when the SubMiner mpv plugin was already installed at the canonical `~/.config/mpv` path.
|
||||||
|
- Launcher: Fixed setup gating so stale cancelled setup state no longer prevents playback when the canonical mpv plugin entrypoint already exists.
|
||||||
|
- Playback: Prevented stale async playlist-browser subtitle rearm callbacks from overriding newer subtitle selections during rapid file changes.
|
||||||
|
|
||||||
|
### Docs
|
||||||
|
- Docs Site: Added a dedicated Subtitle Sidebar guide and linked it from the homepage and configuration docs.
|
||||||
|
- Docs Site: Linked Jimaku integration from the homepage to its dedicated docs page.
|
||||||
|
- Docs Site: Refreshed docs-site theme tokens and hover/selection styling for the updated pages.
|
||||||
|
|
||||||
|
### Internal
|
||||||
|
- Release: Retried AUR clone and push operations in the tagged release workflow.
|
||||||
|
- Release: Kept GitHub Releases green when AUR publish flakes and needs manual follow-up.
|
||||||
|
- Release: Updated Electron to 39.8.6 and pinned patched transitive build dependencies to clear the reported high-severity audit findings.
|
||||||
|
|
||||||
## v0.10.0 (2026-03-29)
|
## v0.10.0 (2026-03-29)
|
||||||
|
|
||||||
|
|||||||
20
README.md
20
README.md
@@ -21,6 +21,8 @@ Look up words with Yomitan, export to Anki in one key, track your immersion —
|
|||||||
|
|
||||||
SubMiner runs as an invisible Electron overlay on top of mpv. Subtitles render as an interactive layer. Move your cursor over any word and trigger a [Yomitan](https://github.com/yomidevs/yomitan) lookup. Press one key to snapshot the sentence, audio, and screenshot into Anki via AnkiConnect.
|
SubMiner runs as an invisible Electron overlay on top of mpv. Subtitles render as an interactive layer. Move your cursor over any word and trigger a [Yomitan](https://github.com/yomidevs/yomitan) lookup. Press one key to snapshot the sentence, audio, and screenshot into Anki via AnkiConnect.
|
||||||
|
|
||||||
|
First-run setup requires the mpv plugin before it can finish. On Windows, the optional `SubMiner mpv` shortcut created during setup is the recommended playback entry point because it launches `mpv` with SubMiner's defaults directly, so you do not need an `mpv.conf` profile just to use it.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
### Dictionary Lookups
|
### Dictionary Lookups
|
||||||
@@ -67,6 +69,8 @@ Local stats dashboard — watch time, anime library, vocabulary growth, mining t
|
|||||||
|
|
||||||
Browse sibling episode files and the active mpv queue in one overlay modal. Open it with `Ctrl+Alt+P` to append episodes from the current directory, jump to queued items, remove entries, or reorder the playlist without leaving playback.
|
Browse sibling episode files and the active mpv queue in one overlay modal. Open it with `Ctrl+Alt+P` to append episodes from the current directory, jump to queued items, remove entries, or reorder the playlist without leaving playback.
|
||||||
|
|
||||||
|
Managed local playback now reapplies your configured subtitle language priorities after mpv loads track metadata, so mixed subtitle sets can settle onto the expected primary and secondary tracks instead of staying on mpv's initial `sid=auto` guess.
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
### Integrations
|
### Integrations
|
||||||
@@ -74,7 +78,7 @@ Browse sibling episode files and the active mpv queue in one overlay modal. Open
|
|||||||
<table>
|
<table>
|
||||||
<tr>
|
<tr>
|
||||||
<td><b>YouTube</b></td>
|
<td><b>YouTube</b></td>
|
||||||
<td>Auto-loaded yt-dlp subtitle tracks at startup with a manual overlay picker on demand (<code>Ctrl+Alt+C</code>)</td>
|
<td>Auto-loaded yt-dlp subtitle tracks at startup with config-driven primary/secondary language priorities and a manual overlay picker on demand (<code>Ctrl+Alt+C</code>)</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><b>AniList</b></td>
|
<td><b>AniList</b></td>
|
||||||
@@ -108,12 +112,12 @@ Browse sibling episode files and the active mpv queue in one overlay modal. Open
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
| | Required | Optional |
|
| | Required | Optional |
|
||||||
| -------------- | --------------------------------------- | -------------------------------------- |
|
| -------------- | --------------------------------------- | ---------------------------------------------------------- |
|
||||||
| **Player** | [`mpv`](https://mpv.io) with IPC socket | — |
|
| **Player** | [`mpv`](https://mpv.io) with IPC socket | — |
|
||||||
| **Processing** | `ffmpeg`, `mecab` + `mecab-ipadic` | `guessit` (AniSkip), `alass` / `ffsubsync` (subtitle sync) |
|
| **Processing** | `ffmpeg`, `mecab` + `mecab-ipadic` | `guessit` (AniSkip), `alass` / `ffsubsync` (subtitle sync) |
|
||||||
| **Media** | — | `yt-dlp`, `chafa`, `ffmpegthumbnailer` |
|
| **Media** | — | `yt-dlp`, `chafa`, `ffmpegthumbnailer` |
|
||||||
| **Selection** | — | `fzf` / `rofi` |
|
| **Selection** | — | `fzf` / `rofi` |
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> [`bun`](https://bun.sh) is required if building from source or using the CLI wrapper: `subminer`. Pre-built releases (AppImage, DMG, installer) do not require it.
|
> [`bun`](https://bun.sh) is required if building from source or using the CLI wrapper: `subminer`. Pre-built releases (AppImage, DMG, installer) do not require it.
|
||||||
@@ -224,7 +228,7 @@ See the [build-from-source guide](https://docs.subminer.moe/installation#from-so
|
|||||||
|
|
||||||
### 2. First Launch
|
### 2. First Launch
|
||||||
|
|
||||||
Run the app. On first launch SubMiner starts in the system tray, creates a default config, and opens a setup popup to install the mpv plugin and configure Yomitan dictionaries.
|
Run the app. On first launch SubMiner starts in the system tray, creates a default config, and opens a setup popup to finish config, install the mpv plugin, and configure Yomitan dictionaries.
|
||||||
|
|
||||||
### 3. Mine
|
### 3. Mine
|
||||||
|
|
||||||
@@ -236,8 +240,6 @@ subminer stats -b # stats daemon in background
|
|||||||
subminer stats -s # stop background stats daemon
|
subminer stats -s # stop background stats daemon
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Full guides on configuration, Anki setup, Jellyfin, immersion tracking, and more: **[docs.subminer.moe](https://docs.subminer.moe)**
|
Full guides on configuration, Anki setup, Jellyfin, immersion tracking, and more: **[docs.subminer.moe](https://docs.subminer.moe)**
|
||||||
|
|||||||
BIN
assets/SubMiner-square.png
Normal file
BIN
assets/SubMiner-square.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.5 MiB |
BIN
assets/SubMiner.ico
Normal file
BIN
assets/SubMiner.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 65 KiB |
@@ -0,0 +1,39 @@
|
|||||||
|
---
|
||||||
|
id: TASK-272
|
||||||
|
title: 'Assess and address PR #40 CodeRabbit review follow-ups'
|
||||||
|
status: Done
|
||||||
|
assignee: []
|
||||||
|
created_date: '2026-04-03 07:52'
|
||||||
|
updated_date: '2026-04-03 08:04'
|
||||||
|
labels:
|
||||||
|
- coderabbit
|
||||||
|
- review
|
||||||
|
- launcher
|
||||||
|
milestone: 'PR #40'
|
||||||
|
dependencies: []
|
||||||
|
references:
|
||||||
|
- 'https://github.com/ksyasuda/SubMiner/pull/40'
|
||||||
|
priority: medium
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||||
|
Implement the valid CodeRabbit findings on PR #40 and keep the Windows mpv shortcut / first-run setup flow consistent end to end.
|
||||||
|
<!-- SECTION:DESCRIPTION:END -->
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
<!-- AC:BEGIN -->
|
||||||
|
- [ ] #1 Windows binary resolution does not return install directories as executable candidates
|
||||||
|
- [ ] #2 Launch-mpv arg parsing preserves space-separated mpv option values and target separation
|
||||||
|
- [ ] #3 Windows mpv launch args keep the final input-ipc-server and script-opts socket path in sync when custom values are supplied
|
||||||
|
- [ ] #4 First-run setup navigation swallows stale or invalid custom-scheme actions without navigating away
|
||||||
|
- [ ] #5 Setup messaging and footer copy reflect configReady, plugin, and dictionary gates consistently
|
||||||
|
- [ ] #6 Regression tests cover the fixed behaviors
|
||||||
|
<!-- AC:END -->
|
||||||
|
|
||||||
|
## Final Summary
|
||||||
|
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:BEGIN -->
|
||||||
|
Addressed CodeRabbit follow-ups for PR #40. Hardened launcher binary discovery on Windows and PATH resolution, fixed launch-mpv argument parsing for value-bearing flags, synced custom Windows mpv IPC socket values into script opts, and tightened first-run setup messaging/navigation to handle stale actions and blocker copy. Verified with `bun test src/main-entry-runtime.test.ts src/main/runtime/windows-mpv-launch.test.ts src/main/runtime/first-run-setup-window.test.ts launcher/mpv.test.ts`.
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:END -->
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
---
|
||||||
|
id: TASK-263
|
||||||
|
title: Reuse pre-add duplicate IDs for generic Kiku field grouping
|
||||||
|
status: Done
|
||||||
|
assignee: []
|
||||||
|
created_date: '2026-03-31 20:44'
|
||||||
|
updated_date: '2026-03-31 20:48'
|
||||||
|
labels:
|
||||||
|
- anki
|
||||||
|
- kiku
|
||||||
|
dependencies: []
|
||||||
|
priority: high
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||||
|
Avoid the extra post-add duplicate lookup on the generic sentence-card creation path by capturing duplicate note IDs before add and reusing that result for Kiku field grouping. Keep Yomitan semantics aligned where practical so duplicate selection is consistent across mining paths.
|
||||||
|
<!-- SECTION:DESCRIPTION:END -->
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
<!-- AC:BEGIN -->
|
||||||
|
- [x] #1 Generic sentence-card creation captures duplicate note IDs before add and reuses them for Kiku field grouping instead of running the existing post-add duplicate finder
|
||||||
|
- [x] #2 Duplicate selection remains deterministic when multiple matching notes exist
|
||||||
|
- [x] #3 Regression tests cover the generic path duplicate reuse behavior and preserve existing non-Kiku behavior
|
||||||
|
- [x] #4 Internal docs/config comments are updated if the behavior or operator-facing semantics changed
|
||||||
|
<!-- AC:END -->
|
||||||
|
|
||||||
|
## Implementation Notes
|
||||||
|
|
||||||
|
<!-- SECTION:NOTES:BEGIN -->
|
||||||
|
No docs update was required because this is internal duplicate-selection plumbing and does not change user-facing config surface.
|
||||||
|
<!-- SECTION:NOTES:END -->
|
||||||
|
|
||||||
|
## Final Summary
|
||||||
|
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:BEGIN -->
|
||||||
|
Generic sentence-card creation now captures exact duplicate note IDs before add when Kiku field grouping is enabled and stores that context by created note ID. Manual field grouping reuses the tracked duplicate IDs first and deterministically picks the most recent matching note, falling back to the legacy duplicate finder only when no tracked context exists. Verified with bun test src/anki-integration/duplicate.test.ts src/anki-integration/card-creation.test.ts src/anki-integration/field-grouping.test.ts and bun run typecheck.
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:END -->
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
---
|
||||||
|
id: TASK-263.1
|
||||||
|
title: Reuse Yomitan popup duplicate IDs in SubMiner bridge
|
||||||
|
status: Done
|
||||||
|
assignee: []
|
||||||
|
created_date: '2026-03-31 22:15'
|
||||||
|
updated_date: '2026-03-31 22:21'
|
||||||
|
labels:
|
||||||
|
- anki
|
||||||
|
- kiku
|
||||||
|
- yomitan
|
||||||
|
dependencies: []
|
||||||
|
parent_task_id: TASK-263
|
||||||
|
priority: high
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||||
|
Thread Yomitan popup/search duplicate note IDs through the existing SubMiner bridge so Kiku/manual grouping can reuse the same duplicate context that already drives the Add duplicate button. Implement and test against the vendored Yomitan copy first; do not rely on upstreamed fork changes yet.
|
||||||
|
<!-- SECTION:DESCRIPTION:END -->
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
<!-- AC:BEGIN -->
|
||||||
|
- [x] #1 Vendored Yomitan bridge returns duplicate note IDs for popup/search mining when available
|
||||||
|
- [x] #2 SubMiner consumes the bridged duplicate IDs and prefers them for Kiku/manual grouping on the Yomitan mining path
|
||||||
|
- [x] #3 Regression tests cover the popup/search bridge payload and duplicate-id reuse behavior
|
||||||
|
- [x] #4 No commit is made for vendored Yomitan-only changes in this repo state
|
||||||
|
<!-- AC:END -->
|
||||||
|
|
||||||
|
## Implementation Notes
|
||||||
|
|
||||||
|
<!-- SECTION:NOTES:BEGIN -->
|
||||||
|
Vendored files changed locally for validation only: vendor/subminer-yomitan/ext/js/display/display-anki.js, vendor/subminer-yomitan/ext/js/comm/api.js, vendor/subminer-yomitan/ext/js/comm/anki-connect.js, vendor/subminer-yomitan/ext/js/background/backend.js. Do not commit those vendor changes in this repo; port them to the fork instead.
|
||||||
|
<!-- SECTION:NOTES:END -->
|
||||||
|
|
||||||
|
## Final Summary
|
||||||
|
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:BEGIN -->
|
||||||
|
Vendored Yomitan popup/search mining now precomputes duplicate note IDs, sends them to the SubMiner Anki proxy as private addNote metadata, and still returns note/duplicate data through the parser bridge. The proxy strips the private metadata before forwarding to upstream AnkiConnect, associates the duplicate IDs with the created note before auto-enrichment begins, and SubMiner also records the bridge result as a secondary cache path. Verified with bun test src/anki-integration/duplicate.test.ts src/anki-integration/card-creation.test.ts src/anki-integration/field-grouping.test.ts src/anki-integration/anki-connect-proxy.test.ts src/core/services/tokenizer/yomitan-parser-runtime.test.ts and bun run typecheck.
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:END -->
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
id: TASK-263.2
|
||||||
|
title: >-
|
||||||
|
Keep Yomitan popup responsive during background add and pause/close before
|
||||||
|
Kiku modal
|
||||||
|
status: Done
|
||||||
|
assignee: []
|
||||||
|
created_date: '2026-04-01 00:42'
|
||||||
|
updated_date: '2026-04-01 02:35'
|
||||||
|
labels:
|
||||||
|
- anki
|
||||||
|
- yomitan
|
||||||
|
- kiku
|
||||||
|
- ux
|
||||||
|
dependencies: []
|
||||||
|
parent_task_id: TASK-263
|
||||||
|
priority: high
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||||
|
Make Yomitan popup add run in background without blocking popup responsiveness. Before opening Kiku field-grouping modal, pause MPV and close the Yomitan popup/parser window if open.
|
||||||
|
<!-- SECTION:DESCRIPTION:END -->
|
||||||
|
|
||||||
|
## Definition of Done
|
||||||
|
<!-- DOD:BEGIN -->
|
||||||
|
- [x] #1 Popup save path returns immediately and prevents duplicate submits
|
||||||
|
- [x] #2 Field-grouping modal request pauses MPV and closes Yomitan popup window first
|
||||||
|
- [x] #3 Regression tests cover async save dispatch and main-side pause/close hook
|
||||||
|
<!-- DOD:END -->
|
||||||
|
|
||||||
|
## Implementation Notes
|
||||||
|
|
||||||
|
<!-- SECTION:NOTES:BEGIN -->
|
||||||
|
2026-03-31: Removed the custom pending label/gray save-button presentation from vendored Yomitan. Background add still runs asynchronously with the internal pending-save guard, so duplicate clicks are ignored while the button keeps its stock appearance.
|
||||||
|
<!-- SECTION:NOTES:END -->
|
||||||
|
|
||||||
|
## Final Summary
|
||||||
|
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:BEGIN -->
|
||||||
|
Yomitan popup save dispatches note creation/add in the background with an internal pending-save guard so repeated clicks are ignored without blocking the popup. Before opening the Kiku field-grouping modal, the renderer now closes the visible lookup popup and pauses MPV. Follow-up UX polish removed the custom pending label/gray styling so the save button keeps Yomitan’s stock presentation while the background action runs.
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:END -->
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
---
|
||||||
|
id: TASK-264
|
||||||
|
title: Replace axios with native fetch across the project
|
||||||
|
status: To Do
|
||||||
|
assignee: []
|
||||||
|
created_date: '2026-04-01 00:44'
|
||||||
|
labels: []
|
||||||
|
dependencies: []
|
||||||
|
priority: medium
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||||
|
Remove axios from the codebase and migrate all project HTTP requests to the platform fetch API, preserving existing request behavior and error handling where applicable.
|
||||||
|
<!-- SECTION:DESCRIPTION:END -->
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
<!-- AC:BEGIN -->
|
||||||
|
- [ ] #1 No production code paths import or depend on axios.
|
||||||
|
- [ ] #2 All existing HTTP requests use fetch or a project-local abstraction built on fetch.
|
||||||
|
- [ ] #3 Request behavior remains functionally equivalent for headers, query params, bodies, status handling, and abort/error cases that are currently supported.
|
||||||
|
- [ ] #4 Tests are updated or added to cover the migrated request flows.
|
||||||
|
- [ ] #5 Documentation is updated if any request semantics or setup steps change.
|
||||||
|
- [ ] #6 axios is removed from project dependencies if it is no longer needed.
|
||||||
|
<!-- AC:END -->
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
---
|
||||||
|
id: TASK-265
|
||||||
|
title: Add remote backend for immersion tracking and stats (prefer Postgres)
|
||||||
|
status: To Do
|
||||||
|
assignee: []
|
||||||
|
created_date: '2026-04-01 00:47'
|
||||||
|
labels: []
|
||||||
|
dependencies: []
|
||||||
|
references:
|
||||||
|
- >-
|
||||||
|
/home/sudacode/projects/japanese/SubMiner/src/core/services/immersion-tracker-service.ts
|
||||||
|
- >-
|
||||||
|
/home/sudacode/projects/japanese/SubMiner/src/core/services/immersion-tracker/storage.ts
|
||||||
|
- >-
|
||||||
|
/home/sudacode/projects/japanese/SubMiner/src/core/services/immersion-tracker/sqlite.ts
|
||||||
|
- /home/sudacode/projects/japanese/SubMiner/src/stats-daemon-runner.ts
|
||||||
|
- /home/sudacode/projects/japanese/SubMiner/src/core/services/stats-server.ts
|
||||||
|
- /home/sudacode/projects/japanese/SubMiner/src/main/boot/services.ts
|
||||||
|
- /home/sudacode/projects/japanese/SubMiner/package.json
|
||||||
|
documentation:
|
||||||
|
- /home/sudacode/projects/japanese/SubMiner/docs/architecture/README.md
|
||||||
|
- >-
|
||||||
|
/home/sudacode/projects/japanese/SubMiner/docs/architecture/stats-trends-data-flow.md
|
||||||
|
- /home/sudacode/projects/japanese/SubMiner/README.md
|
||||||
|
- /home/sudacode/projects/japanese/SubMiner/config.example.jsonc
|
||||||
|
priority: high
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||||
|
Enable immersion tracking/stats to use a remote authoritative backend so multiple devices can share the same history.
|
||||||
|
|
||||||
|
Current state: `ImmersionTrackerService` opens a local `immersion.sqlite` file from the app data/config path, `stats-daemon-runner` points at that same local file, and `config.example.jsonc` only exposes `immersionTracking.dbPath` for a local path override. The stats API/dashboard reads from the same tracker service and assumes the local database is the source of truth.
|
||||||
|
|
||||||
|
Goal: add a remote backend option that avoids shared filesystem/database-file syncing between devices. Do not use SSH/rsync/shared network filesystem as the primary sync strategy for live multi-device use.
|
||||||
|
|
||||||
|
Backend choice: prefer Postgres if it can be integrated without a broad new dependency surface or destabilizing the current runtime; otherwise use the least invasive remote backend that can be shipped with the current stack and document the tradeoff clearly. Preserve the current local SQLite mode as the default/offline fallback if possible.
|
||||||
|
|
||||||
|
This ticket should cover the full product/architecture change: configuration, storage access, stats reads, startup/error handling, migration/bootstrap from existing local data, tests, and docs.
|
||||||
|
<!-- SECTION:DESCRIPTION:END -->
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
<!-- AC:BEGIN -->
|
||||||
|
- [ ] #1 The app can be configured to use a remote authoritative backend for immersion tracking instead of only a local `immersion.sqlite` file.
|
||||||
|
- [ ] #2 The chosen backend persists tracker writes and serves the existing stats read models across app restarts.
|
||||||
|
- [ ] #3 Two devices can point at the same remote backend without relying on a shared filesystem or raw SQLite file sync.
|
||||||
|
- [ ] #4 Local SQLite remains supported as the default or fallback mode for offline use.
|
||||||
|
- [ ] #5 If the remote backend is unavailable or misconfigured, startup/write paths fail with actionable errors instead of silent data loss.
|
||||||
|
- [ ] #6 A migration or bootstrap path exists to move existing local immersion data into the remote backend or seed a new device from it.
|
||||||
|
- [ ] #7 Config/examples/docs explain the backend choice, required connection/setup details, and any security/network assumptions.
|
||||||
|
- [ ] #8 Tests cover backend selection plus at least one representative write/read path against the remote backend.
|
||||||
|
<!-- AC:END -->
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
id: TASK-266
|
||||||
|
title: Preserve paused state for configured subtitle-jump keybindings
|
||||||
|
status: Done
|
||||||
|
assignee: []
|
||||||
|
created_date: '2026-04-01 03:19'
|
||||||
|
updated_date: '2026-04-01 03:19'
|
||||||
|
labels:
|
||||||
|
- renderer
|
||||||
|
- mpv
|
||||||
|
- keybindings
|
||||||
|
- regression
|
||||||
|
dependencies: []
|
||||||
|
priority: high
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||||
|
Regression: configured overlay keybindings that forward raw mpv subtitle-jump commands (for example previous-subtitle on H) can resume playback when invoked while paused. Keyboard-driven edge jumps already preserve paused state; configured keybindings should match that behavior.
|
||||||
|
<!-- SECTION:DESCRIPTION:END -->
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
<!-- AC:BEGIN -->
|
||||||
|
- [x] #1 Configured subtitle-jump keybindings preserve paused playback state after backward seek
|
||||||
|
- [x] #2 Existing keyboard-driven subtitle navigation behavior remains unchanged
|
||||||
|
- [x] #3 Regression test covers paused configured subtitle-jump keybinding handling
|
||||||
|
<!-- AC:END -->
|
||||||
|
|
||||||
|
## Final Summary
|
||||||
|
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:BEGIN -->
|
||||||
|
Configured overlay keybindings that forward `sub-seek` commands now re-check paused state and reapply pause after the seek when playback was already paused. This aligns raw configured subtitle-jump keybindings with the existing keyboard-driven edge-jump behavior and adds regression coverage for the paused backward-seek case.
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:END -->
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
id: TASK-267
|
||||||
|
title: Port validated Yomitan popup changes to fork and resync submodule
|
||||||
|
status: Done
|
||||||
|
assignee: []
|
||||||
|
created_date: '2026-04-01 03:30'
|
||||||
|
updated_date: '2026-04-01 03:33'
|
||||||
|
labels:
|
||||||
|
- yomitan
|
||||||
|
- submodule
|
||||||
|
- git
|
||||||
|
- integration
|
||||||
|
dependencies: []
|
||||||
|
priority: high
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||||
|
Take the locally validated Yomitan popup/bridge changes from the vendored copy, apply them to the standalone `../subminer-yomitan` fork, verify the fork, push the fork commit, then reset the vendored working tree in SubMiner and update the submodule pointer to the pushed fork commit.
|
||||||
|
<!-- SECTION:DESCRIPTION:END -->
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
<!-- AC:BEGIN -->
|
||||||
|
- [x] #1 Standalone `../subminer-yomitan` contains the validated popup/bridge changes and passes the relevant regression test
|
||||||
|
- [x] #2 The fork commit is pushed to its configured remote branch
|
||||||
|
- [x] #3 SubMiner vendored Yomitan working tree is reset and the submodule pointer is updated to the pushed fork commit
|
||||||
|
<!-- AC:END -->
|
||||||
|
|
||||||
|
## Final Summary
|
||||||
|
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:BEGIN -->
|
||||||
|
Applied the validated popup/bridge changes from the vendored Yomitan copy into `../subminer-yomitan`, added the focused async-save regression test there, installed fork deps, and verified with `npx vitest run test/display-anki-save.test.js`. Committed the fork changes as `feat: preserve async popup save state and duplicate metadata`, rebased onto the updated remote `main`, and pushed commit `69620abc` to `origin/main`. Then reset the vendored submodule working tree in SubMiner, checked it out at `69620abc`, and left the superproject with the submodule pointer updated from `3c9ee577` to `69620abc`.
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:END -->
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
---
|
||||||
|
id: TASK-268
|
||||||
|
title: 'Address CodeRabbit review action items for PR #38'
|
||||||
|
status: Done
|
||||||
|
assignee: []
|
||||||
|
created_date: '2026-04-01 05:35'
|
||||||
|
updated_date: '2026-04-01 06:07'
|
||||||
|
labels:
|
||||||
|
- pr-review
|
||||||
|
- coderabbit
|
||||||
|
dependencies: []
|
||||||
|
references:
|
||||||
|
- 'https://github.com/ksyasuda/SubMiner/pull/38'
|
||||||
|
priority: medium
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||||
|
Review unresolved CodeRabbit feedback on PR #38 and implement the actionable fixes without regressing duplicate grouping or popup behavior.
|
||||||
|
<!-- SECTION:DESCRIPTION:END -->
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
<!-- AC:BEGIN -->
|
||||||
|
- [x] #1 All unresolved actionable CodeRabbit review comments on PR #38 are triaged and either fixed in code or explicitly identified as non-actionable or ambiguous.
|
||||||
|
- [x] #2 Code changes preserve duplicate grouping and popup flow behavior covered by existing or added regression tests.
|
||||||
|
- [x] #3 Relevant local verification for the affected areas passes.
|
||||||
|
<!-- AC:END -->
|
||||||
|
|
||||||
|
## Implementation Notes
|
||||||
|
|
||||||
|
<!-- SECTION:NOTES:BEGIN -->
|
||||||
|
2026-04-01: Reopened for follow-up CodeRabbit round after commit 233bde58. Remaining actionable items: guard maxMatches <= 0 in duplicate exact-match helper and strengthen the duplicate tracking test fixture to prove deduplication as well as sorting.
|
||||||
|
|
||||||
|
2026-04-01: Follow-up round addressed locally. Added guard for maxMatches <= 0 in duplicate exact-match scanning and strengthened the pre-add duplicate tracking test fixture to prove deduplication as well as sorting.
|
||||||
|
<!-- SECTION:NOTES:END -->
|
||||||
|
|
||||||
|
## Final Summary
|
||||||
|
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:BEGIN -->
|
||||||
|
Addressed all unresolved actionable CodeRabbit comments on PR #38. Fixed duplicate tracking so empty duplicate lists are not persisted after sentence-card creation, sanitized Yomitan add-note noteId values to accept only positive integers, preserved paused playback for configured subtitle-seek keybindings when pause state is unknown, and short-circuited duplicate exact-match scanning for single-result lookups. Added regression tests for each case and verified with `bun test` on the affected suites plus `bun run typecheck`, `bun run test:fast`, `bun run test:env`, `bun run build`, and `bun run test:smoke:dist`.
|
||||||
|
|
||||||
|
Follow-up CodeRabbit round addressed locally: `findExactDuplicateNoteIds()` now returns early when `maxMatches <= 0`, and the sentence-card duplicate tracking regression test now uses a repeated duplicate ID to assert deduplication plus sorting. Re-verified with targeted duplicate/card tests, `bun run typecheck`, and `bun run test:fast`.
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:END -->
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
---
|
||||||
|
id: TASK-270
|
||||||
|
title: Make Windows mpv shortcut self-contained
|
||||||
|
status: Done
|
||||||
|
assignee: []
|
||||||
|
created_date: '2026-04-02 07:13'
|
||||||
|
updated_date: '2026-04-02 07:19'
|
||||||
|
labels: []
|
||||||
|
dependencies: []
|
||||||
|
priority: medium
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||||
|
Remove the Windows mpv shortcut's dependency on a pre-existing mpv profile so the installer-created `SubMiner mpv` flow works out of the box without requiring the user to edit `mpv.conf`. Keep docs aligned with the new behavior and preserve the optional profile guidance for manual mpv usage.
|
||||||
|
<!-- SECTION:DESCRIPTION:END -->
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
<!-- AC:BEGIN -->
|
||||||
|
- [x] #1 `SubMiner.exe --launch-mpv` launches mpv with SubMiner's required default args without requiring an mpv profile named `subminer`.
|
||||||
|
- [x] #2 Windows shortcut/help/docs no longer describe `--launch-mpv` as depending on the SubMiner mpv profile.
|
||||||
|
- [x] #3 Automated tests cover the Windows launch args behavior and pass after the change.
|
||||||
|
<!-- AC:END -->
|
||||||
|
|
||||||
|
## Final Summary
|
||||||
|
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:BEGIN -->
|
||||||
|
Updated the Windows `--launch-mpv` path to pass SubMiner's default mpv args directly instead of requiring `--profile=subminer`. Adjusted Windows shortcut/help text to describe the self-contained defaults-based launch, and updated Windows docs to state that `mpv.conf` is not required for the shortcut path while preserving the optional profile guidance for manual mpv launches.
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:END -->
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
---
|
||||||
|
id: TASK-271
|
||||||
|
title: Fix local playback subtitle auto-selection and startup pause release
|
||||||
|
status: Done
|
||||||
|
assignee:
|
||||||
|
- codex
|
||||||
|
created_date: '2026-04-03 07:47'
|
||||||
|
updated_date: '2026-04-03 08:03'
|
||||||
|
labels:
|
||||||
|
- bug
|
||||||
|
- playback
|
||||||
|
- subtitles
|
||||||
|
dependencies: []
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||||
|
Investigate local-video startup on desktop playback where managed subtitle defaults can bind the wrong primary subtitle track and startup readiness retries can force playback to resume after the user manually pauses. Scope includes fixing the pause/unpause loop and making local subtitle auto-selection prefer the intended primary/secondary tracks for sentence mining sessions.
|
||||||
|
<!-- SECTION:DESCRIPTION:END -->
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
<!-- AC:BEGIN -->
|
||||||
|
- [x] #1 Desktop local playback no longer forces `pause=no` after the user manually pauses during or after startup readiness handling.
|
||||||
|
- [x] #2 Managed local subtitle startup selects the expected primary track before secondary track selection for mixed-language subtitle sets like Japanese primary plus English secondary.
|
||||||
|
- [x] #3 Regression tests cover the pause-release bug and the local subtitle auto-selection behavior.
|
||||||
|
- [x] #4 Internal docs are updated if runtime behavior or operator expectations change.
|
||||||
|
<!-- AC:END -->
|
||||||
|
|
||||||
|
## Implementation Plan
|
||||||
|
|
||||||
|
<!-- SECTION:PLAN:BEGIN -->
|
||||||
|
1. Add regression coverage for startup autoplay release so duplicate ready handling cannot unpause playback after the user manually pauses the same media.
|
||||||
|
2. Add regression coverage for managed local subtitle startup selection using configured primary/secondary subtitle language preferences, with JA/EN remaining the default fallback behavior.
|
||||||
|
3. Extract or add reusable subtitle track ranking logic that prefers configured primary and secondary subtitle languages, with stable scoring for external tracks and non-SDH labels.
|
||||||
|
4. Update local playback startup/runtime wiring so managed subtitle defaults use explicit ranked selection instead of raw sid=auto / secondary-sid=auto while preserving config-driven language preference ordering.
|
||||||
|
5. Run focused subtitle/playback tests, then update task notes/final summary with any behavior or docs impact.
|
||||||
|
<!-- SECTION:PLAN:END -->
|
||||||
|
|
||||||
|
## Implementation Notes
|
||||||
|
|
||||||
|
<!-- SECTION:NOTES:BEGIN -->
|
||||||
|
Implemented config-aware managed local subtitle selection runtime for local media path changes and playlist-browser local playback rearm, using `youtube.primarySubLanguages` for primary preference and `secondarySub.secondarySubLanguages` for secondary preference with JA/EN fallback defaults.
|
||||||
|
|
||||||
|
Updated autoplay ready gate to ignore duplicate readiness signals for the same media so later manual pauses are not overridden by repeated tokenization-ready events.
|
||||||
|
|
||||||
|
Updated config/template wording to document that the existing subtitle language preferences now drive managed subtitle auto-selection beyond YouTube-only flows.
|
||||||
|
|
||||||
|
Verification: `bun test src/config/config.test.ts src/main/runtime/autoplay-ready-gate.test.ts src/main/runtime/local-subtitle-selection.test.ts src/main/runtime/playlist-browser-runtime.test.ts`; `bun run typecheck`.
|
||||||
|
<!-- SECTION:NOTES:END -->
|
||||||
|
|
||||||
|
## Final Summary
|
||||||
|
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:BEGIN -->
|
||||||
|
Stopped startup readiness retries from re-unpausing the same media after a later manual pause, and added config-aware managed local subtitle selection so local playback prefers the configured primary/secondary subtitle languages instead of relying on raw mpv `sid=auto` behavior. Added regression coverage for autoplay-ready gating, local subtitle selection, playlist-browser local playback rearm, and config template wording updates.
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:END -->
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
---
|
||||||
|
id: TASK-273
|
||||||
|
title: >-
|
||||||
|
Fix first-run setup false positive when canonical mpv plugin is already
|
||||||
|
installed
|
||||||
|
status: Done
|
||||||
|
assignee:
|
||||||
|
- Kyle Yasuda
|
||||||
|
created_date: '2026-04-03 23:26'
|
||||||
|
updated_date: '2026-04-04 00:31'
|
||||||
|
labels:
|
||||||
|
- bug
|
||||||
|
- macos
|
||||||
|
- first-run-setup
|
||||||
|
dependencies: []
|
||||||
|
priority: high
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||||
|
Investigate and fix launcher/app first-run setup gating so playback does not block when the SubMiner mpv plugin is already installed at the canonical mpv config path on macOS. Align mpv path resolution with the actual install location, keep plugin detection scoped to the canonical plugin entrypoint, and make launcher setup gating resilient to stale cancelled setup state.
|
||||||
|
<!-- SECTION:DESCRIPTION:END -->
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
<!-- AC:BEGIN -->
|
||||||
|
- [ ] #1 `resolveDefaultMpvInstallPaths` resolves the canonical macOS mpv config path used by existing installs.
|
||||||
|
- [ ] #2 Playback launcher bypasses first-run setup when the canonical `scripts/subminer/main.lua` plugin entrypoint already exists, even if `setup-state.json` is stale.
|
||||||
|
- [ ] #3 Regression tests cover canonical plugin detection and launcher handling of stale cancelled setup state.
|
||||||
|
<!-- AC:END -->
|
||||||
|
|
||||||
|
## Implementation Notes
|
||||||
|
|
||||||
|
<!-- SECTION:NOTES:BEGIN -->
|
||||||
|
Root cause ended up split across path resolution and launcher gating. No automated test command was executed in this pass by request.
|
||||||
|
<!-- SECTION:NOTES:END -->
|
||||||
|
|
||||||
|
## Final Summary
|
||||||
|
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:BEGIN -->
|
||||||
|
Updated macOS mpv install path resolution to use the canonical `~/.config/mpv` location so first-run plugin detection matches the actual installed plugin path.
|
||||||
|
|
||||||
|
Restricted plugin detection to the canonical `scripts/subminer/main.lua` entrypoint instead of config presence or legacy loader files.
|
||||||
|
|
||||||
|
Updated the launcher setup gate to bypass stale `setup-state.json` when the mpv plugin is already installed, and to ignore an initially stale `cancelled` state after spawning setup.
|
||||||
|
|
||||||
|
Added regression coverage for canonical macOS detection and launcher setup-gate bypass behavior. No automated test command was executed in this pass by request.
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:END -->
|
||||||
|
|
||||||
|
## Definition of Done
|
||||||
|
<!-- DOD:BEGIN -->
|
||||||
|
- [ ] #1 Manual verification with scenario: existing plugin installed in custom mpv config path does not open first-run setup.
|
||||||
|
<!-- DOD:END -->
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
---
|
||||||
|
id: TASK-274
|
||||||
|
title: Stabilize current failing test regressions
|
||||||
|
status: Done
|
||||||
|
assignee:
|
||||||
|
- codex
|
||||||
|
created_date: '2026-04-04 04:40'
|
||||||
|
updated_date: '2026-04-04 05:01'
|
||||||
|
labels: []
|
||||||
|
dependencies: []
|
||||||
|
documentation:
|
||||||
|
- docs/workflow/verification.md
|
||||||
|
- docs/architecture/README.md
|
||||||
|
priority: high
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||||
|
Investigate and fix the current src/test failures across stats CLI lifetime rebuild handling, immersion tracker lifetime rebuild idempotency, renderer test environment cleanup helpers, subtitle sidebar auto-follow behavior, and log retention pruning so the maintained test lanes pass again.
|
||||||
|
<!-- SECTION:DESCRIPTION:END -->
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
<!-- AC:BEGIN -->
|
||||||
|
- [x] #1 Stats CLI lifetime rebuild behavior passes the current regression coverage.
|
||||||
|
- [x] #2 Immersion tracker lifetime rebuild backfill remains idempotent under the existing runtime test.
|
||||||
|
- [x] #3 Renderer modal test helpers restore injected globals exactly to prior state.
|
||||||
|
- [x] #4 Log pruning removes files older than the configured retention window deterministically.
|
||||||
|
- [x] #5 Relevant targeted test files pass after the fixes.
|
||||||
|
<!-- AC:END -->
|
||||||
|
|
||||||
|
## Implementation Plan
|
||||||
|
|
||||||
|
<!-- SECTION:PLAN:BEGIN -->
|
||||||
|
1. Reproduce the failing specs in isolation to separate deterministic regressions from suite-order pollution.
|
||||||
|
2. Fix source or test-helper logic for the three isolated failures: log retention cutoff, stats CLI lifetime rebuild timestamp handling, and subtitle sidebar initial jump behavior.
|
||||||
|
3. Harden renderer modal cleanup regressions so tests verify descriptor restoration without assuming global window/document start absent.
|
||||||
|
4. Re-run the targeted failing files, then the required verification gate for the touched areas and record results.
|
||||||
|
<!-- SECTION:PLAN:END -->
|
||||||
|
|
||||||
|
## Implementation Notes
|
||||||
|
|
||||||
|
<!-- SECTION:NOTES:BEGIN -->
|
||||||
|
Targeted regressions fixed in log pruning, stats CLI lifetime logging/tests, subtitle sidebar auto-follow timing, and renderer global cleanup test isolation.
|
||||||
|
|
||||||
|
Verification: `bun test src/main/runtime/stats-cli-command.test.ts src/shared/log-files.test.ts src/renderer/modals/playlist-browser.test.ts src/renderer/modals/youtube-track-picker.test.ts src/renderer/modals/subtitle-sidebar.test.ts` passed.
|
||||||
|
|
||||||
|
Verification: `bun run test:src` still exits non-zero because of unrelated existing errors in `src/core/services/anilist/anilist-token-store.test.ts` (`Bun.serve is not a function`) plus one remaining non-task failure elsewhere; the originally reported regressions are green in the maintained lane.
|
||||||
|
|
||||||
|
User reported `test:full` still failing after the first regression pass. Reopened to clear the remaining `test:src` fail plus the existing unhandled test errors before handoff.
|
||||||
|
|
||||||
|
Verified final gate with `bun run test:launcher:unit:src` and `bun run test:full`; both pass after fixing the launcher AniSkip fallback title regression and the earlier src-lane regressions.
|
||||||
|
<!-- SECTION:NOTES:END -->
|
||||||
|
|
||||||
|
## Final Summary
|
||||||
|
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:BEGIN -->
|
||||||
|
Stabilized the failing test regressions across source and launcher lanes. Fixed log pruning cutoff math under Bun BigInt mtimes, subtitle sidebar auto-follow timing, renderer global cleanup test isolation, stats CLI lifetime rebuild logging/tests, stats-server node:http fallback isolation, and launcher AniSkip fallback title resolution so basename titles beat generic parent directories while episode-only filenames still prefer the series directory. Verification passed with `bun test launcher/aniskip-metadata.test.ts`, `bun run test:launcher:unit:src`, and `bun run test:full`.
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:END -->
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
---
|
||||||
|
id: TASK-275
|
||||||
|
title: Patch high-severity audit findings with minimal dependency changes
|
||||||
|
status: Done
|
||||||
|
assignee:
|
||||||
|
- codex
|
||||||
|
created_date: '2026-04-04 04:45'
|
||||||
|
updated_date: '2026-04-04 04:50'
|
||||||
|
labels:
|
||||||
|
- security
|
||||||
|
- dependencies
|
||||||
|
dependencies: []
|
||||||
|
---
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
<!-- SECTION:DESCRIPTION:BEGIN -->
|
||||||
|
Update SubMiner's direct Electron runtime and vulnerable build-time transitive dependencies to patched versions using the smallest safe version moves. Keep electron-builder on the current pinned line unless verification shows a blocker. Verify that bun audit no longer reports the current high-severity findings and that the standard project gate still passes.
|
||||||
|
<!-- SECTION:DESCRIPTION:END -->
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
<!-- AC:BEGIN -->
|
||||||
|
- [x] #1 Electron is updated to a patched supported release on the current supported line with no broader dependency refresh
|
||||||
|
- [x] #2 Vulnerable transitive packages @xmldom/xmldom, lodash, and picomatch resolve to patched versions via targeted dependency changes
|
||||||
|
- [x] #3 `bun audit --audit-level high` no longer reports the currently listed high-severity findings
|
||||||
|
- [x] #4 The default handoff verification gate passes, or any failure is documented with the exact command and error output
|
||||||
|
- [x] #5 Any dependency or lockfile changes remain minimal and do not change the pinned electron-builder line unless required
|
||||||
|
<!-- AC:END -->
|
||||||
|
|
||||||
|
## Implementation Plan
|
||||||
|
|
||||||
|
<!-- SECTION:PLAN:BEGIN -->
|
||||||
|
1. Update package.json with the smallest set of dependency changes: bump electron from ^37.10.3 to 39.8.6 and add overrides for @xmldom/xmldom 0.8.12, lodash 4.18.0, and picomatch 4.0.4 while leaving electron-builder pinned at 26.8.2.
|
||||||
|
2. Refresh bun.lock with a lockfile-only install/update and confirm the resolved versions for electron, @xmldom/xmldom, lodash, and picomatch.
|
||||||
|
3. Run bun audit --audit-level high and verify the current high-severity findings are gone.
|
||||||
|
4. Run the default verification gate: bun run typecheck, bun run test:fast, bun run test:env, bun run build, bun run test:smoke:dist.
|
||||||
|
5. If any verification step fails, capture the exact failing command and error, assess whether it is caused by the dependency updates, and stop without broadening scope.
|
||||||
|
<!-- SECTION:PLAN:END -->
|
||||||
|
|
||||||
|
## Implementation Notes
|
||||||
|
|
||||||
|
<!-- SECTION:NOTES:BEGIN -->
|
||||||
|
Updated package.json to pin electron 39.8.6 and add overrides for @xmldom/xmldom 0.8.12, lodash 4.18.0, and picomatch 4.0.4 while keeping electron-builder pinned at 26.8.2.
|
||||||
|
|
||||||
|
Refreshed bun.lock with bun install and confirmed the patched versions resolved in the lockfile.
|
||||||
|
|
||||||
|
Verification passed: bun audit --audit-level high, bun run typecheck, bun run test:fast, bun run test:env, bun run build, bun run test:smoke:dist.
|
||||||
|
|
||||||
|
Added changelog fragment changes/patch-audit-dependencies.md for the security/dependency maintenance update. No internal docs or docs-site updates were needed because the change does not alter user-facing behavior, configuration, or workflows.
|
||||||
|
<!-- SECTION:NOTES:END -->
|
||||||
|
|
||||||
|
## Final Summary
|
||||||
|
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:BEGIN -->
|
||||||
|
Cleared the reported high-severity audit findings with minimal dependency churn by pinning electron to 39.8.6 and overriding @xmldom/xmldom, lodash, and picomatch to patched versions. Kept electron-builder on 26.8.2. bun audit is clean and the full default handoff gate passed: typecheck, fast tests, env tests, build, and dist smoke tests.
|
||||||
|
<!-- SECTION:FINAL_SUMMARY:END -->
|
||||||
13
bun.lock
13
bun.lock
@@ -18,7 +18,7 @@
|
|||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^25.3.0",
|
"@types/node": "^25.3.0",
|
||||||
"@types/ws": "^8.18.1",
|
"@types/ws": "^8.18.1",
|
||||||
"electron": "^37.10.3",
|
"electron": "39.8.6",
|
||||||
"electron-builder": "26.8.2",
|
"electron-builder": "26.8.2",
|
||||||
"esbuild": "^0.25.12",
|
"esbuild": "^0.25.12",
|
||||||
"prettier": "^3.8.1",
|
"prettier": "^3.8.1",
|
||||||
@@ -27,9 +27,12 @@
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
"overrides": {
|
"overrides": {
|
||||||
|
"@xmldom/xmldom": "0.8.12",
|
||||||
"app-builder-lib": "26.8.2",
|
"app-builder-lib": "26.8.2",
|
||||||
"electron-builder-squirrel-windows": "26.8.2",
|
"electron-builder-squirrel-windows": "26.8.2",
|
||||||
|
"lodash": "4.18.0",
|
||||||
"minimatch": "10.2.3",
|
"minimatch": "10.2.3",
|
||||||
|
"picomatch": "4.0.4",
|
||||||
"tar": "7.5.11",
|
"tar": "7.5.11",
|
||||||
},
|
},
|
||||||
"packages": {
|
"packages": {
|
||||||
@@ -185,7 +188,7 @@
|
|||||||
|
|
||||||
"@xhayper/discord-rpc": ["@xhayper/discord-rpc@1.3.3", "", { "dependencies": { "@discordjs/rest": "^2.6.1", "@vladfrangu/async_event_emitter": "^2.4.7", "discord-api-types": "^0.38.42", "ws": "^8.20.0" } }, "sha512-Ih48GHiua7TtZgKO+f0uZPhCeQqb84fY2qUys/oMh8UbUfiUkUJLVCmd/v2AK0/pV33euh0aqSXo7+9LiPSwGw=="],
|
"@xhayper/discord-rpc": ["@xhayper/discord-rpc@1.3.3", "", { "dependencies": { "@discordjs/rest": "^2.6.1", "@vladfrangu/async_event_emitter": "^2.4.7", "discord-api-types": "^0.38.42", "ws": "^8.20.0" } }, "sha512-Ih48GHiua7TtZgKO+f0uZPhCeQqb84fY2qUys/oMh8UbUfiUkUJLVCmd/v2AK0/pV33euh0aqSXo7+9LiPSwGw=="],
|
||||||
|
|
||||||
"@xmldom/xmldom": ["@xmldom/xmldom@0.8.11", "", {}, "sha512-cQzWCtO6C8TQiYl1ruKNn2U6Ao4o4WBBcbL61yJl84x+j5sOWWFU9X7DpND8XZG3daDppSsigMdfAIl2upQBRw=="],
|
"@xmldom/xmldom": ["@xmldom/xmldom@0.8.12", "", {}, "sha512-9k/gHF6n/pAi/9tqr3m3aqkuiNosYTurLLUtc7xQ9sxB/wm7WPygCv8GYa6mS0fLJEHhqMC1ATYhz++U/lRHqg=="],
|
||||||
|
|
||||||
"abbrev": ["abbrev@3.0.1", "", {}, "sha512-AO2ac6pjRB3SJmGJo+v5/aK6Omggp6fsLrs6wN9bd35ulu4cCwaAU9+7ZhXjeqHVkaHThLuzH0nZr0YpCDhygg=="],
|
"abbrev": ["abbrev@3.0.1", "", {}, "sha512-AO2ac6pjRB3SJmGJo+v5/aK6Omggp6fsLrs6wN9bd35ulu4cCwaAU9+7ZhXjeqHVkaHThLuzH0nZr0YpCDhygg=="],
|
||||||
|
|
||||||
@@ -321,7 +324,7 @@
|
|||||||
|
|
||||||
"ejs": ["ejs@3.1.10", "", { "dependencies": { "jake": "^10.8.5" }, "bin": { "ejs": "bin/cli.js" } }, "sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA=="],
|
"ejs": ["ejs@3.1.10", "", { "dependencies": { "jake": "^10.8.5" }, "bin": { "ejs": "bin/cli.js" } }, "sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA=="],
|
||||||
|
|
||||||
"electron": ["electron@37.10.3", "", { "dependencies": { "@electron/get": "^2.0.0", "@types/node": "^22.7.7", "extract-zip": "^2.0.1" }, "bin": { "electron": "cli.js" } }, "sha512-3IjCGSjQmH50IbW2PFveaTzK+KwcFX9PEhE7KXb9v5IT8cLAiryAN7qezm/XzODhDRlLu0xKG1j8xWBtZ/bx/g=="],
|
"electron": ["electron@39.8.6", "", { "dependencies": { "@electron/get": "^2.0.0", "@types/node": "^22.7.7", "extract-zip": "^2.0.1" }, "bin": { "electron": "cli.js" } }, "sha512-uWX6Jh5LmwL13VwOSKBjebI+ck+03GOwc8V2Sgbmr9pJVJ/cHfli/PkjXuRDr+hq+SLHQuT9mGHSIfScebApRA=="],
|
||||||
|
|
||||||
"electron-builder": ["electron-builder@26.8.2", "", { "dependencies": { "app-builder-lib": "26.8.2", "builder-util": "26.8.1", "builder-util-runtime": "9.5.1", "chalk": "^4.1.2", "ci-info": "^4.2.0", "dmg-builder": "26.8.2", "fs-extra": "^10.1.0", "lazy-val": "^1.0.5", "simple-update-notifier": "2.0.0", "yargs": "^17.6.2" }, "bin": { "electron-builder": "cli.js", "install-app-deps": "install-app-deps.js" } }, "sha512-ieiiXPdgH3qrG6lcvy2mtnI5iEmAopmLuVRMSJ5j40weU0tgpNx0OAk9J5X5nnO0j9+KIkxHzwFZVUDk1U3aGw=="],
|
"electron-builder": ["electron-builder@26.8.2", "", { "dependencies": { "app-builder-lib": "26.8.2", "builder-util": "26.8.1", "builder-util-runtime": "9.5.1", "chalk": "^4.1.2", "ci-info": "^4.2.0", "dmg-builder": "26.8.2", "fs-extra": "^10.1.0", "lazy-val": "^1.0.5", "simple-update-notifier": "2.0.0", "yargs": "^17.6.2" }, "bin": { "electron-builder": "cli.js", "install-app-deps": "install-app-deps.js" } }, "sha512-ieiiXPdgH3qrG6lcvy2mtnI5iEmAopmLuVRMSJ5j40weU0tgpNx0OAk9J5X5nnO0j9+KIkxHzwFZVUDk1U3aGw=="],
|
||||||
|
|
||||||
@@ -479,7 +482,7 @@
|
|||||||
|
|
||||||
"libsql": ["libsql@0.5.28", "", { "dependencies": { "@neon-rs/load": "^0.0.4", "detect-libc": "2.0.2" }, "optionalDependencies": { "@libsql/darwin-arm64": "0.5.28", "@libsql/darwin-x64": "0.5.28", "@libsql/linux-arm-gnueabihf": "0.5.28", "@libsql/linux-arm-musleabihf": "0.5.28", "@libsql/linux-arm64-gnu": "0.5.28", "@libsql/linux-arm64-musl": "0.5.28", "@libsql/linux-x64-gnu": "0.5.28", "@libsql/linux-x64-musl": "0.5.28", "@libsql/win32-x64-msvc": "0.5.28" }, "os": [ "linux", "win32", "darwin", ], "cpu": [ "arm", "x64", "arm64", ] }, "sha512-wKqx9FgtPcKHdPfR/Kfm0gejsnbuf8zV+ESPmltFvsq5uXwdeN9fsWn611DmqrdXj1e94NkARcMA2f1syiAqOg=="],
|
"libsql": ["libsql@0.5.28", "", { "dependencies": { "@neon-rs/load": "^0.0.4", "detect-libc": "2.0.2" }, "optionalDependencies": { "@libsql/darwin-arm64": "0.5.28", "@libsql/darwin-x64": "0.5.28", "@libsql/linux-arm-gnueabihf": "0.5.28", "@libsql/linux-arm-musleabihf": "0.5.28", "@libsql/linux-arm64-gnu": "0.5.28", "@libsql/linux-arm64-musl": "0.5.28", "@libsql/linux-x64-gnu": "0.5.28", "@libsql/linux-x64-musl": "0.5.28", "@libsql/win32-x64-msvc": "0.5.28" }, "os": [ "linux", "win32", "darwin", ], "cpu": [ "arm", "x64", "arm64", ] }, "sha512-wKqx9FgtPcKHdPfR/Kfm0gejsnbuf8zV+ESPmltFvsq5uXwdeN9fsWn611DmqrdXj1e94NkARcMA2f1syiAqOg=="],
|
||||||
|
|
||||||
"lodash": ["lodash@4.17.23", "", {}, "sha512-LgVTMpQtIopCi79SJeDiP0TfWi5CNEc/L/aRdTh3yIvmZXTnheWpKjSZhnvMl8iXbC1tFg9gdHHDMLoV7CnG+w=="],
|
"lodash": ["lodash@4.18.0", "", {}, "sha512-l1mfj2atMqndAHI3ls7XqPxEjV2J9ZkcNyHpoZA3r2T1LLwDB69jgkMWh71YKwhBbK0G2f4WSn05ahmQXVxupA=="],
|
||||||
|
|
||||||
"log-symbols": ["log-symbols@4.1.0", "", { "dependencies": { "chalk": "^4.1.0", "is-unicode-supported": "^0.1.0" } }, "sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg=="],
|
"log-symbols": ["log-symbols@4.1.0", "", { "dependencies": { "chalk": "^4.1.0", "is-unicode-supported": "^0.1.0" } }, "sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg=="],
|
||||||
|
|
||||||
@@ -569,7 +572,7 @@
|
|||||||
|
|
||||||
"picocolors": ["picocolors@1.1.1", "", {}, "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA=="],
|
"picocolors": ["picocolors@1.1.1", "", {}, "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA=="],
|
||||||
|
|
||||||
"picomatch": ["picomatch@4.0.3", "", {}, "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q=="],
|
"picomatch": ["picomatch@4.0.4", "", {}, "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A=="],
|
||||||
|
|
||||||
"plist": ["plist@3.1.0", "", { "dependencies": { "@xmldom/xmldom": "^0.8.8", "base64-js": "^1.5.1", "xmlbuilder": "^15.1.1" } }, "sha512-uysumyrvkUX0rX/dEVqt8gC3sTBzd4zoWfLeS29nb53imdaXVvLINYXTI2GNqzaMuvacNx4uJQ8+b3zXR0pkgQ=="],
|
"plist": ["plist@3.1.0", "", { "dependencies": { "@xmldom/xmldom": "^0.8.8", "base64-js": "^1.5.1", "xmlbuilder": "^15.1.1" } }, "sha512-uysumyrvkUX0rX/dEVqt8gC3sTBzd4zoWfLeS29nb53imdaXVvLINYXTI2GNqzaMuvacNx4uJQ8+b3zXR0pkgQ=="],
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +0,0 @@
|
|||||||
type: docs
|
|
||||||
area: docs-site
|
|
||||||
|
|
||||||
- Added a dedicated Subtitle Sidebar guide and linked it from the homepage and configuration docs.
|
|
||||||
- Linked Jimaku integration from the homepage to its dedicated docs page.
|
|
||||||
- Refreshed docs-site theme tokens and hover/selection styling for the updated pages.
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
type: fixed
|
|
||||||
area: main
|
|
||||||
|
|
||||||
- Resolve the YouTube playback socket path lazily so startup honors CLI and config overrides.
|
|
||||||
- Add regression coverage for the lazy socket-path lookup during Windows mpv startup.
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
type: internal
|
|
||||||
area: release
|
|
||||||
|
|
||||||
- Retried AUR clone and push operations in the tagged release workflow.
|
|
||||||
- Kept GitHub Releases green when AUR publish flakes and needs manual follow-up.
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
type: fixed
|
|
||||||
area: main
|
|
||||||
|
|
||||||
- Keep integrated `--start --texthooker` launches on the full app-ready startup path so the texthooker page and websocket servers start together during normal playback startup.
|
|
||||||
- Stop the mpv/plugin auto-start flow from spawning a separate standalone texthooker helper during normal `subminer <video>` launches.
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
type: added
|
|
||||||
area: overlay
|
|
||||||
|
|
||||||
- Added a playlist browser overlay modal for browsing sibling video files and the live mpv queue during playback.
|
|
||||||
- Added the default `Ctrl+Alt+P` keybinding to open the playlist browser and manage queue order without leaving playback.
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
type: fixed
|
|
||||||
area: overlay
|
|
||||||
|
|
||||||
- Keep tracked macOS visible overlays click-through by default so subtitle sidebar passthrough works immediately without requiring a subtitle hover cycle first.
|
|
||||||
- Add regression coverage for the macOS visible-overlay passthrough default.
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
type: fixed
|
|
||||||
area: anilist
|
|
||||||
|
|
||||||
- Stop AniList post-watch from sending a second progress update when the current episode was already satisfied by a ready retry item in the same watch-completion pass.
|
|
||||||
- Add regression coverage for the retry-queue plus live-update duplicate path.
|
|
||||||
@@ -18,7 +18,7 @@
|
|||||||
// ==========================================
|
// ==========================================
|
||||||
"texthooker": {
|
"texthooker": {
|
||||||
"launchAtStartup": true, // Launch texthooker server automatically when SubMiner starts. Values: true | false
|
"launchAtStartup": true, // Launch texthooker server automatically when SubMiner starts. Values: true | false
|
||||||
"openBrowser": true // Open browser setting. Values: true | false
|
"openBrowser": false // Open browser setting. Values: true | false
|
||||||
}, // Configure texthooker startup launch and browser opening behavior.
|
}, // Configure texthooker startup launch and browser opening behavior.
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
@@ -58,7 +58,7 @@
|
|||||||
// Override controller.buttonIndices when your pad reports non-standard raw button numbers.
|
// Override controller.buttonIndices when your pad reports non-standard raw button numbers.
|
||||||
// ==========================================
|
// ==========================================
|
||||||
"controller": {
|
"controller": {
|
||||||
"enabled": true, // Enable overlay controller support through the Chrome Gamepad API. Values: true | false
|
"enabled": false, // Enable overlay controller support through the Chrome Gamepad API. Values: true | false
|
||||||
"preferredGamepadId": "", // Preferred controller id saved from the controller config modal.
|
"preferredGamepadId": "", // Preferred controller id saved from the controller config modal.
|
||||||
"preferredGamepadLabel": "", // Preferred controller display label saved for diagnostics.
|
"preferredGamepadLabel": "", // Preferred controller display label saved for diagnostics.
|
||||||
"smoothScroll": true, // Use smooth scrolling for controller-driven popup scroll input. Values: true | false
|
"smoothScroll": true, // Use smooth scrolling for controller-driven popup scroll input. Values: true | false
|
||||||
@@ -187,7 +187,7 @@
|
|||||||
// ==========================================
|
// ==========================================
|
||||||
// Secondary Subtitles
|
// Secondary Subtitles
|
||||||
// Dual subtitle track options.
|
// Dual subtitle track options.
|
||||||
// Used by the YouTube subtitle loading flow as secondary language preferences.
|
// Used by managed subtitle loading as secondary language preferences for local and YouTube playback.
|
||||||
// Hot-reload: defaultMode updates live while SubMiner is running.
|
// Hot-reload: defaultMode updates live while SubMiner is running.
|
||||||
// ==========================================
|
// ==========================================
|
||||||
"secondarySub": {
|
"secondarySub": {
|
||||||
@@ -225,7 +225,7 @@
|
|||||||
"enableJlpt": false, // Enable JLPT vocabulary level underlines. When disabled, JLPT tagging lookup and underlines are skipped. Values: true | false
|
"enableJlpt": false, // Enable JLPT vocabulary level underlines. When disabled, JLPT tagging lookup and underlines are skipped. Values: true | false
|
||||||
"preserveLineBreaks": false, // Preserve line breaks in visible overlay subtitle rendering. When false, line breaks are flattened to spaces for a single-line flow. Values: true | false
|
"preserveLineBreaks": false, // Preserve line breaks in visible overlay subtitle rendering. When false, line breaks are flattened to spaces for a single-line flow. Values: true | false
|
||||||
"autoPauseVideoOnHover": true, // Automatically pause mpv playback while hovering subtitle text, then resume on leave. Values: true | false
|
"autoPauseVideoOnHover": true, // Automatically pause mpv playback while hovering subtitle text, then resume on leave. Values: true | false
|
||||||
"autoPauseVideoOnYomitanPopup": false, // Automatically pause mpv playback while Yomitan popup is open, then resume when popup closes. Values: true | false
|
"autoPauseVideoOnYomitanPopup": true, // Automatically pause mpv playback while Yomitan popup is open, then resume when popup closes. Values: true | false
|
||||||
"hoverTokenColor": "#f4dbd6", // Hex color used for hovered subtitle token highlight in mpv.
|
"hoverTokenColor": "#f4dbd6", // Hex color used for hovered subtitle token highlight in mpv.
|
||||||
"hoverTokenBackgroundColor": "rgba(54, 58, 79, 0.84)", // CSS color used for hovered subtitle token background highlight in mpv.
|
"hoverTokenBackgroundColor": "rgba(54, 58, 79, 0.84)", // CSS color used for hovered subtitle token background highlight in mpv.
|
||||||
"nameMatchEnabled": true, // Enable subtitle token coloring for matches from the SubMiner character dictionary. Values: true | false
|
"nameMatchEnabled": true, // Enable subtitle token coloring for matches from the SubMiner character dictionary. Values: true | false
|
||||||
@@ -290,7 +290,7 @@
|
|||||||
// Hot-reload: subtitle sidebar changes apply live without restarting SubMiner.
|
// Hot-reload: subtitle sidebar changes apply live without restarting SubMiner.
|
||||||
// ==========================================
|
// ==========================================
|
||||||
"subtitleSidebar": {
|
"subtitleSidebar": {
|
||||||
"enabled": false, // Enable the subtitle sidebar feature for parsed subtitle sources. Values: true | false
|
"enabled": true, // Enable the subtitle sidebar feature for parsed subtitle sources. Values: true | false
|
||||||
"autoOpen": false, // Automatically open the subtitle sidebar once during overlay startup. Values: true | false
|
"autoOpen": false, // Automatically open the subtitle sidebar once during overlay startup. Values: true | false
|
||||||
"layout": "overlay", // Render the subtitle sidebar as a floating overlay or reserve space inside mpv. Values: overlay | embedded
|
"layout": "overlay", // Render the subtitle sidebar as a floating overlay or reserve space inside mpv. Values: overlay | embedded
|
||||||
"toggleKey": "Backslash", // KeyboardEvent.code used to toggle the subtitle sidebar open and closed.
|
"toggleKey": "Backslash", // KeyboardEvent.code used to toggle the subtitle sidebar open and closed.
|
||||||
@@ -330,7 +330,7 @@
|
|||||||
// Most other AnkiConnect settings still require restart.
|
// Most other AnkiConnect settings still require restart.
|
||||||
// ==========================================
|
// ==========================================
|
||||||
"ankiConnect": {
|
"ankiConnect": {
|
||||||
"enabled": false, // Enable AnkiConnect integration. Values: true | false
|
"enabled": true, // Enable AnkiConnect integration. Values: true | false
|
||||||
"url": "http://127.0.0.1:8765", // Url setting.
|
"url": "http://127.0.0.1:8765", // Url setting.
|
||||||
"pollingRate": 3000, // Polling interval in milliseconds.
|
"pollingRate": 3000, // Polling interval in milliseconds.
|
||||||
"proxy": {
|
"proxy": {
|
||||||
@@ -415,14 +415,14 @@
|
|||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
// YouTube Playback Settings
|
// YouTube Playback Settings
|
||||||
// Defaults for SubMiner YouTube subtitle loading and languages.
|
// Defaults for managed subtitle language preferences and YouTube subtitle loading.
|
||||||
// ==========================================
|
// ==========================================
|
||||||
"youtube": {
|
"youtube": {
|
||||||
"primarySubLanguages": [
|
"primarySubLanguages": [
|
||||||
"ja",
|
"ja",
|
||||||
"jpn"
|
"jpn"
|
||||||
] // Comma-separated primary subtitle language priority for YouTube auto-loading.
|
] // Comma-separated primary subtitle language priority for managed subtitle auto-selection.
|
||||||
}, // Defaults for SubMiner YouTube subtitle loading and languages.
|
}, // Defaults for managed subtitle language preferences and YouTube subtitle loading.
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
// Anilist
|
// Anilist
|
||||||
@@ -458,6 +458,15 @@
|
|||||||
"externalProfilePath": "" // Optional external Yomitan Electron profile path to use in read-only mode for shared dictionaries/settings. Example: ~/.config/gsm_overlay
|
"externalProfilePath": "" // Optional external Yomitan Electron profile path to use in read-only mode for shared dictionaries/settings. Example: ~/.config/gsm_overlay
|
||||||
}, // Optional external Yomitan profile integration.
|
}, // Optional external Yomitan profile integration.
|
||||||
|
|
||||||
|
// ==========================================
|
||||||
|
// MPV Launcher
|
||||||
|
// Optional mpv.exe override for Windows playback entry points.
|
||||||
|
// Leave mpv.executablePath blank to auto-discover mpv.exe from SUBMINER_MPV_PATH or PATH.
|
||||||
|
// ==========================================
|
||||||
|
"mpv": {
|
||||||
|
"executablePath": "" // Optional absolute path to mpv.exe for Windows launch flows. Leave empty to auto-discover from SUBMINER_MPV_PATH or PATH.
|
||||||
|
}, // Optional mpv.exe override for Windows playback entry points.
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
// Jellyfin
|
// Jellyfin
|
||||||
// Optional Jellyfin integration for auth, browsing, and playback launch.
|
// Optional Jellyfin integration for auth, browsing, and playback launch.
|
||||||
@@ -497,7 +506,7 @@
|
|||||||
// Uses official SubMiner Discord app assets for polished card visuals.
|
// Uses official SubMiner Discord app assets for polished card visuals.
|
||||||
// ==========================================
|
// ==========================================
|
||||||
"discordPresence": {
|
"discordPresence": {
|
||||||
"enabled": false, // Enable optional Discord Rich Presence updates. Values: true | false
|
"enabled": true, // Enable optional Discord Rich Presence updates. Values: true | false
|
||||||
"presenceStyle": "default", // Presence card text preset: "default" (clean bilingual), "meme" (Mining and crafting), "japanese" (fully JP), or "minimal".
|
"presenceStyle": "default", // Presence card text preset: "default" (clean bilingual), "meme" (Mining and crafting), "japanese" (fully JP), or "minimal".
|
||||||
"updateIntervalMs": 3000, // Minimum interval between presence payload updates.
|
"updateIntervalMs": 3000, // Minimum interval between presence payload updates.
|
||||||
"debounceMs": 750 // Debounce delay used to collapse bursty presence updates.
|
"debounceMs": 750 // Debounce delay used to collapse bursty presence updates.
|
||||||
@@ -544,6 +553,6 @@
|
|||||||
"markWatchedKey": "KeyW", // Key code to mark the current video as watched and advance to the next playlist entry.
|
"markWatchedKey": "KeyW", // Key code to mark the current video as watched and advance to the next playlist entry.
|
||||||
"serverPort": 6969, // Port for the stats HTTP server.
|
"serverPort": 6969, // Port for the stats HTTP server.
|
||||||
"autoStartServer": true, // Automatically start the stats server on launch. Values: true | false
|
"autoStartServer": true, // Automatically start the stats server on launch. Values: true | false
|
||||||
"autoOpenBrowser": true // Automatically open the stats dashboard in a browser when the server starts. Values: true | false
|
"autoOpenBrowser": false // Automatically open the stats dashboard in a browser when the server starts. Values: true | false
|
||||||
} // Local immersion stats dashboard served on localhost and available as an in-app overlay.
|
} // Local immersion stats dashboard served on localhost and available as an in-app overlay.
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -74,7 +74,7 @@ src/
|
|||||||
handlers/ # Keyboard/mouse interaction modules
|
handlers/ # Keyboard/mouse interaction modules
|
||||||
modals/ # Jimaku/Kiku/subsync/runtime-options/session-help modals
|
modals/ # Jimaku/Kiku/subsync/runtime-options/session-help modals
|
||||||
positioning/ # Subtitle position controller (drag-to-reposition)
|
positioning/ # Subtitle position controller (drag-to-reposition)
|
||||||
window-trackers/ # Backend-specific tracker implementations (Hyprland, Sway, X11, macOS)
|
window-trackers/ # Backend-specific tracker implementations (Hyprland, Sway, X11, macOS, Windows)
|
||||||
jimaku/ # Jimaku API integration helpers
|
jimaku/ # Jimaku API integration helpers
|
||||||
subsync/ # Subtitle sync (alass/ffsubsync) helpers
|
subsync/ # Subtitle sync (alass/ffsubsync) helpers
|
||||||
subtitle/ # Subtitle processing utilities
|
subtitle/ # Subtitle processing utilities
|
||||||
|
|||||||
@@ -1,5 +1,21 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## v0.11.0 (2026-04-03)
|
||||||
|
- Added a playlist browser overlay modal for browsing sibling video files and the live mpv queue during playback, with a default `Ctrl+Alt+P` keybinding.
|
||||||
|
- Made mpv plugin installation mandatory in first-run setup (removed skip path); Finish stays disabled until the plugin is installed.
|
||||||
|
- Fixed the Windows `SubMiner mpv` shortcut to launch mpv with required default args directly instead of requiring an `mpv.conf` profile named `subminer`.
|
||||||
|
- Fixed the Windows mpv idle launch so loading a video after opening the shortcut keeps mpv in the SubMiner-managed session and auto-starts the overlay.
|
||||||
|
- Added a blank-by-default `mpv.executablePath` config override for Windows playback when mpv is not on `PATH`, exposed in first-run setup.
|
||||||
|
- Fixed Kiku duplicate grouping to reuse duplicate note IDs from both sentence-card creation and Yomitan popup mining, with background card addition and proper merge-modal sequencing.
|
||||||
|
- Fixed configured subtitle-jump keybindings to keep playback paused when invoked from a paused state.
|
||||||
|
- Fixed managed local subtitle auto-selection to reuse configured language priorities instead of staying on mpv's initial `sid=auto` guess.
|
||||||
|
- Kept tracked macOS visible overlays click-through by default so subtitle sidebar passthrough works immediately.
|
||||||
|
- Stopped AniList post-watch from sending duplicate progress updates when already satisfied by a retry item.
|
||||||
|
- Kept integrated `--start --texthooker` launches on the full app-ready startup path.
|
||||||
|
- Honored `SUBMINER_YTDLP_BIN` consistently across all YouTube flows (playback URL resolution, track probing, subtitle downloads, metadata probing).
|
||||||
|
- Added `windows` as a recognized launcher backend option and auto-detection target.
|
||||||
|
- Added a dedicated Subtitle Sidebar guide to the docs site with links from homepage and configuration docs.
|
||||||
|
|
||||||
## v0.10.0 (2026-03-29)
|
## v0.10.0 (2026-03-29)
|
||||||
- Fixed stats startup so the immersion tracker can run when `Bun.serve` is unavailable.
|
- Fixed stats startup so the immersion tracker can run when `Bun.serve` is unavailable.
|
||||||
- Added a Node `http` fallback for Electron/runtime paths that do not expose Bun, so stats keeps working there too.
|
- Added a Node `http` fallback for Electron/runtime paths that do not expose Bun, so stats keeps working there too.
|
||||||
|
|||||||
@@ -252,7 +252,7 @@ See `config.example.jsonc` for detailed configuration options.
|
|||||||
{
|
{
|
||||||
"texthooker": {
|
"texthooker": {
|
||||||
"launchAtStartup": true,
|
"launchAtStartup": true,
|
||||||
"openBrowser": true
|
"openBrowser": false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -260,7 +260,7 @@ See `config.example.jsonc` for detailed configuration options.
|
|||||||
| Option | Values | Description |
|
| Option | Values | Description |
|
||||||
| ---------------- | --------------- | ------------------------------------------------------------------------------------------------ |
|
| ---------------- | --------------- | ------------------------------------------------------------------------------------------------ |
|
||||||
| `launchAtStartup`| `true`, `false` | Start texthooker automatically with SubMiner startup (default: `true`) |
|
| `launchAtStartup`| `true`, `false` | Start texthooker automatically with SubMiner startup (default: `true`) |
|
||||||
| `openBrowser` | `true`, `false` | Open browser tab when texthooker starts (default: `true`) |
|
| `openBrowser` | `true`, `false` | Open browser tab when texthooker starts (default: `false`) |
|
||||||
|
|
||||||
## Subtitle Display
|
## Subtitle Display
|
||||||
|
|
||||||
@@ -307,7 +307,7 @@ See `config.example.jsonc` for detailed configuration options.
|
|||||||
| `enableJlpt` | boolean | Enable JLPT level underline styling (`false` by default) |
|
| `enableJlpt` | boolean | Enable JLPT level underline styling (`false` by default) |
|
||||||
| `preserveLineBreaks` | boolean | Preserve line breaks in visible overlay subtitle rendering (`false` by default). Enable to mirror mpv line layout. |
|
| `preserveLineBreaks` | boolean | Preserve line breaks in visible overlay subtitle rendering (`false` by default). Enable to mirror mpv line layout. |
|
||||||
| `autoPauseVideoOnHover` | boolean | Pause playback while mouse hovers subtitle text, then resume on leave (`true` by default). |
|
| `autoPauseVideoOnHover` | boolean | Pause playback while mouse hovers subtitle text, then resume on leave (`true` by default). |
|
||||||
| `autoPauseVideoOnYomitanPopup` | boolean | Pause playback while the Yomitan popup is open, then resume when the popup closes (`false` by default). |
|
| `autoPauseVideoOnYomitanPopup` | boolean | Pause playback while the Yomitan popup is open, then resume when the popup closes (`true` by default). |
|
||||||
| `hoverTokenColor` | string | Hex color used for hovered subtitle token highlight in mpv (default: catppuccin mauve) |
|
| `hoverTokenColor` | string | Hex color used for hovered subtitle token highlight in mpv (default: catppuccin mauve) |
|
||||||
| `hoverTokenBackgroundColor` | string | CSS color used for hovered subtitle token background highlight (default: semi-transparent dark) |
|
| `hoverTokenBackgroundColor` | string | CSS color used for hovered subtitle token background highlight (default: semi-transparent dark) |
|
||||||
| `nameMatchEnabled` | boolean | Enable subtitle token coloring for matches from the SubMiner character dictionary (`true` by default) |
|
| `nameMatchEnabled` | boolean | Enable subtitle token coloring for matches from the SubMiner character dictionary (`true` by default) |
|
||||||
@@ -355,7 +355,7 @@ Configure the parsed-subtitle sidebar modal.
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"subtitleSidebar": {
|
"subtitleSidebar": {
|
||||||
"enabled": false,
|
"enabled": true,
|
||||||
"autoOpen": false,
|
"autoOpen": false,
|
||||||
"layout": "overlay",
|
"layout": "overlay",
|
||||||
"toggleKey": "Backslash",
|
"toggleKey": "Backslash",
|
||||||
@@ -369,7 +369,7 @@ Configure the parsed-subtitle sidebar modal.
|
|||||||
|
|
||||||
| Option | Values | Description |
|
| Option | Values | Description |
|
||||||
| --------------------------- | ---------------- | -------------------------------------------------------------------------------- |
|
| --------------------------- | ---------------- | -------------------------------------------------------------------------------- |
|
||||||
| `enabled` | boolean | Enable subtitle sidebar support (`false` by default) |
|
| `enabled` | boolean | Enable subtitle sidebar support (`true` by default) |
|
||||||
| `autoOpen` | boolean | Open sidebar automatically on overlay startup (`false` by default) |
|
| `autoOpen` | boolean | Open sidebar automatically on overlay startup (`false` by default) |
|
||||||
| `layout` | string | `"overlay"` floats over mpv; `"embedded"` reserves right-side player space to mimic browser-like layout |
|
| `layout` | string | `"overlay"` floats over mpv; `"embedded"` reserves right-side player space to mimic browser-like layout |
|
||||||
| `toggleKey` | string | `KeyboardEvent.code` used to open/close the sidebar (default: `"Backslash"`) |
|
| `toggleKey` | string | `KeyboardEvent.code` used to open/close the sidebar (default: `"Backslash"`) |
|
||||||
@@ -448,6 +448,8 @@ See `config.example.jsonc` for detailed configuration options.
|
|||||||
| `autoLoadSecondarySub` | `true`, `false` | Auto-detect and load matching secondary subtitle track |
|
| `autoLoadSecondarySub` | `true`, `false` | Auto-detect and load matching secondary subtitle track |
|
||||||
| `defaultMode` | `"hidden"`, `"visible"`, `"hover"` | Initial display mode (default: `"hover"`) |
|
| `defaultMode` | `"hidden"`, `"visible"`, `"hover"` | Initial display mode (default: `"hover"`) |
|
||||||
|
|
||||||
|
`secondarySub.secondarySubLanguages` also acts as the fallback secondary-language priority for managed startup subtitle selection on local playback and YouTube playback.
|
||||||
|
|
||||||
**Display modes:**
|
**Display modes:**
|
||||||
|
|
||||||
- **hidden** — Secondary subtitles not shown
|
- **hidden** — Secondary subtitles not shown
|
||||||
@@ -846,7 +848,7 @@ This example is intentionally compact. The option table below documents availabl
|
|||||||
|
|
||||||
| Option | Values | Description |
|
| Option | Values | Description |
|
||||||
| --------------------------------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `enabled` | `true`, `false` | Enable AnkiConnect integration (default: `false`) |
|
| `enabled` | `true`, `false` | Enable AnkiConnect integration (default: `true`) |
|
||||||
| `url` | string (URL) | AnkiConnect API URL (default: `http://127.0.0.1:8765`) |
|
| `url` | string (URL) | AnkiConnect API URL (default: `http://127.0.0.1:8765`) |
|
||||||
| `pollingRate` | number (ms) | How often to check for new cards in polling mode (default: `3000`; ignored for direct proxy `addNote`/`addNotes` updates) |
|
| `pollingRate` | number (ms) | How often to check for new cards in polling mode (default: `3000`; ignored for direct proxy `addNote`/`addNotes` updates) |
|
||||||
| `proxy.enabled` | `true`, `false` | Enable local AnkiConnect-compatible proxy for push-based auto-enrichment (default: `true`) |
|
| `proxy.enabled` | `true`, `false` | Enable local AnkiConnect-compatible proxy for push-based auto-enrichment (default: `true`) |
|
||||||
@@ -969,6 +971,7 @@ To refresh roughly once per day, set:
|
|||||||
| `disabled` | No field grouping; duplicate cards are left as-is |
|
| `disabled` | No field grouping; duplicate cards are left as-is |
|
||||||
|
|
||||||
`deleteDuplicateInAuto` controls whether `auto` mode deletes the duplicate after merge (default: `true`). In `manual` mode, the popup asks each time whether to delete the duplicate.
|
`deleteDuplicateInAuto` controls whether `auto` mode deletes the duplicate after merge (default: `true`). In `manual` mode, the popup asks each time whether to delete the duplicate.
|
||||||
|
When the manual merge popup opens, SubMiner pauses playback and closes any open Yomitan popup first so the merge flow can take focus.
|
||||||
|
|
||||||
<video controls playsinline preload="metadata" poster="/assets/kiku-integration-poster.jpg" style="width: 100%; max-width: 960px;">
|
<video controls playsinline preload="metadata" poster="/assets/kiku-integration-poster.jpg" style="width: 100%; max-width: 960px;">
|
||||||
<source :src="'/assets/kiku-integration.webm'" type="video/webm" />
|
<source :src="'/assets/kiku-integration.webm'" type="video/webm" />
|
||||||
@@ -1194,7 +1197,7 @@ Jellyfin remote auto-connect runs only when all three are `true`: `jellyfin.enab
|
|||||||
|
|
||||||
### Discord Rich Presence
|
### Discord Rich Presence
|
||||||
|
|
||||||
Discord Rich Presence is optional and disabled by default. When enabled, SubMiner publishes a polished activity card that reflects current media title, playback state, and session timer.
|
Discord Rich Presence is enabled by default. SubMiner publishes a polished activity card that reflects current media title, playback state, and session timer unless you turn it off.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -1209,14 +1212,14 @@ Discord Rich Presence is optional and disabled by default. When enabled, SubMine
|
|||||||
|
|
||||||
| Option | Values | Description |
|
| Option | Values | Description |
|
||||||
| ------------------ | ------------------------------------------------- | ---------------------------------------------------------- |
|
| ------------------ | ------------------------------------------------- | ---------------------------------------------------------- |
|
||||||
| `enabled` | `true`, `false` | Enable Discord Rich Presence updates (default: `false`) |
|
| `enabled` | `true`, `false` | Enable Discord Rich Presence updates (default: `true`) |
|
||||||
| `presenceStyle` | `"default"`, `"meme"`, `"japanese"`, `"minimal"` | Card text preset (default: `"default"`) |
|
| `presenceStyle` | `"default"`, `"meme"`, `"japanese"`, `"minimal"` | Card text preset (default: `"default"`) |
|
||||||
| `updateIntervalMs` | number | Minimum interval between activity updates in milliseconds |
|
| `updateIntervalMs` | number | Minimum interval between activity updates in milliseconds |
|
||||||
| `debounceMs` | number | Debounce window for bursty playback events in milliseconds |
|
| `debounceMs` | number | Debounce window for bursty playback events in milliseconds |
|
||||||
|
|
||||||
Setup steps:
|
Setup steps:
|
||||||
|
|
||||||
1. Set `discordPresence.enabled` to `true`.
|
1. Leave `discordPresence.enabled` as `true` or set it explicitly if you previously disabled it.
|
||||||
2. Optionally set `discordPresence.presenceStyle` to choose a card text preset.
|
2. Optionally set `discordPresence.presenceStyle` to choose a card text preset.
|
||||||
3. Restart SubMiner.
|
3. Restart SubMiner.
|
||||||
|
|
||||||
@@ -1320,7 +1323,7 @@ Configure the local stats UI served from SubMiner and the in-app stats overlay t
|
|||||||
"toggleKey": "Backquote",
|
"toggleKey": "Backquote",
|
||||||
"serverPort": 6969,
|
"serverPort": 6969,
|
||||||
"autoStartServer": true,
|
"autoStartServer": true,
|
||||||
"autoOpenBrowser": true
|
"autoOpenBrowser": false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -1330,7 +1333,7 @@ Configure the local stats UI served from SubMiner and the in-app stats overlay t
|
|||||||
| `toggleKey` | Electron key code | Overlay-local key code used to toggle the stats overlay. Default `Backquote`. |
|
| `toggleKey` | Electron key code | Overlay-local key code used to toggle the stats overlay. Default `Backquote`. |
|
||||||
| `serverPort` | integer | Localhost port for the browser stats UI. Default `6969`. |
|
| `serverPort` | integer | Localhost port for the browser stats UI. Default `6969`. |
|
||||||
| `autoStartServer` | `true`, `false` | Start the local stats HTTP server automatically once immersion tracking is active. Default `true`. |
|
| `autoStartServer` | `true`, `false` | Start the local stats HTTP server automatically once immersion tracking is active. Default `true`. |
|
||||||
| `autoOpenBrowser` | `true`, `false` | When `subminer stats` starts the server on demand, also open the dashboard in your default browser. Default `true`. |
|
| `autoOpenBrowser` | `true`, `false` | When `subminer stats` starts the server on demand, also open the dashboard in your default browser. Default `false`. |
|
||||||
|
|
||||||
Usage notes:
|
Usage notes:
|
||||||
|
|
||||||
@@ -1341,7 +1344,7 @@ Usage notes:
|
|||||||
|
|
||||||
### YouTube Playback Settings
|
### YouTube Playback Settings
|
||||||
|
|
||||||
Set defaults used by the `subminer` launcher for YouTube subtitle loading:
|
Set defaults used by managed subtitle auto-selection and the `subminer` launcher YouTube flow:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -1353,7 +1356,7 @@ Set defaults used by the `subminer` launcher for YouTube subtitle loading:
|
|||||||
|
|
||||||
| Option | Values | Description |
|
| Option | Values | Description |
|
||||||
| --------------------- | -------------------- | ---------------------------------------------------------------------------------------------- |
|
| --------------------- | -------------------- | ---------------------------------------------------------------------------------------------- |
|
||||||
| `primarySubLanguages` | string[] | Primary subtitle language priority for YouTube auto-loading (default `["ja", "jpn"]`) |
|
| `primarySubLanguages` | string[] | Primary subtitle language priority for managed subtitle auto-selection (default `["ja", "jpn"]`) |
|
||||||
|
|
||||||
Current launcher behavior:
|
Current launcher behavior:
|
||||||
|
|
||||||
@@ -1369,6 +1372,7 @@ Language targets are derived from subtitle config:
|
|||||||
|
|
||||||
- primary track: `youtube.primarySubLanguages` (falls back to `["ja","jpn"]`)
|
- primary track: `youtube.primarySubLanguages` (falls back to `["ja","jpn"]`)
|
||||||
- secondary track: `secondarySub.secondarySubLanguages` (falls back to English when empty)
|
- secondary track: `secondarySub.secondarySubLanguages` (falls back to English when empty)
|
||||||
|
- Local playback uses the same priorities after mpv reports subtitle track metadata, so sidecar/internal mixed sets can override an incorrect initial `sid=auto` pick.
|
||||||
- Tracks are resolved and loaded before mpv starts; the older launcher mode switch has been removed.
|
- Tracks are resolved and loaded before mpv starts; the older launcher mode switch has been removed.
|
||||||
|
|
||||||
Precedence for launcher defaults is: CLI flag > environment variable > `config.jsonc` > built-in default.
|
Precedence for launcher defaults is: CLI flag > environment variable > `config.jsonc` > built-in default.
|
||||||
|
|||||||
@@ -72,7 +72,7 @@ Stats server config lives under `stats`:
|
|||||||
"toggleKey": "Backquote",
|
"toggleKey": "Backquote",
|
||||||
"serverPort": 6969,
|
"serverPort": 6969,
|
||||||
"autoStartServer": true,
|
"autoStartServer": true,
|
||||||
"autoOpenBrowser": true
|
"autoOpenBrowser": false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -23,7 +23,7 @@
|
|||||||
|
|
||||||
**macOS** — macOS 10.13 or later. Accessibility permission required for window tracking.
|
**macOS** — macOS 10.13 or later. Accessibility permission required for window tracking.
|
||||||
|
|
||||||
**Windows** — Windows 10 or later. Install `mpv` and keep it available on `PATH`; SubMiner's packaged build handles window tracking directly.
|
**Windows** — Windows 10 or later. Install `mpv`; keep it on `PATH` for auto-discovery or set `mpv.executablePath` in config if `mpv.exe` lives elsewhere. SubMiner's packaged build handles window tracking directly.
|
||||||
|
|
||||||
### Optional Tools
|
### Optional Tools
|
||||||
|
|
||||||
@@ -171,7 +171,9 @@ Install `mpv` separately and ensure `mpv.exe` is on `PATH`. `ffmpeg` is still re
|
|||||||
|
|
||||||
### Windows Usage Notes
|
### Windows Usage Notes
|
||||||
|
|
||||||
- Launch `SubMiner.exe` once to let the first-run setup flow seed `%APPDATA%\\SubMiner\\config.jsonc`, offer mpv plugin installation, open bundled Yomitan settings, and optionally create `SubMiner mpv` Start Menu/Desktop shortcuts.
|
- Launch `SubMiner.exe` once to let the first-run setup flow seed `%APPDATA%\\SubMiner\\config.jsonc`, require mpv plugin installation, and open bundled Yomitan settings. The optional `SubMiner mpv` Start Menu/Desktop shortcut can also be created during setup, and on Windows it is the recommended way to launch mpv playback with SubMiner defaults.
|
||||||
|
- If `mpv.exe` is not on `PATH`, set `mpv.executablePath` in `config.jsonc` or use the first-run setup field to point at the executable. Leave it blank to keep PATH auto-discovery.
|
||||||
|
- `SubMiner.exe --launch-mpv` and the optional `SubMiner mpv` shortcut pass SubMiner's default mpv socket/subtitle args directly and do not require an `mpv.conf` profile named `subminer`.
|
||||||
- First-run mpv plugin installs pin `binary_path` to the current `SubMiner.exe` automatically. Manual plugin configs can leave `binary_path` empty unless SubMiner is installed in a non-standard location.
|
- First-run mpv plugin installs pin `binary_path` to the current `SubMiner.exe` automatically. Manual plugin configs can leave `binary_path` empty unless SubMiner is installed in a non-standard location.
|
||||||
- Windows plugin installs rewrite `socket_path` to `\\.\pipe\subminer-socket`; do not keep `/tmp/subminer-socket` on Windows.
|
- Windows plugin installs rewrite `socket_path` to `\\.\pipe\subminer-socket`; do not keep `/tmp/subminer-socket` on Windows.
|
||||||
- Native window tracking is built in on Windows; no `xdotool`, `xwininfo`, or compositor-specific helper is required.
|
- Native window tracking is built in on Windows; no `xdotool`, `xwininfo`, or compositor-specific helper is required.
|
||||||
|
|||||||
@@ -98,7 +98,7 @@ Use `subminer <subcommand> -h` for command-specific help.
|
|||||||
| `-T, --no-texthooker` | Disable texthooker server |
|
| `-T, --no-texthooker` | Disable texthooker server |
|
||||||
| `-p, --profile` | mpv profile name (default: `subminer`) |
|
| `-p, --profile` | mpv profile name (default: `subminer`) |
|
||||||
| `-a, --args` | Pass additional mpv arguments as a quoted string |
|
| `-a, --args` | Pass additional mpv arguments as a quoted string |
|
||||||
| `-b, --backend` | Force window backend (`hyprland`, `sway`, `x11`) |
|
| `-b, --backend` | Force window backend (`hyprland`, `sway`, `x11`, `macos`, `windows`) |
|
||||||
| `--log-level` | Logger verbosity (`debug`, `info`, `warn`, `error`) |
|
| `--log-level` | Logger verbosity (`debug`, `info`, `warn`, `error`) |
|
||||||
| `--dev`, `--debug` | Enable app dev-mode (not tied to log level) |
|
| `--dev`, `--debug` | Enable app dev-mode (not tied to log level) |
|
||||||
|
|
||||||
|
|||||||
@@ -51,7 +51,7 @@ The visible overlay renders subtitles as tokenized hoverable word spans. Each wo
|
|||||||
|
|
||||||
- Word-level hover targets for Yomitan lookup
|
- Word-level hover targets for Yomitan lookup
|
||||||
- Auto pause/resume on subtitle hover (enabled by default via `subtitleStyle.autoPauseVideoOnHover`)
|
- Auto pause/resume on subtitle hover (enabled by default via `subtitleStyle.autoPauseVideoOnHover`)
|
||||||
- Optional pause while the Yomitan popup is open (`subtitleStyle.autoPauseVideoOnYomitanPopup`)
|
- Auto pause/resume while the Yomitan popup is open (enabled by default via `subtitleStyle.autoPauseVideoOnYomitanPopup`)
|
||||||
- Right-click to pause/resume
|
- Right-click to pause/resume
|
||||||
- Right-click + drag to reposition subtitles
|
- Right-click + drag to reposition subtitles
|
||||||
- Modal dialogs for Jimaku search, field grouping, subsync, and runtime options
|
- Modal dialogs for Jimaku search, field grouping, subsync, and runtime options
|
||||||
|
|||||||
@@ -79,7 +79,7 @@ texthooker_enabled=yes
|
|||||||
# Port for the texthooker server.
|
# Port for the texthooker server.
|
||||||
texthooker_port=5174
|
texthooker_port=5174
|
||||||
|
|
||||||
# Window manager backend: auto, hyprland, sway, x11, macos.
|
# Window manager backend: auto, hyprland, sway, x11, macos, windows.
|
||||||
backend=auto
|
backend=auto
|
||||||
|
|
||||||
# Start the overlay automatically when a file is loaded.
|
# Start the overlay automatically when a file is loaded.
|
||||||
|
|||||||
@@ -18,7 +18,7 @@
|
|||||||
// ==========================================
|
// ==========================================
|
||||||
"texthooker": {
|
"texthooker": {
|
||||||
"launchAtStartup": true, // Launch texthooker server automatically when SubMiner starts. Values: true | false
|
"launchAtStartup": true, // Launch texthooker server automatically when SubMiner starts. Values: true | false
|
||||||
"openBrowser": true // Open browser setting. Values: true | false
|
"openBrowser": false // Open browser setting. Values: true | false
|
||||||
}, // Configure texthooker startup launch and browser opening behavior.
|
}, // Configure texthooker startup launch and browser opening behavior.
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
@@ -58,7 +58,7 @@
|
|||||||
// Override controller.buttonIndices when your pad reports non-standard raw button numbers.
|
// Override controller.buttonIndices when your pad reports non-standard raw button numbers.
|
||||||
// ==========================================
|
// ==========================================
|
||||||
"controller": {
|
"controller": {
|
||||||
"enabled": true, // Enable overlay controller support through the Chrome Gamepad API. Values: true | false
|
"enabled": false, // Enable overlay controller support through the Chrome Gamepad API. Values: true | false
|
||||||
"preferredGamepadId": "", // Preferred controller id saved from the controller config modal.
|
"preferredGamepadId": "", // Preferred controller id saved from the controller config modal.
|
||||||
"preferredGamepadLabel": "", // Preferred controller display label saved for diagnostics.
|
"preferredGamepadLabel": "", // Preferred controller display label saved for diagnostics.
|
||||||
"smoothScroll": true, // Use smooth scrolling for controller-driven popup scroll input. Values: true | false
|
"smoothScroll": true, // Use smooth scrolling for controller-driven popup scroll input. Values: true | false
|
||||||
@@ -187,7 +187,7 @@
|
|||||||
// ==========================================
|
// ==========================================
|
||||||
// Secondary Subtitles
|
// Secondary Subtitles
|
||||||
// Dual subtitle track options.
|
// Dual subtitle track options.
|
||||||
// Used by the YouTube subtitle loading flow as secondary language preferences.
|
// Used by managed subtitle loading as secondary language preferences for local and YouTube playback.
|
||||||
// Hot-reload: defaultMode updates live while SubMiner is running.
|
// Hot-reload: defaultMode updates live while SubMiner is running.
|
||||||
// ==========================================
|
// ==========================================
|
||||||
"secondarySub": {
|
"secondarySub": {
|
||||||
@@ -225,7 +225,7 @@
|
|||||||
"enableJlpt": false, // Enable JLPT vocabulary level underlines. When disabled, JLPT tagging lookup and underlines are skipped. Values: true | false
|
"enableJlpt": false, // Enable JLPT vocabulary level underlines. When disabled, JLPT tagging lookup and underlines are skipped. Values: true | false
|
||||||
"preserveLineBreaks": false, // Preserve line breaks in visible overlay subtitle rendering. When false, line breaks are flattened to spaces for a single-line flow. Values: true | false
|
"preserveLineBreaks": false, // Preserve line breaks in visible overlay subtitle rendering. When false, line breaks are flattened to spaces for a single-line flow. Values: true | false
|
||||||
"autoPauseVideoOnHover": true, // Automatically pause mpv playback while hovering subtitle text, then resume on leave. Values: true | false
|
"autoPauseVideoOnHover": true, // Automatically pause mpv playback while hovering subtitle text, then resume on leave. Values: true | false
|
||||||
"autoPauseVideoOnYomitanPopup": false, // Automatically pause mpv playback while Yomitan popup is open, then resume when popup closes. Values: true | false
|
"autoPauseVideoOnYomitanPopup": true, // Automatically pause mpv playback while Yomitan popup is open, then resume when popup closes. Values: true | false
|
||||||
"hoverTokenColor": "#f4dbd6", // Hex color used for hovered subtitle token highlight in mpv.
|
"hoverTokenColor": "#f4dbd6", // Hex color used for hovered subtitle token highlight in mpv.
|
||||||
"hoverTokenBackgroundColor": "rgba(54, 58, 79, 0.84)", // CSS color used for hovered subtitle token background highlight in mpv.
|
"hoverTokenBackgroundColor": "rgba(54, 58, 79, 0.84)", // CSS color used for hovered subtitle token background highlight in mpv.
|
||||||
"nameMatchEnabled": true, // Enable subtitle token coloring for matches from the SubMiner character dictionary. Values: true | false
|
"nameMatchEnabled": true, // Enable subtitle token coloring for matches from the SubMiner character dictionary. Values: true | false
|
||||||
@@ -290,7 +290,7 @@
|
|||||||
// Hot-reload: subtitle sidebar changes apply live without restarting SubMiner.
|
// Hot-reload: subtitle sidebar changes apply live without restarting SubMiner.
|
||||||
// ==========================================
|
// ==========================================
|
||||||
"subtitleSidebar": {
|
"subtitleSidebar": {
|
||||||
"enabled": false, // Enable the subtitle sidebar feature for parsed subtitle sources. Values: true | false
|
"enabled": true, // Enable the subtitle sidebar feature for parsed subtitle sources. Values: true | false
|
||||||
"autoOpen": false, // Automatically open the subtitle sidebar once during overlay startup. Values: true | false
|
"autoOpen": false, // Automatically open the subtitle sidebar once during overlay startup. Values: true | false
|
||||||
"layout": "overlay", // Render the subtitle sidebar as a floating overlay or reserve space inside mpv. Values: overlay | embedded
|
"layout": "overlay", // Render the subtitle sidebar as a floating overlay or reserve space inside mpv. Values: overlay | embedded
|
||||||
"toggleKey": "Backslash", // KeyboardEvent.code used to toggle the subtitle sidebar open and closed.
|
"toggleKey": "Backslash", // KeyboardEvent.code used to toggle the subtitle sidebar open and closed.
|
||||||
@@ -330,7 +330,7 @@
|
|||||||
// Most other AnkiConnect settings still require restart.
|
// Most other AnkiConnect settings still require restart.
|
||||||
// ==========================================
|
// ==========================================
|
||||||
"ankiConnect": {
|
"ankiConnect": {
|
||||||
"enabled": false, // Enable AnkiConnect integration. Values: true | false
|
"enabled": true, // Enable AnkiConnect integration. Values: true | false
|
||||||
"url": "http://127.0.0.1:8765", // Url setting.
|
"url": "http://127.0.0.1:8765", // Url setting.
|
||||||
"pollingRate": 3000, // Polling interval in milliseconds.
|
"pollingRate": 3000, // Polling interval in milliseconds.
|
||||||
"proxy": {
|
"proxy": {
|
||||||
@@ -415,14 +415,14 @@
|
|||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
// YouTube Playback Settings
|
// YouTube Playback Settings
|
||||||
// Defaults for SubMiner YouTube subtitle loading and languages.
|
// Defaults for managed subtitle language preferences and YouTube subtitle loading.
|
||||||
// ==========================================
|
// ==========================================
|
||||||
"youtube": {
|
"youtube": {
|
||||||
"primarySubLanguages": [
|
"primarySubLanguages": [
|
||||||
"ja",
|
"ja",
|
||||||
"jpn"
|
"jpn"
|
||||||
] // Comma-separated primary subtitle language priority for YouTube auto-loading.
|
] // Comma-separated primary subtitle language priority for managed subtitle auto-selection.
|
||||||
}, // Defaults for SubMiner YouTube subtitle loading and languages.
|
}, // Defaults for managed subtitle language preferences and YouTube subtitle loading.
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
// Anilist
|
// Anilist
|
||||||
@@ -458,6 +458,15 @@
|
|||||||
"externalProfilePath": "" // Optional external Yomitan Electron profile path to use in read-only mode for shared dictionaries/settings. Example: ~/.config/gsm_overlay
|
"externalProfilePath": "" // Optional external Yomitan Electron profile path to use in read-only mode for shared dictionaries/settings. Example: ~/.config/gsm_overlay
|
||||||
}, // Optional external Yomitan profile integration.
|
}, // Optional external Yomitan profile integration.
|
||||||
|
|
||||||
|
// ==========================================
|
||||||
|
// MPV Launcher
|
||||||
|
// Optional mpv.exe override for Windows playback entry points.
|
||||||
|
// Leave mpv.executablePath blank to auto-discover mpv.exe from SUBMINER_MPV_PATH or PATH.
|
||||||
|
// ==========================================
|
||||||
|
"mpv": {
|
||||||
|
"executablePath": "" // Optional absolute path to mpv.exe for Windows launch flows. Leave empty to auto-discover from SUBMINER_MPV_PATH or PATH.
|
||||||
|
}, // Optional mpv.exe override for Windows playback entry points.
|
||||||
|
|
||||||
// ==========================================
|
// ==========================================
|
||||||
// Jellyfin
|
// Jellyfin
|
||||||
// Optional Jellyfin integration for auth, browsing, and playback launch.
|
// Optional Jellyfin integration for auth, browsing, and playback launch.
|
||||||
@@ -497,7 +506,7 @@
|
|||||||
// Uses official SubMiner Discord app assets for polished card visuals.
|
// Uses official SubMiner Discord app assets for polished card visuals.
|
||||||
// ==========================================
|
// ==========================================
|
||||||
"discordPresence": {
|
"discordPresence": {
|
||||||
"enabled": false, // Enable optional Discord Rich Presence updates. Values: true | false
|
"enabled": true, // Enable optional Discord Rich Presence updates. Values: true | false
|
||||||
"presenceStyle": "default", // Presence card text preset: "default" (clean bilingual), "meme" (Mining and crafting), "japanese" (fully JP), or "minimal".
|
"presenceStyle": "default", // Presence card text preset: "default" (clean bilingual), "meme" (Mining and crafting), "japanese" (fully JP), or "minimal".
|
||||||
"updateIntervalMs": 3000, // Minimum interval between presence payload updates.
|
"updateIntervalMs": 3000, // Minimum interval between presence payload updates.
|
||||||
"debounceMs": 750 // Debounce delay used to collapse bursty presence updates.
|
"debounceMs": 750 // Debounce delay used to collapse bursty presence updates.
|
||||||
@@ -544,6 +553,6 @@
|
|||||||
"markWatchedKey": "KeyW", // Key code to mark the current video as watched and advance to the next playlist entry.
|
"markWatchedKey": "KeyW", // Key code to mark the current video as watched and advance to the next playlist entry.
|
||||||
"serverPort": 6969, // Port for the stats HTTP server.
|
"serverPort": 6969, // Port for the stats HTTP server.
|
||||||
"autoStartServer": true, // Automatically start the stats server on launch. Values: true | false
|
"autoStartServer": true, // Automatically start the stats server on launch. Values: true | false
|
||||||
"autoOpenBrowser": true // Automatically open the stats dashboard in a browser when the server starts. Values: true | false
|
"autoOpenBrowser": false // Automatically open the stats dashboard in a browser when the server starts. Values: true | false
|
||||||
} // Local immersion stats dashboard served on localhost and available as an in-app overlay.
|
} // Local immersion stats dashboard served on localhost and available as an in-app overlay.
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
The subtitle sidebar displays the full parsed cue list for the active subtitle file as a scrollable panel alongside mpv. It lets you review past and upcoming lines, click any cue to seek directly to that moment, and follow along without depending on the transient overlay subtitles.
|
The subtitle sidebar displays the full parsed cue list for the active subtitle file as a scrollable panel alongside mpv. It lets you review past and upcoming lines, click any cue to seek directly to that moment, and follow along without depending on the transient overlay subtitles.
|
||||||
|
|
||||||
The sidebar is opt-in and disabled by default. Enable it under `subtitleSidebar.enabled` in your config.
|
The sidebar is enabled by default. Set `subtitleSidebar.enabled` to `false` if you want to turn it off.
|
||||||
|
|
||||||
## How It Works
|
## How It Works
|
||||||
|
|
||||||
@@ -29,7 +29,7 @@ Enable and configure the sidebar under `subtitleSidebar` in your config file:
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"subtitleSidebar": {
|
"subtitleSidebar": {
|
||||||
"enabled": false,
|
"enabled": true,
|
||||||
"autoOpen": false,
|
"autoOpen": false,
|
||||||
"layout": "overlay",
|
"layout": "overlay",
|
||||||
"toggleKey": "Backslash",
|
"toggleKey": "Backslash",
|
||||||
@@ -43,7 +43,7 @@ Enable and configure the sidebar under `subtitleSidebar` in your config file:
|
|||||||
|
|
||||||
| Option | Type | Default | Description |
|
| Option | Type | Default | Description |
|
||||||
| --------------------------- | ------- | ------------ | -------------------------------------------------------------------------------------------------- |
|
| --------------------------- | ------- | ------------ | -------------------------------------------------------------------------------------------------- |
|
||||||
| `enabled` | boolean | `false` | Enable subtitle sidebar support |
|
| `enabled` | boolean | `true` | Enable subtitle sidebar support |
|
||||||
| `autoOpen` | boolean | `false` | Open the sidebar automatically on overlay startup |
|
| `autoOpen` | boolean | `false` | Open the sidebar automatically on overlay startup |
|
||||||
| `layout` | string | `"overlay"` | `"overlay"` floats over mpv; `"embedded"` reserves right-side player space |
|
| `layout` | string | `"overlay"` | `"overlay"` floats over mpv; `"embedded"` reserves right-side player space |
|
||||||
| `toggleKey` | string | `"Backslash"` | `KeyboardEvent.code` for the toggle shortcut |
|
| `toggleKey` | string | `"Backslash"` | `KeyboardEvent.code` for the toggle shortcut |
|
||||||
|
|||||||
@@ -117,12 +117,15 @@ SubMiner.AppImage --help # Show all options
|
|||||||
|
|
||||||
### Windows mpv Shortcut
|
### Windows mpv Shortcut
|
||||||
|
|
||||||
If you enabled the optional Windows shortcut during install, SubMiner creates a `SubMiner mpv` shortcut in the Start menu and/or on the desktop. It runs `SubMiner.exe --launch-mpv`, which starts `mpv.exe` with SubMiner's `subminer` profile.
|
First-run setup creates the config file, then requires the mpv plugin and Yomitan dictionaries before it can finish.
|
||||||
|
|
||||||
|
If you enabled the optional Windows shortcut during install, SubMiner creates a `SubMiner mpv` shortcut in the Start menu and/or on the desktop. On Windows, that shortcut is the recommended way to launch local files with SubMiner because it starts `mpv.exe` with the right defaults directly.
|
||||||
|
After setup completes, the shortcut is the normal Windows playback entry point.
|
||||||
|
|
||||||
You can use it three ways:
|
You can use it three ways:
|
||||||
|
|
||||||
- Double-click `SubMiner mpv` to open `mpv` with the SubMiner profile.
|
- Double-click `SubMiner mpv` to open `mpv` with SubMiner's default socket/subtitle args.
|
||||||
- Drag a video file onto `SubMiner mpv` to launch that file with the same profile.
|
- Drag a video file onto `SubMiner mpv` to launch that file with the same defaults.
|
||||||
- Run it directly from Command Prompt or PowerShell with `--launch-mpv`.
|
- Run it directly from Command Prompt or PowerShell with `--launch-mpv`.
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
@@ -130,7 +133,7 @@ You can use it three ways:
|
|||||||
& "C:\Program Files\SubMiner\SubMiner.exe" --launch-mpv "C:\Videos\episode 01.mkv"
|
& "C:\Program Files\SubMiner\SubMiner.exe" --launch-mpv "C:\Videos\episode 01.mkv"
|
||||||
```
|
```
|
||||||
|
|
||||||
This flow requires `mpv.exe` to be on `PATH`. If it is installed elsewhere, set `SUBMINER_MPV_PATH` to the full `mpv.exe` path before launching.
|
This flow requires `mpv.exe` to be discoverable. Leave `mpv.executablePath` blank to auto-discover from `PATH`, or set it to the full `mpv.exe` path if mpv is installed elsewhere. `SUBMINER_MPV_PATH` is still honored as a fallback. On Windows, `--launch-mpv` does not require an `mpv.conf` profile named `subminer`.
|
||||||
|
|
||||||
### Launcher Subcommands
|
### Launcher Subcommands
|
||||||
|
|
||||||
@@ -157,12 +160,13 @@ SubMiner.AppImage --setup
|
|||||||
Setup flow:
|
Setup flow:
|
||||||
|
|
||||||
- config file: create the default config directory and prefer `config.jsonc`
|
- config file: create the default config directory and prefer `config.jsonc`
|
||||||
- plugin status: install or skip the bundled mpv plugin
|
- plugin status: install the bundled mpv plugin before finishing setup
|
||||||
- Yomitan shortcut: open bundled Yomitan settings directly from the setup window
|
- Yomitan shortcut: open bundled Yomitan settings directly from the setup window
|
||||||
- dictionary check: ensure at least one bundled Yomitan dictionary is available
|
- dictionary check: ensure at least one bundled Yomitan dictionary is available, unless an external Yomitan profile is configured
|
||||||
- Windows: optionally create or remove `SubMiner mpv` Start Menu/Desktop shortcuts (`SubMiner.exe --launch-mpv`)
|
- Windows: optionally create or remove `SubMiner mpv` Start Menu/Desktop shortcuts (`SubMiner.exe --launch-mpv`)
|
||||||
|
- Windows: optionally set `mpv.executablePath` if `mpv.exe` is not on `PATH`
|
||||||
- refresh: re-check plugin + dictionary state without restarting
|
- refresh: re-check plugin + dictionary state without restarting
|
||||||
- `Finish setup` stays disabled until dictionary availability is detected
|
- `Finish setup` stays disabled until the config, plugin, and dictionary gates are satisfied
|
||||||
- finish action writes setup completion state and suppresses future auto-open prompts
|
- finish action writes setup completion state and suppresses future auto-open prompts
|
||||||
|
|
||||||
AniList character dictionary auto-sync (optional):
|
AniList character dictionary auto-sync (optional):
|
||||||
@@ -189,7 +193,7 @@ Top-level launcher flags like `--jellyfin-*` are intentionally rejected.
|
|||||||
|
|
||||||
You can append additional MPV arguments with launcher `-a/--args`, for example `--args "--ao=alsa --volume=80"`.
|
You can append additional MPV arguments with launcher `-a/--args`, for example `--args "--ao=alsa --volume=80"`.
|
||||||
|
|
||||||
You can define a matching profile in `~/.config/mpv/mpv.conf` for consistency when launching `mpv` manually or from other tools. `subminer` launches with `--profile=subminer` by default (or override with `subminer -p <profile> ...`):
|
You can define a matching profile in `~/.config/mpv/mpv.conf` for consistency when launching `mpv` manually or from other tools. The Windows `SubMiner.exe --launch-mpv` shortcut path uses equivalent args directly, but skips the extra current-directory subtitle scan to avoid duplicate sidecar detection when you drag a video onto the shortcut; the optional profile remains useful for manual mpv launches and the `subminer` wrapper defaults to `--profile=subminer` (or override with `subminer -p <profile> ...`):
|
||||||
|
|
||||||
```ini
|
```ini
|
||||||
[subminer]
|
[subminer]
|
||||||
@@ -210,10 +214,6 @@ secondary-sid=auto
|
|||||||
secondary-sub-visibility=no
|
secondary-sub-visibility=no
|
||||||
```
|
```
|
||||||
|
|
||||||
::: warning
|
|
||||||
`secondary-slang` is not a valid mpv option. Use `slang` with `sid=auto` / `secondary-sid=auto` to set subtitle language preferences.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Yomitan setup
|
### Yomitan setup
|
||||||
|
|
||||||
SubMiner includes a bundled Yomitan extension for overlay word lookup. This bundled extension is separate from any Yomitan browser extension you may have installed.
|
SubMiner includes a bundled Yomitan extension for overlay word lookup. This bundled extension is separate from any Yomitan browser extension you may have installed.
|
||||||
@@ -238,6 +238,8 @@ Notes:
|
|||||||
- Secondary target languages come from `secondarySub.secondarySubLanguages` (defaults to English if unset).
|
- Secondary target languages come from `secondarySub.secondarySubLanguages` (defaults to English if unset).
|
||||||
- Configure defaults in `$XDG_CONFIG_HOME/SubMiner/config.jsonc` (or `~/.config/SubMiner/config.jsonc`) under `youtube` and `secondarySub`.
|
- Configure defaults in `$XDG_CONFIG_HOME/SubMiner/config.jsonc` (or `~/.config/SubMiner/config.jsonc`) under `youtube` and `secondarySub`.
|
||||||
|
|
||||||
|
For local video files, SubMiner now uses those same config-driven language priorities after mpv finishes reporting subtitle tracks. That means mixed internal/external subtitle sets can correct an initial `sid=auto` guess and settle onto the expected primary and secondary tracks without manual cycling.
|
||||||
|
|
||||||
## Controller Support
|
## Controller Support
|
||||||
|
|
||||||
SubMiner supports gamepad/controller input for couch-friendly usage via the Chrome Gamepad API. Controller input drives the overlay while keyboard-only mode is enabled.
|
SubMiner supports gamepad/controller input for couch-friendly usage via the Chrome Gamepad API. Controller input drives the overlay while keyboard-only mode is enabled.
|
||||||
@@ -291,13 +293,11 @@ See [Keyboard Shortcuts](/shortcuts) for the full reference, including mining sh
|
|||||||
| `Alt+Shift+O` | Toggle visible overlay |
|
| `Alt+Shift+O` | Toggle visible overlay |
|
||||||
| `Alt+Shift+Y` | Open Yomitan settings |
|
| `Alt+Shift+Y` | Open Yomitan settings |
|
||||||
|
|
||||||
::: tip
|
|
||||||
`Alt+Shift+Y` is fixed and not configurable. All other shortcuts can be changed under `shortcuts` in your config.
|
`Alt+Shift+Y` is fixed and not configurable. All other shortcuts can be changed under `shortcuts` in your config.
|
||||||
:::
|
|
||||||
|
|
||||||
Useful overlay-local default keybinding: `Ctrl+Alt+P` opens the playlist browser for the current video's parent directory and the live mpv queue so you can append, reorder, remove, or jump between episodes without leaving playback.
|
Useful overlay-local default keybinding: `Ctrl+Alt+P` opens the playlist browser for the current video's parent directory and the live mpv queue so you can append, reorder, remove, or jump between episodes without leaving playback.
|
||||||
|
|
||||||
Hovering over subtitle text pauses mpv by default; leaving resumes it. Disable with `subtitleStyle.autoPauseVideoOnHover: false`. To also pause while the Yomitan popup is open, set `subtitleStyle.autoPauseVideoOnYomitanPopup: true`.
|
Hovering over subtitle text pauses mpv by default; leaving resumes it. Yomitan popups also pause playback by default. Set `subtitleStyle.autoPauseVideoOnHover: false` or `subtitleStyle.autoPauseVideoOnYomitanPopup: false` to disable either behavior.
|
||||||
|
|
||||||
### Drag-and-Drop
|
### Drag-and-Drop
|
||||||
|
|
||||||
|
|||||||
@@ -34,7 +34,7 @@ SubMiner's integration ports are configured in `config.jsonc`.
|
|||||||
},
|
},
|
||||||
"texthooker": {
|
"texthooker": {
|
||||||
"launchAtStartup": true,
|
"launchAtStartup": true,
|
||||||
"openBrowser": true
|
"openBrowser": false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -125,6 +125,12 @@ function titleOverlapScore(expectedTitle: string, candidateTitle: string): numbe
|
|||||||
if (!expected || !candidate) return 0;
|
if (!expected || !candidate) return 0;
|
||||||
|
|
||||||
if (candidate.includes(expected)) return 120;
|
if (candidate.includes(expected)) return 120;
|
||||||
|
if (
|
||||||
|
candidate.split(' ').length >= 2 &&
|
||||||
|
` ${expected} `.includes(` ${candidate} `)
|
||||||
|
) {
|
||||||
|
return 90;
|
||||||
|
}
|
||||||
|
|
||||||
const expectedTokens = tokenizeMatchWords(expectedTitle);
|
const expectedTokens = tokenizeMatchWords(expectedTitle);
|
||||||
if (expectedTokens.length === 0) return 0;
|
if (expectedTokens.length === 0) return 0;
|
||||||
@@ -339,6 +345,12 @@ function isSeasonDirectoryName(value: string): boolean {
|
|||||||
return /^(?:season|s)[\s._-]*\d{1,2}$/i.test(value.trim());
|
return /^(?:season|s)[\s._-]*\d{1,2}$/i.test(value.trim());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function isEpisodeOnlyBaseName(value: string): boolean {
|
||||||
|
return /^(?:[Ss]\d{1,2}[Ee]\d{1,3}|[Ee][Pp]?[\s._-]*\d{1,3}|\d{1,3})(?:$|[\s._-])/.test(
|
||||||
|
value.trim(),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
function inferTitleFromPath(mediaPath: string): string {
|
function inferTitleFromPath(mediaPath: string): string {
|
||||||
const directory = path.dirname(mediaPath);
|
const directory = path.dirname(mediaPath);
|
||||||
const segments = directory.split(/[\\/]+/).filter((segment) => segment.length > 0);
|
const segments = directory.split(/[\\/]+/).filter((segment) => segment.length > 0);
|
||||||
@@ -445,8 +457,11 @@ export function inferAniSkipMetadataForFile(
|
|||||||
}
|
}
|
||||||
|
|
||||||
const baseName = path.basename(mediaPath, path.extname(mediaPath));
|
const baseName = path.basename(mediaPath, path.extname(mediaPath));
|
||||||
|
const cleanedBaseName = cleanupTitle(baseName);
|
||||||
const pathTitle = inferTitleFromPath(mediaPath);
|
const pathTitle = inferTitleFromPath(mediaPath);
|
||||||
const fallbackTitle = pathTitle || cleanupTitle(baseName) || baseName;
|
const fallbackTitle = isEpisodeOnlyBaseName(baseName)
|
||||||
|
? pathTitle || cleanedBaseName || baseName
|
||||||
|
: cleanedBaseName || pathTitle || baseName;
|
||||||
return {
|
return {
|
||||||
title: fallbackTitle,
|
title: fallbackTitle,
|
||||||
season: detectSeasonFromNameOrDir(mediaPath),
|
season: detectSeasonFromNameOrDir(mediaPath),
|
||||||
|
|||||||
@@ -21,7 +21,9 @@ import {
|
|||||||
getDefaultConfigDir,
|
getDefaultConfigDir,
|
||||||
getSetupStatePath,
|
getSetupStatePath,
|
||||||
readSetupState,
|
readSetupState,
|
||||||
|
resolveDefaultMpvInstallPaths,
|
||||||
} from '../../src/shared/setup-state.js';
|
} from '../../src/shared/setup-state.js';
|
||||||
|
import { detectInstalledFirstRunPlugin } from '../../src/main/runtime/first-run-setup-plugin.js';
|
||||||
import { hasLauncherExternalYomitanProfileConfig } from '../config.js';
|
import { hasLauncherExternalYomitanProfileConfig } from '../config.js';
|
||||||
|
|
||||||
const SETUP_WAIT_TIMEOUT_MS = 10 * 60 * 1000;
|
const SETUP_WAIT_TIMEOUT_MS = 10 * 60 * 1000;
|
||||||
@@ -105,6 +107,14 @@ async function ensurePlaybackSetupReady(context: LauncherCommandContext): Promis
|
|||||||
const ready = await ensureLauncherSetupReady({
|
const ready = await ensureLauncherSetupReady({
|
||||||
readSetupState: () => readSetupState(statePath),
|
readSetupState: () => readSetupState(statePath),
|
||||||
isExternalYomitanConfigured: () => hasLauncherExternalYomitanProfileConfig(),
|
isExternalYomitanConfigured: () => hasLauncherExternalYomitanProfileConfig(),
|
||||||
|
isPluginInstalled: () => {
|
||||||
|
const installPaths = resolveDefaultMpvInstallPaths(
|
||||||
|
process.platform,
|
||||||
|
os.homedir(),
|
||||||
|
process.env.XDG_CONFIG_HOME,
|
||||||
|
);
|
||||||
|
return detectInstalledFirstRunPlugin(installPaths);
|
||||||
|
},
|
||||||
launchSetupApp: () => {
|
launchSetupApp: () => {
|
||||||
const setupArgs = ['--background', '--setup'];
|
const setupArgs = ['--background', '--setup'];
|
||||||
if (args.logLevel) {
|
if (args.logLevel) {
|
||||||
|
|||||||
@@ -62,6 +62,7 @@ test('createDefaultArgs normalizes configured language codes and env thread over
|
|||||||
assert.deepEqual(parsed.youtubeAudioLangs, ['ja', 'jpn', 'en', 'eng']);
|
assert.deepEqual(parsed.youtubeAudioLangs, ['ja', 'jpn', 'en', 'eng']);
|
||||||
assert.equal(parsed.whisperThreads, 7);
|
assert.equal(parsed.whisperThreads, 7);
|
||||||
assert.equal(parsed.youtubeWhisperSourceLanguage, 'ja');
|
assert.equal(parsed.youtubeWhisperSourceLanguage, 'ja');
|
||||||
|
assert.equal(parsed.profile, '');
|
||||||
} finally {
|
} finally {
|
||||||
if (originalThreads === undefined) {
|
if (originalThreads === undefined) {
|
||||||
delete process.env.SUBMINER_WHISPER_THREADS;
|
delete process.env.SUBMINER_WHISPER_THREADS;
|
||||||
|
|||||||
@@ -49,10 +49,17 @@ function parseLogLevel(value: string): LogLevel {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function parseBackend(value: string): Backend {
|
function parseBackend(value: string): Backend {
|
||||||
if (value === 'auto' || value === 'hyprland' || value === 'x11' || value === 'macos') {
|
if (
|
||||||
|
value === 'auto' ||
|
||||||
|
value === 'hyprland' ||
|
||||||
|
value === 'sway' ||
|
||||||
|
value === 'x11' ||
|
||||||
|
value === 'macos' ||
|
||||||
|
value === 'windows'
|
||||||
|
) {
|
||||||
return value as Backend;
|
return value as Backend;
|
||||||
}
|
}
|
||||||
fail(`Invalid backend: ${value} (must be auto, hyprland, x11, or macos)`);
|
fail(`Invalid backend: ${value} (must be auto, hyprland, sway, x11, macos, or windows)`);
|
||||||
}
|
}
|
||||||
|
|
||||||
function parseDictionaryTarget(value: string): string {
|
function parseDictionaryTarget(value: string): string {
|
||||||
@@ -97,7 +104,7 @@ export function createDefaultArgs(launcherConfig: LauncherYoutubeSubgenConfig):
|
|||||||
backend: 'auto',
|
backend: 'auto',
|
||||||
directory: '.',
|
directory: '.',
|
||||||
recursive: false,
|
recursive: false,
|
||||||
profile: 'subminer',
|
profile: '',
|
||||||
startOverlay: false,
|
startOverlay: false,
|
||||||
whisperBin: process.env.SUBMINER_WHISPER_BIN || launcherConfig.whisperBin || '',
|
whisperBin: process.env.SUBMINER_WHISPER_BIN || launcherConfig.whisperBin || '',
|
||||||
whisperModel: process.env.SUBMINER_WHISPER_MODEL || launcherConfig.whisperModel || '',
|
whisperModel: process.env.SUBMINER_WHISPER_MODEL || launcherConfig.whisperModel || '',
|
||||||
|
|||||||
@@ -17,20 +17,20 @@ test('resolveTopLevelCommand respects the app alias after root options', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test('parseCliPrograms keeps root options and target when no command is present', () => {
|
test('parseCliPrograms keeps root options and target when no command is present', () => {
|
||||||
const result = parseCliPrograms(['--backend', 'x11', '/tmp/movie.mkv'], 'subminer');
|
const result = parseCliPrograms(['--backend', 'windows', '/tmp/movie.mkv'], 'subminer');
|
||||||
|
|
||||||
assert.equal(result.options.backend, 'x11');
|
assert.equal(result.options.backend, 'windows');
|
||||||
assert.equal(result.rootTarget, '/tmp/movie.mkv');
|
assert.equal(result.rootTarget, '/tmp/movie.mkv');
|
||||||
assert.equal(result.invocations.appInvocation, null);
|
assert.equal(result.invocations.appInvocation, null);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('parseCliPrograms routes app alias arguments through passthrough mode', () => {
|
test('parseCliPrograms routes app alias arguments through passthrough mode', () => {
|
||||||
const result = parseCliPrograms(
|
const result = parseCliPrograms(
|
||||||
['--backend', 'macos', 'bin', '--anilist', '--log-level', 'debug'],
|
['--backend', 'windows', 'bin', '--anilist', '--log-level', 'debug'],
|
||||||
'subminer',
|
'subminer',
|
||||||
);
|
);
|
||||||
|
|
||||||
assert.equal(result.options.backend, 'macos');
|
assert.equal(result.options.backend, 'windows');
|
||||||
assert.deepEqual(result.invocations.appInvocation, {
|
assert.deepEqual(result.invocations.appInvocation, {
|
||||||
appArgs: ['--anilist', '--log-level', 'debug'],
|
appArgs: ['--anilist', '--log-level', 'debug'],
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -43,7 +43,10 @@ export interface CliInvocations {
|
|||||||
|
|
||||||
function applyRootOptions(program: Command): void {
|
function applyRootOptions(program: Command): void {
|
||||||
program
|
program
|
||||||
.option('-b, --backend <backend>', 'Display backend')
|
.option(
|
||||||
|
'-b, --backend <backend>',
|
||||||
|
'Display backend (auto, hyprland, sway, x11, macos, windows)',
|
||||||
|
)
|
||||||
.option('-d, --directory <dir>', 'Directory to browse')
|
.option('-d, --directory <dir>', 'Directory to browse')
|
||||||
.option('-a, --args <args>', 'Pass arguments to MPV')
|
.option('-a, --args <args>', 'Pass arguments to MPV')
|
||||||
.option('-r, --recursive', 'Search directories recursively')
|
.option('-r, --recursive', 'Search directories recursively')
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ import { EventEmitter } from 'node:events';
|
|||||||
import type { Args } from './types';
|
import type { Args } from './types';
|
||||||
import {
|
import {
|
||||||
cleanupPlaybackSession,
|
cleanupPlaybackSession,
|
||||||
|
detectBackend,
|
||||||
findAppBinary,
|
findAppBinary,
|
||||||
launchAppCommandDetached,
|
launchAppCommandDetached,
|
||||||
launchTexthookerOnly,
|
launchTexthookerOnly,
|
||||||
@@ -56,6 +57,22 @@ function createTempSocketPath(): { dir: string; socketPath: string } {
|
|||||||
return { dir, socketPath: path.join(dir, 'mpv.sock') };
|
return { dir, socketPath: path.join(dir, 'mpv.sock') };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function withPlatform<T>(platform: NodeJS.Platform, callback: () => T): T {
|
||||||
|
const originalDescriptor = Object.getOwnPropertyDescriptor(process, 'platform');
|
||||||
|
Object.defineProperty(process, 'platform', {
|
||||||
|
configurable: true,
|
||||||
|
value: platform,
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
return callback();
|
||||||
|
} finally {
|
||||||
|
if (originalDescriptor) {
|
||||||
|
Object.defineProperty(process, 'platform', originalDescriptor);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
test('mpv module exposes only canonical socket readiness helper', () => {
|
test('mpv module exposes only canonical socket readiness helper', () => {
|
||||||
assert.equal('waitForSocket' in mpvModule, false);
|
assert.equal('waitForSocket' in mpvModule, false);
|
||||||
});
|
});
|
||||||
@@ -102,6 +119,12 @@ test('parseMpvArgString preserves empty quoted tokens', () => {
|
|||||||
]);
|
]);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('detectBackend resolves windows on win32 auto mode', () => {
|
||||||
|
withPlatform('win32', () => {
|
||||||
|
assert.equal(detectBackend('auto'), 'windows');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
test('launchTexthookerOnly exits non-zero when app binary cannot be spawned', () => {
|
test('launchTexthookerOnly exits non-zero when app binary cannot be spawned', () => {
|
||||||
const error = withProcessExitIntercept(() => {
|
const error = withProcessExitIntercept(() => {
|
||||||
launchTexthookerOnly('/definitely-missing-subminer-binary', makeArgs());
|
launchTexthookerOnly('/definitely-missing-subminer-binary', makeArgs());
|
||||||
@@ -427,6 +450,21 @@ function withFindAppBinaryEnvSandbox(run: () => void): void {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function withFindAppBinaryPlatformSandbox(
|
||||||
|
platform: NodeJS.Platform,
|
||||||
|
run: (pathModule: typeof path) => void,
|
||||||
|
): void {
|
||||||
|
const originalPlatform = process.platform;
|
||||||
|
try {
|
||||||
|
Object.defineProperty(process, 'platform', { value: platform, configurable: true });
|
||||||
|
withFindAppBinaryEnvSandbox(() =>
|
||||||
|
run(platform === 'win32' ? (path.win32 as typeof path) : path),
|
||||||
|
);
|
||||||
|
} finally {
|
||||||
|
Object.defineProperty(process, 'platform', { value: originalPlatform, configurable: true });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
function withAccessSyncStub(
|
function withAccessSyncStub(
|
||||||
isExecutablePath: (filePath: string) => boolean,
|
isExecutablePath: (filePath: string) => boolean,
|
||||||
run: () => void,
|
run: () => void,
|
||||||
@@ -447,62 +485,197 @@ function withAccessSyncStub(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
test('findAppBinary resolves ~/.local/bin/SubMiner.AppImage when it exists', () => {
|
function withRealpathSyncStub(resolvePath: (filePath: string) => string, run: () => void): void {
|
||||||
const baseDir = fs.mkdtempSync(path.join(os.tmpdir(), 'subminer-test-home-'));
|
const originalRealpathSync = fs.realpathSync;
|
||||||
const originalHomedir = os.homedir;
|
|
||||||
try {
|
try {
|
||||||
os.homedir = () => baseDir;
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||||
const appImage = path.join(baseDir, '.local/bin/SubMiner.AppImage');
|
(fs as any).realpathSync = (filePath: string): string => resolvePath(filePath);
|
||||||
makeExecutable(appImage);
|
run();
|
||||||
|
|
||||||
withFindAppBinaryEnvSandbox(() => {
|
|
||||||
const result = findAppBinary('/some/other/path/subminer');
|
|
||||||
assert.equal(result, appImage);
|
|
||||||
});
|
|
||||||
} finally {
|
} finally {
|
||||||
os.homedir = originalHomedir;
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||||
fs.rmSync(baseDir, { recursive: true, force: true });
|
(fs as any).realpathSync = originalRealpathSync;
|
||||||
}
|
}
|
||||||
});
|
}
|
||||||
|
|
||||||
test('findAppBinary resolves /opt/SubMiner/SubMiner.AppImage when ~/.local/bin candidate does not exist', () => {
|
test(
|
||||||
const baseDir = fs.mkdtempSync(path.join(os.tmpdir(), 'subminer-test-home-'));
|
'findAppBinary resolves ~/.local/bin/SubMiner.AppImage when it exists',
|
||||||
|
{ concurrency: false },
|
||||||
|
() => {
|
||||||
|
const baseDir = fs.mkdtempSync(path.join(os.tmpdir(), 'subminer-test-home-'));
|
||||||
|
const originalHomedir = os.homedir;
|
||||||
|
try {
|
||||||
|
os.homedir = () => baseDir;
|
||||||
|
const appImage = path.join(baseDir, '.local/bin/SubMiner.AppImage');
|
||||||
|
makeExecutable(appImage);
|
||||||
|
|
||||||
|
withFindAppBinaryPlatformSandbox('linux', (pathModule) => {
|
||||||
|
const result = findAppBinary('/some/other/path/subminer', pathModule);
|
||||||
|
assert.equal(result, appImage);
|
||||||
|
});
|
||||||
|
} finally {
|
||||||
|
os.homedir = originalHomedir;
|
||||||
|
fs.rmSync(baseDir, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
test(
|
||||||
|
'findAppBinary resolves /opt/SubMiner/SubMiner.AppImage when ~/.local/bin candidate does not exist',
|
||||||
|
{ concurrency: false },
|
||||||
|
() => {
|
||||||
|
const baseDir = fs.mkdtempSync(path.join(os.tmpdir(), 'subminer-test-home-'));
|
||||||
|
const originalHomedir = os.homedir;
|
||||||
|
try {
|
||||||
|
os.homedir = () => baseDir;
|
||||||
|
withFindAppBinaryPlatformSandbox('linux', (pathModule) => {
|
||||||
|
withAccessSyncStub(
|
||||||
|
(filePath) => filePath === '/opt/SubMiner/SubMiner.AppImage',
|
||||||
|
() => {
|
||||||
|
const result = findAppBinary('/some/other/path/subminer', pathModule);
|
||||||
|
assert.equal(result, '/opt/SubMiner/SubMiner.AppImage');
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
} finally {
|
||||||
|
os.homedir = originalHomedir;
|
||||||
|
fs.rmSync(baseDir, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
test(
|
||||||
|
'findAppBinary finds subminer on PATH when AppImage candidates do not exist',
|
||||||
|
{ concurrency: false },
|
||||||
|
() => {
|
||||||
|
const baseDir = fs.mkdtempSync(path.join(os.tmpdir(), 'subminer-test-path-'));
|
||||||
|
const originalHomedir = os.homedir;
|
||||||
|
const originalPath = process.env.PATH;
|
||||||
|
try {
|
||||||
|
os.homedir = () => baseDir;
|
||||||
|
// No AppImage candidates in empty home dir; place subminer wrapper on PATH
|
||||||
|
const binDir = path.join(baseDir, 'bin');
|
||||||
|
const wrapperPath = path.join(binDir, 'subminer');
|
||||||
|
makeExecutable(wrapperPath);
|
||||||
|
process.env.PATH = `${binDir}${path.delimiter}${originalPath ?? ''}`;
|
||||||
|
|
||||||
|
withFindAppBinaryPlatformSandbox('linux', (pathModule) => {
|
||||||
|
withAccessSyncStub(
|
||||||
|
(filePath) => filePath === wrapperPath,
|
||||||
|
() => {
|
||||||
|
// selfPath must differ from wrapperPath so the self-check does not exclude it
|
||||||
|
const result = findAppBinary(path.join(baseDir, 'launcher', 'subminer'), pathModule);
|
||||||
|
assert.equal(result, wrapperPath);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
} finally {
|
||||||
|
os.homedir = originalHomedir;
|
||||||
|
process.env.PATH = originalPath;
|
||||||
|
fs.rmSync(baseDir, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
test(
|
||||||
|
'findAppBinary excludes PATH matches that canonicalize to the launcher path',
|
||||||
|
{ concurrency: false },
|
||||||
|
() => {
|
||||||
|
const baseDir = fs.mkdtempSync(path.join(os.tmpdir(), 'subminer-test-realpath-'));
|
||||||
|
const originalHomedir = os.homedir;
|
||||||
|
const originalPath = process.env.PATH;
|
||||||
|
try {
|
||||||
|
os.homedir = () => baseDir;
|
||||||
|
const binDir = path.join(baseDir, 'bin');
|
||||||
|
const wrapperPath = path.join(binDir, 'subminer');
|
||||||
|
const canonicalPath = path.join(baseDir, 'launch', 'subminer');
|
||||||
|
makeExecutable(wrapperPath);
|
||||||
|
process.env.PATH = `${binDir}${path.delimiter}${originalPath ?? ''}`;
|
||||||
|
|
||||||
|
withFindAppBinaryPlatformSandbox('linux', (pathModule) => {
|
||||||
|
withAccessSyncStub(
|
||||||
|
(filePath) => filePath === wrapperPath,
|
||||||
|
() => {
|
||||||
|
withRealpathSyncStub(
|
||||||
|
(filePath) => {
|
||||||
|
if (filePath === canonicalPath || filePath === wrapperPath) {
|
||||||
|
return canonicalPath;
|
||||||
|
}
|
||||||
|
return filePath;
|
||||||
|
},
|
||||||
|
() => {
|
||||||
|
const result = findAppBinary(canonicalPath, pathModule);
|
||||||
|
assert.equal(result, null);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
} finally {
|
||||||
|
os.homedir = originalHomedir;
|
||||||
|
process.env.PATH = originalPath;
|
||||||
|
fs.rmSync(baseDir, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
test('findAppBinary resolves Windows install paths when present', { concurrency: false }, () => {
|
||||||
|
const baseDir = fs.mkdtempSync(path.join(os.tmpdir(), 'subminer-test-win-'));
|
||||||
const originalHomedir = os.homedir;
|
const originalHomedir = os.homedir;
|
||||||
|
const originalLocalAppData = process.env.LOCALAPPDATA;
|
||||||
try {
|
try {
|
||||||
os.homedir = () => baseDir;
|
os.homedir = () => baseDir;
|
||||||
withFindAppBinaryEnvSandbox(() => {
|
process.env.LOCALAPPDATA = path.win32.join(baseDir, 'AppData', 'Local');
|
||||||
|
const appExe = path.win32.join(
|
||||||
|
baseDir,
|
||||||
|
'AppData',
|
||||||
|
'Local',
|
||||||
|
'Programs',
|
||||||
|
'SubMiner',
|
||||||
|
'SubMiner.exe',
|
||||||
|
);
|
||||||
|
|
||||||
|
withFindAppBinaryPlatformSandbox('win32', (pathModule) => {
|
||||||
withAccessSyncStub(
|
withAccessSyncStub(
|
||||||
(filePath) => filePath === '/opt/SubMiner/SubMiner.AppImage',
|
(filePath) => filePath === appExe,
|
||||||
() => {
|
() => {
|
||||||
const result = findAppBinary('/some/other/path/subminer');
|
const result = findAppBinary(
|
||||||
assert.equal(result, '/opt/SubMiner/SubMiner.AppImage');
|
pathModule.join(baseDir, 'launcher', 'SubMiner.exe'),
|
||||||
|
pathModule,
|
||||||
|
);
|
||||||
|
assert.equal(result, appExe);
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
} finally {
|
} finally {
|
||||||
os.homedir = originalHomedir;
|
os.homedir = originalHomedir;
|
||||||
|
if (originalLocalAppData === undefined) {
|
||||||
|
delete process.env.LOCALAPPDATA;
|
||||||
|
} else {
|
||||||
|
process.env.LOCALAPPDATA = originalLocalAppData;
|
||||||
|
}
|
||||||
fs.rmSync(baseDir, { recursive: true, force: true });
|
fs.rmSync(baseDir, { recursive: true, force: true });
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
test('findAppBinary finds subminer on PATH when AppImage candidates do not exist', () => {
|
test('findAppBinary resolves SubMiner.exe on PATH on Windows', { concurrency: false }, () => {
|
||||||
const baseDir = fs.mkdtempSync(path.join(os.tmpdir(), 'subminer-test-path-'));
|
const baseDir = fs.mkdtempSync(path.join(os.tmpdir(), 'subminer-test-win-path-'));
|
||||||
const originalHomedir = os.homedir;
|
const originalHomedir = os.homedir;
|
||||||
const originalPath = process.env.PATH;
|
const originalPath = process.env.PATH;
|
||||||
try {
|
try {
|
||||||
os.homedir = () => baseDir;
|
os.homedir = () => baseDir;
|
||||||
// No AppImage candidates in empty home dir; place subminer wrapper on PATH
|
const binDir = path.win32.join(baseDir, 'bin');
|
||||||
const binDir = path.join(baseDir, 'bin');
|
const wrapperPath = path.win32.join(binDir, 'SubMiner.exe');
|
||||||
const wrapperPath = path.join(binDir, 'subminer');
|
|
||||||
makeExecutable(wrapperPath);
|
makeExecutable(wrapperPath);
|
||||||
process.env.PATH = `${binDir}${path.delimiter}${originalPath ?? ''}`;
|
process.env.PATH = `${binDir}${path.win32.delimiter}${originalPath ?? ''}`;
|
||||||
|
|
||||||
withFindAppBinaryEnvSandbox(() => {
|
withFindAppBinaryPlatformSandbox('win32', (pathModule) => {
|
||||||
withAccessSyncStub(
|
withAccessSyncStub(
|
||||||
(filePath) => filePath === wrapperPath,
|
(filePath) => filePath === wrapperPath,
|
||||||
() => {
|
() => {
|
||||||
// selfPath must differ from wrapperPath so the self-check does not exclude it
|
const result = findAppBinary(
|
||||||
const result = findAppBinary(path.join(baseDir, 'launcher', 'subminer'));
|
pathModule.join(baseDir, 'launcher', 'SubMiner.exe'),
|
||||||
|
pathModule,
|
||||||
|
);
|
||||||
assert.equal(result, wrapperPath);
|
assert.equal(result, wrapperPath);
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
@@ -513,3 +686,42 @@ test('findAppBinary finds subminer on PATH when AppImage candidates do not exist
|
|||||||
fs.rmSync(baseDir, { recursive: true, force: true });
|
fs.rmSync(baseDir, { recursive: true, force: true });
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test(
|
||||||
|
'findAppBinary resolves a Windows install directory to SubMiner.exe',
|
||||||
|
{ concurrency: false },
|
||||||
|
() => {
|
||||||
|
const baseDir = fs.mkdtempSync(path.join(os.tmpdir(), 'subminer-test-win-dir-'));
|
||||||
|
const originalHomedir = os.homedir;
|
||||||
|
const originalSubminerBinaryPath = process.env.SUBMINER_BINARY_PATH;
|
||||||
|
try {
|
||||||
|
os.homedir = () => baseDir;
|
||||||
|
const installDir = path.win32.join(baseDir, 'Programs', 'SubMiner');
|
||||||
|
const appExe = path.win32.join(installDir, 'SubMiner.exe');
|
||||||
|
process.env.SUBMINER_BINARY_PATH = installDir;
|
||||||
|
fs.mkdirSync(installDir, { recursive: true });
|
||||||
|
fs.writeFileSync(appExe, '#!/bin/sh\nexit 0\n');
|
||||||
|
fs.chmodSync(appExe, 0o755);
|
||||||
|
|
||||||
|
const originalPlatform = process.platform;
|
||||||
|
try {
|
||||||
|
Object.defineProperty(process, 'platform', { value: 'win32', configurable: true });
|
||||||
|
const result = findAppBinary(
|
||||||
|
path.win32.join(baseDir, 'launcher', 'SubMiner.exe'),
|
||||||
|
path.win32,
|
||||||
|
);
|
||||||
|
assert.equal(result, appExe);
|
||||||
|
} finally {
|
||||||
|
Object.defineProperty(process, 'platform', { value: originalPlatform, configurable: true });
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
os.homedir = originalHomedir;
|
||||||
|
if (originalSubminerBinaryPath === undefined) {
|
||||||
|
delete process.env.SUBMINER_BINARY_PATH;
|
||||||
|
} else {
|
||||||
|
process.env.SUBMINER_BINARY_PATH = originalSubminerBinaryPath;
|
||||||
|
}
|
||||||
|
fs.rmSync(baseDir, { recursive: true, force: true });
|
||||||
|
}
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|||||||
121
launcher/mpv.ts
121
launcher/mpv.ts
@@ -14,11 +14,11 @@ import {
|
|||||||
isExecutable,
|
isExecutable,
|
||||||
resolveBinaryPathCandidate,
|
resolveBinaryPathCandidate,
|
||||||
resolveCommandInvocation,
|
resolveCommandInvocation,
|
||||||
realpathMaybe,
|
|
||||||
isYoutubeTarget,
|
isYoutubeTarget,
|
||||||
uniqueNormalizedLangCodes,
|
uniqueNormalizedLangCodes,
|
||||||
sleep,
|
sleep,
|
||||||
normalizeLangCode,
|
normalizeLangCode,
|
||||||
|
realpathMaybe,
|
||||||
} from './util.js';
|
} from './util.js';
|
||||||
|
|
||||||
export const state = {
|
export const state = {
|
||||||
@@ -35,6 +35,8 @@ type SpawnTarget = {
|
|||||||
args: string[];
|
args: string[];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
type PathModule = Pick<typeof path, 'join' | 'extname' | 'delimiter' | 'sep' | 'resolve'>;
|
||||||
|
|
||||||
const DETACHED_IDLE_MPV_PID_FILE = path.join(os.tmpdir(), 'subminer-idle-mpv.pid');
|
const DETACHED_IDLE_MPV_PID_FILE = path.join(os.tmpdir(), 'subminer-idle-mpv.pid');
|
||||||
const OVERLAY_START_SOCKET_READY_TIMEOUT_MS = 900;
|
const OVERLAY_START_SOCKET_READY_TIMEOUT_MS = 900;
|
||||||
const OVERLAY_START_COMMAND_SETTLE_TIMEOUT_MS = 700;
|
const OVERLAY_START_COMMAND_SETTLE_TIMEOUT_MS = 700;
|
||||||
@@ -225,6 +227,7 @@ export function makeTempDir(prefix: string): string {
|
|||||||
|
|
||||||
export function detectBackend(backend: Backend): Exclude<Backend, 'auto'> {
|
export function detectBackend(backend: Backend): Exclude<Backend, 'auto'> {
|
||||||
if (backend !== 'auto') return backend;
|
if (backend !== 'auto') return backend;
|
||||||
|
if (process.platform === 'win32') return 'windows';
|
||||||
if (process.platform === 'darwin') return 'macos';
|
if (process.platform === 'darwin') return 'macos';
|
||||||
const xdgCurrentDesktop = (process.env.XDG_CURRENT_DESKTOP || '').toLowerCase();
|
const xdgCurrentDesktop = (process.env.XDG_CURRENT_DESKTOP || '').toLowerCase();
|
||||||
const xdgSessionDesktop = (process.env.XDG_SESSION_DESKTOP || '').toLowerCase();
|
const xdgSessionDesktop = (process.env.XDG_SESSION_DESKTOP || '').toLowerCase();
|
||||||
@@ -243,18 +246,49 @@ export function detectBackend(backend: Backend): Exclude<Backend, 'auto'> {
|
|||||||
fail('Could not detect display backend');
|
fail('Could not detect display backend');
|
||||||
}
|
}
|
||||||
|
|
||||||
function resolveMacAppBinaryCandidate(candidate: string): string {
|
function resolveAppBinaryCandidate(candidate: string, pathModule: PathModule = path): string {
|
||||||
const direct = resolveBinaryPathCandidate(candidate);
|
const direct = resolveBinaryPathCandidate(candidate);
|
||||||
if (!direct) return '';
|
if (!direct) return '';
|
||||||
|
|
||||||
if (process.platform !== 'darwin') {
|
if (process.platform === 'win32') {
|
||||||
return isExecutable(direct) ? direct : '';
|
try {
|
||||||
|
if (fs.existsSync(direct) && fs.statSync(direct).isDirectory()) {
|
||||||
|
for (const candidateBinary of ['SubMiner.exe', 'subminer.exe']) {
|
||||||
|
const nestedCandidate = pathModule.join(direct, candidateBinary);
|
||||||
|
if (isExecutable(nestedCandidate)) {
|
||||||
|
return nestedCandidate;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
// ignore
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isExecutable(direct)) {
|
||||||
|
return direct;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!pathModule.extname(direct)) {
|
||||||
|
for (const extension of ['.exe', '.cmd', '.bat']) {
|
||||||
|
const withExtension = `${direct}${extension}`;
|
||||||
|
if (isExecutable(withExtension)) {
|
||||||
|
return withExtension;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return '';
|
||||||
}
|
}
|
||||||
|
|
||||||
if (isExecutable(direct)) {
|
if (isExecutable(direct)) {
|
||||||
return direct;
|
return direct;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (process.platform !== 'darwin') {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
const appIndex = direct.indexOf('.app/');
|
const appIndex = direct.indexOf('.app/');
|
||||||
const appPath =
|
const appPath =
|
||||||
direct.endsWith('.app') && direct.includes('.app')
|
direct.endsWith('.app') && direct.includes('.app')
|
||||||
@@ -265,8 +299,8 @@ function resolveMacAppBinaryCandidate(candidate: string): string {
|
|||||||
if (!appPath) return '';
|
if (!appPath) return '';
|
||||||
|
|
||||||
const candidates = [
|
const candidates = [
|
||||||
path.join(appPath, 'Contents', 'MacOS', 'SubMiner'),
|
pathModule.join(appPath, 'Contents', 'MacOS', 'SubMiner'),
|
||||||
path.join(appPath, 'Contents', 'MacOS', 'subminer'),
|
pathModule.join(appPath, 'Contents', 'MacOS', 'subminer'),
|
||||||
];
|
];
|
||||||
|
|
||||||
for (const candidateBinary of candidates) {
|
for (const candidateBinary of candidates) {
|
||||||
@@ -278,37 +312,78 @@ function resolveMacAppBinaryCandidate(candidate: string): string {
|
|||||||
return '';
|
return '';
|
||||||
}
|
}
|
||||||
|
|
||||||
export function findAppBinary(selfPath: string): string | null {
|
function findCommandOnPath(candidates: string[], pathModule: PathModule = path): string {
|
||||||
|
const pathDirs = getPathEnv().split(pathModule.delimiter);
|
||||||
|
for (const candidateName of candidates) {
|
||||||
|
for (const dir of pathDirs) {
|
||||||
|
if (!dir) continue;
|
||||||
|
|
||||||
|
const directCandidate = pathModule.join(dir, candidateName);
|
||||||
|
if (isExecutable(directCandidate)) {
|
||||||
|
return directCandidate;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (process.platform === 'win32' && !pathModule.extname(candidateName)) {
|
||||||
|
for (const extension of ['.exe', '.cmd', '.bat']) {
|
||||||
|
const extendedCandidate = pathModule.join(dir, `${candidateName}${extension}`);
|
||||||
|
if (isExecutable(extendedCandidate)) {
|
||||||
|
return extendedCandidate;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
export function findAppBinary(selfPath: string, pathModule: PathModule = path): string | null {
|
||||||
const envPaths = [process.env.SUBMINER_APPIMAGE_PATH, process.env.SUBMINER_BINARY_PATH].filter(
|
const envPaths = [process.env.SUBMINER_APPIMAGE_PATH, process.env.SUBMINER_BINARY_PATH].filter(
|
||||||
(candidate): candidate is string => Boolean(candidate),
|
(candidate): candidate is string => Boolean(candidate),
|
||||||
);
|
);
|
||||||
|
|
||||||
for (const envPath of envPaths) {
|
for (const envPath of envPaths) {
|
||||||
const resolved = resolveMacAppBinaryCandidate(envPath);
|
const resolved = resolveAppBinaryCandidate(envPath, pathModule);
|
||||||
if (resolved) {
|
if (resolved) {
|
||||||
return resolved;
|
return resolved;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const candidates: string[] = [];
|
const candidates: string[] = [];
|
||||||
if (process.platform === 'darwin') {
|
if (process.platform === 'win32') {
|
||||||
|
const localAppData =
|
||||||
|
process.env.LOCALAPPDATA?.trim() ||
|
||||||
|
(process.env.APPDATA?.trim() || '').replace(/[\\/]Roaming$/i, `${pathModule.sep}Local`) ||
|
||||||
|
pathModule.join(os.homedir(), 'AppData', 'Local');
|
||||||
|
const programFiles = process.env.ProgramFiles?.trim() || 'C:\\Program Files';
|
||||||
|
const programFilesX86 = process.env['ProgramFiles(x86)']?.trim() || 'C:\\Program Files (x86)';
|
||||||
|
candidates.push(pathModule.join(localAppData, 'Programs', 'SubMiner', 'SubMiner.exe'));
|
||||||
|
candidates.push(pathModule.join(programFiles, 'SubMiner', 'SubMiner.exe'));
|
||||||
|
candidates.push(pathModule.join(programFilesX86, 'SubMiner', 'SubMiner.exe'));
|
||||||
|
candidates.push('C:\\SubMiner\\SubMiner.exe');
|
||||||
|
} else if (process.platform === 'darwin') {
|
||||||
candidates.push('/Applications/SubMiner.app/Contents/MacOS/SubMiner');
|
candidates.push('/Applications/SubMiner.app/Contents/MacOS/SubMiner');
|
||||||
candidates.push('/Applications/SubMiner.app/Contents/MacOS/subminer');
|
candidates.push('/Applications/SubMiner.app/Contents/MacOS/subminer');
|
||||||
candidates.push(path.join(os.homedir(), 'Applications/SubMiner.app/Contents/MacOS/SubMiner'));
|
candidates.push(
|
||||||
candidates.push(path.join(os.homedir(), 'Applications/SubMiner.app/Contents/MacOS/subminer'));
|
pathModule.join(os.homedir(), 'Applications/SubMiner.app/Contents/MacOS/SubMiner'),
|
||||||
|
);
|
||||||
|
candidates.push(
|
||||||
|
pathModule.join(os.homedir(), 'Applications/SubMiner.app/Contents/MacOS/subminer'),
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
candidates.push(pathModule.join(os.homedir(), '.local/bin/SubMiner.AppImage'));
|
||||||
|
candidates.push('/opt/SubMiner/SubMiner.AppImage');
|
||||||
}
|
}
|
||||||
|
|
||||||
candidates.push(path.join(os.homedir(), '.local/bin/SubMiner.AppImage'));
|
|
||||||
candidates.push('/opt/SubMiner/SubMiner.AppImage');
|
|
||||||
|
|
||||||
for (const candidate of candidates) {
|
for (const candidate of candidates) {
|
||||||
if (isExecutable(candidate)) return candidate;
|
const resolved = resolveAppBinaryCandidate(candidate, pathModule);
|
||||||
|
if (resolved) return resolved;
|
||||||
}
|
}
|
||||||
|
|
||||||
const fromPath = getPathEnv()
|
const fromPath = findCommandOnPath(
|
||||||
.split(path.delimiter)
|
process.platform === 'win32' ? ['SubMiner', 'subminer'] : ['subminer'],
|
||||||
.map((dir) => path.join(dir, 'subminer'))
|
pathModule,
|
||||||
.find((candidate) => isExecutable(candidate));
|
);
|
||||||
|
|
||||||
if (fromPath) {
|
if (fromPath) {
|
||||||
const resolvedSelf = realpathMaybe(selfPath);
|
const resolvedSelf = realpathMaybe(selfPath);
|
||||||
@@ -634,7 +709,9 @@ export async function startMpv(
|
|||||||
mpvArgs.push(`--input-ipc-server=${socketPath}`);
|
mpvArgs.push(`--input-ipc-server=${socketPath}`);
|
||||||
mpvArgs.push(target);
|
mpvArgs.push(target);
|
||||||
|
|
||||||
const mpvTarget = resolveCommandInvocation('mpv', mpvArgs);
|
const mpvTarget = resolveCommandInvocation('mpv', mpvArgs, {
|
||||||
|
normalizeWindowsShellArgs: false,
|
||||||
|
});
|
||||||
state.mpvProc = spawn(mpvTarget.command, mpvTarget.args, { stdio: 'inherit' });
|
state.mpvProc = spawn(mpvTarget.command, mpvTarget.args, { stdio: 'inherit' });
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1076,7 +1153,9 @@ export function launchMpvIdleDetached(
|
|||||||
);
|
);
|
||||||
mpvArgs.push(`--log-file=${getMpvLogPath()}`);
|
mpvArgs.push(`--log-file=${getMpvLogPath()}`);
|
||||||
mpvArgs.push(`--input-ipc-server=${socketPath}`);
|
mpvArgs.push(`--input-ipc-server=${socketPath}`);
|
||||||
const mpvTarget = resolveCommandInvocation('mpv', mpvArgs);
|
const mpvTarget = resolveCommandInvocation('mpv', mpvArgs, {
|
||||||
|
normalizeWindowsShellArgs: false,
|
||||||
|
});
|
||||||
const proc = spawn(mpvTarget.command, mpvTarget.args, {
|
const proc = spawn(mpvTarget.command, mpvTarget.args, {
|
||||||
stdio: 'ignore',
|
stdio: 'ignore',
|
||||||
detached: true,
|
detached: true,
|
||||||
|
|||||||
@@ -116,6 +116,36 @@ test('ensureLauncherSetupReady bypasses setup gate when external yomitan is conf
|
|||||||
assert.deepEqual(calls, []);
|
assert.deepEqual(calls, []);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('ensureLauncherSetupReady bypasses setup gate when plugin is already installed', async () => {
|
||||||
|
const calls: string[] = [];
|
||||||
|
|
||||||
|
const ready = await ensureLauncherSetupReady({
|
||||||
|
readSetupState: () => ({
|
||||||
|
version: 3,
|
||||||
|
status: 'cancelled',
|
||||||
|
completedAt: null,
|
||||||
|
completionSource: null,
|
||||||
|
yomitanSetupMode: null,
|
||||||
|
lastSeenYomitanDictionaryCount: 0,
|
||||||
|
pluginInstallStatus: 'unknown',
|
||||||
|
pluginInstallPathSummary: null,
|
||||||
|
windowsMpvShortcutPreferences: { startMenuEnabled: true, desktopEnabled: true },
|
||||||
|
windowsMpvShortcutLastStatus: 'unknown',
|
||||||
|
}),
|
||||||
|
isPluginInstalled: () => true,
|
||||||
|
launchSetupApp: () => {
|
||||||
|
calls.push('launch');
|
||||||
|
},
|
||||||
|
sleep: async () => undefined,
|
||||||
|
now: () => 0,
|
||||||
|
timeoutMs: 5_000,
|
||||||
|
pollIntervalMs: 100,
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(ready, true);
|
||||||
|
assert.deepEqual(calls, []);
|
||||||
|
});
|
||||||
|
|
||||||
test('ensureLauncherSetupReady fails on timeout/cancelled state', async () => {
|
test('ensureLauncherSetupReady fails on timeout/cancelled state', async () => {
|
||||||
const result = await ensureLauncherSetupReady({
|
const result = await ensureLauncherSetupReady({
|
||||||
readSetupState: () => ({
|
readSetupState: () => ({
|
||||||
@@ -132,10 +162,73 @@ test('ensureLauncherSetupReady fails on timeout/cancelled state', async () => {
|
|||||||
}),
|
}),
|
||||||
launchSetupApp: () => undefined,
|
launchSetupApp: () => undefined,
|
||||||
sleep: async () => undefined,
|
sleep: async () => undefined,
|
||||||
now: () => 0,
|
now: (() => {
|
||||||
|
let value = 0;
|
||||||
|
return () => (value += 100);
|
||||||
|
})(),
|
||||||
timeoutMs: 5_000,
|
timeoutMs: 5_000,
|
||||||
pollIntervalMs: 100,
|
pollIntervalMs: 100,
|
||||||
});
|
});
|
||||||
|
|
||||||
assert.equal(result, false);
|
assert.equal(result, false);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('ensureLauncherSetupReady ignores stale cancelled state after launching setup app', async () => {
|
||||||
|
let reads = 0;
|
||||||
|
|
||||||
|
const result = await ensureLauncherSetupReady({
|
||||||
|
readSetupState: () => {
|
||||||
|
reads += 1;
|
||||||
|
if (reads <= 2) {
|
||||||
|
return {
|
||||||
|
version: 3,
|
||||||
|
status: 'cancelled',
|
||||||
|
completedAt: null,
|
||||||
|
completionSource: null,
|
||||||
|
yomitanSetupMode: null,
|
||||||
|
lastSeenYomitanDictionaryCount: 0,
|
||||||
|
pluginInstallStatus: 'unknown',
|
||||||
|
pluginInstallPathSummary: null,
|
||||||
|
windowsMpvShortcutPreferences: { startMenuEnabled: true, desktopEnabled: true },
|
||||||
|
windowsMpvShortcutLastStatus: 'unknown',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (reads === 3) {
|
||||||
|
return {
|
||||||
|
version: 3,
|
||||||
|
status: 'in_progress',
|
||||||
|
completedAt: null,
|
||||||
|
completionSource: null,
|
||||||
|
yomitanSetupMode: null,
|
||||||
|
lastSeenYomitanDictionaryCount: 0,
|
||||||
|
pluginInstallStatus: 'unknown',
|
||||||
|
pluginInstallPathSummary: null,
|
||||||
|
windowsMpvShortcutPreferences: { startMenuEnabled: true, desktopEnabled: true },
|
||||||
|
windowsMpvShortcutLastStatus: 'unknown',
|
||||||
|
};
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
version: 3,
|
||||||
|
status: 'completed',
|
||||||
|
completedAt: '2026-03-07T00:00:00.000Z',
|
||||||
|
completionSource: 'legacy_auto_detected',
|
||||||
|
yomitanSetupMode: 'internal',
|
||||||
|
lastSeenYomitanDictionaryCount: 1,
|
||||||
|
pluginInstallStatus: 'installed',
|
||||||
|
pluginInstallPathSummary: '/tmp/mpv',
|
||||||
|
windowsMpvShortcutPreferences: { startMenuEnabled: true, desktopEnabled: true },
|
||||||
|
windowsMpvShortcutLastStatus: 'unknown',
|
||||||
|
};
|
||||||
|
},
|
||||||
|
launchSetupApp: () => undefined,
|
||||||
|
sleep: async () => undefined,
|
||||||
|
now: (() => {
|
||||||
|
let value = 0;
|
||||||
|
return () => (value += 100);
|
||||||
|
})(),
|
||||||
|
timeoutMs: 5_000,
|
||||||
|
pollIntervalMs: 100,
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(result, true);
|
||||||
|
});
|
||||||
|
|||||||
@@ -6,15 +6,24 @@ export async function waitForSetupCompletion(deps: {
|
|||||||
now: () => number;
|
now: () => number;
|
||||||
timeoutMs: number;
|
timeoutMs: number;
|
||||||
pollIntervalMs: number;
|
pollIntervalMs: number;
|
||||||
|
ignoreInitialCancelledState?: boolean;
|
||||||
}): Promise<'completed' | 'cancelled' | 'timeout'> {
|
}): Promise<'completed' | 'cancelled' | 'timeout'> {
|
||||||
const deadline = deps.now() + deps.timeoutMs;
|
const deadline = deps.now() + deps.timeoutMs;
|
||||||
|
let ignoringCancelled = deps.ignoreInitialCancelledState === true;
|
||||||
|
|
||||||
while (deps.now() <= deadline) {
|
while (deps.now() <= deadline) {
|
||||||
const state = deps.readSetupState();
|
const state = deps.readSetupState();
|
||||||
if (isSetupCompleted(state)) {
|
if (isSetupCompleted(state)) {
|
||||||
return 'completed';
|
return 'completed';
|
||||||
}
|
}
|
||||||
|
if (ignoringCancelled && state != null && state.status !== 'cancelled') {
|
||||||
|
ignoringCancelled = false;
|
||||||
|
}
|
||||||
if (state?.status === 'cancelled') {
|
if (state?.status === 'cancelled') {
|
||||||
|
if (ignoringCancelled) {
|
||||||
|
await deps.sleep(deps.pollIntervalMs);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
return 'cancelled';
|
return 'cancelled';
|
||||||
}
|
}
|
||||||
await deps.sleep(deps.pollIntervalMs);
|
await deps.sleep(deps.pollIntervalMs);
|
||||||
@@ -26,6 +35,7 @@ export async function waitForSetupCompletion(deps: {
|
|||||||
export async function ensureLauncherSetupReady(deps: {
|
export async function ensureLauncherSetupReady(deps: {
|
||||||
readSetupState: () => SetupState | null;
|
readSetupState: () => SetupState | null;
|
||||||
isExternalYomitanConfigured?: () => boolean;
|
isExternalYomitanConfigured?: () => boolean;
|
||||||
|
isPluginInstalled?: () => boolean;
|
||||||
launchSetupApp: () => void;
|
launchSetupApp: () => void;
|
||||||
sleep: (ms: number) => Promise<void>;
|
sleep: (ms: number) => Promise<void>;
|
||||||
now: () => number;
|
now: () => number;
|
||||||
@@ -35,11 +45,18 @@ export async function ensureLauncherSetupReady(deps: {
|
|||||||
if (deps.isExternalYomitanConfigured?.()) {
|
if (deps.isExternalYomitanConfigured?.()) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
if (isSetupCompleted(deps.readSetupState())) {
|
if (deps.isPluginInstalled?.()) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
const initialState = deps.readSetupState();
|
||||||
|
if (isSetupCompleted(initialState)) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
deps.launchSetupApp();
|
deps.launchSetupApp();
|
||||||
const result = await waitForSetupCompletion(deps);
|
const result = await waitForSetupCompletion({
|
||||||
|
...deps,
|
||||||
|
ignoreInitialCancelledState: initialState?.status === 'cancelled',
|
||||||
|
});
|
||||||
return result === 'completed';
|
return result === 'completed';
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -79,7 +79,7 @@ function createSmokeCase(name: string): SmokeCase {
|
|||||||
|
|
||||||
writeExecutable(
|
writeExecutable(
|
||||||
fakeMpvPath,
|
fakeMpvPath,
|
||||||
`#!/usr/bin/env node
|
`#!/usr/bin/env bun
|
||||||
const fs = require('node:fs');
|
const fs = require('node:fs');
|
||||||
const net = require('node:net');
|
const net = require('node:net');
|
||||||
const path = require('node:path');
|
const path = require('node:path');
|
||||||
@@ -118,7 +118,7 @@ process.on('SIGTERM', closeAndExit);
|
|||||||
|
|
||||||
writeExecutable(
|
writeExecutable(
|
||||||
fakeAppPath,
|
fakeAppPath,
|
||||||
`#!/usr/bin/env node
|
`#!/usr/bin/env bun
|
||||||
const fs = require('node:fs');
|
const fs = require('node:fs');
|
||||||
|
|
||||||
const logPath = ${JSON.stringify(fakeAppLogPath)};
|
const logPath = ${JSON.stringify(fakeAppLogPath)};
|
||||||
|
|||||||
@@ -68,7 +68,7 @@ export const DEFAULT_MPV_SUBMINER_ARGS = [
|
|||||||
] as const;
|
] as const;
|
||||||
|
|
||||||
export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
|
export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
|
||||||
export type Backend = 'auto' | 'hyprland' | 'x11' | 'macos';
|
export type Backend = 'auto' | 'hyprland' | 'sway' | 'x11' | 'macos' | 'windows';
|
||||||
export type JimakuLanguagePreference = 'ja' | 'en' | 'none';
|
export type JimakuLanguagePreference = 'ja' | 'en' | 'none';
|
||||||
|
|
||||||
export interface LauncherAiConfig {
|
export interface LauncherAiConfig {
|
||||||
|
|||||||
@@ -244,13 +244,19 @@ export function inferWhisperLanguage(langCodes: string[], fallback: string): str
|
|||||||
return fallback;
|
return fallback;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface CommandInvocationOptions {
|
||||||
|
normalizeWindowsShellArgs?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
export function resolveCommandInvocation(
|
export function resolveCommandInvocation(
|
||||||
executable: string,
|
executable: string,
|
||||||
args: string[],
|
args: string[],
|
||||||
|
options: CommandInvocationOptions = {},
|
||||||
): { command: string; args: string[] } {
|
): { command: string; args: string[] } {
|
||||||
if (process.platform !== 'win32') {
|
if (process.platform !== 'win32') {
|
||||||
return { command: executable, args };
|
return { command: executable, args };
|
||||||
}
|
}
|
||||||
|
const { normalizeWindowsShellArgs = true } = options;
|
||||||
|
|
||||||
const resolvedExecutable = resolveExecutablePath(executable) ?? executable;
|
const resolvedExecutable = resolveExecutablePath(executable) ?? executable;
|
||||||
const extension = path.extname(resolvedExecutable).toLowerCase();
|
const extension = path.extname(resolvedExecutable).toLowerCase();
|
||||||
@@ -267,7 +273,9 @@ export function resolveCommandInvocation(
|
|||||||
command: bashTarget.command,
|
command: bashTarget.command,
|
||||||
args: [
|
args: [
|
||||||
normalizeWindowsShellArg(resolvedExecutable, bashTarget.flavor),
|
normalizeWindowsShellArg(resolvedExecutable, bashTarget.flavor),
|
||||||
...args.map((arg) => normalizeWindowsShellArg(arg, bashTarget.flavor)),
|
...args.map((arg) =>
|
||||||
|
normalizeWindowsShellArgs ? normalizeWindowsShellArg(arg, bashTarget.flavor) : arg,
|
||||||
|
),
|
||||||
],
|
],
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
@@ -280,7 +288,9 @@ export function resolveCommandInvocation(
|
|||||||
command: bashTarget.command,
|
command: bashTarget.command,
|
||||||
args: [
|
args: [
|
||||||
normalizeWindowsShellArg(resolvedExecutable, bashTarget.flavor),
|
normalizeWindowsShellArg(resolvedExecutable, bashTarget.flavor),
|
||||||
...args.map((arg) => normalizeWindowsShellArg(arg, bashTarget.flavor)),
|
...args.map((arg) =>
|
||||||
|
normalizeWindowsShellArgs ? normalizeWindowsShellArg(arg, bashTarget.flavor) : arg,
|
||||||
|
),
|
||||||
],
|
],
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
20
package.json
20
package.json
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "subminer",
|
"name": "subminer",
|
||||||
"version": "0.10.0",
|
"version": "0.11.0",
|
||||||
"description": "All-in-one sentence mining overlay with AnkiConnect and dictionary integration",
|
"description": "All-in-one sentence mining overlay with AnkiConnect and dictionary integration",
|
||||||
"packageManager": "bun@1.3.5",
|
"packageManager": "bun@1.3.5",
|
||||||
"main": "dist/main-entry.js",
|
"main": "dist/main-entry.js",
|
||||||
@@ -13,9 +13,10 @@
|
|||||||
"test-yomitan-parser:electron": "bun run build:yomitan && bun build scripts/test-yomitan-parser.ts --format=cjs --target=node --outfile dist/scripts/test-yomitan-parser.js --external electron && env -u ELECTRON_RUN_AS_NODE electron dist/scripts/test-yomitan-parser.js",
|
"test-yomitan-parser:electron": "bun run build:yomitan && bun build scripts/test-yomitan-parser.ts --format=cjs --target=node --outfile dist/scripts/test-yomitan-parser.js --external electron && env -u ELECTRON_RUN_AS_NODE electron dist/scripts/test-yomitan-parser.js",
|
||||||
"build:yomitan": "bun scripts/build-yomitan.mjs",
|
"build:yomitan": "bun scripts/build-yomitan.mjs",
|
||||||
"build:assets": "bun scripts/prepare-build-assets.mjs",
|
"build:assets": "bun scripts/prepare-build-assets.mjs",
|
||||||
|
"build:launcher": "bun build ./launcher/main.ts --target=bun --packages=bundle --outfile=dist/launcher/subminer",
|
||||||
"build:stats": "cd stats && bun run build",
|
"build:stats": "cd stats && bun run build",
|
||||||
"dev:stats": "cd stats && bun run dev",
|
"dev:stats": "cd stats && bun run dev",
|
||||||
"build": "bun run build:yomitan && bun run build:stats && tsc -p tsconfig.json && bun run build:renderer && bun run build:assets",
|
"build": "bun run build:yomitan && bun run build:stats && tsc -p tsconfig.json && bun run build:renderer && bun run build:launcher && bun run build:assets",
|
||||||
"build:renderer": "esbuild src/renderer/renderer.ts --bundle --platform=browser --format=esm --target=es2022 --outfile=dist/renderer/renderer.js --sourcemap",
|
"build:renderer": "esbuild src/renderer/renderer.ts --bundle --platform=browser --format=esm --target=es2022 --outfile=dist/renderer/renderer.js --sourcemap",
|
||||||
"changelog:build": "bun run scripts/build-changelog.ts build",
|
"changelog:build": "bun run scripts/build-changelog.ts build",
|
||||||
"changelog:check": "bun run scripts/build-changelog.ts check",
|
"changelog:check": "bun run scripts/build-changelog.ts check",
|
||||||
@@ -37,8 +38,8 @@
|
|||||||
"docs:preview": "bun run --cwd docs-site docs:preview",
|
"docs:preview": "bun run --cwd docs-site docs:preview",
|
||||||
"docs:test": "bun run --cwd docs-site test",
|
"docs:test": "bun run --cwd docs-site test",
|
||||||
"test:docs:kb": "bun test scripts/docs-knowledge-base.test.ts",
|
"test:docs:kb": "bun test scripts/docs-knowledge-base.test.ts",
|
||||||
"test:config:src": "bun test src/config/config.test.ts src/config/path-resolution.test.ts src/config/resolve/anki-connect.test.ts src/config/resolve/subtitle-style.test.ts src/config/resolve/jellyfin.test.ts src/config/definitions/domain-registry.test.ts src/generate-config-example.test.ts src/verify-config-example.test.ts",
|
"test:config:src": "bun test src/config/config.test.ts src/config/path-resolution.test.ts src/config/resolve/anki-connect.test.ts src/config/resolve/integrations.test.ts src/config/resolve/subtitle-style.test.ts src/config/resolve/jellyfin.test.ts src/config/definitions/domain-registry.test.ts src/generate-config-example.test.ts src/verify-config-example.test.ts",
|
||||||
"test:config:dist": "bun test dist/config/config.test.js dist/config/path-resolution.test.js dist/config/resolve/anki-connect.test.js dist/config/resolve/subtitle-style.test.js dist/config/resolve/jellyfin.test.js dist/config/definitions/domain-registry.test.js dist/generate-config-example.test.js dist/verify-config-example.test.js",
|
"test:config:dist": "bun test dist/config/config.test.js dist/config/path-resolution.test.js dist/config/resolve/anki-connect.test.js dist/config/resolve/integrations.test.js dist/config/resolve/subtitle-style.test.js dist/config/resolve/jellyfin.test.js dist/config/definitions/domain-registry.test.js dist/generate-config-example.test.js dist/verify-config-example.test.js",
|
||||||
"test:config:smoke:dist": "bun test dist/config/path-resolution.test.js",
|
"test:config:smoke:dist": "bun test dist/config/path-resolution.test.js",
|
||||||
"test:plugin:src": "lua scripts/test-plugin-start-gate.lua && lua scripts/test-plugin-binary-windows.lua",
|
"test:plugin:src": "lua scripts/test-plugin-start-gate.lua && lua scripts/test-plugin-binary-windows.lua",
|
||||||
"test:launcher:smoke:src": "bun test launcher/smoke.e2e.test.ts",
|
"test:launcher:smoke:src": "bun test launcher/smoke.e2e.test.ts",
|
||||||
@@ -80,9 +81,12 @@
|
|||||||
"build:win:unsigned": "bun run build && node scripts/build-win-unsigned.mjs"
|
"build:win:unsigned": "bun run build && node scripts/build-win-unsigned.mjs"
|
||||||
},
|
},
|
||||||
"overrides": {
|
"overrides": {
|
||||||
|
"@xmldom/xmldom": "0.8.12",
|
||||||
"app-builder-lib": "26.8.2",
|
"app-builder-lib": "26.8.2",
|
||||||
"electron-builder-squirrel-windows": "26.8.2",
|
"electron-builder-squirrel-windows": "26.8.2",
|
||||||
|
"lodash": "4.18.0",
|
||||||
"minimatch": "10.2.3",
|
"minimatch": "10.2.3",
|
||||||
|
"picomatch": "4.0.4",
|
||||||
"tar": "7.5.11"
|
"tar": "7.5.11"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
@@ -111,7 +115,7 @@
|
|||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^25.3.0",
|
"@types/node": "^25.3.0",
|
||||||
"@types/ws": "^8.18.1",
|
"@types/ws": "^8.18.1",
|
||||||
"electron": "^37.10.3",
|
"electron": "39.8.6",
|
||||||
"electron-builder": "26.8.2",
|
"electron-builder": "26.8.2",
|
||||||
"esbuild": "^0.25.12",
|
"esbuild": "^0.25.12",
|
||||||
"prettier": "^3.8.1",
|
"prettier": "^3.8.1",
|
||||||
@@ -122,7 +126,7 @@
|
|||||||
"productName": "SubMiner",
|
"productName": "SubMiner",
|
||||||
"executableName": "SubMiner",
|
"executableName": "SubMiner",
|
||||||
"artifactName": "SubMiner-${version}.${ext}",
|
"artifactName": "SubMiner-${version}.${ext}",
|
||||||
"icon": "assets/SubMiner.png",
|
"icon": "assets/SubMiner-square.png",
|
||||||
"directories": {
|
"directories": {
|
||||||
"output": "release"
|
"output": "release"
|
||||||
},
|
},
|
||||||
@@ -141,7 +145,7 @@
|
|||||||
"zip"
|
"zip"
|
||||||
],
|
],
|
||||||
"category": "public.app-category.video",
|
"category": "public.app-category.video",
|
||||||
"icon": "assets/SubMiner.png",
|
"icon": "assets/SubMiner-square.png",
|
||||||
"hardenedRuntime": true,
|
"hardenedRuntime": true,
|
||||||
"entitlements": "build/entitlements.mac.plist",
|
"entitlements": "build/entitlements.mac.plist",
|
||||||
"entitlementsInherit": "build/entitlements.mac.plist",
|
"entitlementsInherit": "build/entitlements.mac.plist",
|
||||||
@@ -157,7 +161,7 @@
|
|||||||
"nsis",
|
"nsis",
|
||||||
"zip"
|
"zip"
|
||||||
],
|
],
|
||||||
"icon": "assets/SubMiner.png"
|
"icon": "assets/SubMiner.ico"
|
||||||
},
|
},
|
||||||
"nsis": {
|
"nsis": {
|
||||||
"oneClick": false,
|
"oneClick": false,
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ texthooker_enabled=yes
|
|||||||
# Texthooker WebSocket port
|
# Texthooker WebSocket port
|
||||||
texthooker_port=5174
|
texthooker_port=5174
|
||||||
|
|
||||||
# Window manager backend: auto, hyprland, sway, x11
|
# Window manager backend: auto, hyprland, sway, x11, macos, windows
|
||||||
# "auto" detects based on environment variables
|
# "auto" detects based on environment variables
|
||||||
backend=auto
|
backend=auto
|
||||||
|
|
||||||
|
|||||||
@@ -29,13 +29,25 @@ function M.create(ctx)
|
|||||||
return options_helper.coerce_bool(raw_auto_start, false)
|
return options_helper.coerce_bool(raw_auto_start, false)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
local function rearm_managed_subtitle_defaults()
|
||||||
|
if not process.has_matching_mpv_ipc_socket(opts.socket_path) then
|
||||||
|
return false
|
||||||
|
end
|
||||||
|
|
||||||
|
mp.set_property_native("sub-auto", "fuzzy")
|
||||||
|
mp.set_property_native("sid", "auto")
|
||||||
|
mp.set_property_native("secondary-sid", "auto")
|
||||||
|
return true
|
||||||
|
end
|
||||||
|
|
||||||
local function on_file_loaded()
|
local function on_file_loaded()
|
||||||
aniskip.clear_aniskip_state()
|
aniskip.clear_aniskip_state()
|
||||||
process.disarm_auto_play_ready_gate()
|
process.disarm_auto_play_ready_gate()
|
||||||
|
local has_matching_socket = rearm_managed_subtitle_defaults()
|
||||||
|
|
||||||
local should_auto_start = resolve_auto_start_enabled()
|
local should_auto_start = resolve_auto_start_enabled()
|
||||||
if should_auto_start then
|
if should_auto_start then
|
||||||
if not process.has_matching_mpv_ipc_socket(opts.socket_path) then
|
if not has_matching_socket then
|
||||||
subminer_log(
|
subminer_log(
|
||||||
"info",
|
"info",
|
||||||
"lifecycle",
|
"lifecycle",
|
||||||
|
|||||||
@@ -51,9 +51,16 @@ function ensureSubmodulePresent() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function getSourceState() {
|
function getSourceState() {
|
||||||
const revision = readCommand('git', ['rev-parse', 'HEAD'], submoduleDir);
|
try {
|
||||||
const dirty = readCommand('git', ['status', '--short', '--untracked-files=no'], submoduleDir);
|
const revision = readCommand('git', ['rev-parse', 'HEAD'], submoduleDir);
|
||||||
return { revision, dirty };
|
const dirty = readCommand('git', ['status', '--short', '--untracked-files=no'], submoduleDir);
|
||||||
|
return { revision, dirty };
|
||||||
|
} catch (error) {
|
||||||
|
if (process.env.SUBMINER_YOMITAN_ALLOW_MISSING_GIT === '1') {
|
||||||
|
return { revision: 'unknown', dirty: '' };
|
||||||
|
}
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function isBuildCurrent(force) {
|
function isBuildCurrent(force) {
|
||||||
|
|||||||
@@ -38,7 +38,11 @@ const lanes: Record<string, LaneConfig> = {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
function collectFiles(rootDir: string, includeSuffixes: string[], excludeSet: Set<string>): string[] {
|
function collectFiles(
|
||||||
|
rootDir: string,
|
||||||
|
includeSuffixes: string[],
|
||||||
|
excludeSet: Set<string>,
|
||||||
|
): string[] {
|
||||||
const out: string[] = [];
|
const out: string[] = [];
|
||||||
const visit = (currentDir: string) => {
|
const visit = (currentDir: string) => {
|
||||||
for (const entry of readdirSync(currentDir, { withFileTypes: true })) {
|
for (const entry of readdirSync(currentDir, { withFileTypes: true })) {
|
||||||
@@ -145,7 +149,12 @@ function parseLcovReport(report: string): LcovRecord[] {
|
|||||||
}
|
}
|
||||||
if (line.startsWith('BRDA:')) {
|
if (line.startsWith('BRDA:')) {
|
||||||
const [lineNumber, block, branch, hits] = line.slice(5).split(',');
|
const [lineNumber, block, branch, hits] = line.slice(5).split(',');
|
||||||
if (lineNumber === undefined || block === undefined || branch === undefined || hits === undefined) {
|
if (
|
||||||
|
lineNumber === undefined ||
|
||||||
|
block === undefined ||
|
||||||
|
branch === undefined ||
|
||||||
|
hits === undefined
|
||||||
|
) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
ensureCurrent().branches.set(`${lineNumber}:${block}:${branch}`, {
|
ensureCurrent().branches.set(`${lineNumber}:${block}:${branch}`, {
|
||||||
@@ -224,7 +233,9 @@ export function mergeLcovReports(reports: string[]): string {
|
|||||||
chunks.push(`FNDA:${record.functionHits.get(name) ?? 0},${name}`);
|
chunks.push(`FNDA:${record.functionHits.get(name) ?? 0},${name}`);
|
||||||
}
|
}
|
||||||
chunks.push(`FNF:${functions.length}`);
|
chunks.push(`FNF:${functions.length}`);
|
||||||
chunks.push(`FNH:${functions.filter(([name]) => (record.functionHits.get(name) ?? 0) > 0).length}`);
|
chunks.push(
|
||||||
|
`FNH:${functions.filter(([name]) => (record.functionHits.get(name) ?? 0) > 0).length}`,
|
||||||
|
);
|
||||||
|
|
||||||
const branches = [...record.branches.values()].sort((a, b) =>
|
const branches = [...record.branches.values()].sort((a, b) =>
|
||||||
a.line === b.line
|
a.line === b.line
|
||||||
@@ -298,7 +309,9 @@ function runCoverageLane(): number {
|
|||||||
}
|
}
|
||||||
|
|
||||||
writeFileSync(join(coverageDir, 'lcov.info'), mergeLcovReports(reports), 'utf8');
|
writeFileSync(join(coverageDir, 'lcov.info'), mergeLcovReports(reports), 'utf8');
|
||||||
process.stdout.write(`Merged LCOV written to ${relative(repoRoot, join(coverageDir, 'lcov.info'))}\n`);
|
process.stdout.write(
|
||||||
|
`Merged LCOV written to ${relative(repoRoot, join(coverageDir, 'lcov.info'))}\n`,
|
||||||
|
);
|
||||||
return 0;
|
return 0;
|
||||||
} finally {
|
} finally {
|
||||||
rmSync(shardRoot, { recursive: true, force: true });
|
rmSync(shardRoot, { recursive: true, force: true });
|
||||||
|
|||||||
@@ -178,6 +178,12 @@ local function run_plugin_scenario(config)
|
|||||||
value = value,
|
value = value,
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
function mp.set_property(name, value)
|
||||||
|
recorded.property_sets[#recorded.property_sets + 1] = {
|
||||||
|
name = name,
|
||||||
|
value = value,
|
||||||
|
}
|
||||||
|
end
|
||||||
function mp.get_script_name()
|
function mp.get_script_name()
|
||||||
return "subminer"
|
return "subminer"
|
||||||
end
|
end
|
||||||
@@ -531,6 +537,38 @@ do
|
|||||||
)
|
)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
do
|
||||||
|
local recorded, err = run_plugin_scenario({
|
||||||
|
process_list = "",
|
||||||
|
option_overrides = {
|
||||||
|
binary_path = binary_path,
|
||||||
|
auto_start = "yes",
|
||||||
|
auto_start_visible_overlay = "yes",
|
||||||
|
auto_start_pause_until_ready = "no",
|
||||||
|
socket_path = "/tmp/subminer-socket",
|
||||||
|
},
|
||||||
|
input_ipc_server = "/tmp/subminer-socket",
|
||||||
|
media_title = "Random Movie",
|
||||||
|
files = {
|
||||||
|
[binary_path] = true,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
assert_true(recorded ~= nil, "plugin failed to load for subtitle rearm scenario: " .. tostring(err))
|
||||||
|
fire_event(recorded, "file-loaded")
|
||||||
|
assert_true(
|
||||||
|
has_property_set(recorded.property_sets, "sub-auto", "fuzzy"),
|
||||||
|
"managed file-loaded should rearm sub-auto for idle mpv sessions"
|
||||||
|
)
|
||||||
|
assert_true(
|
||||||
|
has_property_set(recorded.property_sets, "sid", "auto"),
|
||||||
|
"managed file-loaded should rearm primary subtitle selection for idle mpv sessions"
|
||||||
|
)
|
||||||
|
assert_true(
|
||||||
|
has_property_set(recorded.property_sets, "secondary-sid", "auto"),
|
||||||
|
"managed file-loaded should rearm secondary subtitle selection for idle mpv sessions"
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
do
|
do
|
||||||
local recorded, err = run_plugin_scenario({
|
local recorded, err = run_plugin_scenario({
|
||||||
process_list = "",
|
process_list = "",
|
||||||
@@ -1037,6 +1075,10 @@ do
|
|||||||
start_call == nil,
|
start_call == nil,
|
||||||
"auto-start should be skipped when mpv input-ipc-server does not match configured socket_path"
|
"auto-start should be skipped when mpv input-ipc-server does not match configured socket_path"
|
||||||
)
|
)
|
||||||
|
assert_true(
|
||||||
|
not has_property_set(recorded.property_sets, "sid", "auto"),
|
||||||
|
"subtitle rearm should not run when mpv input-ipc-server does not match configured socket_path"
|
||||||
|
)
|
||||||
assert_true(
|
assert_true(
|
||||||
not has_property_set(recorded.property_sets, "pause", true),
|
not has_property_set(recorded.property_sets, "pause", true),
|
||||||
"pause-until-ready gate should not arm when socket_path does not match"
|
"pause-until-ready gate should not arm when socket_path does not match"
|
||||||
|
|||||||
@@ -51,6 +51,7 @@ import { KnownWordCacheManager } from './anki-integration/known-word-cache';
|
|||||||
import { PollingRunner } from './anki-integration/polling';
|
import { PollingRunner } from './anki-integration/polling';
|
||||||
import type { AnkiConnectProxyServer } from './anki-integration/anki-connect-proxy';
|
import type { AnkiConnectProxyServer } from './anki-integration/anki-connect-proxy';
|
||||||
import { findDuplicateNote as findDuplicateNoteForAnkiIntegration } from './anki-integration/duplicate';
|
import { findDuplicateNote as findDuplicateNoteForAnkiIntegration } from './anki-integration/duplicate';
|
||||||
|
import { findDuplicateNoteIds as findDuplicateNoteIdsForAnkiIntegration } from './anki-integration/duplicate';
|
||||||
import { CardCreationService } from './anki-integration/card-creation';
|
import { CardCreationService } from './anki-integration/card-creation';
|
||||||
import { FieldGroupingService } from './anki-integration/field-grouping';
|
import { FieldGroupingService } from './anki-integration/field-grouping';
|
||||||
import { FieldGroupingMergeCollaborator } from './anki-integration/field-grouping-merge';
|
import { FieldGroupingMergeCollaborator } from './anki-integration/field-grouping-merge';
|
||||||
@@ -148,6 +149,7 @@ export class AnkiIntegration {
|
|||||||
private aiConfig: AiConfig;
|
private aiConfig: AiConfig;
|
||||||
private recordCardsMinedCallback: ((count: number, noteIds?: number[]) => void) | null = null;
|
private recordCardsMinedCallback: ((count: number, noteIds?: number[]) => void) | null = null;
|
||||||
private noteIdRedirects = new Map<number, number>();
|
private noteIdRedirects = new Map<number, number>();
|
||||||
|
private trackedDuplicateNoteIds = new Map<number, number[]>();
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
config: AnkiConnectConfig,
|
config: AnkiConnectConfig,
|
||||||
@@ -264,6 +266,9 @@ export class AnkiIntegration {
|
|||||||
recordCardsAdded: (count, noteIds) => {
|
recordCardsAdded: (count, noteIds) => {
|
||||||
this.recordCardsMinedSafely(count, noteIds, 'proxy');
|
this.recordCardsMinedSafely(count, noteIds, 'proxy');
|
||||||
},
|
},
|
||||||
|
trackAddedDuplicateNoteIds: (noteId, duplicateNoteIds) => {
|
||||||
|
this.trackDuplicateNoteIdsForNote(noteId, duplicateNoteIds);
|
||||||
|
},
|
||||||
getDeck: () => this.config.deck,
|
getDeck: () => this.config.deck,
|
||||||
findNotes: async (query, options) =>
|
findNotes: async (query, options) =>
|
||||||
(await this.client.findNotes(query, options)) as number[],
|
(await this.client.findNotes(query, options)) as number[],
|
||||||
@@ -361,6 +366,11 @@ export class AnkiIntegration {
|
|||||||
trackLastAddedNoteId: (noteId) => {
|
trackLastAddedNoteId: (noteId) => {
|
||||||
this.previousNoteIds.add(noteId);
|
this.previousNoteIds.add(noteId);
|
||||||
},
|
},
|
||||||
|
trackLastAddedDuplicateNoteIds: (noteId, duplicateNoteIds) => {
|
||||||
|
this.trackedDuplicateNoteIds.set(noteId, [...duplicateNoteIds]);
|
||||||
|
},
|
||||||
|
findDuplicateNoteIds: (expression, noteInfo) =>
|
||||||
|
this.findDuplicateNoteIds(expression, noteInfo),
|
||||||
recordCardsMinedCallback: (count, noteIds) => {
|
recordCardsMinedCallback: (count, noteIds) => {
|
||||||
this.recordCardsMinedSafely(count, noteIds, 'card creation');
|
this.recordCardsMinedSafely(count, noteIds, 'card creation');
|
||||||
},
|
},
|
||||||
@@ -382,6 +392,10 @@ export class AnkiIntegration {
|
|||||||
extractFields: (fields) => this.extractFields(fields),
|
extractFields: (fields) => this.extractFields(fields),
|
||||||
findDuplicateNote: (expression, noteId, noteInfo) =>
|
findDuplicateNote: (expression, noteId, noteInfo) =>
|
||||||
this.findDuplicateNote(expression, noteId, noteInfo),
|
this.findDuplicateNote(expression, noteId, noteInfo),
|
||||||
|
getTrackedDuplicateNoteIds: (noteId) =>
|
||||||
|
this.trackedDuplicateNoteIds.has(noteId)
|
||||||
|
? [...(this.trackedDuplicateNoteIds.get(noteId) ?? [])]
|
||||||
|
: null,
|
||||||
hasAllConfiguredFields: (noteInfo, configuredFieldNames) =>
|
hasAllConfiguredFields: (noteInfo, configuredFieldNames) =>
|
||||||
this.hasAllConfiguredFields(noteInfo, configuredFieldNames),
|
this.hasAllConfiguredFields(noteInfo, configuredFieldNames),
|
||||||
processNewCard: (noteId, options) => this.processNewCard(noteId, options),
|
processNewCard: (noteId, options) => this.processNewCard(noteId, options),
|
||||||
@@ -1042,6 +1056,10 @@ export class AnkiIntegration {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
trackDuplicateNoteIdsForNote(noteId: number, duplicateNoteIds: number[]): void {
|
||||||
|
this.trackedDuplicateNoteIds.set(noteId, [...duplicateNoteIds]);
|
||||||
|
}
|
||||||
|
|
||||||
private async findDuplicateNote(
|
private async findDuplicateNote(
|
||||||
expression: string,
|
expression: string,
|
||||||
excludeNoteId: number,
|
excludeNoteId: number,
|
||||||
@@ -1065,6 +1083,25 @@ export class AnkiIntegration {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private async findDuplicateNoteIds(expression: string, noteInfo: NoteInfo): Promise<number[]> {
|
||||||
|
return findDuplicateNoteIdsForAnkiIntegration(expression, -1, noteInfo, {
|
||||||
|
findNotes: async (query, options) => (await this.client.findNotes(query, options)) as unknown,
|
||||||
|
notesInfo: async (noteIds) => (await this.client.notesInfo(noteIds)) as unknown,
|
||||||
|
getDeck: () => this.config.deck,
|
||||||
|
getWordFieldCandidates: () => this.getConfiguredWordFieldCandidates(),
|
||||||
|
resolveFieldName: (info, preferredName) => this.resolveNoteFieldName(info, preferredName),
|
||||||
|
logInfo: (message) => {
|
||||||
|
log.info(message);
|
||||||
|
},
|
||||||
|
logDebug: (message) => {
|
||||||
|
log.debug(message);
|
||||||
|
},
|
||||||
|
logWarn: (message, error) => {
|
||||||
|
log.warn(message, (error as Error).message);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
private getPreferredSentenceAudioFieldName(): string {
|
private getPreferredSentenceAudioFieldName(): string {
|
||||||
const sentenceCardConfig = this.getEffectiveSentenceCardConfig();
|
const sentenceCardConfig = this.getEffectiveSentenceCardConfig();
|
||||||
return sentenceCardConfig.audioField || 'SentenceAudio';
|
return sentenceCardConfig.audioField || 'SentenceAudio';
|
||||||
|
|||||||
@@ -324,6 +324,123 @@ test('proxy fallback-enqueues latest note for addNote responses without note IDs
|
|||||||
assert.deepEqual(recordedCards, [1]);
|
assert.deepEqual(recordedCards, [1]);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('proxy tracks duplicate note ids from addNote request metadata before enrichment', async () => {
|
||||||
|
const processed: number[] = [];
|
||||||
|
const tracked: Array<{ noteId: number; duplicateNoteIds: number[] }> = [];
|
||||||
|
const proxy = new AnkiConnectProxyServer({
|
||||||
|
shouldAutoUpdateNewCards: () => true,
|
||||||
|
processNewCard: async (noteId) => {
|
||||||
|
processed.push(noteId);
|
||||||
|
},
|
||||||
|
trackAddedDuplicateNoteIds: (noteId, duplicateNoteIds) => {
|
||||||
|
tracked.push({ noteId, duplicateNoteIds });
|
||||||
|
},
|
||||||
|
logInfo: () => undefined,
|
||||||
|
logWarn: () => undefined,
|
||||||
|
logError: () => undefined,
|
||||||
|
});
|
||||||
|
|
||||||
|
(
|
||||||
|
proxy as unknown as {
|
||||||
|
maybeEnqueueFromRequest: (request: Record<string, unknown>, responseBody: Buffer) => void;
|
||||||
|
}
|
||||||
|
).maybeEnqueueFromRequest(
|
||||||
|
{
|
||||||
|
action: 'addNote',
|
||||||
|
params: {
|
||||||
|
note: {},
|
||||||
|
subminerDuplicateNoteIds: [11, -1, 40, 11, 25],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
Buffer.from(JSON.stringify({ result: 42, error: null }), 'utf8'),
|
||||||
|
);
|
||||||
|
|
||||||
|
await waitForCondition(() => processed.length === 1);
|
||||||
|
assert.deepEqual(tracked, [{ noteId: 42, duplicateNoteIds: [11, 25, 40] }]);
|
||||||
|
assert.deepEqual(processed, [42]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('proxy strips SubMiner duplicate metadata before forwarding upstream addNote request', async () => {
|
||||||
|
let upstreamBody = '';
|
||||||
|
const upstream = http.createServer(async (req, res) => {
|
||||||
|
upstreamBody = await new Promise<string>((resolve) => {
|
||||||
|
const chunks: Buffer[] = [];
|
||||||
|
req.on('data', (chunk) => chunks.push(Buffer.from(chunk)));
|
||||||
|
req.on('end', () => resolve(Buffer.concat(chunks).toString('utf8')));
|
||||||
|
});
|
||||||
|
res.statusCode = 200;
|
||||||
|
res.setHeader('content-type', 'application/json');
|
||||||
|
res.end(JSON.stringify({ result: 42, error: null }));
|
||||||
|
});
|
||||||
|
upstream.listen(0, '127.0.0.1');
|
||||||
|
await once(upstream, 'listening');
|
||||||
|
const upstreamAddress = upstream.address();
|
||||||
|
assert.ok(upstreamAddress && typeof upstreamAddress === 'object');
|
||||||
|
const upstreamPort = upstreamAddress.port;
|
||||||
|
|
||||||
|
const tracked: Array<{ noteId: number; duplicateNoteIds: number[] }> = [];
|
||||||
|
const proxy = new AnkiConnectProxyServer({
|
||||||
|
shouldAutoUpdateNewCards: () => true,
|
||||||
|
processNewCard: async () => undefined,
|
||||||
|
trackAddedDuplicateNoteIds: (noteId, duplicateNoteIds) => {
|
||||||
|
tracked.push({ noteId, duplicateNoteIds });
|
||||||
|
},
|
||||||
|
logInfo: () => undefined,
|
||||||
|
logWarn: () => undefined,
|
||||||
|
logError: () => undefined,
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
proxy.start({
|
||||||
|
host: '127.0.0.1',
|
||||||
|
port: 0,
|
||||||
|
upstreamUrl: `http://127.0.0.1:${upstreamPort}`,
|
||||||
|
});
|
||||||
|
|
||||||
|
const proxyServer = (
|
||||||
|
proxy as unknown as {
|
||||||
|
server: http.Server | null;
|
||||||
|
}
|
||||||
|
).server;
|
||||||
|
assert.ok(proxyServer);
|
||||||
|
if (!proxyServer.listening) {
|
||||||
|
await once(proxyServer, 'listening');
|
||||||
|
}
|
||||||
|
const proxyAddress = proxyServer.address();
|
||||||
|
assert.ok(proxyAddress && typeof proxyAddress === 'object');
|
||||||
|
const proxyPort = proxyAddress.port;
|
||||||
|
|
||||||
|
const response = await fetch(`http://127.0.0.1:${proxyPort}`, {
|
||||||
|
method: 'POST',
|
||||||
|
headers: {
|
||||||
|
'content-type': 'application/json',
|
||||||
|
},
|
||||||
|
body: JSON.stringify({
|
||||||
|
action: 'addNote',
|
||||||
|
version: 6,
|
||||||
|
params: {
|
||||||
|
note: {
|
||||||
|
deckName: 'Mining',
|
||||||
|
modelName: 'Sentence',
|
||||||
|
fields: { Expression: '食べる' },
|
||||||
|
},
|
||||||
|
subminerDuplicateNoteIds: [18, 7],
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(response.status, 200);
|
||||||
|
assert.deepEqual(await response.json(), { result: 42, error: null });
|
||||||
|
await waitForCondition(() => tracked.length === 1);
|
||||||
|
assert.equal(upstreamBody.includes('subminerDuplicateNoteIds'), false);
|
||||||
|
assert.deepEqual(tracked, [{ noteId: 42, duplicateNoteIds: [7, 18] }]);
|
||||||
|
} finally {
|
||||||
|
proxy.stop();
|
||||||
|
upstream.close();
|
||||||
|
await once(upstream, 'close');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
test('proxy returns addNote response without waiting for background enrichment', async () => {
|
test('proxy returns addNote response without waiting for background enrichment', async () => {
|
||||||
const processed: number[] = [];
|
const processed: number[] = [];
|
||||||
let releaseProcessing: (() => void) | undefined;
|
let releaseProcessing: (() => void) | undefined;
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ export interface AnkiConnectProxyServerDeps {
|
|||||||
shouldAutoUpdateNewCards: () => boolean;
|
shouldAutoUpdateNewCards: () => boolean;
|
||||||
processNewCard: (noteId: number) => Promise<void>;
|
processNewCard: (noteId: number) => Promise<void>;
|
||||||
recordCardsAdded?: (count: number, noteIds: number[]) => void;
|
recordCardsAdded?: (count: number, noteIds: number[]) => void;
|
||||||
|
trackAddedDuplicateNoteIds?: (noteId: number, duplicateNoteIds: number[]) => void;
|
||||||
getDeck?: () => string | undefined;
|
getDeck?: () => string | undefined;
|
||||||
findNotes?: (
|
findNotes?: (
|
||||||
query: string,
|
query: string,
|
||||||
@@ -161,6 +162,8 @@ export class AnkiConnectProxyServer {
|
|||||||
}
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
|
const forwardedBody =
|
||||||
|
req.method === 'POST' ? this.getForwardRequestBody(rawBody, requestJson) : rawBody;
|
||||||
const targetUrl = new URL(req.url || '/', upstreamUrl).toString();
|
const targetUrl = new URL(req.url || '/', upstreamUrl).toString();
|
||||||
const contentType =
|
const contentType =
|
||||||
typeof req.headers['content-type'] === 'string'
|
typeof req.headers['content-type'] === 'string'
|
||||||
@@ -169,7 +172,7 @@ export class AnkiConnectProxyServer {
|
|||||||
const upstreamResponse = await this.client.request<ArrayBuffer>({
|
const upstreamResponse = await this.client.request<ArrayBuffer>({
|
||||||
url: targetUrl,
|
url: targetUrl,
|
||||||
method: req.method,
|
method: req.method,
|
||||||
data: req.method === 'POST' ? rawBody : undefined,
|
data: req.method === 'POST' ? forwardedBody : undefined,
|
||||||
headers: {
|
headers: {
|
||||||
'content-type': contentType,
|
'content-type': contentType,
|
||||||
},
|
},
|
||||||
@@ -219,6 +222,8 @@ export class AnkiConnectProxyServer {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
this.maybeTrackDuplicateNoteIds(requestJson, action, responseResult);
|
||||||
|
|
||||||
const noteIds =
|
const noteIds =
|
||||||
action === 'multi'
|
action === 'multi'
|
||||||
? this.collectMultiResultIds(requestJson, responseResult)
|
? this.collectMultiResultIds(requestJson, responseResult)
|
||||||
@@ -231,6 +236,83 @@ export class AnkiConnectProxyServer {
|
|||||||
this.enqueueNotes(noteIds);
|
this.enqueueNotes(noteIds);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private maybeTrackDuplicateNoteIds(
|
||||||
|
requestJson: Record<string, unknown>,
|
||||||
|
action: string,
|
||||||
|
responseResult: unknown,
|
||||||
|
): void {
|
||||||
|
if (action !== 'addNote') {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const duplicateNoteIds = this.getRequestDuplicateNoteIds(requestJson);
|
||||||
|
if (duplicateNoteIds.length === 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const noteId = this.collectSingleResultId(responseResult)[0];
|
||||||
|
if (!noteId) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
this.deps.trackAddedDuplicateNoteIds?.(noteId, duplicateNoteIds);
|
||||||
|
}
|
||||||
|
|
||||||
|
private getForwardRequestBody(
|
||||||
|
rawBody: Buffer,
|
||||||
|
requestJson: Record<string, unknown> | null,
|
||||||
|
): Buffer {
|
||||||
|
if (!requestJson) {
|
||||||
|
return rawBody;
|
||||||
|
}
|
||||||
|
|
||||||
|
const sanitized = this.sanitizeRequestJson(requestJson);
|
||||||
|
if (sanitized === requestJson) {
|
||||||
|
return rawBody;
|
||||||
|
}
|
||||||
|
|
||||||
|
return Buffer.from(JSON.stringify(sanitized), 'utf8');
|
||||||
|
}
|
||||||
|
|
||||||
|
private sanitizeRequestJson(requestJson: Record<string, unknown>): Record<string, unknown> {
|
||||||
|
const action =
|
||||||
|
typeof requestJson.action === 'string'
|
||||||
|
? requestJson.action
|
||||||
|
: String(requestJson.action ?? '');
|
||||||
|
if (action !== 'addNote') {
|
||||||
|
return requestJson;
|
||||||
|
}
|
||||||
|
|
||||||
|
const params =
|
||||||
|
requestJson.params && typeof requestJson.params === 'object'
|
||||||
|
? (requestJson.params as Record<string, unknown>)
|
||||||
|
: null;
|
||||||
|
if (!params || !Object.prototype.hasOwnProperty.call(params, 'subminerDuplicateNoteIds')) {
|
||||||
|
return requestJson;
|
||||||
|
}
|
||||||
|
|
||||||
|
const nextParams = { ...params };
|
||||||
|
delete nextParams.subminerDuplicateNoteIds;
|
||||||
|
return {
|
||||||
|
...requestJson,
|
||||||
|
params: nextParams,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private getRequestDuplicateNoteIds(requestJson: Record<string, unknown>): number[] {
|
||||||
|
const params =
|
||||||
|
requestJson.params && typeof requestJson.params === 'object'
|
||||||
|
? (requestJson.params as Record<string, unknown>)
|
||||||
|
: null;
|
||||||
|
const rawNoteIds = Array.isArray(params?.subminerDuplicateNoteIds)
|
||||||
|
? params.subminerDuplicateNoteIds
|
||||||
|
: [];
|
||||||
|
return [
|
||||||
|
...new Set(
|
||||||
|
rawNoteIds.filter((entry): entry is number => {
|
||||||
|
return typeof entry === 'number' && Number.isInteger(entry) && entry > 0;
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
].sort((left, right) => left - right);
|
||||||
|
}
|
||||||
|
|
||||||
private requestIncludesAddAction(action: string, requestJson: Record<string, unknown>): boolean {
|
private requestIncludesAddAction(action: string, requestJson: Record<string, unknown>): boolean {
|
||||||
if (action === 'addNote' || action === 'addNotes') {
|
if (action === 'addNote' || action === 'addNotes') {
|
||||||
return true;
|
return true;
|
||||||
|
|||||||
@@ -397,3 +397,178 @@ test('CardCreationService uses stream-open-filename for remote media generation'
|
|||||||
assert.deepEqual(audioPaths, ['https://audio.example/videoplayback?mime=audio%2Fwebm']);
|
assert.deepEqual(audioPaths, ['https://audio.example/videoplayback?mime=audio%2Fwebm']);
|
||||||
assert.deepEqual(imagePaths, ['https://video.example/videoplayback?mime=video%2Fmp4']);
|
assert.deepEqual(imagePaths, ['https://video.example/videoplayback?mime=video%2Fmp4']);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('CardCreationService tracks pre-add duplicate note ids for kiku sentence cards', async () => {
|
||||||
|
const trackedDuplicates: Array<{ noteId: number; duplicateNoteIds: number[] }> = [];
|
||||||
|
const duplicateLookupExpressions: string[] = [];
|
||||||
|
|
||||||
|
const service = new CardCreationService({
|
||||||
|
getConfig: () =>
|
||||||
|
({
|
||||||
|
deck: 'Mining',
|
||||||
|
fields: {
|
||||||
|
word: 'Expression',
|
||||||
|
sentence: 'Sentence',
|
||||||
|
audio: 'SentenceAudio',
|
||||||
|
},
|
||||||
|
media: {
|
||||||
|
generateAudio: false,
|
||||||
|
generateImage: false,
|
||||||
|
},
|
||||||
|
behavior: {},
|
||||||
|
ai: false,
|
||||||
|
}) as AnkiConnectConfig,
|
||||||
|
getAiConfig: () => ({}),
|
||||||
|
getTimingTracker: () => ({}) as never,
|
||||||
|
getMpvClient: () =>
|
||||||
|
({
|
||||||
|
currentVideoPath: '/video.mp4',
|
||||||
|
currentSubText: '字幕',
|
||||||
|
currentSubStart: 1,
|
||||||
|
currentSubEnd: 2,
|
||||||
|
currentTimePos: 1.5,
|
||||||
|
currentAudioStreamIndex: 0,
|
||||||
|
}) as never,
|
||||||
|
client: {
|
||||||
|
addNote: async () => 42,
|
||||||
|
addTags: async () => undefined,
|
||||||
|
notesInfo: async () => [],
|
||||||
|
updateNoteFields: async () => undefined,
|
||||||
|
storeMediaFile: async () => undefined,
|
||||||
|
findNotes: async () => [],
|
||||||
|
retrieveMediaFile: async () => '',
|
||||||
|
},
|
||||||
|
mediaGenerator: {
|
||||||
|
generateAudio: async () => null,
|
||||||
|
generateScreenshot: async () => null,
|
||||||
|
generateAnimatedImage: async () => null,
|
||||||
|
},
|
||||||
|
showOsdNotification: () => undefined,
|
||||||
|
showUpdateResult: () => undefined,
|
||||||
|
showStatusNotification: () => undefined,
|
||||||
|
showNotification: async () => undefined,
|
||||||
|
beginUpdateProgress: () => undefined,
|
||||||
|
endUpdateProgress: () => undefined,
|
||||||
|
withUpdateProgress: async (_message, action) => action(),
|
||||||
|
resolveConfiguredFieldName: () => null,
|
||||||
|
resolveNoteFieldName: () => null,
|
||||||
|
getAnimatedImageLeadInSeconds: async () => 0,
|
||||||
|
extractFields: () => ({}),
|
||||||
|
processSentence: (sentence) => sentence,
|
||||||
|
setCardTypeFields: () => undefined,
|
||||||
|
mergeFieldValue: (_existing, newValue) => newValue,
|
||||||
|
formatMiscInfoPattern: () => '',
|
||||||
|
getEffectiveSentenceCardConfig: () => ({
|
||||||
|
model: 'Sentence',
|
||||||
|
sentenceField: 'Sentence',
|
||||||
|
audioField: 'SentenceAudio',
|
||||||
|
lapisEnabled: false,
|
||||||
|
kikuEnabled: true,
|
||||||
|
kikuFieldGrouping: 'manual',
|
||||||
|
kikuDeleteDuplicateInAuto: false,
|
||||||
|
}),
|
||||||
|
getFallbackDurationSeconds: () => 10,
|
||||||
|
appendKnownWordsFromNoteInfo: () => undefined,
|
||||||
|
isUpdateInProgress: () => false,
|
||||||
|
setUpdateInProgress: () => undefined,
|
||||||
|
trackLastAddedNoteId: () => undefined,
|
||||||
|
findDuplicateNoteIds: async (expression) => {
|
||||||
|
duplicateLookupExpressions.push(expression);
|
||||||
|
return [18, 7, 30, 7];
|
||||||
|
},
|
||||||
|
trackLastAddedDuplicateNoteIds: (noteId, duplicateNoteIds) => {
|
||||||
|
trackedDuplicates.push({ noteId, duplicateNoteIds });
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const created = await service.createSentenceCard('重複文', 0, 1);
|
||||||
|
|
||||||
|
assert.equal(created, true);
|
||||||
|
assert.deepEqual(duplicateLookupExpressions, ['重複文']);
|
||||||
|
assert.deepEqual(trackedDuplicates, [{ noteId: 42, duplicateNoteIds: [7, 18, 30] }]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('CardCreationService does not track duplicate ids when pre-add lookup returns none', async () => {
|
||||||
|
const trackedDuplicates: Array<{ noteId: number; duplicateNoteIds: number[] }> = [];
|
||||||
|
|
||||||
|
const service = new CardCreationService({
|
||||||
|
getConfig: () =>
|
||||||
|
({
|
||||||
|
deck: 'Mining',
|
||||||
|
fields: {
|
||||||
|
word: 'Expression',
|
||||||
|
sentence: 'Sentence',
|
||||||
|
audio: 'SentenceAudio',
|
||||||
|
},
|
||||||
|
media: {
|
||||||
|
generateAudio: false,
|
||||||
|
generateImage: false,
|
||||||
|
},
|
||||||
|
behavior: {},
|
||||||
|
ai: false,
|
||||||
|
}) as AnkiConnectConfig,
|
||||||
|
getAiConfig: () => ({}),
|
||||||
|
getTimingTracker: () => ({}) as never,
|
||||||
|
getMpvClient: () =>
|
||||||
|
({
|
||||||
|
currentVideoPath: '/video.mp4',
|
||||||
|
currentSubText: '字幕',
|
||||||
|
currentSubStart: 1,
|
||||||
|
currentSubEnd: 2,
|
||||||
|
currentTimePos: 1.5,
|
||||||
|
currentAudioStreamIndex: 0,
|
||||||
|
}) as never,
|
||||||
|
client: {
|
||||||
|
addNote: async () => 42,
|
||||||
|
addTags: async () => undefined,
|
||||||
|
notesInfo: async () => [],
|
||||||
|
updateNoteFields: async () => undefined,
|
||||||
|
storeMediaFile: async () => undefined,
|
||||||
|
findNotes: async () => [],
|
||||||
|
retrieveMediaFile: async () => '',
|
||||||
|
},
|
||||||
|
mediaGenerator: {
|
||||||
|
generateAudio: async () => null,
|
||||||
|
generateScreenshot: async () => null,
|
||||||
|
generateAnimatedImage: async () => null,
|
||||||
|
},
|
||||||
|
showOsdNotification: () => undefined,
|
||||||
|
showUpdateResult: () => undefined,
|
||||||
|
showStatusNotification: () => undefined,
|
||||||
|
showNotification: async () => undefined,
|
||||||
|
beginUpdateProgress: () => undefined,
|
||||||
|
endUpdateProgress: () => undefined,
|
||||||
|
withUpdateProgress: async (_message, action) => action(),
|
||||||
|
resolveConfiguredFieldName: () => null,
|
||||||
|
resolveNoteFieldName: () => null,
|
||||||
|
getAnimatedImageLeadInSeconds: async () => 0,
|
||||||
|
extractFields: () => ({}),
|
||||||
|
processSentence: (sentence) => sentence,
|
||||||
|
setCardTypeFields: () => undefined,
|
||||||
|
mergeFieldValue: (_existing, newValue) => newValue,
|
||||||
|
formatMiscInfoPattern: () => '',
|
||||||
|
getEffectiveSentenceCardConfig: () => ({
|
||||||
|
model: 'Sentence',
|
||||||
|
sentenceField: 'Sentence',
|
||||||
|
audioField: 'SentenceAudio',
|
||||||
|
lapisEnabled: false,
|
||||||
|
kikuEnabled: true,
|
||||||
|
kikuFieldGrouping: 'manual',
|
||||||
|
kikuDeleteDuplicateInAuto: false,
|
||||||
|
}),
|
||||||
|
getFallbackDurationSeconds: () => 10,
|
||||||
|
appendKnownWordsFromNoteInfo: () => undefined,
|
||||||
|
isUpdateInProgress: () => false,
|
||||||
|
setUpdateInProgress: () => undefined,
|
||||||
|
trackLastAddedNoteId: () => undefined,
|
||||||
|
findDuplicateNoteIds: async () => [],
|
||||||
|
trackLastAddedDuplicateNoteIds: (noteId, duplicateNoteIds) => {
|
||||||
|
trackedDuplicates.push({ noteId, duplicateNoteIds });
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const created = await service.createSentenceCard('重複なし', 0, 1);
|
||||||
|
|
||||||
|
assert.equal(created, true);
|
||||||
|
assert.deepEqual(trackedDuplicates, []);
|
||||||
|
});
|
||||||
|
|||||||
@@ -112,6 +112,8 @@ interface CardCreationDeps {
|
|||||||
isUpdateInProgress: () => boolean;
|
isUpdateInProgress: () => boolean;
|
||||||
setUpdateInProgress: (value: boolean) => void;
|
setUpdateInProgress: (value: boolean) => void;
|
||||||
trackLastAddedNoteId?: (noteId: number) => void;
|
trackLastAddedNoteId?: (noteId: number) => void;
|
||||||
|
trackLastAddedDuplicateNoteIds?: (noteId: number, duplicateNoteIds: number[]) => void;
|
||||||
|
findDuplicateNoteIds?: (expression: string, noteInfo: CardCreationNoteInfo) => Promise<number[]>;
|
||||||
recordCardsMinedCallback?: (count: number, noteIds?: number[]) => void;
|
recordCardsMinedCallback?: (count: number, noteIds?: number[]) => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -548,6 +550,30 @@ export class CardCreationService {
|
|||||||
fields[getConfiguredWordFieldName(this.deps.getConfig())] = sentence;
|
fields[getConfiguredWordFieldName(this.deps.getConfig())] = sentence;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const pendingNoteInfo = this.createPendingNoteInfo(fields);
|
||||||
|
const pendingNoteFields = Object.fromEntries(
|
||||||
|
Object.entries(fields).map(([name, value]) => [name.toLowerCase(), value]),
|
||||||
|
);
|
||||||
|
const pendingExpressionText = getPreferredWordValueFromExtractedFields(
|
||||||
|
pendingNoteFields,
|
||||||
|
this.deps.getConfig(),
|
||||||
|
).trim();
|
||||||
|
let duplicateNoteIds: number[] = [];
|
||||||
|
if (
|
||||||
|
sentenceCardConfig.kikuEnabled &&
|
||||||
|
sentenceCardConfig.kikuFieldGrouping !== 'disabled' &&
|
||||||
|
pendingExpressionText &&
|
||||||
|
this.deps.findDuplicateNoteIds
|
||||||
|
) {
|
||||||
|
try {
|
||||||
|
duplicateNoteIds = sortUniqueNoteIds(
|
||||||
|
await this.deps.findDuplicateNoteIds(pendingExpressionText, pendingNoteInfo),
|
||||||
|
);
|
||||||
|
} catch (error) {
|
||||||
|
log.warn('Failed to capture pre-add duplicate note ids:', (error as Error).message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
const deck = this.deps.getConfig().deck || 'Default';
|
const deck = this.deps.getConfig().deck || 'Default';
|
||||||
let noteId: number;
|
let noteId: number;
|
||||||
try {
|
try {
|
||||||
@@ -570,6 +596,14 @@ export class CardCreationService {
|
|||||||
log.warn('Failed to track last added note:', (error as Error).message);
|
log.warn('Failed to track last added note:', (error as Error).message);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (duplicateNoteIds.length > 0) {
|
||||||
|
try {
|
||||||
|
this.deps.trackLastAddedDuplicateNoteIds?.(noteId, duplicateNoteIds);
|
||||||
|
} catch (error) {
|
||||||
|
log.warn('Failed to track duplicate note ids:', (error as Error).message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
this.deps.recordCardsMinedCallback?.(1, [noteId]);
|
this.deps.recordCardsMinedCallback?.(1, [noteId]);
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
@@ -685,6 +719,13 @@ export class CardCreationService {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private createPendingNoteInfo(fields: Record<string, string>): CardCreationNoteInfo {
|
||||||
|
return {
|
||||||
|
noteId: -1,
|
||||||
|
fields: Object.fromEntries(Object.entries(fields).map(([name, value]) => [name, { value }])),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
private async mediaGenerateAudio(
|
private async mediaGenerateAudio(
|
||||||
videoPath: string,
|
videoPath: string,
|
||||||
startTime: number,
|
startTime: number,
|
||||||
@@ -764,3 +805,7 @@ export class CardCreationService {
|
|||||||
return `image_${timestamp}.${ext}`;
|
return `image_${timestamp}.${ext}`;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function sortUniqueNoteIds(noteIds: number[]): number[] {
|
||||||
|
return [...new Set(noteIds)].sort((left, right) => left - right);
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import test from 'node:test';
|
import test from 'node:test';
|
||||||
import assert from 'node:assert/strict';
|
import assert from 'node:assert/strict';
|
||||||
import { findDuplicateNote, type NoteInfo } from './duplicate';
|
import { findDuplicateNote, findDuplicateNoteIds, type NoteInfo } from './duplicate';
|
||||||
|
|
||||||
function createFieldResolver(noteInfo: NoteInfo, preferredName: string): string | null {
|
function createFieldResolver(noteInfo: NoteInfo, preferredName: string): string | null {
|
||||||
const names = Object.keys(noteInfo.fields);
|
const names = Object.keys(noteInfo.fields);
|
||||||
@@ -267,3 +267,68 @@ test('findDuplicateNote does not disable retries on findNotes calls', async () =
|
|||||||
assert.ok(seenOptions.length > 0);
|
assert.ok(seenOptions.length > 0);
|
||||||
assert.ok(seenOptions.every((options) => options?.maxRetries !== 0));
|
assert.ok(seenOptions.every((options) => options?.maxRetries !== 0));
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('findDuplicateNote stops after the first exact-match chunk', async () => {
|
||||||
|
const currentNote: NoteInfo = {
|
||||||
|
noteId: 100,
|
||||||
|
fields: {
|
||||||
|
Expression: { value: '貴様' },
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
let notesInfoCalls = 0;
|
||||||
|
const candidateIds = Array.from({ length: 51 }, (_, index) => 200 + index);
|
||||||
|
const duplicateId = await findDuplicateNote('貴様', 100, currentNote, {
|
||||||
|
findNotes: async () => candidateIds,
|
||||||
|
notesInfo: async (noteIds) => {
|
||||||
|
notesInfoCalls += 1;
|
||||||
|
return noteIds.map((noteId) => ({
|
||||||
|
noteId,
|
||||||
|
fields: {
|
||||||
|
Expression: { value: noteId === 200 ? '貴様' : `別単語-${noteId}` },
|
||||||
|
},
|
||||||
|
}));
|
||||||
|
},
|
||||||
|
getDeck: () => 'Japanese::Mining',
|
||||||
|
resolveFieldName: (noteInfo, preferredName) => createFieldResolver(noteInfo, preferredName),
|
||||||
|
logWarn: () => {},
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(duplicateId, 200);
|
||||||
|
assert.equal(notesInfoCalls, 1);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('findDuplicateNoteIds returns no matches when maxMatches is zero', async () => {
|
||||||
|
const currentNote: NoteInfo = {
|
||||||
|
noteId: 100,
|
||||||
|
fields: {
|
||||||
|
Expression: { value: '貴様' },
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
let notesInfoCalls = 0;
|
||||||
|
const duplicateIds = await findDuplicateNoteIds(
|
||||||
|
'貴様',
|
||||||
|
100,
|
||||||
|
currentNote,
|
||||||
|
{
|
||||||
|
findNotes: async () => [200],
|
||||||
|
notesInfo: async (noteIds) => {
|
||||||
|
notesInfoCalls += 1;
|
||||||
|
return noteIds.map((noteId) => ({
|
||||||
|
noteId,
|
||||||
|
fields: {
|
||||||
|
Expression: { value: '貴様' },
|
||||||
|
},
|
||||||
|
}));
|
||||||
|
},
|
||||||
|
getDeck: () => 'Japanese::Mining',
|
||||||
|
resolveFieldName: (noteInfo, preferredName) => createFieldResolver(noteInfo, preferredName),
|
||||||
|
logWarn: () => {},
|
||||||
|
},
|
||||||
|
0,
|
||||||
|
);
|
||||||
|
|
||||||
|
assert.deepEqual(duplicateIds, []);
|
||||||
|
assert.equal(notesInfoCalls, 0);
|
||||||
|
});
|
||||||
|
|||||||
@@ -24,13 +24,24 @@ export async function findDuplicateNote(
|
|||||||
noteInfo: NoteInfo,
|
noteInfo: NoteInfo,
|
||||||
deps: DuplicateDetectionDeps,
|
deps: DuplicateDetectionDeps,
|
||||||
): Promise<number | null> {
|
): Promise<number | null> {
|
||||||
|
const duplicateNoteIds = await findDuplicateNoteIds(expression, excludeNoteId, noteInfo, deps, 1);
|
||||||
|
return duplicateNoteIds[0] ?? null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function findDuplicateNoteIds(
|
||||||
|
expression: string,
|
||||||
|
excludeNoteId: number,
|
||||||
|
noteInfo: NoteInfo,
|
||||||
|
deps: DuplicateDetectionDeps,
|
||||||
|
maxMatches?: number,
|
||||||
|
): Promise<number[]> {
|
||||||
const configuredWordFieldCandidates = deps.getWordFieldCandidates?.() ?? ['Expression', 'Word'];
|
const configuredWordFieldCandidates = deps.getWordFieldCandidates?.() ?? ['Expression', 'Word'];
|
||||||
const sourceCandidates = getDuplicateSourceCandidates(
|
const sourceCandidates = getDuplicateSourceCandidates(
|
||||||
noteInfo,
|
noteInfo,
|
||||||
expression,
|
expression,
|
||||||
configuredWordFieldCandidates,
|
configuredWordFieldCandidates,
|
||||||
);
|
);
|
||||||
if (sourceCandidates.length === 0) return null;
|
if (sourceCandidates.length === 0) return [];
|
||||||
deps.logInfo?.(
|
deps.logInfo?.(
|
||||||
`[duplicate] start expr="${expression}" sourceCandidates=${sourceCandidates
|
`[duplicate] start expr="${expression}" sourceCandidates=${sourceCandidates
|
||||||
.map((entry) => `${entry.fieldName}:${entry.value}`)
|
.map((entry) => `${entry.fieldName}:${entry.value}`)
|
||||||
@@ -83,42 +94,49 @@ export async function findDuplicateNote(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return await findFirstExactDuplicateNoteId(
|
return await findExactDuplicateNoteIds(
|
||||||
noteIds,
|
noteIds,
|
||||||
excludeNoteId,
|
excludeNoteId,
|
||||||
sourceCandidates.map((candidate) => candidate.value),
|
sourceCandidates.map((candidate) => candidate.value),
|
||||||
configuredWordFieldCandidates,
|
configuredWordFieldCandidates,
|
||||||
deps,
|
deps,
|
||||||
|
maxMatches,
|
||||||
);
|
);
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
deps.logWarn('Duplicate search failed:', error);
|
deps.logWarn('Duplicate search failed:', error);
|
||||||
return null;
|
return [];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function findFirstExactDuplicateNoteId(
|
function findExactDuplicateNoteIds(
|
||||||
candidateNoteIds: Iterable<number>,
|
candidateNoteIds: Iterable<number>,
|
||||||
excludeNoteId: number,
|
excludeNoteId: number,
|
||||||
sourceValues: string[],
|
sourceValues: string[],
|
||||||
candidateFieldNames: string[],
|
candidateFieldNames: string[],
|
||||||
deps: DuplicateDetectionDeps,
|
deps: DuplicateDetectionDeps,
|
||||||
): Promise<number | null> {
|
maxMatches?: number,
|
||||||
|
): Promise<number[]> {
|
||||||
|
if (maxMatches !== undefined && maxMatches <= 0) {
|
||||||
|
return Promise.resolve([]);
|
||||||
|
}
|
||||||
|
|
||||||
const candidates = Array.from(candidateNoteIds).filter((id) => id !== excludeNoteId);
|
const candidates = Array.from(candidateNoteIds).filter((id) => id !== excludeNoteId);
|
||||||
deps.logDebug?.(`[duplicate] candidateIds=${candidates.length} exclude=${excludeNoteId}`);
|
deps.logDebug?.(`[duplicate] candidateIds=${candidates.length} exclude=${excludeNoteId}`);
|
||||||
if (candidates.length === 0) {
|
if (candidates.length === 0) {
|
||||||
deps.logInfo?.('[duplicate] no candidates after query + exclude');
|
deps.logInfo?.('[duplicate] no candidates after query + exclude');
|
||||||
return Promise.resolve(null);
|
return Promise.resolve([]);
|
||||||
}
|
}
|
||||||
|
|
||||||
const normalizedValues = new Set(
|
const normalizedValues = new Set(
|
||||||
sourceValues.map((value) => normalizeDuplicateValue(value)).filter((value) => value.length > 0),
|
sourceValues.map((value) => normalizeDuplicateValue(value)).filter((value) => value.length > 0),
|
||||||
);
|
);
|
||||||
if (normalizedValues.size === 0) {
|
if (normalizedValues.size === 0) {
|
||||||
return Promise.resolve(null);
|
return Promise.resolve([]);
|
||||||
}
|
}
|
||||||
|
|
||||||
const chunkSize = 50;
|
const chunkSize = 50;
|
||||||
return (async () => {
|
return (async () => {
|
||||||
|
const matches: number[] = [];
|
||||||
for (let i = 0; i < candidates.length; i += chunkSize) {
|
for (let i = 0; i < candidates.length; i += chunkSize) {
|
||||||
const chunk = candidates.slice(i, i + chunkSize);
|
const chunk = candidates.slice(i, i + chunkSize);
|
||||||
const notesInfoResult = (await deps.notesInfo(chunk)) as unknown[];
|
const notesInfoResult = (await deps.notesInfo(chunk)) as unknown[];
|
||||||
@@ -133,13 +151,19 @@ function findFirstExactDuplicateNoteId(
|
|||||||
`[duplicate] exact-match noteId=${noteInfo.noteId} field=${resolvedField}`,
|
`[duplicate] exact-match noteId=${noteInfo.noteId} field=${resolvedField}`,
|
||||||
);
|
);
|
||||||
deps.logInfo?.(`[duplicate] matched noteId=${noteInfo.noteId} field=${resolvedField}`);
|
deps.logInfo?.(`[duplicate] matched noteId=${noteInfo.noteId} field=${resolvedField}`);
|
||||||
return noteInfo.noteId;
|
matches.push(noteInfo.noteId);
|
||||||
|
if (maxMatches !== undefined && matches.length >= maxMatches) {
|
||||||
|
return matches;
|
||||||
|
}
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
deps.logInfo?.('[duplicate] no exact match in candidate notes');
|
if (matches.length === 0) {
|
||||||
return null;
|
deps.logInfo?.('[duplicate] no exact match in candidate notes');
|
||||||
|
}
|
||||||
|
return matches;
|
||||||
})();
|
})();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ function createHarness(
|
|||||||
noteIds?: number[];
|
noteIds?: number[];
|
||||||
notesInfo?: NoteInfo[][];
|
notesInfo?: NoteInfo[][];
|
||||||
duplicateNoteId?: number | null;
|
duplicateNoteId?: number | null;
|
||||||
|
trackedDuplicateNoteIds?: number[] | null;
|
||||||
hasAllConfiguredFields?: boolean;
|
hasAllConfiguredFields?: boolean;
|
||||||
manualHandled?: boolean;
|
manualHandled?: boolean;
|
||||||
expression?: string | null;
|
expression?: string | null;
|
||||||
@@ -74,6 +75,7 @@ function createHarness(
|
|||||||
duplicateRequests.push({ expression, excludeNoteId });
|
duplicateRequests.push({ expression, excludeNoteId });
|
||||||
return options.duplicateNoteId ?? 99;
|
return options.duplicateNoteId ?? 99;
|
||||||
},
|
},
|
||||||
|
getTrackedDuplicateNoteIds: () => options.trackedDuplicateNoteIds ?? null,
|
||||||
hasAllConfiguredFields: () => options.hasAllConfiguredFields ?? true,
|
hasAllConfiguredFields: () => options.hasAllConfiguredFields ?? true,
|
||||||
processNewCard: async (noteId, processOptions) => {
|
processNewCard: async (noteId, processOptions) => {
|
||||||
processCalls.push({ noteId, options: processOptions });
|
processCalls.push({ noteId, options: processOptions });
|
||||||
@@ -223,6 +225,46 @@ test('triggerFieldGroupingForLastAddedCard finds the newest note and hands off t
|
|||||||
]);
|
]);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('triggerFieldGroupingForLastAddedCard prefers tracked duplicate note ids before duplicate lookup', async () => {
|
||||||
|
const harness = createHarness({
|
||||||
|
noteIds: [7],
|
||||||
|
notesInfo: [
|
||||||
|
[
|
||||||
|
{
|
||||||
|
noteId: 7,
|
||||||
|
fields: {
|
||||||
|
Expression: { value: 'word-7' },
|
||||||
|
Sentence: { value: 'line-7' },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
[
|
||||||
|
{
|
||||||
|
noteId: 7,
|
||||||
|
fields: {
|
||||||
|
Expression: { value: 'word-7' },
|
||||||
|
Sentence: { value: 'line-7' },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
],
|
||||||
|
trackedDuplicateNoteIds: [12, 40, 25],
|
||||||
|
duplicateNoteId: 99,
|
||||||
|
hasAllConfiguredFields: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
await harness.service.triggerFieldGroupingForLastAddedCard();
|
||||||
|
|
||||||
|
assert.deepEqual(harness.duplicateRequests, []);
|
||||||
|
assert.deepEqual(harness.autoCalls, [
|
||||||
|
{
|
||||||
|
originalNoteId: 40,
|
||||||
|
newNoteId: 7,
|
||||||
|
expression: 'word-7',
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
test('triggerFieldGroupingForLastAddedCard refreshes the card when configured fields are missing', async () => {
|
test('triggerFieldGroupingForLastAddedCard refreshes the card when configured fields are missing', async () => {
|
||||||
const processCalls: Array<{ noteId: number; options?: { skipKikuFieldGrouping?: boolean } }> = [];
|
const processCalls: Array<{ noteId: number; options?: { skipKikuFieldGrouping?: boolean } }> = [];
|
||||||
const harness = createHarness({
|
const harness = createHarness({
|
||||||
|
|||||||
@@ -41,6 +41,7 @@ interface FieldGroupingDeps {
|
|||||||
excludeNoteId: number,
|
excludeNoteId: number,
|
||||||
noteInfo: FieldGroupingNoteInfo,
|
noteInfo: FieldGroupingNoteInfo,
|
||||||
) => Promise<number | null>;
|
) => Promise<number | null>;
|
||||||
|
getTrackedDuplicateNoteIds?: (noteId: number) => number[] | null;
|
||||||
hasAllConfiguredFields: (
|
hasAllConfiguredFields: (
|
||||||
noteInfo: FieldGroupingNoteInfo,
|
noteInfo: FieldGroupingNoteInfo,
|
||||||
configuredFieldNames: (string | undefined)[],
|
configuredFieldNames: (string | undefined)[],
|
||||||
@@ -117,11 +118,11 @@ export class FieldGroupingService {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const duplicateNoteId = await this.deps.findDuplicateNote(
|
const trackedDuplicateNoteIds = this.deps.getTrackedDuplicateNoteIds?.(noteId) ?? null;
|
||||||
expressionText,
|
const duplicateNoteId =
|
||||||
noteId,
|
trackedDuplicateNoteIds !== null
|
||||||
noteInfoBeforeUpdate,
|
? pickMostRecentDuplicateNoteId(trackedDuplicateNoteIds, noteId)
|
||||||
);
|
: await this.deps.findDuplicateNote(expressionText, noteId, noteInfoBeforeUpdate);
|
||||||
if (duplicateNoteId === null) {
|
if (duplicateNoteId === null) {
|
||||||
this.deps.showOsdNotification('No duplicate card found');
|
this.deps.showOsdNotification('No duplicate card found');
|
||||||
return;
|
return;
|
||||||
@@ -243,3 +244,17 @@ export class FieldGroupingService {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function pickMostRecentDuplicateNoteId(
|
||||||
|
duplicateNoteIds: number[],
|
||||||
|
excludeNoteId: number,
|
||||||
|
): number | null {
|
||||||
|
let bestNoteId: number | null = null;
|
||||||
|
for (const noteId of duplicateNoteIds) {
|
||||||
|
if (noteId === excludeNoteId) continue;
|
||||||
|
if (bestNoteId === null || noteId > bestNoteId) {
|
||||||
|
bestNoteId = noteId;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return bestNoteId;
|
||||||
|
}
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ test('printHelp includes configured texthooker port', () => {
|
|||||||
|
|
||||||
assert.match(output, /--help\s+Show this help/);
|
assert.match(output, /--help\s+Show this help/);
|
||||||
assert.match(output, /default: 7777/);
|
assert.match(output, /default: 7777/);
|
||||||
assert.match(output, /--launch-mpv/);
|
assert.match(output, /--launch-mpv.*Launch mpv with SubMiner defaults and exit/);
|
||||||
assert.match(output, /--stats\s+Open the stats dashboard in your browser/);
|
assert.match(output, /--stats\s+Open the stats dashboard in your browser/);
|
||||||
assert.doesNotMatch(output, /--refresh-known-words/);
|
assert.doesNotMatch(output, /--refresh-known-words/);
|
||||||
assert.match(output, /--setup\s+Open first-run setup window/);
|
assert.match(output, /--setup\s+Open first-run setup window/);
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ ${B}Usage:${R} subminer ${D}[command] [options]${R}
|
|||||||
${B}Session${R}
|
${B}Session${R}
|
||||||
--background Start in tray/background mode
|
--background Start in tray/background mode
|
||||||
--start Connect to mpv and launch overlay
|
--start Connect to mpv and launch overlay
|
||||||
--launch-mpv ${D}[targets...]${R} Launch mpv with the SubMiner mpv profile and exit
|
--launch-mpv ${D}[targets...]${R} Launch mpv with SubMiner defaults and exit
|
||||||
--stop Stop the running instance
|
--stop Stop the running instance
|
||||||
--stats Open the stats dashboard in your browser
|
--stats Open the stats dashboard in your browser
|
||||||
--texthooker Start texthooker server only ${D}(no overlay)${R}
|
--texthooker Start texthooker server only ${D}(no overlay)${R}
|
||||||
|
|||||||
@@ -37,6 +37,9 @@ test('loads defaults when config is missing', () => {
|
|||||||
assert.equal(config.jellyfin.remoteControlDeviceName, 'SubMiner');
|
assert.equal(config.jellyfin.remoteControlDeviceName, 'SubMiner');
|
||||||
assert.equal(config.ai.enabled, false);
|
assert.equal(config.ai.enabled, false);
|
||||||
assert.equal(config.ai.apiKeyCommand, '');
|
assert.equal(config.ai.apiKeyCommand, '');
|
||||||
|
assert.equal(config.texthooker.openBrowser, false);
|
||||||
|
assert.equal(config.controller.enabled, false);
|
||||||
|
assert.equal(config.ankiConnect.enabled, true);
|
||||||
assert.deepEqual(config.ankiConnect.ai, {
|
assert.deepEqual(config.ankiConnect.ai, {
|
||||||
enabled: false,
|
enabled: false,
|
||||||
model: '',
|
model: '',
|
||||||
@@ -47,12 +50,13 @@ test('loads defaults when config is missing', () => {
|
|||||||
assert.equal(config.startupWarmups.yomitanExtension, true);
|
assert.equal(config.startupWarmups.yomitanExtension, true);
|
||||||
assert.equal(config.startupWarmups.subtitleDictionaries, true);
|
assert.equal(config.startupWarmups.subtitleDictionaries, true);
|
||||||
assert.equal(config.startupWarmups.jellyfinRemoteSession, true);
|
assert.equal(config.startupWarmups.jellyfinRemoteSession, true);
|
||||||
assert.equal(config.discordPresence.enabled, false);
|
assert.equal(config.discordPresence.enabled, true);
|
||||||
assert.equal(config.discordPresence.updateIntervalMs, 3_000);
|
assert.equal(config.discordPresence.updateIntervalMs, 3_000);
|
||||||
assert.equal(config.subtitleStyle.backgroundColor, 'rgb(30, 32, 48, 0.88)');
|
assert.equal(config.subtitleStyle.backgroundColor, 'rgb(30, 32, 48, 0.88)');
|
||||||
assert.equal(config.subtitleStyle.preserveLineBreaks, false);
|
assert.equal(config.subtitleStyle.preserveLineBreaks, false);
|
||||||
assert.equal(config.subtitleStyle.autoPauseVideoOnHover, true);
|
assert.equal(config.subtitleStyle.autoPauseVideoOnHover, true);
|
||||||
assert.equal(config.subtitleStyle.autoPauseVideoOnYomitanPopup, false);
|
assert.equal(config.subtitleStyle.autoPauseVideoOnYomitanPopup, true);
|
||||||
|
assert.equal(config.subtitleSidebar.enabled, true);
|
||||||
assert.equal(config.subtitleStyle.hoverTokenColor, '#f4dbd6');
|
assert.equal(config.subtitleStyle.hoverTokenColor, '#f4dbd6');
|
||||||
assert.equal(config.subtitleStyle.hoverTokenBackgroundColor, 'rgba(54, 58, 79, 0.84)');
|
assert.equal(config.subtitleStyle.hoverTokenBackgroundColor, 'rgba(54, 58, 79, 0.84)');
|
||||||
assert.equal(
|
assert.equal(
|
||||||
@@ -96,6 +100,7 @@ test('loads defaults when config is missing', () => {
|
|||||||
assert.equal(config.immersionTracking.lifetimeSummaries?.global, true);
|
assert.equal(config.immersionTracking.lifetimeSummaries?.global, true);
|
||||||
assert.equal(config.immersionTracking.lifetimeSummaries?.anime, true);
|
assert.equal(config.immersionTracking.lifetimeSummaries?.anime, true);
|
||||||
assert.equal(config.immersionTracking.lifetimeSummaries?.media, true);
|
assert.equal(config.immersionTracking.lifetimeSummaries?.media, true);
|
||||||
|
assert.equal(config.stats.autoOpenBrowser, false);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('throws actionable startup parse error for malformed config at construction time', () => {
|
test('throws actionable startup parse error for malformed config at construction time', () => {
|
||||||
@@ -2122,7 +2127,23 @@ test('template generator includes known keys', () => {
|
|||||||
assert.match(output, /"port": 6678,? \/\/ Annotated subtitle websocket server port\./);
|
assert.match(output, /"port": 6678,? \/\/ Annotated subtitle websocket server port\./);
|
||||||
assert.match(
|
assert.match(
|
||||||
output,
|
output,
|
||||||
/"enabled": false,? \/\/ Enable AnkiConnect integration\. Values: true \| false/,
|
/"openBrowser": false,? \/\/ Open browser setting\. Values: true \| false/,
|
||||||
|
);
|
||||||
|
assert.match(
|
||||||
|
output,
|
||||||
|
/"enabled": false,? \/\/ Enable overlay controller support through the Chrome Gamepad API\. Values: true \| false/,
|
||||||
|
);
|
||||||
|
assert.match(
|
||||||
|
output,
|
||||||
|
/"autoPauseVideoOnYomitanPopup": true,? \/\/ Automatically pause mpv playback while Yomitan popup is open, then resume when popup closes\. Values: true \| false/,
|
||||||
|
);
|
||||||
|
assert.match(
|
||||||
|
output,
|
||||||
|
/"enabled": true,? \/\/ Enable the subtitle sidebar feature for parsed subtitle sources\. Values: true \| false/,
|
||||||
|
);
|
||||||
|
assert.match(
|
||||||
|
output,
|
||||||
|
/"enabled": true,? \/\/ Enable AnkiConnect integration\. Values: true \| false/,
|
||||||
);
|
);
|
||||||
assert.match(
|
assert.match(
|
||||||
output,
|
output,
|
||||||
@@ -2138,7 +2159,15 @@ test('template generator includes known keys', () => {
|
|||||||
);
|
);
|
||||||
assert.match(
|
assert.match(
|
||||||
output,
|
output,
|
||||||
/"primarySubLanguages": \[\s*"ja",\s*"jpn"\s*\],? \/\/ Comma-separated primary subtitle language priority for YouTube auto-loading\./,
|
/"enabled": true,? \/\/ Enable optional Discord Rich Presence updates\. Values: true \| false/,
|
||||||
|
);
|
||||||
|
assert.match(
|
||||||
|
output,
|
||||||
|
/"autoOpenBrowser": false,? \/\/ Automatically open the stats dashboard in a browser when the server starts\. Values: true \| false/,
|
||||||
|
);
|
||||||
|
assert.match(
|
||||||
|
output,
|
||||||
|
/"primarySubLanguages": \[\s*"ja",\s*"jpn"\s*\],? \/\/ Comma-separated primary subtitle language priority for managed subtitle auto-selection\./,
|
||||||
);
|
);
|
||||||
assert.doesNotMatch(output, /"mode": "automatic"/);
|
assert.doesNotMatch(output, /"mode": "automatic"/);
|
||||||
assert.doesNotMatch(output, /"fixWithAi": false/);
|
assert.doesNotMatch(output, /"fixWithAi": false/);
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ const {
|
|||||||
startupWarmups,
|
startupWarmups,
|
||||||
auto_start_overlay,
|
auto_start_overlay,
|
||||||
} = CORE_DEFAULT_CONFIG;
|
} = CORE_DEFAULT_CONFIG;
|
||||||
const { ankiConnect, jimaku, anilist, yomitan, jellyfin, discordPresence, ai, youtubeSubgen } =
|
const { ankiConnect, jimaku, anilist, mpv, yomitan, jellyfin, discordPresence, ai, youtubeSubgen } =
|
||||||
INTEGRATIONS_DEFAULT_CONFIG;
|
INTEGRATIONS_DEFAULT_CONFIG;
|
||||||
const { subtitleStyle, subtitleSidebar } = SUBTITLE_DEFAULT_CONFIG;
|
const { subtitleStyle, subtitleSidebar } = SUBTITLE_DEFAULT_CONFIG;
|
||||||
const { immersionTracking } = IMMERSION_DEFAULT_CONFIG;
|
const { immersionTracking } = IMMERSION_DEFAULT_CONFIG;
|
||||||
@@ -60,6 +60,7 @@ export const DEFAULT_CONFIG: ResolvedConfig = {
|
|||||||
auto_start_overlay,
|
auto_start_overlay,
|
||||||
jimaku,
|
jimaku,
|
||||||
anilist,
|
anilist,
|
||||||
|
mpv,
|
||||||
yomitan,
|
yomitan,
|
||||||
jellyfin,
|
jellyfin,
|
||||||
discordPresence,
|
discordPresence,
|
||||||
|
|||||||
@@ -31,10 +31,10 @@ export const CORE_DEFAULT_CONFIG: Pick<
|
|||||||
},
|
},
|
||||||
texthooker: {
|
texthooker: {
|
||||||
launchAtStartup: true,
|
launchAtStartup: true,
|
||||||
openBrowser: true,
|
openBrowser: false,
|
||||||
},
|
},
|
||||||
controller: {
|
controller: {
|
||||||
enabled: true,
|
enabled: false,
|
||||||
preferredGamepadId: '',
|
preferredGamepadId: '',
|
||||||
preferredGamepadLabel: '',
|
preferredGamepadLabel: '',
|
||||||
smoothScroll: true,
|
smoothScroll: true,
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ export const INTEGRATIONS_DEFAULT_CONFIG: Pick<
|
|||||||
| 'ankiConnect'
|
| 'ankiConnect'
|
||||||
| 'jimaku'
|
| 'jimaku'
|
||||||
| 'anilist'
|
| 'anilist'
|
||||||
|
| 'mpv'
|
||||||
| 'yomitan'
|
| 'yomitan'
|
||||||
| 'jellyfin'
|
| 'jellyfin'
|
||||||
| 'discordPresence'
|
| 'discordPresence'
|
||||||
@@ -12,7 +13,7 @@ export const INTEGRATIONS_DEFAULT_CONFIG: Pick<
|
|||||||
| 'youtubeSubgen'
|
| 'youtubeSubgen'
|
||||||
> = {
|
> = {
|
||||||
ankiConnect: {
|
ankiConnect: {
|
||||||
enabled: false,
|
enabled: true,
|
||||||
url: 'http://127.0.0.1:8765',
|
url: 'http://127.0.0.1:8765',
|
||||||
pollingRate: 3000,
|
pollingRate: 3000,
|
||||||
proxy: {
|
proxy: {
|
||||||
@@ -90,6 +91,9 @@ export const INTEGRATIONS_DEFAULT_CONFIG: Pick<
|
|||||||
languagePreference: 'ja',
|
languagePreference: 'ja',
|
||||||
maxEntryResults: 10,
|
maxEntryResults: 10,
|
||||||
},
|
},
|
||||||
|
mpv: {
|
||||||
|
executablePath: '',
|
||||||
|
},
|
||||||
anilist: {
|
anilist: {
|
||||||
enabled: false,
|
enabled: false,
|
||||||
accessToken: '',
|
accessToken: '',
|
||||||
@@ -128,7 +132,7 @@ export const INTEGRATIONS_DEFAULT_CONFIG: Pick<
|
|||||||
transcodeVideoCodec: 'h264',
|
transcodeVideoCodec: 'h264',
|
||||||
},
|
},
|
||||||
discordPresence: {
|
discordPresence: {
|
||||||
enabled: false,
|
enabled: true,
|
||||||
presenceStyle: 'default' as const,
|
presenceStyle: 'default' as const,
|
||||||
updateIntervalMs: 3_000,
|
updateIntervalMs: 3_000,
|
||||||
debounceMs: 750,
|
debounceMs: 750,
|
||||||
|
|||||||
@@ -6,6 +6,6 @@ export const STATS_DEFAULT_CONFIG: Pick<ResolvedConfig, 'stats'> = {
|
|||||||
markWatchedKey: 'KeyW',
|
markWatchedKey: 'KeyW',
|
||||||
serverPort: 6969,
|
serverPort: 6969,
|
||||||
autoStartServer: true,
|
autoStartServer: true,
|
||||||
autoOpenBrowser: true,
|
autoOpenBrowser: false,
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ export const SUBTITLE_DEFAULT_CONFIG: Pick<ResolvedConfig, 'subtitleStyle' | 'su
|
|||||||
enableJlpt: false,
|
enableJlpt: false,
|
||||||
preserveLineBreaks: false,
|
preserveLineBreaks: false,
|
||||||
autoPauseVideoOnHover: true,
|
autoPauseVideoOnHover: true,
|
||||||
autoPauseVideoOnYomitanPopup: false,
|
autoPauseVideoOnYomitanPopup: true,
|
||||||
hoverTokenColor: '#f4dbd6',
|
hoverTokenColor: '#f4dbd6',
|
||||||
hoverTokenBackgroundColor: 'rgba(54, 58, 79, 0.84)',
|
hoverTokenBackgroundColor: 'rgba(54, 58, 79, 0.84)',
|
||||||
nameMatchEnabled: true,
|
nameMatchEnabled: true,
|
||||||
@@ -58,7 +58,7 @@ export const SUBTITLE_DEFAULT_CONFIG: Pick<ResolvedConfig, 'subtitleStyle' | 'su
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
subtitleSidebar: {
|
subtitleSidebar: {
|
||||||
enabled: false,
|
enabled: true,
|
||||||
autoOpen: false,
|
autoOpen: false,
|
||||||
layout: 'overlay',
|
layout: 'overlay',
|
||||||
toggleKey: 'Backslash',
|
toggleKey: 'Backslash',
|
||||||
|
|||||||
@@ -28,6 +28,7 @@ test('config option registry includes critical paths and has unique entries', ()
|
|||||||
'ankiConnect.enabled',
|
'ankiConnect.enabled',
|
||||||
'anilist.characterDictionary.enabled',
|
'anilist.characterDictionary.enabled',
|
||||||
'anilist.characterDictionary.collapsibleSections.description',
|
'anilist.characterDictionary.collapsibleSections.description',
|
||||||
|
'mpv.executablePath',
|
||||||
'yomitan.externalProfilePath',
|
'yomitan.externalProfilePath',
|
||||||
'immersionTracking.enabled',
|
'immersionTracking.enabled',
|
||||||
]) {
|
]) {
|
||||||
@@ -48,6 +49,7 @@ test('config template sections include expected domains and unique keys', () =>
|
|||||||
'subtitleStyle',
|
'subtitleStyle',
|
||||||
'ankiConnect',
|
'ankiConnect',
|
||||||
'yomitan',
|
'yomitan',
|
||||||
|
'mpv',
|
||||||
'immersionTracking',
|
'immersionTracking',
|
||||||
];
|
];
|
||||||
|
|
||||||
|
|||||||
@@ -87,7 +87,8 @@ export function buildCoreConfigOptionRegistry(
|
|||||||
path: 'youtube.primarySubLanguages',
|
path: 'youtube.primarySubLanguages',
|
||||||
kind: 'string',
|
kind: 'string',
|
||||||
defaultValue: defaultConfig.youtube.primarySubLanguages.join(','),
|
defaultValue: defaultConfig.youtube.primarySubLanguages.join(','),
|
||||||
description: 'Comma-separated primary subtitle language priority for YouTube auto-loading.',
|
description:
|
||||||
|
'Comma-separated primary subtitle language priority for managed subtitle auto-selection.',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
path: 'controller.enabled',
|
path: 'controller.enabled',
|
||||||
|
|||||||
@@ -238,6 +238,13 @@ export function buildIntegrationConfigOptionRegistry(
|
|||||||
description:
|
description:
|
||||||
'Optional external Yomitan Electron profile path to use in read-only mode for shared dictionaries/settings. Example: ~/.config/gsm_overlay',
|
'Optional external Yomitan Electron profile path to use in read-only mode for shared dictionaries/settings. Example: ~/.config/gsm_overlay',
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
path: 'mpv.executablePath',
|
||||||
|
kind: 'string',
|
||||||
|
defaultValue: defaultConfig.mpv.executablePath,
|
||||||
|
description:
|
||||||
|
'Optional absolute path to mpv.exe for Windows launch flows. Leave empty to auto-discover from SUBMINER_MPV_PATH or PATH.',
|
||||||
|
},
|
||||||
{
|
{
|
||||||
path: 'jellyfin.enabled',
|
path: 'jellyfin.enabled',
|
||||||
kind: 'boolean',
|
kind: 'boolean',
|
||||||
|
|||||||
@@ -74,7 +74,7 @@ const CORE_TEMPLATE_SECTIONS: ConfigTemplateSection[] = [
|
|||||||
title: 'Secondary Subtitles',
|
title: 'Secondary Subtitles',
|
||||||
description: [
|
description: [
|
||||||
'Dual subtitle track options.',
|
'Dual subtitle track options.',
|
||||||
'Used by the YouTube subtitle loading flow as secondary language preferences.',
|
'Used by managed subtitle loading as secondary language preferences for local and YouTube playback.',
|
||||||
],
|
],
|
||||||
notes: ['Hot-reload: defaultMode updates live while SubMiner is running.'],
|
notes: ['Hot-reload: defaultMode updates live while SubMiner is running.'],
|
||||||
key: 'secondarySub',
|
key: 'secondarySub',
|
||||||
@@ -131,7 +131,9 @@ const INTEGRATION_TEMPLATE_SECTIONS: ConfigTemplateSection[] = [
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: 'YouTube Playback Settings',
|
title: 'YouTube Playback Settings',
|
||||||
description: ['Defaults for SubMiner YouTube subtitle loading and languages.'],
|
description: [
|
||||||
|
'Defaults for managed subtitle language preferences and YouTube subtitle loading.',
|
||||||
|
],
|
||||||
key: 'youtube',
|
key: 'youtube',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -153,6 +155,14 @@ const INTEGRATION_TEMPLATE_SECTIONS: ConfigTemplateSection[] = [
|
|||||||
],
|
],
|
||||||
key: 'yomitan',
|
key: 'yomitan',
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
title: 'MPV Launcher',
|
||||||
|
description: [
|
||||||
|
'Optional mpv.exe override for Windows playback entry points.',
|
||||||
|
'Leave mpv.executablePath blank to auto-discover mpv.exe from SUBMINER_MPV_PATH or PATH.',
|
||||||
|
],
|
||||||
|
key: 'mpv',
|
||||||
|
},
|
||||||
{
|
{
|
||||||
title: 'Jellyfin',
|
title: 'Jellyfin',
|
||||||
description: [
|
description: [
|
||||||
|
|||||||
31
src/config/resolve/integrations.test.ts
Normal file
31
src/config/resolve/integrations.test.ts
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
import assert from 'node:assert/strict';
|
||||||
|
import test from 'node:test';
|
||||||
|
import { resolveConfig } from '../resolve';
|
||||||
|
|
||||||
|
test('resolveConfig trims configured mpv executable path', () => {
|
||||||
|
const { resolved, warnings } = resolveConfig({
|
||||||
|
mpv: {
|
||||||
|
executablePath: ' C:\\Program Files\\mpv\\mpv.exe ',
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(resolved.mpv.executablePath, 'C:\\Program Files\\mpv\\mpv.exe');
|
||||||
|
assert.deepEqual(warnings, []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('resolveConfig warns for invalid mpv executable path type', () => {
|
||||||
|
const { resolved, warnings } = resolveConfig({
|
||||||
|
mpv: {
|
||||||
|
executablePath: 42 as never,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(resolved.mpv.executablePath, '');
|
||||||
|
assert.equal(warnings.length, 1);
|
||||||
|
assert.deepEqual(warnings[0], {
|
||||||
|
path: 'mpv.executablePath',
|
||||||
|
value: 42,
|
||||||
|
fallback: '',
|
||||||
|
message: 'Expected string.',
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -228,6 +228,22 @@ export function applyIntegrationConfig(context: ResolveContext): void {
|
|||||||
warn('yomitan', src.yomitan, resolved.yomitan, 'Expected object.');
|
warn('yomitan', src.yomitan, resolved.yomitan, 'Expected object.');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (isObject(src.mpv)) {
|
||||||
|
const executablePath = asString(src.mpv.executablePath);
|
||||||
|
if (executablePath !== undefined) {
|
||||||
|
resolved.mpv.executablePath = executablePath.trim();
|
||||||
|
} else if (src.mpv.executablePath !== undefined) {
|
||||||
|
warn(
|
||||||
|
'mpv.executablePath',
|
||||||
|
src.mpv.executablePath,
|
||||||
|
resolved.mpv.executablePath,
|
||||||
|
'Expected string.',
|
||||||
|
);
|
||||||
|
}
|
||||||
|
} else if (src.mpv !== undefined) {
|
||||||
|
warn('mpv', src.mpv, resolved.mpv, 'Expected object.');
|
||||||
|
}
|
||||||
|
|
||||||
if (isObject(src.jellyfin)) {
|
if (isObject(src.jellyfin)) {
|
||||||
const enabled = asBoolean(src.jellyfin.enabled);
|
const enabled = asBoolean(src.jellyfin.enabled);
|
||||||
if (enabled !== undefined) {
|
if (enabled !== undefined) {
|
||||||
|
|||||||
@@ -55,7 +55,7 @@ test('discordPresence invalid values warn and keep defaults', () => {
|
|||||||
|
|
||||||
applyIntegrationConfig(context);
|
applyIntegrationConfig(context);
|
||||||
|
|
||||||
assert.equal(context.resolved.discordPresence.enabled, false);
|
assert.equal(context.resolved.discordPresence.enabled, true);
|
||||||
assert.equal(context.resolved.discordPresence.updateIntervalMs, 3_000);
|
assert.equal(context.resolved.discordPresence.updateIntervalMs, 3_000);
|
||||||
assert.equal(context.resolved.discordPresence.debounceMs, 750);
|
assert.equal(context.resolved.discordPresence.debounceMs, 750);
|
||||||
|
|
||||||
|
|||||||
@@ -71,7 +71,7 @@ test('subtitleSidebar falls back and warns on invalid values', () => {
|
|||||||
|
|
||||||
applySubtitleDomainConfig(context);
|
applySubtitleDomainConfig(context);
|
||||||
|
|
||||||
assert.equal(context.resolved.subtitleSidebar.enabled, false);
|
assert.equal(context.resolved.subtitleSidebar.enabled, true);
|
||||||
assert.equal(context.resolved.subtitleSidebar.autoOpen, false);
|
assert.equal(context.resolved.subtitleSidebar.autoOpen, false);
|
||||||
assert.equal(context.resolved.subtitleSidebar.layout, 'overlay');
|
assert.equal(context.resolved.subtitleSidebar.layout, 'overlay');
|
||||||
assert.equal(context.resolved.subtitleSidebar.maxWidth, 420);
|
assert.equal(context.resolved.subtitleSidebar.maxWidth, 420);
|
||||||
|
|||||||
@@ -56,7 +56,7 @@ test('subtitleStyle autoPauseVideoOnYomitanPopup falls back on invalid value', (
|
|||||||
|
|
||||||
applySubtitleDomainConfig(context);
|
applySubtitleDomainConfig(context);
|
||||||
|
|
||||||
assert.equal(context.resolved.subtitleStyle.autoPauseVideoOnYomitanPopup, false);
|
assert.equal(context.resolved.subtitleStyle.autoPauseVideoOnYomitanPopup, true);
|
||||||
assert.ok(
|
assert.ok(
|
||||||
warnings.some(
|
warnings.some(
|
||||||
(warning) =>
|
(warning) =>
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
import { describe, it } from 'node:test';
|
import { describe, it } from 'node:test';
|
||||||
import assert from 'node:assert/strict';
|
import assert from 'node:assert/strict';
|
||||||
import fs from 'node:fs';
|
import fs from 'node:fs';
|
||||||
|
import http from 'node:http';
|
||||||
import os from 'node:os';
|
import os from 'node:os';
|
||||||
import path from 'node:path';
|
import path from 'node:path';
|
||||||
import { createStatsApp, startStatsServer } from '../stats-server.js';
|
import { createStatsApp, startStatsServer } from '../stats-server.js';
|
||||||
@@ -1172,7 +1173,23 @@ describe('stats server API routes', () => {
|
|||||||
|
|
||||||
const bun = globalThis as typeof globalThis & BunRuntime;
|
const bun = globalThis as typeof globalThis & BunRuntime;
|
||||||
const originalServe = bun.Bun.serve;
|
const originalServe = bun.Bun.serve;
|
||||||
|
const originalCreateServer = http.createServer;
|
||||||
|
let listenedWith: { port: number; hostname: string } | null = null;
|
||||||
|
let closeCalls = 0;
|
||||||
bun.Bun.serve = undefined;
|
bun.Bun.serve = undefined;
|
||||||
|
(
|
||||||
|
http as typeof http & {
|
||||||
|
createServer: typeof http.createServer;
|
||||||
|
}
|
||||||
|
).createServer = (() =>
|
||||||
|
({
|
||||||
|
listen: (port: number, hostname: string) => {
|
||||||
|
listenedWith = { port, hostname };
|
||||||
|
},
|
||||||
|
close: () => {
|
||||||
|
closeCalls += 1;
|
||||||
|
},
|
||||||
|
}) as unknown as ReturnType<typeof http.createServer>) as typeof http.createServer;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const server = startStatsServer({
|
const server = startStatsServer({
|
||||||
@@ -1181,9 +1198,16 @@ describe('stats server API routes', () => {
|
|||||||
tracker: createMockTracker(),
|
tracker: createMockTracker(),
|
||||||
});
|
});
|
||||||
|
|
||||||
|
assert.deepEqual(listenedWith, { port: 0, hostname: '127.0.0.1' });
|
||||||
server.close();
|
server.close();
|
||||||
|
assert.equal(closeCalls, 1);
|
||||||
} finally {
|
} finally {
|
||||||
bun.Bun.serve = originalServe;
|
bun.Bun.serve = originalServe;
|
||||||
|
(
|
||||||
|
http as typeof http & {
|
||||||
|
createServer: typeof http.createServer;
|
||||||
|
}
|
||||||
|
).createServer = originalCreateServer;
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -83,7 +83,9 @@ const PRESENCE_STYLES: Record<DiscordPresenceStylePreset, PresenceStyleDefinitio
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
function resolvePresenceStyle(preset: DiscordPresenceStylePreset | undefined): PresenceStyleDefinition {
|
function resolvePresenceStyle(
|
||||||
|
preset: DiscordPresenceStylePreset | undefined,
|
||||||
|
): PresenceStyleDefinition {
|
||||||
return PRESENCE_STYLES[preset ?? 'default'] ?? PRESENCE_STYLES.default;
|
return PRESENCE_STYLES[preset ?? 'default'] ?? PRESENCE_STYLES.default;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -130,9 +132,7 @@ export function buildDiscordPresenceActivity(
|
|||||||
const status = buildStatus(snapshot);
|
const status = buildStatus(snapshot);
|
||||||
const title = sanitizeText(snapshot.mediaTitle, basename(snapshot.mediaPath) || 'Unknown media');
|
const title = sanitizeText(snapshot.mediaTitle, basename(snapshot.mediaPath) || 'Unknown media');
|
||||||
const details =
|
const details =
|
||||||
snapshot.connected && snapshot.mediaPath
|
snapshot.connected && snapshot.mediaPath ? trimField(title) : style.fallbackDetails;
|
||||||
? trimField(title)
|
|
||||||
: style.fallbackDetails;
|
|
||||||
const timeline = `${formatClock(snapshot.currentTimeSec)} / ${formatClock(snapshot.mediaDurationSec)}`;
|
const timeline = `${formatClock(snapshot.currentTimeSec)} / ${formatClock(snapshot.mediaDurationSec)}`;
|
||||||
const state =
|
const state =
|
||||||
snapshot.connected && snapshot.mediaPath
|
snapshot.connected && snapshot.mediaPath
|
||||||
@@ -157,10 +157,7 @@ export function buildDiscordPresenceActivity(
|
|||||||
if (style.smallImageText.trim().length > 0) {
|
if (style.smallImageText.trim().length > 0) {
|
||||||
activity.smallImageText = trimField(style.smallImageText.trim());
|
activity.smallImageText = trimField(style.smallImageText.trim());
|
||||||
}
|
}
|
||||||
if (
|
if (style.buttonLabel.trim().length > 0 && /^https?:\/\//.test(style.buttonUrl.trim())) {
|
||||||
style.buttonLabel.trim().length > 0 &&
|
|
||||||
/^https?:\/\//.test(style.buttonUrl.trim())
|
|
||||||
) {
|
|
||||||
activity.buttons = [
|
activity.buttons = [
|
||||||
{
|
{
|
||||||
label: trimField(style.buttonLabel.trim(), 32),
|
label: trimField(style.buttonLabel.trim(), 32),
|
||||||
|
|||||||
@@ -380,42 +380,22 @@ export class ImmersionTrackerService {
|
|||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
const eventsRetention = daysToRetentionWindow(
|
const eventsRetention = daysToRetentionWindow(retention.eventsDays, 7, 3650);
|
||||||
retention.eventsDays,
|
const telemetryRetention = daysToRetentionWindow(retention.telemetryDays, 30, 3650);
|
||||||
7,
|
const sessionsRetention = daysToRetentionWindow(retention.sessionsDays, 30, 3650);
|
||||||
3650,
|
|
||||||
);
|
|
||||||
const telemetryRetention = daysToRetentionWindow(
|
|
||||||
retention.telemetryDays,
|
|
||||||
30,
|
|
||||||
3650,
|
|
||||||
);
|
|
||||||
const sessionsRetention = daysToRetentionWindow(
|
|
||||||
retention.sessionsDays,
|
|
||||||
30,
|
|
||||||
3650,
|
|
||||||
);
|
|
||||||
this.eventsRetentionMs = eventsRetention.ms;
|
this.eventsRetentionMs = eventsRetention.ms;
|
||||||
this.eventsRetentionDays = eventsRetention.days;
|
this.eventsRetentionDays = eventsRetention.days;
|
||||||
this.telemetryRetentionMs = telemetryRetention.ms;
|
this.telemetryRetentionMs = telemetryRetention.ms;
|
||||||
this.telemetryRetentionDays = telemetryRetention.days;
|
this.telemetryRetentionDays = telemetryRetention.days;
|
||||||
this.sessionsRetentionMs = sessionsRetention.ms;
|
this.sessionsRetentionMs = sessionsRetention.ms;
|
||||||
this.sessionsRetentionDays = sessionsRetention.days;
|
this.sessionsRetentionDays = sessionsRetention.days;
|
||||||
this.dailyRollupRetentionMs = daysToRetentionWindow(
|
this.dailyRollupRetentionMs = daysToRetentionWindow(retention.dailyRollupsDays, 365, 36500).ms;
|
||||||
retention.dailyRollupsDays,
|
|
||||||
365,
|
|
||||||
36500,
|
|
||||||
).ms;
|
|
||||||
this.monthlyRollupRetentionMs = daysToRetentionWindow(
|
this.monthlyRollupRetentionMs = daysToRetentionWindow(
|
||||||
retention.monthlyRollupsDays,
|
retention.monthlyRollupsDays,
|
||||||
5 * 365,
|
5 * 365,
|
||||||
36500,
|
36500,
|
||||||
).ms;
|
).ms;
|
||||||
this.vacuumIntervalMs = daysToRetentionWindow(
|
this.vacuumIntervalMs = daysToRetentionWindow(retention.vacuumIntervalDays, 7, 3650).ms;
|
||||||
retention.vacuumIntervalDays,
|
|
||||||
7,
|
|
||||||
3650,
|
|
||||||
).ms;
|
|
||||||
this.db = new Database(this.dbPath);
|
this.db = new Database(this.dbPath);
|
||||||
applyPragmas(this.db);
|
applyPragmas(this.db);
|
||||||
ensureSchema(this.db);
|
ensureSchema(this.db);
|
||||||
|
|||||||
@@ -975,79 +975,79 @@ test('getTrendsDashboard month grouping spans every touched calendar month and k
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
const insertDailyRollup = db.prepare(
|
const insertDailyRollup = db.prepare(
|
||||||
`
|
`
|
||||||
INSERT INTO imm_daily_rollups (
|
INSERT INTO imm_daily_rollups (
|
||||||
rollup_day, video_id, total_sessions, total_active_min, total_lines_seen,
|
rollup_day, video_id, total_sessions, total_active_min, total_lines_seen,
|
||||||
total_tokens_seen, total_cards, CREATED_DATE, LAST_UPDATE_DATE
|
total_tokens_seen, total_cards, CREATED_DATE, LAST_UPDATE_DATE
|
||||||
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)
|
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)
|
||||||
`,
|
`,
|
||||||
);
|
);
|
||||||
const insertMonthlyRollup = db.prepare(
|
const insertMonthlyRollup = db.prepare(
|
||||||
`
|
`
|
||||||
INSERT INTO imm_monthly_rollups (
|
INSERT INTO imm_monthly_rollups (
|
||||||
rollup_month, video_id, total_sessions, total_active_min, total_lines_seen,
|
rollup_month, video_id, total_sessions, total_active_min, total_lines_seen,
|
||||||
total_tokens_seen, total_cards, CREATED_DATE, LAST_UPDATE_DATE
|
total_tokens_seen, total_cards, CREATED_DATE, LAST_UPDATE_DATE
|
||||||
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)
|
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)
|
||||||
`,
|
`,
|
||||||
);
|
);
|
||||||
insertDailyRollup.run(20500, febVideoId, 1, 30, 4, 100, 2, febStartedAtMs, febStartedAtMs);
|
insertDailyRollup.run(20500, febVideoId, 1, 30, 4, 100, 2, febStartedAtMs, febStartedAtMs);
|
||||||
insertDailyRollup.run(20513, marVideoId, 1, 30, 4, 120, 4, marStartedAtMs, marStartedAtMs);
|
insertDailyRollup.run(20513, marVideoId, 1, 30, 4, 120, 4, marStartedAtMs, marStartedAtMs);
|
||||||
insertMonthlyRollup.run(202602, febVideoId, 1, 30, 4, 100, 2, febStartedAtMs, febStartedAtMs);
|
insertMonthlyRollup.run(202602, febVideoId, 1, 30, 4, 100, 2, febStartedAtMs, febStartedAtMs);
|
||||||
insertMonthlyRollup.run(202603, marVideoId, 1, 30, 4, 120, 4, marStartedAtMs, marStartedAtMs);
|
insertMonthlyRollup.run(202603, marVideoId, 1, 30, 4, 120, 4, marStartedAtMs, marStartedAtMs);
|
||||||
|
|
||||||
db.prepare(
|
db.prepare(
|
||||||
`
|
`
|
||||||
INSERT INTO imm_words (
|
INSERT INTO imm_words (
|
||||||
headword, word, reading, part_of_speech, pos1, pos2, pos3, first_seen, last_seen, frequency
|
headword, word, reading, part_of_speech, pos1, pos2, pos3, first_seen, last_seen, frequency
|
||||||
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
|
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
|
||||||
`,
|
`,
|
||||||
).run(
|
).run(
|
||||||
'二月',
|
'二月',
|
||||||
'二月',
|
'二月',
|
||||||
'にがつ',
|
'にがつ',
|
||||||
'noun',
|
'noun',
|
||||||
'名詞',
|
'名詞',
|
||||||
'',
|
'',
|
||||||
'',
|
'',
|
||||||
(BigInt(febStartedAtMs) / 1000n).toString(),
|
(BigInt(febStartedAtMs) / 1000n).toString(),
|
||||||
(BigInt(febStartedAtMs) / 1000n).toString(),
|
(BigInt(febStartedAtMs) / 1000n).toString(),
|
||||||
1,
|
1,
|
||||||
);
|
);
|
||||||
db.prepare(
|
db.prepare(
|
||||||
`
|
`
|
||||||
INSERT INTO imm_words (
|
INSERT INTO imm_words (
|
||||||
headword, word, reading, part_of_speech, pos1, pos2, pos3, first_seen, last_seen, frequency
|
headword, word, reading, part_of_speech, pos1, pos2, pos3, first_seen, last_seen, frequency
|
||||||
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
|
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
|
||||||
`,
|
`,
|
||||||
).run(
|
).run(
|
||||||
'三月',
|
'三月',
|
||||||
'三月',
|
'三月',
|
||||||
'さんがつ',
|
'さんがつ',
|
||||||
'noun',
|
'noun',
|
||||||
'名詞',
|
'名詞',
|
||||||
'',
|
'',
|
||||||
'',
|
'',
|
||||||
(BigInt(marStartedAtMs) / 1000n).toString(),
|
(BigInt(marStartedAtMs) / 1000n).toString(),
|
||||||
(BigInt(marStartedAtMs) / 1000n).toString(),
|
(BigInt(marStartedAtMs) / 1000n).toString(),
|
||||||
1,
|
1,
|
||||||
);
|
);
|
||||||
|
|
||||||
const dashboard = getTrendsDashboard(db, '30d', 'month');
|
const dashboard = getTrendsDashboard(db, '30d', 'month');
|
||||||
|
|
||||||
assert.equal(dashboard.activity.watchTime.length, 2);
|
assert.equal(dashboard.activity.watchTime.length, 2);
|
||||||
assert.deepEqual(
|
assert.deepEqual(
|
||||||
dashboard.progress.newWords.map((point) => point.label),
|
dashboard.progress.newWords.map((point) => point.label),
|
||||||
dashboard.activity.watchTime.map((point) => point.label),
|
dashboard.activity.watchTime.map((point) => point.label),
|
||||||
);
|
);
|
||||||
assert.deepEqual(
|
assert.deepEqual(
|
||||||
dashboard.progress.episodes.map((point) => point.label),
|
dashboard.progress.episodes.map((point) => point.label),
|
||||||
dashboard.activity.watchTime.map((point) => point.label),
|
dashboard.activity.watchTime.map((point) => point.label),
|
||||||
);
|
);
|
||||||
assert.deepEqual(
|
assert.deepEqual(
|
||||||
dashboard.progress.lookups.map((point) => point.label),
|
dashboard.progress.lookups.map((point) => point.label),
|
||||||
dashboard.activity.watchTime.map((point) => point.label),
|
dashboard.activity.watchTime.map((point) => point.label),
|
||||||
);
|
);
|
||||||
} finally {
|
} finally {
|
||||||
db.close();
|
db.close();
|
||||||
cleanupDbPath(dbPath);
|
cleanupDbPath(dbPath);
|
||||||
@@ -1230,18 +1230,7 @@ test('getQueryHints counts new words by distinct headword first-seen time', () =
|
|||||||
headword, word, reading, part_of_speech, pos1, pos2, pos3, first_seen, last_seen, frequency
|
headword, word, reading, part_of_speech, pos1, pos2, pos3, first_seen, last_seen, frequency
|
||||||
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
|
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
|
||||||
`,
|
`,
|
||||||
).run(
|
).run('猫', '猫', 'ねこ', 'noun', '名詞', '', '', String(twoDaysAgo), String(twoDaysAgo), 1);
|
||||||
'猫',
|
|
||||||
'猫',
|
|
||||||
'ねこ',
|
|
||||||
'noun',
|
|
||||||
'名詞',
|
|
||||||
'',
|
|
||||||
'',
|
|
||||||
String(twoDaysAgo),
|
|
||||||
String(twoDaysAgo),
|
|
||||||
1,
|
|
||||||
);
|
|
||||||
|
|
||||||
const hints = getQueryHints(db);
|
const hints = getQueryHints(db);
|
||||||
assert.equal(hints.newWordsToday, 1);
|
assert.equal(hints.newWordsToday, 1);
|
||||||
|
|||||||
@@ -82,12 +82,9 @@ function hasRetainedPriorSession(
|
|||||||
LIMIT 1
|
LIMIT 1
|
||||||
`,
|
`,
|
||||||
)
|
)
|
||||||
.get(
|
.get(videoId, toDbTimestamp(startedAtMs), toDbTimestamp(startedAtMs), currentSessionId) as {
|
||||||
videoId,
|
found: number;
|
||||||
toDbTimestamp(startedAtMs),
|
} | null;
|
||||||
toDbTimestamp(startedAtMs),
|
|
||||||
currentSessionId,
|
|
||||||
) as { found: number } | null;
|
|
||||||
return Boolean(row);
|
return Boolean(row);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -150,7 +147,7 @@ function resetLifetimeSummaries(db: DatabaseSync, nowMs: number): void {
|
|||||||
LAST_UPDATE_DATE = ?
|
LAST_UPDATE_DATE = ?
|
||||||
WHERE global_id = 1
|
WHERE global_id = 1
|
||||||
`,
|
`,
|
||||||
).run(toDbTimestamp(nowMs), toDbTimestamp(nowMs));
|
).run(toDbTimestamp(nowMs), toDbTimestamp(nowMs));
|
||||||
}
|
}
|
||||||
|
|
||||||
function rebuildLifetimeSummariesInternal(
|
function rebuildLifetimeSummariesInternal(
|
||||||
|
|||||||
@@ -126,9 +126,9 @@ test('pruneRawRetention skips disabled retention windows', () => {
|
|||||||
const remainingTelemetry = db
|
const remainingTelemetry = db
|
||||||
.prepare('SELECT COUNT(*) AS count FROM imm_session_telemetry')
|
.prepare('SELECT COUNT(*) AS count FROM imm_session_telemetry')
|
||||||
.get() as { count: number };
|
.get() as { count: number };
|
||||||
const remainingSessions = db
|
const remainingSessions = db.prepare('SELECT COUNT(*) AS count FROM imm_sessions').get() as {
|
||||||
.prepare('SELECT COUNT(*) AS count FROM imm_sessions')
|
count: number;
|
||||||
.get() as { count: number };
|
};
|
||||||
|
|
||||||
assert.equal(result.deletedSessionEvents, 0);
|
assert.equal(result.deletedSessionEvents, 0);
|
||||||
assert.equal(result.deletedTelemetryRows, 0);
|
assert.equal(result.deletedTelemetryRows, 0);
|
||||||
|
|||||||
@@ -56,10 +56,7 @@ export function pruneRawRetention(
|
|||||||
sessionsRetentionDays?: number;
|
sessionsRetentionDays?: number;
|
||||||
},
|
},
|
||||||
): RawRetentionResult {
|
): RawRetentionResult {
|
||||||
const resolveCutoff = (
|
const resolveCutoff = (retentionMs: number, retentionDays: number | undefined): string => {
|
||||||
retentionMs: number,
|
|
||||||
retentionDays: number | undefined,
|
|
||||||
): string => {
|
|
||||||
if (retentionDays !== undefined) {
|
if (retentionDays !== undefined) {
|
||||||
return subtractDbTimestamp(currentMs, BigInt(retentionDays) * 86_400_000n);
|
return subtractDbTimestamp(currentMs, BigInt(retentionDays) * 86_400_000n);
|
||||||
}
|
}
|
||||||
@@ -68,9 +65,11 @@ export function pruneRawRetention(
|
|||||||
|
|
||||||
const deletedSessionEvents = Number.isFinite(policy.eventsRetentionMs)
|
const deletedSessionEvents = Number.isFinite(policy.eventsRetentionMs)
|
||||||
? (
|
? (
|
||||||
db.prepare(`DELETE FROM imm_session_events WHERE ts_ms < ?`).run(
|
db
|
||||||
resolveCutoff(policy.eventsRetentionMs, policy.eventsRetentionDays),
|
.prepare(`DELETE FROM imm_session_events WHERE ts_ms < ?`)
|
||||||
) as { changes: number }
|
.run(resolveCutoff(policy.eventsRetentionMs, policy.eventsRetentionDays)) as {
|
||||||
|
changes: number;
|
||||||
|
}
|
||||||
).changes
|
).changes
|
||||||
: 0;
|
: 0;
|
||||||
const deletedTelemetryRows = Number.isFinite(policy.telemetryRetentionMs)
|
const deletedTelemetryRows = Number.isFinite(policy.telemetryRetentionMs)
|
||||||
|
|||||||
@@ -150,9 +150,11 @@ export function getSessionEvents(
|
|||||||
ORDER BY ts_ms ASC
|
ORDER BY ts_ms ASC
|
||||||
LIMIT ?
|
LIMIT ?
|
||||||
`);
|
`);
|
||||||
const rows = stmt.all(sessionId, ...eventTypes, limit) as Array<SessionEventRow & {
|
const rows = stmt.all(sessionId, ...eventTypes, limit) as Array<
|
||||||
tsMs: number | string;
|
SessionEventRow & {
|
||||||
}>;
|
tsMs: number | string;
|
||||||
|
}
|
||||||
|
>;
|
||||||
return rows.map((row) => ({
|
return rows.map((row) => ({
|
||||||
...row,
|
...row,
|
||||||
tsMs: fromDbTimestamp(row.tsMs) ?? 0,
|
tsMs: fromDbTimestamp(row.tsMs) ?? 0,
|
||||||
|
|||||||
@@ -355,9 +355,7 @@ export function upsertCoverArt(
|
|||||||
const fetchedAtMs = toDbTimestamp(nowMs());
|
const fetchedAtMs = toDbTimestamp(nowMs());
|
||||||
const coverBlob = normalizeCoverBlobBytes(art.coverBlob);
|
const coverBlob = normalizeCoverBlobBytes(art.coverBlob);
|
||||||
const computedCoverBlobHash =
|
const computedCoverBlobHash =
|
||||||
coverBlob && coverBlob.length > 0
|
coverBlob && coverBlob.length > 0 ? createHash('sha256').update(coverBlob).digest('hex') : null;
|
||||||
? createHash('sha256').update(coverBlob).digest('hex')
|
|
||||||
: null;
|
|
||||||
let coverBlobHash = computedCoverBlobHash ?? sharedCoverBlobHash ?? null;
|
let coverBlobHash = computedCoverBlobHash ?? sharedCoverBlobHash ?? null;
|
||||||
if (!coverBlobHash && (!coverBlob || coverBlob.length === 0)) {
|
if (!coverBlobHash && (!coverBlob || coverBlob.length === 0)) {
|
||||||
coverBlobHash = existing?.coverBlobHash ?? null;
|
coverBlobHash = existing?.coverBlobHash ?? null;
|
||||||
|
|||||||
@@ -39,10 +39,12 @@ export function getSessionSummaries(db: DatabaseSync, limit = 50): SessionSummar
|
|||||||
ORDER BY s.started_at_ms DESC
|
ORDER BY s.started_at_ms DESC
|
||||||
LIMIT ?
|
LIMIT ?
|
||||||
`);
|
`);
|
||||||
const rows = prepared.all(limit) as Array<SessionSummaryQueryRow & {
|
const rows = prepared.all(limit) as Array<
|
||||||
startedAtMs: number | string;
|
SessionSummaryQueryRow & {
|
||||||
endedAtMs: number | string | null;
|
startedAtMs: number | string;
|
||||||
}>;
|
endedAtMs: number | string | null;
|
||||||
|
}
|
||||||
|
>;
|
||||||
return rows.map((row) => ({
|
return rows.map((row) => ({
|
||||||
...row,
|
...row,
|
||||||
startedAtMs: fromDbTimestamp(row.startedAtMs) ?? 0,
|
startedAtMs: fromDbTimestamp(row.startedAtMs) ?? 0,
|
||||||
@@ -69,19 +71,21 @@ export function getSessionTimeline(
|
|||||||
`;
|
`;
|
||||||
|
|
||||||
if (limit === undefined) {
|
if (limit === undefined) {
|
||||||
const rows = db.prepare(select).all(sessionId) as Array<SessionTimelineRow & {
|
const rows = db.prepare(select).all(sessionId) as Array<
|
||||||
sampleMs: number | string;
|
SessionTimelineRow & {
|
||||||
}>;
|
sampleMs: number | string;
|
||||||
|
}
|
||||||
|
>;
|
||||||
return rows.map((row) => ({
|
return rows.map((row) => ({
|
||||||
...row,
|
...row,
|
||||||
sampleMs: fromDbTimestamp(row.sampleMs) ?? 0,
|
sampleMs: fromDbTimestamp(row.sampleMs) ?? 0,
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
const rows = db
|
const rows = db.prepare(`${select}\n LIMIT ?`).all(sessionId, limit) as Array<
|
||||||
.prepare(`${select}\n LIMIT ?`)
|
SessionTimelineRow & {
|
||||||
.all(sessionId, limit) as Array<SessionTimelineRow & {
|
sampleMs: number | string;
|
||||||
sampleMs: number | string;
|
}
|
||||||
}>;
|
>;
|
||||||
return rows.map((row) => ({
|
return rows.map((row) => ({
|
||||||
...row,
|
...row,
|
||||||
sampleMs: fromDbTimestamp(row.sampleMs) ?? 0,
|
sampleMs: fromDbTimestamp(row.sampleMs) ?? 0,
|
||||||
|
|||||||
@@ -359,10 +359,7 @@ function getNumericCalendarValue(
|
|||||||
return Number(row?.value ?? 0);
|
return Number(row?.value ?? 0);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getLocalEpochDay(
|
export function getLocalEpochDay(db: DatabaseSync, timestampMs: number | bigint | string): number {
|
||||||
db: DatabaseSync,
|
|
||||||
timestampMs: number | bigint | string,
|
|
||||||
): number {
|
|
||||||
return getNumericCalendarValue(
|
return getNumericCalendarValue(
|
||||||
db,
|
db,
|
||||||
`
|
`
|
||||||
@@ -375,10 +372,7 @@ export function getLocalEpochDay(
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getLocalMonthKey(
|
export function getLocalMonthKey(db: DatabaseSync, timestampMs: number | bigint | string): number {
|
||||||
db: DatabaseSync,
|
|
||||||
timestampMs: number | bigint | string,
|
|
||||||
): number {
|
|
||||||
return getNumericCalendarValue(
|
return getNumericCalendarValue(
|
||||||
db,
|
db,
|
||||||
`
|
`
|
||||||
@@ -391,10 +385,7 @@ export function getLocalMonthKey(
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getLocalDayOfWeek(
|
export function getLocalDayOfWeek(db: DatabaseSync, timestampMs: number | bigint | string): number {
|
||||||
db: DatabaseSync,
|
|
||||||
timestampMs: number | bigint | string,
|
|
||||||
): number {
|
|
||||||
return getNumericCalendarValue(
|
return getNumericCalendarValue(
|
||||||
db,
|
db,
|
||||||
`
|
`
|
||||||
@@ -407,10 +398,7 @@ export function getLocalDayOfWeek(
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getLocalHourOfDay(
|
export function getLocalHourOfDay(db: DatabaseSync, timestampMs: number | bigint | string): number {
|
||||||
db: DatabaseSync,
|
|
||||||
timestampMs: number | bigint | string,
|
|
||||||
): number {
|
|
||||||
return getNumericCalendarValue(
|
return getNumericCalendarValue(
|
||||||
db,
|
db,
|
||||||
`
|
`
|
||||||
@@ -458,7 +446,8 @@ export function getShiftedLocalDayTimestamp(
|
|||||||
dayOffset: number,
|
dayOffset: number,
|
||||||
): string {
|
): string {
|
||||||
const normalizedDayOffset = Math.trunc(dayOffset);
|
const normalizedDayOffset = Math.trunc(dayOffset);
|
||||||
const modifier = normalizedDayOffset >= 0 ? `+${normalizedDayOffset} days` : `${normalizedDayOffset} days`;
|
const modifier =
|
||||||
|
normalizedDayOffset >= 0 ? `+${normalizedDayOffset} days` : `${normalizedDayOffset} days`;
|
||||||
const row = db
|
const row = db
|
||||||
.prepare(
|
.prepare(
|
||||||
`
|
`
|
||||||
|
|||||||
@@ -87,7 +87,20 @@ const TREND_DAY_LIMITS: Record<Exclude<TrendRange, 'all'>, number> = {
|
|||||||
'90d': 90,
|
'90d': 90,
|
||||||
};
|
};
|
||||||
|
|
||||||
const MONTH_NAMES = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
|
const MONTH_NAMES = [
|
||||||
|
'Jan',
|
||||||
|
'Feb',
|
||||||
|
'Mar',
|
||||||
|
'Apr',
|
||||||
|
'May',
|
||||||
|
'Jun',
|
||||||
|
'Jul',
|
||||||
|
'Aug',
|
||||||
|
'Sep',
|
||||||
|
'Oct',
|
||||||
|
'Nov',
|
||||||
|
'Dec',
|
||||||
|
];
|
||||||
|
|
||||||
const DAY_NAMES = ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'];
|
const DAY_NAMES = ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'];
|
||||||
|
|
||||||
@@ -101,7 +114,11 @@ function getTrendMonthlyLimit(db: DatabaseSync, range: TrendRange): number {
|
|||||||
}
|
}
|
||||||
const currentTimestamp = currentDbTimestamp();
|
const currentTimestamp = currentDbTimestamp();
|
||||||
const todayStartMs = getShiftedLocalDayTimestamp(db, currentTimestamp, 0);
|
const todayStartMs = getShiftedLocalDayTimestamp(db, currentTimestamp, 0);
|
||||||
const cutoffMs = getShiftedLocalDayTimestamp(db, currentTimestamp, -(TREND_DAY_LIMITS[range] - 1));
|
const cutoffMs = getShiftedLocalDayTimestamp(
|
||||||
|
db,
|
||||||
|
currentTimestamp,
|
||||||
|
-(TREND_DAY_LIMITS[range] - 1),
|
||||||
|
);
|
||||||
const currentMonthKey = getLocalMonthKey(db, todayStartMs);
|
const currentMonthKey = getLocalMonthKey(db, todayStartMs);
|
||||||
const cutoffMonthKey = getLocalMonthKey(db, cutoffMs);
|
const cutoffMonthKey = getLocalMonthKey(db, cutoffMs);
|
||||||
const currentYear = Math.floor(currentMonthKey / 100);
|
const currentYear = Math.floor(currentMonthKey / 100);
|
||||||
@@ -630,8 +647,10 @@ export function getTrendsDashboard(
|
|||||||
|
|
||||||
const animePerDay = {
|
const animePerDay = {
|
||||||
episodes: buildEpisodesPerAnimeFromDailyRollups(dailyRollups, titlesByVideoId),
|
episodes: buildEpisodesPerAnimeFromDailyRollups(dailyRollups, titlesByVideoId),
|
||||||
watchTime: buildPerAnimeFromDailyRollups(dailyRollups, titlesByVideoId, (rollup) =>
|
watchTime: buildPerAnimeFromDailyRollups(
|
||||||
rollup.totalActiveMin,
|
dailyRollups,
|
||||||
|
titlesByVideoId,
|
||||||
|
(rollup) => rollup.totalActiveMin,
|
||||||
),
|
),
|
||||||
cards: buildPerAnimeFromDailyRollups(
|
cards: buildPerAnimeFromDailyRollups(
|
||||||
dailyRollups,
|
dailyRollups,
|
||||||
|
|||||||
@@ -184,6 +184,39 @@ test('dispatchMpvProtocolMessage sets secondary subtitle track based on track li
|
|||||||
assert.deepEqual(state.commands, [{ command: ['set_property', 'secondary-sid', 2] }]);
|
assert.deepEqual(state.commands, [{ command: ['set_property', 'secondary-sid', 2] }]);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('dispatchMpvProtocolMessage prefers the already selected matching secondary track', async () => {
|
||||||
|
const { deps, state } = createDeps();
|
||||||
|
|
||||||
|
await dispatchMpvProtocolMessage(
|
||||||
|
{
|
||||||
|
request_id: MPV_REQUEST_ID_TRACK_LIST_SECONDARY,
|
||||||
|
data: [
|
||||||
|
{
|
||||||
|
type: 'sub',
|
||||||
|
id: 2,
|
||||||
|
lang: 'ja',
|
||||||
|
title: 'ja.srt',
|
||||||
|
selected: false,
|
||||||
|
external: true,
|
||||||
|
'external-filename': '/tmp/dupe.srt',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'sub',
|
||||||
|
id: 3,
|
||||||
|
lang: 'ja',
|
||||||
|
title: 'ja.srt',
|
||||||
|
selected: true,
|
||||||
|
external: true,
|
||||||
|
'external-filename': '/tmp/dupe.srt',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
deps,
|
||||||
|
);
|
||||||
|
|
||||||
|
assert.deepEqual(state.commands, [{ command: ['set_property', 'secondary-sid', 3] }]);
|
||||||
|
});
|
||||||
|
|
||||||
test('dispatchMpvProtocolMessage restores secondary visibility on shutdown', async () => {
|
test('dispatchMpvProtocolMessage restores secondary visibility on shutdown', async () => {
|
||||||
const { deps, state } = createDeps();
|
const { deps, state } = createDeps();
|
||||||
|
|
||||||
|
|||||||
@@ -93,6 +93,101 @@ export interface MpvProtocolHandleMessageDeps {
|
|||||||
restorePreviousSecondarySubVisibility: () => void;
|
restorePreviousSecondarySubVisibility: () => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type SubtitleTrackCandidate = {
|
||||||
|
id: number;
|
||||||
|
lang: string;
|
||||||
|
title: string;
|
||||||
|
selected: boolean;
|
||||||
|
external: boolean;
|
||||||
|
externalFilename: string | null;
|
||||||
|
};
|
||||||
|
|
||||||
|
function normalizeSubtitleTrackCandidate(
|
||||||
|
track: Record<string, unknown>,
|
||||||
|
): SubtitleTrackCandidate | null {
|
||||||
|
const id =
|
||||||
|
typeof track.id === 'number'
|
||||||
|
? track.id
|
||||||
|
: typeof track.id === 'string'
|
||||||
|
? Number(track.id.trim())
|
||||||
|
: Number.NaN;
|
||||||
|
if (!Number.isInteger(id)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const externalFilename =
|
||||||
|
typeof track['external-filename'] === 'string' && track['external-filename'].trim().length > 0
|
||||||
|
? track['external-filename'].trim()
|
||||||
|
: typeof track.external_filename === 'string' && track.external_filename.trim().length > 0
|
||||||
|
? track.external_filename.trim()
|
||||||
|
: null;
|
||||||
|
|
||||||
|
return {
|
||||||
|
id,
|
||||||
|
lang: String(track.lang || '')
|
||||||
|
.trim()
|
||||||
|
.toLowerCase(),
|
||||||
|
title: String(track.title || '')
|
||||||
|
.trim()
|
||||||
|
.toLowerCase(),
|
||||||
|
selected: track.selected === true,
|
||||||
|
external: track.external === true,
|
||||||
|
externalFilename,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function getSubtitleTrackIdentity(track: SubtitleTrackCandidate): string {
|
||||||
|
if (track.externalFilename) {
|
||||||
|
return `external:${track.externalFilename.toLowerCase()}`;
|
||||||
|
}
|
||||||
|
if (track.title.length > 0) {
|
||||||
|
return `title:${track.title}`;
|
||||||
|
}
|
||||||
|
return `id:${track.id}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function pickSecondarySubtitleTrackId(
|
||||||
|
tracks: Array<Record<string, unknown>>,
|
||||||
|
preferredLanguages: string[],
|
||||||
|
): number | null {
|
||||||
|
const normalizedLanguages = preferredLanguages
|
||||||
|
.map((language) => language.trim().toLowerCase())
|
||||||
|
.filter((language) => language.length > 0);
|
||||||
|
if (normalizedLanguages.length === 0) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const subtitleTracks = tracks
|
||||||
|
.filter((track) => track.type === 'sub')
|
||||||
|
.map(normalizeSubtitleTrackCandidate)
|
||||||
|
.filter((track): track is SubtitleTrackCandidate => track !== null);
|
||||||
|
|
||||||
|
const dedupedTracks = new Map<string, SubtitleTrackCandidate>();
|
||||||
|
for (const track of subtitleTracks) {
|
||||||
|
const identity = getSubtitleTrackIdentity(track);
|
||||||
|
const existing = dedupedTracks.get(identity);
|
||||||
|
if (!existing || (track.selected && !existing.selected)) {
|
||||||
|
dedupedTracks.set(identity, track);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const uniqueTracks = [...dedupedTracks.values()];
|
||||||
|
|
||||||
|
for (const language of normalizedLanguages) {
|
||||||
|
const selectedMatch = uniqueTracks.find((track) => track.selected && track.lang === language);
|
||||||
|
if (selectedMatch) {
|
||||||
|
return selectedMatch.id;
|
||||||
|
}
|
||||||
|
|
||||||
|
const match = uniqueTracks.find((track) => track.lang === language);
|
||||||
|
if (match) {
|
||||||
|
return match.id;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
export function splitMpvMessagesFromBuffer(
|
export function splitMpvMessagesFromBuffer(
|
||||||
buffer: string,
|
buffer: string,
|
||||||
onMessage?: MpvMessageParser,
|
onMessage?: MpvMessageParser,
|
||||||
@@ -283,15 +378,11 @@ export async function dispatchMpvProtocolMessage(
|
|||||||
if (Array.isArray(tracks)) {
|
if (Array.isArray(tracks)) {
|
||||||
const config = deps.getResolvedConfig();
|
const config = deps.getResolvedConfig();
|
||||||
const languages = config.secondarySub?.secondarySubLanguages || [];
|
const languages = config.secondarySub?.secondarySubLanguages || [];
|
||||||
const subTracks = tracks.filter((track) => track.type === 'sub');
|
const secondaryTrackId = pickSecondarySubtitleTrackId(tracks, languages);
|
||||||
for (const language of languages) {
|
if (secondaryTrackId !== null) {
|
||||||
const match = subTracks.find((track) => track.lang === language);
|
deps.sendCommand({
|
||||||
if (match) {
|
command: ['set_property', 'secondary-sid', secondaryTrackId],
|
||||||
deps.sendCommand({
|
});
|
||||||
command: ['set_property', 'secondary-sid', match.id],
|
|
||||||
});
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else if (msg.request_id === MPV_REQUEST_ID_TRACK_LIST_AUDIO) {
|
} else if (msg.request_id === MPV_REQUEST_ID_TRACK_LIST_AUDIO) {
|
||||||
|
|||||||
@@ -102,10 +102,7 @@ async function writeFetchResponse(res: ServerResponse, response: Response): Prom
|
|||||||
res.end(Buffer.from(body));
|
res.end(Buffer.from(body));
|
||||||
}
|
}
|
||||||
|
|
||||||
function startNodeHttpServer(
|
function startNodeHttpServer(app: Hono, config: StatsServerConfig): { close: () => void } {
|
||||||
app: Hono,
|
|
||||||
config: StatsServerConfig,
|
|
||||||
): { close: () => void } {
|
|
||||||
const server = http.createServer((req, res) => {
|
const server = http.createServer((req, res) => {
|
||||||
void (async () => {
|
void (async () => {
|
||||||
try {
|
try {
|
||||||
@@ -1075,11 +1072,9 @@ export function startStatsServer(config: StatsServerConfig): { close: () => void
|
|||||||
|
|
||||||
const bunRuntime = globalThis as typeof globalThis & {
|
const bunRuntime = globalThis as typeof globalThis & {
|
||||||
Bun?: {
|
Bun?: {
|
||||||
serve?: (options: {
|
serve?: (options: { fetch: (typeof app)['fetch']; port: number; hostname: string }) => {
|
||||||
fetch: (typeof app)['fetch'];
|
stop: () => void;
|
||||||
port: number;
|
};
|
||||||
hostname: string;
|
|
||||||
}) => { stop: () => void };
|
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -92,6 +92,52 @@ test('triggerSubsyncFromConfig opens manual picker in manual mode', async () =>
|
|||||||
assert.equal(inProgressState, false);
|
assert.equal(inProgressState, false);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('triggerSubsyncFromConfig dedupes repeated subtitle source tracks', async () => {
|
||||||
|
let payloadTrackCount = 0;
|
||||||
|
|
||||||
|
await triggerSubsyncFromConfig(
|
||||||
|
makeDeps({
|
||||||
|
getMpvClient: () => ({
|
||||||
|
connected: true,
|
||||||
|
currentAudioStreamIndex: null,
|
||||||
|
send: () => {},
|
||||||
|
requestProperty: async (name: string) => {
|
||||||
|
if (name === 'path') return '/tmp/video.mkv';
|
||||||
|
if (name === 'sid') return 1;
|
||||||
|
if (name === 'secondary-sid') return 2;
|
||||||
|
if (name === 'track-list') {
|
||||||
|
return [
|
||||||
|
{ id: 1, type: 'sub', selected: true, lang: 'jpn' },
|
||||||
|
{
|
||||||
|
id: 2,
|
||||||
|
type: 'sub',
|
||||||
|
selected: true,
|
||||||
|
external: true,
|
||||||
|
lang: 'eng',
|
||||||
|
'external-filename': '/tmp/ref.srt',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 3,
|
||||||
|
type: 'sub',
|
||||||
|
selected: false,
|
||||||
|
external: true,
|
||||||
|
lang: 'eng',
|
||||||
|
'external-filename': '/tmp/ref.srt',
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
openManualPicker: (payload) => {
|
||||||
|
payloadTrackCount = payload.sourceTracks.length;
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
assert.equal(payloadTrackCount, 1);
|
||||||
|
});
|
||||||
|
|
||||||
test('triggerSubsyncFromConfig reports failures to OSD', async () => {
|
test('triggerSubsyncFromConfig reports failures to OSD', async () => {
|
||||||
const osd: string[] = [];
|
const osd: string[] = [];
|
||||||
await triggerSubsyncFromConfig(
|
await triggerSubsyncFromConfig(
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user