133 lines
6.5 KiB
Markdown
133 lines
6.5 KiB
Markdown
# fader_master hands-on checklist (Arch + PipeWire)
|
||
|
||
Automated tests cover validation, buffering, IPC, rollback, rendering, and
|
||
atomic persistence. This checklist records manual acceptance with your real
|
||
PipeWire session, APC MINI, applications, and terminal. Existing checked items
|
||
are historical observations; the new unchecked items still need manual testing.
|
||
|
||
## Setup
|
||
|
||
Use a disposable profile directory so editor Save does not modify tracked
|
||
examples:
|
||
|
||
```sh
|
||
work=$(mktemp -d /tmp/fader-master-check.XXXXXX)
|
||
cp examples/profiles/{arch-pipewire,desktop}.toml "$work/"
|
||
cargo run --locked -p fader_master -- serve \
|
||
--config "$work/arch-pipewire.toml" --audio pulse
|
||
```
|
||
|
||
In another terminal:
|
||
|
||
```sh
|
||
cargo run --locked -p fader_master -- tui
|
||
```
|
||
|
||
Restart the server too after rebuilding. A new client or all-in-one launcher
|
||
can reconnect to an old server process; it cannot replace its implementation.
|
||
|
||
Known mappings: Music `CC48/Note64`, Browser `CC49/Note65`, Media sync
|
||
`CC50/Note66`, and Master `CC56/Note98`. The profile polling interval is 10 ms
|
||
and accepts 1–100 ms.
|
||
|
||
## MPRIS/QBZ opt-in checks (new, not yet hardware-qualified)
|
||
|
||
Use a disposable profile, build with default `mpris` support and restart both
|
||
processes. Start QBZ in the same user's desktop session; leave it paused and
|
||
start a second, different MPRIS player to check targeting. Configure the real
|
||
controller input/output ports (do not overwrite the checked-in examples).
|
||
|
||
- [ ] Media appears even with no audio stream; P discovers paused QBZ. A manual
|
||
exact bus-name selector reaches QBZ only. A broad regex matching both players
|
||
reports ambiguity and sends no command.
|
||
- [ ] A/E/D, rename, control action/parameter editing and Save/exit survive Save,
|
||
server restart and client reconnect. Unsupported controls show unsupported.
|
||
- [ ] Learn Play/Pause/Stop, release/hold buttons and U-unbind. Only presses act;
|
||
bindings persist after Save/restart. Removing the surface unbinds controls.
|
||
- [ ] Only the confirmed Play/Pause/Stop state lights. External player changes
|
||
update LEDs. Verify controller-specific on/off colors; reconnect resynchronizes.
|
||
- [ ] Global, per-fader and per-entry feedback switches send no output while off,
|
||
including no clearing messages. Re-enable/Save restores observed indicators.
|
||
- [ ] Seek forward/back and absolute position, shuffle, repeat and playlist
|
||
activation work where QBZ reports support. Unsupported properties stay disabled.
|
||
- [ ] Quit/restart QBZ, switch profiles and unplug/replug the controller. Errors
|
||
recover; expired commands are not replayed against a replacement player.
|
||
|
||
Hardware-free D-Bus qualification (creates its own bus and fake players, never
|
||
controls desktop applications):
|
||
|
||
```sh
|
||
dbus-run-session -- cargo test -p fader_master private_bus -- --ignored
|
||
```
|
||
|
||
## Mixer smoke test
|
||
|
||
- [x] TUI shows Music, Browser, Media, Master, and the APC backend ID; startup
|
||
does not change any live volume or mute.
|
||
- [x] CC48/49 control only their applications; CC50 sets both Media members to
|
||
one absolute value; CC56/Note98 affect only the default output.
|
||
- [x] Pickup starts `waiting`, becomes `tracking` only after crossing the live
|
||
value, and returns to `waiting` after an external volume change.
|
||
- [x] A rapid fader sweep stays responsive and converges to its last position;
|
||
rapid double mute presses preserve both edges.
|
||
- [x] With Browser offline, its controls are nonfatal and are not replayed when
|
||
Browser starts.
|
||
|
||
|
||
## Profile switching and recovery
|
||
|
||
Both disposable profiles are siblings, so while the server is running:
|
||
|
||
```sh
|
||
cargo run --locked -p fader_master -- profile switch desktop
|
||
cargo run --locked -p fader_master -- profile switch arch-pipewire
|
||
```
|
||
|
||
- [x] Each successful switch changes the profile shown in Config, preserves
|
||
observed live audio without a write, and requires pickup again.
|
||
- [x] A missing/invalid profile reports an error and leaves the old profile
|
||
active. A switch attempted during pending fader work returns an actionable
|
||
retry error instead of crossing generations.
|
||
- [x] Stop the server while TUI remains open: rows stay visible, the error is
|
||
internal to the TUI, and restart reconnects without replaying input.
|
||
local socket operation failed for /run/user/1000/fader_master/control.sock: Connection refused (os error 111)
|
||
error is smooth but unhelpful, log the actual error and show a helpful one ?
|
||
- [x] Unplug/replug APC MINI: server/TUI stay alive, status changes to
|
||
`missing — connect device`, and reconnection rearms pickup.
|
||
- [x] Start TUI before the server and confirm it recovers automatically when the
|
||
socket appears.
|
||
|
||
## Polling and report
|
||
|
||
- [x] Compare `poll_interval_ms = 10`, `5`, and `2` (restart between values).
|
||
Record responsiveness, CPU impact, and the lowest useful value.
|
||
About the same, cpu usage a little on the higer end of what I would like tho
|
||
- [ ] Run `cargo run --locked -p fader_master -- status`; confirm `status=ready`
|
||
and expected final values.
|
||
- [ ] Report any pre-pickup jump, wrong target, rough sweep, stale/pending value,
|
||
lost mute edge, failed Save diagnostic, reconnect over one second,
|
||
terminal corruption, or process exit.
|
||
|
||
Explicit `profile switch --restore` remains optional for manual testing because
|
||
it deliberately writes saved state. Mute LED feedback is implemented; verify
|
||
the configured on/off values against the particular surface.
|
||
|
||
## Layout, settings, and persistence
|
||
|
||
- [ ] Move a fader in both directions, Save, restart the server, and move it
|
||
again. Verify that selection follows it and the order never snaps back.
|
||
- [ ] Add and rename separators with both nonempty and empty names. Create two
|
||
unnamed separators and verify they remain independently editable/movable.
|
||
- [ ] Try separator Slim/Standard/Thick/Fill and all four decorations in both
|
||
orientations. Plain + empty name should be blank space; unnamed lines should
|
||
be continuous. Multiple Fill separators should share leftover space.
|
||
- [ ] Try Slim, Bordered slim, Standard, and Thick faders. Resize the terminal:
|
||
horizontal entries should stay on one row, and selection should stay visible.
|
||
- [ ] Change theme, orientation, and each pickup-status mode in Config. Save
|
||
and restart; all choices should persist. Hidden pickup status must not disable
|
||
the hardware pickup behavior.
|
||
- [ ] Hide an application fader used by a group, then restore it from the
|
||
Config popup. Verify that its MIDI binding and group membership still work.
|
||
- [ ] Relearn a mute button, Save, and confirm only the new button controls it
|
||
and receives feedback. Open Help with h/?; Escape closes popups, Q confirms quit.
|