mirror of
https://github.com/Psychotoxical/psysonic.git
synced 2026-07-22 07:15:47 +00:00
test(playerStore): playback actions + audio event handlers (Phase F1 / PR 2b) (#541)
playbackActions.test.ts: pause (invoke + failed-invoke controlled), resume (warm path, no-track guard), togglePlay (both branches), seek (clamp to dur-0.25, 100 ms debounce, coalesce rapid drags, no-op guards), next (advance, repeat=all wrap, repeat=off audio_stop + reset), previous (>3 s restart, jump-back, queueIndex=0 no-op), toggleRepeat cycle. events.test.ts: audio:progress (commit on active transport, drop without track / paused, duration=0 falls back to track.duration), audio:track_switched (advance, repeat=one pin, repeat=all wrap, end+off no-op, scrobbled+ lastfmLoved reset), audio:ended (immediate playback reset, radio path clears currentRadio without queue advance). 4 listener-lifecycle regression tests cover section 4.2 of the pre-refactor testing plan v2 -- cleanup actually unsubs; re-init keeps count=1; double-init without cleanup stacks (contract pin so a refactor that drops the cleanup return value fails loudly). playerStore.ts coverage 18.1% -> 39.55% lines. PR 2c (progress snapshot + persistence flush) pushes past the F1 50% floor.
This commit is contained in:
committed by
GitHub
parent
42e3fdb976
commit
4a18e15489
@@ -0,0 +1,285 @@
|
||||
/**
|
||||
* Audio-event handler characterization for `playerStore` (Phase F1 / PR 2b).
|
||||
*
|
||||
* Drives the Rust engine's `audio:*` channels through `emitTauriEvent` and
|
||||
* asserts on observable store state. Also covers the listener-lifecycle
|
||||
* regression test from §4.2 of the pre-refactor testing plan v2 — the
|
||||
* cleanup function returned by `initAudioListeners` must actually unsub.
|
||||
*/
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
|
||||
vi.mock('@/api/subsonic', async () => {
|
||||
const actual = await vi.importActual<typeof import('@/api/subsonic')>('@/api/subsonic');
|
||||
return {
|
||||
...actual,
|
||||
savePlayQueue: vi.fn(async () => undefined),
|
||||
getPlayQueue: vi.fn(async () => ({ songs: [], current: undefined, position: 0 })),
|
||||
buildStreamUrl: vi.fn((id: string) => `https://mock/stream/${id}`),
|
||||
buildCoverArtUrl: vi.fn((id: string) => `https://mock/cover/${id}`),
|
||||
getSong: vi.fn(async () => null),
|
||||
getRandomSongs: vi.fn(async () => []),
|
||||
getSimilarSongs2: vi.fn(async () => []),
|
||||
getTopSongs: vi.fn(async () => []),
|
||||
getAlbumInfo2: vi.fn(async () => null),
|
||||
reportNowPlaying: vi.fn(async () => undefined),
|
||||
scrobbleSong: vi.fn(async () => undefined),
|
||||
setRating: vi.fn(async () => undefined),
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock('@/api/lastfm', () => ({
|
||||
lastfmScrobble: vi.fn(async () => undefined),
|
||||
lastfmUpdateNowPlaying: vi.fn(async () => undefined),
|
||||
lastfmLoveTrack: vi.fn(async () => undefined),
|
||||
lastfmUnloveTrack: vi.fn(async () => undefined),
|
||||
lastfmGetTrackLoved: vi.fn(async () => false),
|
||||
lastfmGetAllLovedTracks: vi.fn(async () => []),
|
||||
}));
|
||||
|
||||
vi.mock('@/utils/orbitBulkGuard', () => ({
|
||||
orbitBulkGuard: vi.fn(async () => true),
|
||||
}));
|
||||
|
||||
import { initAudioListeners, usePlayerStore } from './playerStore';
|
||||
import {
|
||||
emitTauriEvent,
|
||||
onInvoke,
|
||||
tauriMockListenerCount,
|
||||
} from '@/test/mocks/tauri';
|
||||
import { resetPlayerStore, resetAuthStore } from '@/test/helpers/storeReset';
|
||||
import { makeTrack, makeTracks } from '@/test/helpers/factories';
|
||||
|
||||
function stubPlaybackInvokes(): void {
|
||||
onInvoke('audio_play', () => undefined);
|
||||
onInvoke('audio_pause', () => undefined);
|
||||
onInvoke('audio_resume', () => undefined);
|
||||
onInvoke('audio_stop', () => undefined);
|
||||
onInvoke('audio_seek', () => undefined);
|
||||
onInvoke('audio_get_state', () => ({ playing: false }));
|
||||
onInvoke('audio_update_replay_gain', () => undefined);
|
||||
onInvoke('audio_set_normalization', () => undefined);
|
||||
onInvoke('discord_update_presence', () => undefined);
|
||||
onInvoke('frontend_debug_log', () => undefined);
|
||||
}
|
||||
|
||||
let cleanupListeners: (() => void) | null = null;
|
||||
|
||||
beforeEach(() => {
|
||||
vi.useFakeTimers();
|
||||
resetPlayerStore();
|
||||
resetAuthStore();
|
||||
stubPlaybackInvokes();
|
||||
cleanupListeners = initAudioListeners();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
cleanupListeners?.();
|
||||
cleanupListeners = null;
|
||||
vi.runOnlyPendingTimers();
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
describe('audio:progress', () => {
|
||||
it('commits currentTime to the store when transport is active', () => {
|
||||
const track = makeTrack({ duration: 100 });
|
||||
usePlayerStore.setState({ currentTrack: track, isPlaying: true });
|
||||
|
||||
// Above the 5 s store-commit threshold so the first event causes a write.
|
||||
emitTauriEvent('audio:progress', { current_time: 25, duration: 100 });
|
||||
|
||||
expect(usePlayerStore.getState().currentTime).toBeCloseTo(25, 5);
|
||||
expect(usePlayerStore.getState().progress).toBeCloseTo(0.25, 5);
|
||||
});
|
||||
|
||||
it('is ignored when there is no current track', () => {
|
||||
usePlayerStore.setState({ currentTrack: null, currentTime: 0 });
|
||||
emitTauriEvent('audio:progress', { current_time: 25, duration: 100 });
|
||||
expect(usePlayerStore.getState().currentTime).toBe(0);
|
||||
});
|
||||
|
||||
it('is ignored when transport is inactive (paused, no radio)', () => {
|
||||
const track = makeTrack({ duration: 100 });
|
||||
usePlayerStore.setState({ currentTrack: track, isPlaying: false, currentTime: 0 });
|
||||
emitTauriEvent('audio:progress', { current_time: 25, duration: 100 });
|
||||
expect(usePlayerStore.getState().currentTime).toBe(0);
|
||||
});
|
||||
|
||||
it('uses the track duration when the event reports duration ≤ 0', () => {
|
||||
const track = makeTrack({ duration: 200 });
|
||||
usePlayerStore.setState({ currentTrack: track, isPlaying: true });
|
||||
emitTauriEvent('audio:progress', { current_time: 50, duration: 0 });
|
||||
// Falls back to track.duration = 200, so progress = 50/200 = 0.25.
|
||||
expect(usePlayerStore.getState().progress).toBeCloseTo(0.25, 5);
|
||||
});
|
||||
});
|
||||
|
||||
describe('audio:track_switched', () => {
|
||||
it('advances to queue[queueIndex + 1] under repeatMode=off', () => {
|
||||
const queue = makeTracks(3);
|
||||
usePlayerStore.setState({
|
||||
queue,
|
||||
queueIndex: 0,
|
||||
currentTrack: queue[0],
|
||||
repeatMode: 'off',
|
||||
});
|
||||
emitTauriEvent('audio:track_switched', queue[1].duration);
|
||||
const s = usePlayerStore.getState();
|
||||
expect(s.currentTrack?.id).toBe(queue[1].id);
|
||||
expect(s.queueIndex).toBe(1);
|
||||
expect(s.isPlaying).toBe(true);
|
||||
expect(s.scrobbled).toBe(false);
|
||||
expect(s.progress).toBe(0);
|
||||
expect(s.currentTime).toBe(0);
|
||||
});
|
||||
|
||||
it('replays the same track under repeatMode=one (queueIndex stays put)', () => {
|
||||
const queue = makeTracks(3);
|
||||
usePlayerStore.setState({
|
||||
queue,
|
||||
queueIndex: 1,
|
||||
currentTrack: queue[1],
|
||||
repeatMode: 'one',
|
||||
});
|
||||
emitTauriEvent('audio:track_switched', queue[1].duration);
|
||||
const s = usePlayerStore.getState();
|
||||
expect(s.currentTrack?.id).toBe(queue[1].id);
|
||||
expect(s.queueIndex).toBe(1);
|
||||
});
|
||||
|
||||
it('wraps to queue[0] when at the end with repeatMode=all', () => {
|
||||
const queue = makeTracks(3);
|
||||
usePlayerStore.setState({
|
||||
queue,
|
||||
queueIndex: 2,
|
||||
currentTrack: queue[2],
|
||||
repeatMode: 'all',
|
||||
});
|
||||
emitTauriEvent('audio:track_switched', queue[0].duration);
|
||||
const s = usePlayerStore.getState();
|
||||
expect(s.currentTrack?.id).toBe(queue[0].id);
|
||||
expect(s.queueIndex).toBe(0);
|
||||
});
|
||||
|
||||
it('is a no-op when at the end with repeatMode=off', () => {
|
||||
const queue = makeTracks(2);
|
||||
usePlayerStore.setState({
|
||||
queue,
|
||||
queueIndex: 1,
|
||||
currentTrack: queue[1],
|
||||
repeatMode: 'off',
|
||||
});
|
||||
emitTauriEvent('audio:track_switched', queue[1].duration);
|
||||
// No next candidate → handler returns early before state changes.
|
||||
const s = usePlayerStore.getState();
|
||||
expect(s.currentTrack?.id).toBe(queue[1].id);
|
||||
expect(s.queueIndex).toBe(1);
|
||||
});
|
||||
|
||||
it('resets scrobbled + lastfmLoved flags so the new track can be rescored', () => {
|
||||
const queue = makeTracks(2);
|
||||
usePlayerStore.setState({
|
||||
queue,
|
||||
queueIndex: 0,
|
||||
currentTrack: queue[0],
|
||||
scrobbled: true,
|
||||
lastfmLoved: true,
|
||||
});
|
||||
emitTauriEvent('audio:track_switched', queue[1].duration);
|
||||
expect(usePlayerStore.getState().scrobbled).toBe(false);
|
||||
expect(usePlayerStore.getState().lastfmLoved).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('audio:ended', () => {
|
||||
// Module-scope `lastGaplessSwitchTime` is updated by handleAudioTrackSwitched
|
||||
// in adjacent tests; the ghost-guard skips audio:ended events fired within
|
||||
// 600 ms of a track switch. Advance the fake clock to bypass the guard.
|
||||
beforeEach(() => {
|
||||
vi.advanceTimersByTime(1000);
|
||||
});
|
||||
|
||||
it('immediately resets playback bookkeeping (before the 150 ms next() timer)', () => {
|
||||
const queue = makeTracks(2);
|
||||
usePlayerStore.setState({
|
||||
queue,
|
||||
queueIndex: 0,
|
||||
currentTrack: queue[0],
|
||||
isPlaying: true,
|
||||
progress: 0.99,
|
||||
currentTime: 178,
|
||||
buffered: 1,
|
||||
});
|
||||
emitTauriEvent('audio:ended', undefined);
|
||||
const s = usePlayerStore.getState();
|
||||
expect(s.isPlaying).toBe(false);
|
||||
expect(s.progress).toBe(0);
|
||||
expect(s.currentTime).toBe(0);
|
||||
expect(s.buffered).toBe(0);
|
||||
// currentTrack stays — `next()` (deferred 150 ms) will replace it.
|
||||
expect(s.currentTrack?.id).toBe(queue[0].id);
|
||||
});
|
||||
|
||||
it('clears state and currentRadio for a radio stream without advancing the queue', () => {
|
||||
const queue = makeTracks(2);
|
||||
usePlayerStore.setState({
|
||||
queue,
|
||||
queueIndex: 0,
|
||||
currentTrack: queue[0],
|
||||
currentRadio: { id: 'r1', name: 'Test FM', streamUrl: 'https://radio.test/stream' },
|
||||
isPlaying: true,
|
||||
});
|
||||
emitTauriEvent('audio:ended', undefined);
|
||||
const s = usePlayerStore.getState();
|
||||
expect(s.isPlaying).toBe(false);
|
||||
expect(s.currentRadio).toBeNull();
|
||||
expect(s.progress).toBe(0);
|
||||
expect(s.currentTime).toBe(0);
|
||||
// Queue not advanced.
|
||||
expect(s.queueIndex).toBe(0);
|
||||
expect(s.currentTrack?.id).toBe(queue[0].id);
|
||||
});
|
||||
});
|
||||
|
||||
describe('initAudioListeners — listener lifecycle (regression §4.2)', () => {
|
||||
it('registers exactly one listener per audio:* channel', () => {
|
||||
// beforeEach already called initAudioListeners once.
|
||||
expect(tauriMockListenerCount('audio:progress')).toBe(1);
|
||||
expect(tauriMockListenerCount('audio:ended')).toBe(1);
|
||||
expect(tauriMockListenerCount('audio:track_switched')).toBe(1);
|
||||
expect(tauriMockListenerCount('audio:playing')).toBe(1);
|
||||
});
|
||||
|
||||
it('cleanup() removes all audio:* listeners it registered', async () => {
|
||||
// Tear down the listeners attached by beforeEach.
|
||||
cleanupListeners?.();
|
||||
cleanupListeners = null;
|
||||
// `pending.forEach(p => p.then(unlisten => unlisten()))` runs in microtasks
|
||||
// — flush twice to ride through the then-chain.
|
||||
await Promise.resolve();
|
||||
await Promise.resolve();
|
||||
expect(tauriMockListenerCount('audio:progress')).toBe(0);
|
||||
expect(tauriMockListenerCount('audio:ended')).toBe(0);
|
||||
expect(tauriMockListenerCount('audio:track_switched')).toBe(0);
|
||||
expect(tauriMockListenerCount('audio:playing')).toBe(0);
|
||||
});
|
||||
|
||||
it('re-init after cleanup keeps the count at 1 (no leak)', async () => {
|
||||
cleanupListeners?.();
|
||||
cleanupListeners = null;
|
||||
await Promise.resolve();
|
||||
await Promise.resolve();
|
||||
cleanupListeners = initAudioListeners();
|
||||
expect(tauriMockListenerCount('audio:progress')).toBe(1);
|
||||
expect(tauriMockListenerCount('audio:track_switched')).toBe(1);
|
||||
});
|
||||
|
||||
it('init without cleanup stacks listeners — guards against missing useEffect cleanup', () => {
|
||||
// Demonstrates the pre-ShortcutMap bug shape: calling init twice without
|
||||
// tearing down accumulates handlers. The Real Fix lives in the consumer
|
||||
// (React useEffect cleanup); this test pins the contract so a refactor
|
||||
// that silently swallows the cleanup return value fails loudly.
|
||||
const second = initAudioListeners();
|
||||
expect(tauriMockListenerCount('audio:progress')).toBe(2);
|
||||
second();
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user