koel/resources/assets/js/components/screens/GenreScreen.spec.ts

import { expect, it } from 'vitest'
import { fireEvent, waitFor } from '@testing-library/vue'
import factory from '@/__tests__/factory'
import UnitTestCase from '@/__tests__/UnitTestCase'
import { genreStore, songStore } from '@/stores'
import { playbackService } from '@/services'
import GenreScreen from './GenreScreen.vue'

new class extends UnitTestCase {
  private async renderComponent (genre?: Genre, songs?: Song[]) {
    genre = genre || factory<Genre>('genre')

    const fetchGenreMock = this.mock(genreStore, 'fetchOne').mockResolvedValue(genre)
    const paginateMock = this.mock(songStore, 'paginateForGenre').mockResolvedValue({
      nextPage: 2,
      songs: songs || factory<Song>('song', 13)
    })

    await this.router.activateRoute({
      path: `genres/${genre.name}`,
      screen: 'Genre'
    }, { name: genre.name })

    const rendered = this.render(GenreScreen, {
      global: {
        stubs: {
          SongList: this.stub('song-list')
        }
      }
    })

    await waitFor(() => {
      expect(fetchGenreMock).toHaveBeenCalledWith(genre.name)
      expect(paginateMock).toHaveBeenCalledWith(genre.name, 'title', 'asc', 1)
    })

    await this.tick(2)

    return rendered
  }

  protected test () {
    it('renders the song list', async () => {
      const { getByTestId } = await this.renderComponent()

      expect(getByTestId('song-list')).toBeTruthy()
    })

    it('shuffles all songs without fetching if genre has <= 500 songs', async () => {
      const genre = factory<Genre>('genre', { song_count: 10 })
      const songs = factory<Song>('song', 10)
      const playbackMock = this.mock(playbackService, 'queueAndPlay')

      const { getByTitle } = await this.renderComponent(genre, songs)

      await fireEvent.click(getByTitle('Shuffle all songs'))

      expect(playbackMock).toHaveBeenCalledWith(songs, true)
    })

    it('fetches and shuffles all songs if genre has > 500 songs', async () => {
      const genre = factory<Genre>('genre', { song_count: 501 })
      const songs = factory<Song>('song', 10) // we don't really need to generate 501 songs
      const playbackMock = this.mock(playbackService, 'queueAndPlay')
      const fetchMock = this.mock(songStore, 'fetchRandomForGenre').mockResolvedValue(songs)

      const { getByTitle } = await this.renderComponent(genre, songs)

      await fireEvent.click(getByTitle('Shuffle all songs'))

      await waitFor(() => {
        expect(fetchMock).toHaveBeenCalledWith(genre, 500)
        expect(playbackMock).toHaveBeenCalledWith(songs)
      })
    })
  }
}