test(ui): QueuePanel (§4.4 DnD regression) + PlayerBar (Phase F5b) (#547)

QueuePanel.test.tsx (8): empty-queue affordance, one row per queue track
with matching data-queue-idx, track titles render. Toolbar exposes
Shuffle queue / Save Playlist / Load Playlist / Copy queue share link /
Clear via aria-label; Shuffle is disabled when the queue has fewer than
2 tracks.

§4.4 of the v2 plan -- DnD architecture pin. Queue rows do NOT declare
draggable=true (no HTML5 native drag); the source file has no
dataTransfer.setData / dataTransfer.getData / onDragStart / onDrop JSX
usage; no application/json MIME anywhere. The project's psy-drop custom
event system sidesteps WebView2's text/plain-only restriction by
avoiding HTML5 DnD entirely -- a refactor that re-introduces native DnD
on the queue would silently break Windows.

PlayerBar.test.tsx (9): renders the labelled "Music Player" region.
Surfaces Previous Track / Play / Next Track / Repeat / Stop when a
track is loaded. The middle control flips between "Play" and "Pause"
based on isPlaying. Control wiring: clicking Play/Pause calls
togglePlay, Previous calls previous, Next calls next, Repeat cycles
off -> all -> one, Stop calls stop. The region landmark is still
rendered when no track is loaded.

Adds a generic scrollIntoView no-op stub in src/test/mocks/browser.ts --
jsdom does not implement it and QueuePanel's queueAutoScroll calls it
on mount with auto-advance enabled. Benefits any future component test
that touches scroll affordances.

Frontend suite: 382 -> 399 tests (+17).
This commit is contained in:
Frank Stellmacher
2026-05-11 23:16:08 +02:00
committed by GitHub
parent fae615fdb8
commit 2c38db6ea6
3 changed files with 333 additions and 0 deletions
+154
View File
@@ -0,0 +1,154 @@
/**
* `PlayerBar` characterization (Phase F5b).
*
* Asserts on the public control wiring (play/pause/next/prev/repeat/stop)
* and the no-track empty state. Visual / hover / overflow logic lives in
* the manual smoke list — jsdom doesn't compute layout.
*/
import { beforeEach, describe, expect, it, vi } from 'vitest';
vi.mock('@/api/subsonic', () => ({
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}`),
buildDownloadUrl: vi.fn((id: string) => `https://mock/download/${id}`),
coverArtCacheKey: vi.fn((id: string, size = 256) => `mock:cover:${id}:${size}`),
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),
}));
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 () => []),
}));
import PlayerBar from './PlayerBar';
import { renderWithProviders } from '@/test/helpers/renderWithProviders';
import { usePlayerStore } from '@/store/playerStore';
import { useAuthStore } from '@/store/authStore';
import { resetAllStores } from '@/test/helpers/storeReset';
import { makeTrack } from '@/test/helpers/factories';
import { onInvoke } from '@/test/mocks/tauri';
import { fireEvent } from '@testing-library/react';
beforeEach(() => {
vi.useFakeTimers();
resetAllStores();
const id = useAuthStore.getState().addServer({
name: 'T', url: 'https://x.test', username: 'u', password: 'p',
});
useAuthStore.getState().setActiveServer(id);
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('discord_update_presence', () => undefined);
});
describe('PlayerBar — render', () => {
it('renders the player region with the labelled landmark', () => {
const { getByLabelText } = renderWithProviders(<PlayerBar />);
expect(getByLabelText('Music Player')).toBeInTheDocument();
});
it('exposes Previous Track / Play / Next Track / Repeat / Stop controls when a track is loaded', () => {
const track = makeTrack();
usePlayerStore.setState({ currentTrack: track, isPlaying: false });
const { getByLabelText } = renderWithProviders(<PlayerBar />);
expect(getByLabelText('Previous Track')).toBeInTheDocument();
expect(getByLabelText('Play')).toBeInTheDocument();
expect(getByLabelText('Next Track')).toBeInTheDocument();
expect(getByLabelText('Repeat')).toBeInTheDocument();
expect(getByLabelText('Stop')).toBeInTheDocument();
});
it('the middle control reads "Pause" while playback is active', () => {
usePlayerStore.setState({ currentTrack: makeTrack(), isPlaying: true });
const { getByLabelText } = renderWithProviders(<PlayerBar />);
expect(getByLabelText('Pause')).toBeInTheDocument();
});
});
describe('PlayerBar — control wiring', () => {
it('clicking the Play/Pause button calls togglePlay', () => {
const track = makeTrack();
usePlayerStore.setState({ currentTrack: track, isPlaying: false });
const toggleSpy = vi.spyOn(usePlayerStore.getState(), 'togglePlay');
const { getByLabelText } = renderWithProviders(<PlayerBar />);
fireEvent.click(getByLabelText('Play'));
expect(toggleSpy).toHaveBeenCalledTimes(1);
});
it('clicking Previous Track calls previous()', () => {
usePlayerStore.setState({
queue: [makeTrack({ id: 'a' }), makeTrack({ id: 'b' })],
queueIndex: 1,
currentTrack: makeTrack({ id: 'b' }),
currentTime: 10, // > 3 s → restart current
});
const prevSpy = vi.spyOn(usePlayerStore.getState(), 'previous');
const { getByLabelText } = renderWithProviders(<PlayerBar />);
fireEvent.click(getByLabelText('Previous Track'));
expect(prevSpy).toHaveBeenCalledTimes(1);
});
it('clicking Next Track calls next()', () => {
const t1 = makeTrack({ id: 'a' });
const t2 = makeTrack({ id: 'b' });
usePlayerStore.setState({ queue: [t1, t2], queueIndex: 0, currentTrack: t1 });
const nextSpy = vi.spyOn(usePlayerStore.getState(), 'next');
const { getByLabelText } = renderWithProviders(<PlayerBar />);
fireEvent.click(getByLabelText('Next Track'));
expect(nextSpy).toHaveBeenCalledTimes(1);
});
it('clicking Repeat cycles through off → all → one', () => {
usePlayerStore.setState({ currentTrack: makeTrack() });
const { getByLabelText, rerender } = renderWithProviders(<PlayerBar />);
expect(usePlayerStore.getState().repeatMode).toBe('off');
fireEvent.click(getByLabelText('Repeat'));
expect(usePlayerStore.getState().repeatMode).toBe('all');
rerender(<PlayerBar />);
fireEvent.click(getByLabelText('Repeat'));
expect(usePlayerStore.getState().repeatMode).toBe('one');
});
it('clicking Stop calls stop()', () => {
usePlayerStore.setState({ currentTrack: makeTrack(), isPlaying: true });
const stopSpy = vi.spyOn(usePlayerStore.getState(), 'stop');
const { getByLabelText } = renderWithProviders(<PlayerBar />);
fireEvent.click(getByLabelText('Stop'));
expect(stopSpy).toHaveBeenCalledTimes(1);
});
});
describe('PlayerBar — empty state (no current track)', () => {
it('still renders the region landmark when no track is loaded', () => {
usePlayerStore.setState({ currentTrack: null, isPlaying: false });
const { getByLabelText } = renderWithProviders(<PlayerBar />);
expect(getByLabelText('Music Player')).toBeInTheDocument();
});
});
+169
View File
@@ -0,0 +1,169 @@
/**
* `QueuePanel` characterization (Phase F5b).
*
* Includes the §4.4 regression test from the v2 plan — queue DnD must
* NOT use HTML5 native `dataTransfer.setData`/`draggable=true`. The
* project's custom `psy-drop` system sidesteps WebView2's
* `text/plain`-only restriction by avoiding HTML5 DnD entirely; a
* refactor that re-introduces native DnD would silently break Windows.
*/
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
vi.mock('@/api/subsonic', () => ({
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}`),
buildDownloadUrl: vi.fn((id: string) => `https://mock/download/${id}`),
coverArtCacheKey: vi.fn((id: string, size = 256) => `mock:cover:${id}:${size}`),
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),
}));
vi.mock('@/api/lastfm', () => ({
lastfmScrobble: vi.fn(async () => undefined),
lastfmUpdateNowPlaying: vi.fn(async () => undefined),
lastfmGetTrackLoved: vi.fn(async () => false),
lastfmGetAllLovedTracks: vi.fn(async () => []),
}));
vi.mock('@/utils/orbitBulkGuard', () => ({
orbitBulkGuard: vi.fn(async () => true),
}));
import QueuePanel from './QueuePanel';
import { renderWithProviders } from '@/test/helpers/renderWithProviders';
import { usePlayerStore } from '@/store/playerStore';
import { useAuthStore } from '@/store/authStore';
import { resetAllStores } from '@/test/helpers/storeReset';
import { makeTrack, makeTracks } from '@/test/helpers/factories';
import { onInvoke } from '@/test/mocks/tauri';
import { readFileSync } from 'node:fs';
import { join } from 'node:path';
beforeEach(() => {
resetAllStores();
const id = useAuthStore.getState().addServer({
name: 'T', url: 'https://x.test', username: 'u', password: 'p',
});
useAuthStore.getState().setActiveServer(id);
onInvoke('audio_play', () => undefined);
onInvoke('audio_pause', () => undefined);
onInvoke('audio_stop', () => undefined);
onInvoke('audio_seek', () => undefined);
onInvoke('audio_get_state', () => ({ playing: false }));
onInvoke('audio_update_replay_gain', () => undefined);
onInvoke('discord_update_presence', () => undefined);
});
describe('QueuePanel — render surface', () => {
it('renders an empty-queue affordance when the queue is empty', () => {
const { container } = renderWithProviders(<QueuePanel />);
expect(container.querySelector('.queue-panel')).not.toBeNull();
// No queue rows present.
expect(container.querySelectorAll('[data-queue-idx]').length).toBe(0);
});
it('renders one row per queue track with the matching data-queue-idx', () => {
const tracks = makeTracks(3);
usePlayerStore.setState({
queue: tracks,
queueIndex: 0,
currentTrack: tracks[0],
});
const { container } = renderWithProviders(<QueuePanel />);
const rows = container.querySelectorAll<HTMLElement>('[data-queue-idx]');
expect(rows.length).toBe(3);
expect(rows[0]?.getAttribute('data-queue-idx')).toBe('0');
expect(rows[2]?.getAttribute('data-queue-idx')).toBe('2');
});
it('renders each queue row with the track title text', () => {
const t1 = makeTrack({ id: 'q1', title: 'Test Song A' });
const t2 = makeTrack({ id: 'q2', title: 'Test Song B' });
usePlayerStore.setState({
queue: [t1, t2],
queueIndex: 0,
currentTrack: t1,
});
const { getAllByText, getByText } = renderWithProviders(<QueuePanel />);
// Title A appears both in the now-playing section and in the row;
// assert at least one match. Title B only lives in its row.
expect(getAllByText('Test Song A').length).toBeGreaterThan(0);
expect(getByText('Test Song B')).toBeInTheDocument();
});
});
describe('QueuePanel — toolbar', () => {
it('exposes Shuffle / Save Playlist / Load Playlist / Share Queue / Clear via aria-label', () => {
const tracks = makeTracks(3);
usePlayerStore.setState({
queue: tracks,
queueIndex: 0,
currentTrack: tracks[0],
});
const { getByLabelText } = renderWithProviders(<QueuePanel />);
expect(getByLabelText('Shuffle queue')).toBeInTheDocument();
expect(getByLabelText('Save Playlist')).toBeInTheDocument();
expect(getByLabelText('Load Playlist')).toBeInTheDocument();
expect(getByLabelText('Copy queue share link')).toBeInTheDocument();
expect(getByLabelText('Clear')).toBeInTheDocument();
});
it('Shuffle button is disabled when the queue has fewer than 2 tracks', () => {
usePlayerStore.setState({
queue: [makeTrack()],
queueIndex: 0,
currentTrack: makeTrack(),
});
const { getByLabelText } = renderWithProviders(<QueuePanel />);
const shuffle = getByLabelText('Shuffle queue') as HTMLButtonElement;
expect(shuffle.disabled).toBe(true);
});
});
describe('QueuePanel — DnD architecture pin (§4.4 of v2 plan)', () => {
// The custom `psy-drop` event system in DragDropContext sidesteps
// WebView2's `text/plain`-only DnD restriction by avoiding HTML5 native
// DnD entirely. These tests make sure a refactor that "modernises" the
// queue back to native HTML5 DnD breaks loudly.
it('queue rows do not declare draggable=true (no HTML5 native drag)', () => {
usePlayerStore.setState({
queue: makeTracks(3),
queueIndex: 0,
currentTrack: makeTrack(),
});
const { container } = renderWithProviders(<QueuePanel />);
const rows = container.querySelectorAll<HTMLElement>('[data-queue-idx]');
for (const row of rows) {
expect(row.getAttribute('draggable')).not.toBe('true');
}
});
it('the source file has no `dataTransfer.setData` / `dataTransfer.getData` / `onDragStart` / `onDrop` JSX usage', () => {
// Static check — protect against re-introducing native DnD. The
// `dragenter` / `dragover` props are allowed because the document
// listens for them to render the drop indicator without acting as
// a sink for HTML5 payloads.
const source = readFileSync(join(process.cwd(), 'src/components/QueuePanel.tsx'), 'utf8');
expect(source).not.toMatch(/dataTransfer\.setData/);
expect(source).not.toMatch(/dataTransfer\.getData/);
expect(source).not.toMatch(/\bonDragStart\s*=/);
expect(source).not.toMatch(/\bonDrop\s*=/);
});
it('the source file does not use `application/json` MIME anywhere (WebView2 restriction)', () => {
const source = readFileSync(join(process.cwd(), 'src/components/QueuePanel.tsx'), 'utf8');
expect(source).not.toMatch(/application\/json/);
});
});
afterEach(() => {
usePlayerStore.getState().closeContextMenu();
});
+10
View File
@@ -100,6 +100,16 @@ export function installBrowserMocks(): void {
URL.createObjectURL = createObjectUrlMock as unknown as typeof URL.createObjectURL; URL.createObjectURL = createObjectUrlMock as unknown as typeof URL.createObjectURL;
URL.revokeObjectURL = revokeObjectUrlMock as unknown as typeof URL.revokeObjectURL; URL.revokeObjectURL = revokeObjectUrlMock as unknown as typeof URL.revokeObjectURL;
} }
// jsdom lacks scrollIntoView — components that auto-scroll the queue / lists
// crash on mount without this stub.
if (typeof Element !== 'undefined' && !('scrollIntoView' in Element.prototype)) {
Object.defineProperty(Element.prototype, 'scrollIntoView', {
configurable: true,
writable: true,
value: function scrollIntoView(_opts?: ScrollIntoViewOptions | boolean) { /* no-op */ },
});
}
} }
export function resetBrowserMocks(): void { export function resetBrowserMocks(): void {