mirror of
https://github.com/kilyabin/psysonic.git
synced 2026-07-22 14:35:41 +00:00
refactor(player): E.20 — extract HTML5 radio player (#584)
The HTMLAudioElement that handles internet-radio streams + its six
event listeners + the bounded stalled-reconnect loop move into
`src/store/radioPlayer.ts`. The module owns the singleton audio
element, the `radioStopping` suppression flag, the reconnect counter
and timer, and `MAX_RADIO_RECONNECTS`. Public API:
- `playRadioStream(url, volume)` — sets src + clamped volume + play,
resets reconnect counter
- `pauseRadio()` / `resumeRadio()` — soft pause/resume (keep src)
- `stopRadio()` — full stop (flag + pause + clear src + cancel
reconnect timer)
- `setRadioVolume(v)` — direct volume with clamp
- `clearRadioReconnectTimer()` — exposed for cleanup paths
playerStore's seven direct-access patterns become API calls. The
three `radioStopping = true; pause; src = ''` triples collapse to
single `stopRadio()` calls.
18 tests pin the imperative API + the listener loop: ended/error
state-clear, stalled → 4 s reconnect, stalled coalescing, the
MAX_RADIO_RECONNECTS hard stop, playing-resets-counter, and the
suspend → cancel.
playerStore 2983 → 2909 LOC.
This commit is contained in:
committed by
GitHub
parent
7dc4888a06
commit
6d07720b4f
@@ -0,0 +1,214 @@
|
||||
/**
|
||||
* Tests cover the imperative API — playRadioStream / pauseRadio /
|
||||
* resumeRadio / stopRadio / setRadioVolume / clearRadioReconnectTimer.
|
||||
* The reconnect listener loop is exercised indirectly: dispatching the
|
||||
* 'stalled' event on the audio element drives the timer + counter.
|
||||
*/
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
|
||||
const hoisted = vi.hoisted(() => {
|
||||
const playerStateGet = vi.fn(() => ({ currentRadio: null as { id: string } | null }));
|
||||
return {
|
||||
showToastMock: vi.fn(),
|
||||
playerSetStateMock: vi.fn(),
|
||||
playerStateGet,
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock('../utils/toast', () => ({ showToast: hoisted.showToastMock }));
|
||||
vi.mock('./playerStore', () => ({
|
||||
usePlayerStore: {
|
||||
getState: hoisted.playerStateGet,
|
||||
setState: hoisted.playerSetStateMock,
|
||||
},
|
||||
}));
|
||||
|
||||
import {
|
||||
_radioAudioForTest,
|
||||
_resetRadioPlayerForTest,
|
||||
clearRadioReconnectTimer,
|
||||
pauseRadio,
|
||||
playRadioStream,
|
||||
resumeRadio,
|
||||
setRadioVolume,
|
||||
stopRadio,
|
||||
} from './radioPlayer';
|
||||
|
||||
const audio = _radioAudioForTest();
|
||||
let pauseSpy: ReturnType<typeof vi.spyOn>;
|
||||
let playSpy: ReturnType<typeof vi.spyOn>;
|
||||
let loadSpy: ReturnType<typeof vi.spyOn>;
|
||||
|
||||
beforeEach(() => {
|
||||
vi.useFakeTimers();
|
||||
hoisted.showToastMock.mockClear();
|
||||
hoisted.playerSetStateMock.mockClear();
|
||||
hoisted.playerStateGet.mockReset();
|
||||
hoisted.playerStateGet.mockReturnValue({ currentRadio: null });
|
||||
pauseSpy = vi.spyOn(audio, 'pause').mockImplementation(() => {});
|
||||
playSpy = vi.spyOn(audio, 'play').mockResolvedValue(undefined as never);
|
||||
loadSpy = vi.spyOn(audio, 'load').mockImplementation(() => {});
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
_resetRadioPlayerForTest();
|
||||
pauseSpy.mockRestore();
|
||||
playSpy.mockRestore();
|
||||
loadSpy.mockRestore();
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
describe('playRadioStream', () => {
|
||||
it('sets src + clamped volume + calls play', async () => {
|
||||
await playRadioStream('https://stream.example/foo', 0.6);
|
||||
expect(audio.src).toContain('https://stream.example/foo');
|
||||
expect(audio.volume).toBeCloseTo(0.6);
|
||||
expect(playSpy).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('clamps volume above 1 to 1', async () => {
|
||||
await playRadioStream('https://x/y', 1.5);
|
||||
expect(audio.volume).toBe(1);
|
||||
});
|
||||
|
||||
it('clamps volume below 0 to 0', async () => {
|
||||
await playRadioStream('https://x/y', -0.5);
|
||||
expect(audio.volume).toBe(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('pauseRadio / resumeRadio', () => {
|
||||
it('pause delegates to audio.pause without touching src', async () => {
|
||||
await playRadioStream('https://x/y', 0.5);
|
||||
const before = audio.src;
|
||||
pauseRadio();
|
||||
expect(pauseSpy).toHaveBeenCalled();
|
||||
expect(audio.src).toBe(before);
|
||||
});
|
||||
|
||||
it('resume delegates to audio.play', () => {
|
||||
void resumeRadio();
|
||||
expect(playSpy).toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe('stopRadio', () => {
|
||||
it('pauses + clears src + cancels reconnect timer', async () => {
|
||||
await playRadioStream('https://x/y', 0.5);
|
||||
stopRadio();
|
||||
expect(pauseSpy).toHaveBeenCalled();
|
||||
// JSdom resolves an empty src against the page URL, so assert via the
|
||||
// observable HTMLAudioElement attribute instead.
|
||||
expect(audio.getAttribute('src')).toBe('');
|
||||
});
|
||||
|
||||
it('does not show an error toast if the resulting "error" event was caused by stop', () => {
|
||||
stopRadio();
|
||||
audio.dispatchEvent(new Event('error'));
|
||||
expect(hoisted.showToastMock).not.toHaveBeenCalled();
|
||||
expect(hoisted.playerSetStateMock).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe('setRadioVolume', () => {
|
||||
it('sets the volume directly', () => {
|
||||
setRadioVolume(0.3);
|
||||
expect(audio.volume).toBeCloseTo(0.3);
|
||||
});
|
||||
|
||||
it('clamps the volume', () => {
|
||||
setRadioVolume(2);
|
||||
expect(audio.volume).toBe(1);
|
||||
setRadioVolume(-1);
|
||||
expect(audio.volume).toBe(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('event listeners', () => {
|
||||
it('"ended" clears radio state', () => {
|
||||
audio.dispatchEvent(new Event('ended'));
|
||||
const calls = hoisted.playerSetStateMock.mock.calls;
|
||||
const lastCall = calls[calls.length - 1]?.[0] as Record<string, unknown>;
|
||||
expect(lastCall).toMatchObject({
|
||||
isPlaying: false,
|
||||
currentRadio: null,
|
||||
progress: 0,
|
||||
currentTime: 0,
|
||||
});
|
||||
});
|
||||
|
||||
it('"error" (without prior stop) shows a toast + clears radio state', () => {
|
||||
audio.dispatchEvent(new Event('error'));
|
||||
expect(hoisted.showToastMock).toHaveBeenCalledWith('Radio stream error', 3000, 'error');
|
||||
const calls = hoisted.playerSetStateMock.mock.calls;
|
||||
const lastCall = calls[calls.length - 1]?.[0] as Record<string, unknown>;
|
||||
expect(lastCall).toMatchObject({ isPlaying: false, currentRadio: null });
|
||||
});
|
||||
|
||||
it('"stalled" schedules a reconnect attempt after 4 s', () => {
|
||||
hoisted.playerStateGet.mockReturnValue({ currentRadio: { id: 'r1' } });
|
||||
audio.dispatchEvent(new Event('stalled'));
|
||||
expect(loadSpy).not.toHaveBeenCalled();
|
||||
vi.advanceTimersByTime(4000);
|
||||
expect(loadSpy).toHaveBeenCalledTimes(1);
|
||||
expect(playSpy).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('"stalled" suppresses second schedule when one is already pending', () => {
|
||||
hoisted.playerStateGet.mockReturnValue({ currentRadio: { id: 'r1' } });
|
||||
audio.dispatchEvent(new Event('stalled'));
|
||||
audio.dispatchEvent(new Event('stalled'));
|
||||
vi.advanceTimersByTime(4000);
|
||||
expect(loadSpy).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('"stalled" gives up after MAX_RADIO_RECONNECTS (5) attempts', () => {
|
||||
hoisted.playerStateGet.mockReturnValue({ currentRadio: { id: 'r1' } });
|
||||
for (let i = 0; i < 5; i++) {
|
||||
audio.dispatchEvent(new Event('stalled'));
|
||||
vi.advanceTimersByTime(4000);
|
||||
}
|
||||
// Sixth stall → counter at max, gives up with toast + state clear.
|
||||
audio.dispatchEvent(new Event('stalled'));
|
||||
expect(hoisted.showToastMock).toHaveBeenCalledWith('Radio stream disconnected', 4000, 'error');
|
||||
const calls = hoisted.playerSetStateMock.mock.calls;
|
||||
const lastCall = calls[calls.length - 1]?.[0] as Record<string, unknown>;
|
||||
expect(lastCall).toMatchObject({ isPlaying: false, currentRadio: null });
|
||||
});
|
||||
|
||||
it('"playing" resets the reconnect counter (next stall starts fresh)', () => {
|
||||
hoisted.playerStateGet.mockReturnValue({ currentRadio: { id: 'r1' } });
|
||||
// Push counter to 1 via one stall cycle
|
||||
audio.dispatchEvent(new Event('stalled'));
|
||||
vi.advanceTimersByTime(4000);
|
||||
// Successful 'playing' resets
|
||||
audio.dispatchEvent(new Event('playing'));
|
||||
loadSpy.mockClear();
|
||||
// Next stall: should schedule again (counter is 0)
|
||||
audio.dispatchEvent(new Event('stalled'));
|
||||
vi.advanceTimersByTime(4000);
|
||||
expect(loadSpy).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('"suspend" cancels a pending reconnect', () => {
|
||||
hoisted.playerStateGet.mockReturnValue({ currentRadio: { id: 'r1' } });
|
||||
audio.dispatchEvent(new Event('stalled'));
|
||||
audio.dispatchEvent(new Event('suspend'));
|
||||
vi.advanceTimersByTime(4000);
|
||||
expect(loadSpy).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe('clearRadioReconnectTimer', () => {
|
||||
it('cancels a scheduled reconnect', () => {
|
||||
hoisted.playerStateGet.mockReturnValue({ currentRadio: { id: 'r1' } });
|
||||
audio.dispatchEvent(new Event('stalled'));
|
||||
clearRadioReconnectTimer();
|
||||
vi.advanceTimersByTime(10_000);
|
||||
expect(loadSpy).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('is a no-op when nothing is scheduled', () => {
|
||||
expect(() => clearRadioReconnectTimer()).not.toThrow();
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user