resources/assets/js/components/playlist/PlaylistContextMenu.spec.ts
import { expect, it } from 'vitest'
import UnitTestCase from '@/__tests__/UnitTestCase'
import factory from '@/__tests__/factory'
import { MessageToasterStub } from '@/__tests__/stubs'
import { screen, waitFor } from '@testing-library/vue'
import { queueStore } from '@/stores/queueStore'
import { songStore } from '@/stores/songStore'
import { userStore } from '@/stores/userStore'
import { playbackService } from '@/services/playbackService'
import { eventBus } from '@/utils/eventBus'
import Router from '@/router'
import PlaylistContextMenu from './PlaylistContextMenu.vue'
new class extends UnitTestCase {
protected test () {
it('edits a standard playlist', async () => {
const playlist = factory('playlist')
await this.renderComponent(playlist)
const emitMock = this.mock(eventBus, 'emit')
await this.user.click(screen.getByText('Edit…'))
expect(emitMock).toHaveBeenCalledWith('MODAL_SHOW_EDIT_PLAYLIST_FORM', playlist)
})
it('edits a smart playlist', async () => {
const playlist = factory.states('smart')('playlist')
await this.renderComponent(playlist)
const emitMock = this.mock(eventBus, 'emit')
await this.user.click(screen.getByText('Edit…'))
expect(emitMock).toHaveBeenCalledWith('MODAL_SHOW_EDIT_PLAYLIST_FORM', playlist)
})
it('deletes a playlist', async () => {
const playlist = factory('playlist')
await this.renderComponent(playlist)
const emitMock = this.mock(eventBus, 'emit')
await this.user.click(screen.getByText('Delete'))
expect(emitMock).toHaveBeenCalledWith('PLAYLIST_DELETE', playlist)
})
it('plays', async () => {
const playlist = factory('playlist')
const songs = factory('song', 3)
const fetchMock = this.mock(songStore, 'fetchForPlaylist').mockResolvedValue(songs)
const queueMock = this.mock(playbackService, 'queueAndPlay')
const goMock = this.mock(Router, 'go')
await this.renderComponent(playlist)
await this.user.click(screen.getByText('Play'))
await waitFor(() => {
expect(fetchMock).toHaveBeenCalledWith(playlist)
expect(queueMock).toHaveBeenCalledWith(songs)
expect(goMock).toHaveBeenCalledWith('queue')
})
})
it('warns if attempting to play an empty playlist', async () => {
const playlist = factory('playlist')
const fetchMock = this.mock(songStore, 'fetchForPlaylist').mockResolvedValue([])
const queueMock = this.mock(playbackService, 'queueAndPlay')
const goMock = this.mock(Router, 'go')
const warnMock = this.mock(MessageToasterStub.value, 'warning')
await this.renderComponent(playlist)
await this.user.click(screen.getByText('Play'))
await waitFor(() => {
expect(fetchMock).toHaveBeenCalledWith(playlist)
expect(queueMock).not.toHaveBeenCalled()
expect(goMock).not.toHaveBeenCalled()
expect(warnMock).toHaveBeenCalledWith('The playlist is empty.')
})
})
it('shuffles', async () => {
const playlist = factory('playlist')
const songs = factory('song', 3)
const fetchMock = this.mock(songStore, 'fetchForPlaylist').mockResolvedValue(songs)
const queueMock = this.mock(playbackService, 'queueAndPlay')
const goMock = this.mock(Router, 'go')
await this.renderComponent(playlist)
await this.user.click(screen.getByText('Shuffle'))
await waitFor(() => {
expect(fetchMock).toHaveBeenCalledWith(playlist)
expect(queueMock).toHaveBeenCalledWith(songs, true)
expect(goMock).toHaveBeenCalledWith('queue')
})
})
it('warns if attempting to shuffle an empty playlist', async () => {
const playlist = factory('playlist')
const fetchMock = this.mock(songStore, 'fetchForPlaylist').mockResolvedValue([])
const queueMock = this.mock(playbackService, 'queueAndPlay')
const goMock = this.mock(Router, 'go')
const warnMock = this.mock(MessageToasterStub.value, 'warning')
await this.renderComponent(playlist)
await this.user.click(screen.getByText('Shuffle'))
await waitFor(() => {
expect(fetchMock).toHaveBeenCalledWith(playlist)
expect(queueMock).not.toHaveBeenCalled()
expect(goMock).not.toHaveBeenCalled()
expect(warnMock).toHaveBeenCalledWith('The playlist is empty.')
})
})
it('queues', async () => {
const playlist = factory('playlist')
const songs = factory('song', 3)
const fetchMock = this.mock(songStore, 'fetchForPlaylist').mockResolvedValue(songs)
const queueMock = this.mock(queueStore, 'queueAfterCurrent')
const toastMock = this.mock(MessageToasterStub.value, 'success')
await this.renderComponent(playlist)
await this.user.click(screen.getByText('Add to Queue'))
await waitFor(() => {
expect(fetchMock).toHaveBeenCalledWith(playlist)
expect(queueMock).toHaveBeenCalledWith(songs)
expect(toastMock).toHaveBeenCalledWith('Playlist added to queue.')
})
})
it('does not have an option to edit or delete if the playlist is not owned by the current user', async () => {
const user = factory('user')
const playlist = factory('playlist', {
user_id: user.id + 1,
})
await this.renderComponent(playlist, user)
expect(screen.queryByText('Edit…')).toBeNull()
expect(screen.queryByText('Delete')).toBeNull()
})
it('opens collaboration form', async () => {
this.enablePlusEdition()
const playlist = factory('playlist')
await this.renderComponent(playlist)
const emitMock = this.mock(eventBus, 'emit')
await this.user.click(screen.getByText('Collaborate…'))
expect(emitMock).toHaveBeenCalledWith('MODAL_SHOW_PLAYLIST_COLLABORATION', playlist)
})
}
private async renderComponent (playlist: Playlist, user: User | null = null) {
userStore.state.current = user || factory('user', {
id: playlist.user_id,
})
this.render(PlaylistContextMenu)
eventBus.emit('PLAYLIST_CONTEXT_MENU_REQUESTED', { pageX: 420, pageY: 42 } as MouseEvent, playlist)
await this.tick(2)
}
}