|
| 1 | +/** |
| 2 | + * Unit tests for lyrics functionality |
| 3 | + * |
| 4 | + * Tests cover: |
| 5 | + * - Lyrics API layer (Tauri command invocation) |
| 6 | + * - Lyrics fetch behavior (track change, visibility gating) |
| 7 | + * - Now Playing view component lyrics state management |
| 8 | + */ |
| 9 | + |
| 10 | +import { beforeEach, describe, expect, it, vi } from 'vitest'; |
| 11 | + |
| 12 | +// Mock Tauri invoke |
| 13 | +const mockInvoke = vi.fn(); |
| 14 | +globalThis.window = { |
| 15 | + __TAURI__: { |
| 16 | + core: { |
| 17 | + invoke: mockInvoke, |
| 18 | + }, |
| 19 | + }, |
| 20 | +}; |
| 21 | + |
| 22 | +// Import after mocks are set up |
| 23 | +const { lyrics } = await import('../js/api/lyrics.js'); |
| 24 | + |
| 25 | +describe('lyrics API', () => { |
| 26 | + beforeEach(() => { |
| 27 | + mockInvoke.mockReset(); |
| 28 | + }); |
| 29 | + |
| 30 | + describe('get', () => { |
| 31 | + it('invokes lyrics_get with correct params', async () => { |
| 32 | + mockInvoke.mockResolvedValue({ |
| 33 | + plain_lyrics: 'Hello world', |
| 34 | + synced_lyrics: null, |
| 35 | + instrumental: false, |
| 36 | + }); |
| 37 | + |
| 38 | + const result = await lyrics.get({ |
| 39 | + artist: 'Queen', |
| 40 | + title: 'Bohemian Rhapsody', |
| 41 | + album: 'A Night at the Opera', |
| 42 | + duration: 354, |
| 43 | + }); |
| 44 | + |
| 45 | + expect(mockInvoke).toHaveBeenCalledWith('lyrics_get', { |
| 46 | + artist: 'Queen', |
| 47 | + title: 'Bohemian Rhapsody', |
| 48 | + album: 'A Night at the Opera', |
| 49 | + duration: 354, |
| 50 | + }); |
| 51 | + |
| 52 | + expect(result).toEqual({ |
| 53 | + plain_lyrics: 'Hello world', |
| 54 | + synced_lyrics: null, |
| 55 | + instrumental: false, |
| 56 | + }); |
| 57 | + }); |
| 58 | + |
| 59 | + it('passes null for missing optional params', async () => { |
| 60 | + mockInvoke.mockResolvedValue(null); |
| 61 | + |
| 62 | + await lyrics.get({ |
| 63 | + artist: 'Queen', |
| 64 | + title: 'Bohemian Rhapsody', |
| 65 | + }); |
| 66 | + |
| 67 | + expect(mockInvoke).toHaveBeenCalledWith('lyrics_get', { |
| 68 | + artist: 'Queen', |
| 69 | + title: 'Bohemian Rhapsody', |
| 70 | + album: null, |
| 71 | + duration: null, |
| 72 | + }); |
| 73 | + }); |
| 74 | + |
| 75 | + it('returns null when backend returns null (no lyrics)', async () => { |
| 76 | + mockInvoke.mockResolvedValue(null); |
| 77 | + |
| 78 | + const result = await lyrics.get({ |
| 79 | + artist: 'Unknown', |
| 80 | + title: 'Unknown', |
| 81 | + }); |
| 82 | + |
| 83 | + expect(result).toBeNull(); |
| 84 | + }); |
| 85 | + |
| 86 | + it('throws ApiError on invoke failure', async () => { |
| 87 | + mockInvoke.mockRejectedValue('Database error'); |
| 88 | + |
| 89 | + await expect( |
| 90 | + lyrics.get({ artist: 'A', title: 'B' }), |
| 91 | + ).rejects.toThrow(); |
| 92 | + }); |
| 93 | + }); |
| 94 | + |
| 95 | + describe('clearCache', () => { |
| 96 | + it('invokes lyrics_clear_cache', async () => { |
| 97 | + mockInvoke.mockResolvedValue(undefined); |
| 98 | + |
| 99 | + await lyrics.clearCache(); |
| 100 | + |
| 101 | + expect(mockInvoke).toHaveBeenCalledWith('lyrics_clear_cache'); |
| 102 | + }); |
| 103 | + }); |
| 104 | +}); |
| 105 | + |
| 106 | +describe('now-playing-view lyrics state', () => { |
| 107 | + /** |
| 108 | + * Creates a minimal test instance of the now-playing-view component |
| 109 | + * with mocked Alpine.js $store and $watch |
| 110 | + */ |
| 111 | + function createTestComponent() { |
| 112 | + const watchers = {}; |
| 113 | + const component = { |
| 114 | + // Lyrics state |
| 115 | + lyrics: null, |
| 116 | + lyricsLoading: false, |
| 117 | + _lyricsTrackKey: null, |
| 118 | + _lyricsFetchId: 0, |
| 119 | + |
| 120 | + // Mock Alpine $store |
| 121 | + $store: { |
| 122 | + player: { currentTrack: null }, |
| 123 | + ui: { view: 'library' }, |
| 124 | + queue: { playOrderItems: [], items: [] }, |
| 125 | + }, |
| 126 | + |
| 127 | + // Mock Alpine $watch |
| 128 | + $watch(key, callback) { |
| 129 | + watchers[key] = callback; |
| 130 | + }, |
| 131 | + |
| 132 | + // Mock Alpine $refs |
| 133 | + $refs: {}, |
| 134 | + |
| 135 | + // Trigger a watcher manually |
| 136 | + _trigger(key) { |
| 137 | + if (watchers[key]) watchers[key](); |
| 138 | + }, |
| 139 | + }; |
| 140 | + |
| 141 | + // Import and bind the methods from the actual module |
| 142 | + // Instead, we replicate the core logic for unit testing |
| 143 | + component._onTrackOrViewChange = function () { |
| 144 | + const track = this.$store.player.currentTrack; |
| 145 | + const isVisible = this.$store.ui.view === 'nowPlaying'; |
| 146 | + |
| 147 | + if (!track || !isVisible) return; |
| 148 | + |
| 149 | + const trackKey = `${track.artist || ''}::${track.title || ''}`; |
| 150 | + if (trackKey === this._lyricsTrackKey) return; |
| 151 | + |
| 152 | + this._lyricsTrackKey = trackKey; |
| 153 | + this._fetchLyrics(track); |
| 154 | + }; |
| 155 | + |
| 156 | + component._fetchLyrics = async function (track) { |
| 157 | + const fetchId = ++this._lyricsFetchId; |
| 158 | + this.lyrics = null; |
| 159 | + this.lyricsLoading = true; |
| 160 | + |
| 161 | + try { |
| 162 | + const durationSecs = track.duration ? Math.round(track.duration / 1000) : null; |
| 163 | + const result = await lyrics.get({ |
| 164 | + artist: track.artist || '', |
| 165 | + title: track.title || '', |
| 166 | + album: track.album || '', |
| 167 | + duration: durationSecs, |
| 168 | + }); |
| 169 | + |
| 170 | + if (this._lyricsFetchId !== fetchId) return; |
| 171 | + |
| 172 | + if (result && result.plain_lyrics) { |
| 173 | + this.lyrics = result.plain_lyrics; |
| 174 | + } else { |
| 175 | + this.lyrics = null; |
| 176 | + } |
| 177 | + } catch (_error) { |
| 178 | + if (this._lyricsFetchId !== fetchId) return; |
| 179 | + this.lyrics = null; |
| 180 | + } finally { |
| 181 | + if (this._lyricsFetchId === fetchId) { |
| 182 | + this.lyricsLoading = false; |
| 183 | + } |
| 184 | + } |
| 185 | + }; |
| 186 | + |
| 187 | + // Wire up watches like init() would |
| 188 | + component.$watch('$store.player.currentTrack', () => component._onTrackOrViewChange()); |
| 189 | + component.$watch('$store.ui.view', () => component._onTrackOrViewChange()); |
| 190 | + |
| 191 | + return component; |
| 192 | + } |
| 193 | + |
| 194 | + beforeEach(() => { |
| 195 | + mockInvoke.mockReset(); |
| 196 | + }); |
| 197 | + |
| 198 | + it('does not fetch lyrics when view is not nowPlaying', () => { |
| 199 | + const comp = createTestComponent(); |
| 200 | + comp.$store.player.currentTrack = { id: 1, artist: 'Queen', title: 'Test', duration: 300000 }; |
| 201 | + comp.$store.ui.view = 'library'; |
| 202 | + |
| 203 | + comp._trigger('$store.player.currentTrack'); |
| 204 | + |
| 205 | + expect(mockInvoke).not.toHaveBeenCalled(); |
| 206 | + expect(comp.lyrics).toBeNull(); |
| 207 | + }); |
| 208 | + |
| 209 | + it('fetches lyrics when track changes and view is nowPlaying', async () => { |
| 210 | + const comp = createTestComponent(); |
| 211 | + mockInvoke.mockResolvedValue({ |
| 212 | + plain_lyrics: 'Some lyrics', |
| 213 | + synced_lyrics: null, |
| 214 | + instrumental: false, |
| 215 | + }); |
| 216 | + |
| 217 | + comp.$store.ui.view = 'nowPlaying'; |
| 218 | + comp.$store.player.currentTrack = { |
| 219 | + id: 1, |
| 220 | + artist: 'Queen', |
| 221 | + title: 'Bohemian Rhapsody', |
| 222 | + album: 'A Night at the Opera', |
| 223 | + duration: 354000, |
| 224 | + }; |
| 225 | + |
| 226 | + comp._trigger('$store.player.currentTrack'); |
| 227 | + |
| 228 | + // Wait for async fetch |
| 229 | + await vi.waitFor(() => expect(comp.lyricsLoading).toBe(false)); |
| 230 | + |
| 231 | + expect(mockInvoke).toHaveBeenCalledWith('lyrics_get', { |
| 232 | + artist: 'Queen', |
| 233 | + title: 'Bohemian Rhapsody', |
| 234 | + album: 'A Night at the Opera', |
| 235 | + duration: 354, |
| 236 | + }); |
| 237 | + expect(comp.lyrics).toBe('Some lyrics'); |
| 238 | + }); |
| 239 | + |
| 240 | + it('fetches lyrics when switching to nowPlaying view with a track', async () => { |
| 241 | + const comp = createTestComponent(); |
| 242 | + mockInvoke.mockResolvedValue({ |
| 243 | + plain_lyrics: 'Lyrics here', |
| 244 | + synced_lyrics: null, |
| 245 | + instrumental: false, |
| 246 | + }); |
| 247 | + |
| 248 | + comp.$store.player.currentTrack = { id: 1, artist: 'Queen', title: 'Test', duration: 200000 }; |
| 249 | + comp.$store.ui.view = 'nowPlaying'; |
| 250 | + |
| 251 | + comp._trigger('$store.ui.view'); |
| 252 | + |
| 253 | + await vi.waitFor(() => expect(comp.lyricsLoading).toBe(false)); |
| 254 | + |
| 255 | + expect(mockInvoke).toHaveBeenCalled(); |
| 256 | + expect(comp.lyrics).toBe('Lyrics here'); |
| 257 | + }); |
| 258 | + |
| 259 | + it('sets lyrics to null when backend returns null', async () => { |
| 260 | + const comp = createTestComponent(); |
| 261 | + mockInvoke.mockResolvedValue(null); |
| 262 | + |
| 263 | + comp.$store.ui.view = 'nowPlaying'; |
| 264 | + comp.$store.player.currentTrack = { |
| 265 | + id: 1, |
| 266 | + artist: 'Unknown', |
| 267 | + title: 'Unknown', |
| 268 | + duration: 100000, |
| 269 | + }; |
| 270 | + |
| 271 | + comp._trigger('$store.player.currentTrack'); |
| 272 | + |
| 273 | + await vi.waitFor(() => expect(comp.lyricsLoading).toBe(false)); |
| 274 | + |
| 275 | + expect(comp.lyrics).toBeNull(); |
| 276 | + }); |
| 277 | + |
| 278 | + it('does not re-fetch for the same track', async () => { |
| 279 | + const comp = createTestComponent(); |
| 280 | + mockInvoke.mockResolvedValue({ |
| 281 | + plain_lyrics: 'Lyrics', |
| 282 | + synced_lyrics: null, |
| 283 | + instrumental: false, |
| 284 | + }); |
| 285 | + |
| 286 | + comp.$store.ui.view = 'nowPlaying'; |
| 287 | + comp.$store.player.currentTrack = { id: 1, artist: 'Queen', title: 'Test', duration: 200000 }; |
| 288 | + |
| 289 | + comp._trigger('$store.player.currentTrack'); |
| 290 | + await vi.waitFor(() => expect(comp.lyricsLoading).toBe(false)); |
| 291 | + |
| 292 | + expect(mockInvoke).toHaveBeenCalledTimes(1); |
| 293 | + |
| 294 | + // Trigger again with same artist+title |
| 295 | + comp._trigger('$store.player.currentTrack'); |
| 296 | + |
| 297 | + expect(mockInvoke).toHaveBeenCalledTimes(1); |
| 298 | + }); |
| 299 | + |
| 300 | + it('clears lyrics before fetching for a new track', async () => { |
| 301 | + const comp = createTestComponent(); |
| 302 | + |
| 303 | + // First track has lyrics |
| 304 | + mockInvoke.mockResolvedValueOnce({ |
| 305 | + plain_lyrics: 'First', |
| 306 | + synced_lyrics: null, |
| 307 | + instrumental: false, |
| 308 | + }); |
| 309 | + comp.$store.ui.view = 'nowPlaying'; |
| 310 | + comp.$store.player.currentTrack = { id: 1, artist: 'A', title: 'Song1', duration: 200000 }; |
| 311 | + comp._trigger('$store.player.currentTrack'); |
| 312 | + await vi.waitFor(() => expect(comp.lyricsLoading).toBe(false)); |
| 313 | + expect(comp.lyrics).toBe('First'); |
| 314 | + |
| 315 | + // Switch to second track — lyrics should clear immediately |
| 316 | + mockInvoke.mockResolvedValueOnce({ |
| 317 | + plain_lyrics: 'Second', |
| 318 | + synced_lyrics: null, |
| 319 | + instrumental: false, |
| 320 | + }); |
| 321 | + comp.$store.player.currentTrack = { id: 2, artist: 'B', title: 'Song2', duration: 300000 }; |
| 322 | + comp._trigger('$store.player.currentTrack'); |
| 323 | + |
| 324 | + // During loading, lyrics should be null (cleared) |
| 325 | + expect(comp.lyrics).toBeNull(); |
| 326 | + expect(comp.lyricsLoading).toBe(true); |
| 327 | + |
| 328 | + await vi.waitFor(() => expect(comp.lyricsLoading).toBe(false)); |
| 329 | + expect(comp.lyrics).toBe('Second'); |
| 330 | + }); |
| 331 | + |
| 332 | + it('handles fetch error gracefully', async () => { |
| 333 | + const comp = createTestComponent(); |
| 334 | + mockInvoke.mockRejectedValue(new Error('Network error')); |
| 335 | + |
| 336 | + comp.$store.ui.view = 'nowPlaying'; |
| 337 | + comp.$store.player.currentTrack = { id: 1, artist: 'A', title: 'B', duration: 100000 }; |
| 338 | + comp._trigger('$store.player.currentTrack'); |
| 339 | + |
| 340 | + await vi.waitFor(() => expect(comp.lyricsLoading).toBe(false)); |
| 341 | + |
| 342 | + expect(comp.lyrics).toBeNull(); |
| 343 | + }); |
| 344 | +}); |
0 commit comments