import { cloneDeep } from 'lodash'; import { issuableTypes } from '~/boards/constants'; import * as types from '~/boards/stores/mutation_types'; import mutations from '~/boards/stores/mutations'; import defaultState from '~/boards/stores/state'; import { mockBoard, mockLists, rawIssue, mockIssue, mockIssue2, mockGroupProjects, labels, mockList, } from '../mock_data'; describe('Board Store Mutations', () => { let state; const initialBoardListsState = { 'gid://gitlab/List/1': mockLists[0], 'gid://gitlab/List/2': mockLists[1], }; const setBoardsListsState = () => { state = cloneDeep({ ...state, boardItemsByListId: { 'gid://gitlab/List/1': [mockIssue.id] }, boardLists: { 'gid://gitlab/List/1': mockList }, }); }; beforeEach(() => { state = defaultState(); }); describe('REQUEST_CURRENT_BOARD', () => { it('Should set isBoardLoading state to true', () => { mutations[types.REQUEST_CURRENT_BOARD](state); expect(state.isBoardLoading).toBe(true); }); }); describe('RECEIVE_BOARD_SUCCESS', () => { it('Should set board to state', () => { mutations[types.RECEIVE_BOARD_SUCCESS](state, mockBoard); expect(state.board).toEqual({ ...mockBoard, labels: mockBoard.labels.nodes, }); }); }); describe('RECEIVE_BOARD_FAILURE', () => { it('Should set error in state', () => { mutations[types.RECEIVE_BOARD_FAILURE](state); expect(state.error).toEqual( 'An error occurred while fetching the board. Please reload the page.', ); }); }); describe('SET_INITIAL_BOARD_DATA', () => { it('Should set initial Boards data to state', () => { const allowSubEpics = true; const boardId = 1; const fullPath = 'gitlab-org'; const boardType = 'group'; const disabled = false; const issuableType = issuableTypes.issue; mutations[types.SET_INITIAL_BOARD_DATA](state, { allowSubEpics, boardId, fullPath, boardType, disabled, issuableType, }); expect(state.allowSubEpics).toBe(allowSubEpics); expect(state.boardId).toEqual(boardId); expect(state.fullPath).toEqual(fullPath); expect(state.boardType).toEqual(boardType); expect(state.disabled).toEqual(disabled); expect(state.issuableType).toEqual(issuableType); }); }); describe('SET_BOARD_CONFIG', () => { it('Should set board config data o state', () => { const boardConfig = { milestoneId: 1, milestoneTitle: 'Milestone 1', }; mutations[types.SET_BOARD_CONFIG](state, boardConfig); expect(state.boardConfig).toEqual(boardConfig); }); }); describe('RECEIVE_BOARD_LISTS_SUCCESS', () => { it('Should set boardLists to state', () => { mutations[types.RECEIVE_BOARD_LISTS_SUCCESS](state, initialBoardListsState); expect(state.boardLists).toEqual(initialBoardListsState); }); }); describe('RECEIVE_BOARD_LISTS_FAILURE', () => { it('Should set error in state', () => { mutations[types.RECEIVE_BOARD_LISTS_FAILURE](state); expect(state.error).toEqual( 'An error occurred while fetching the board lists. Please reload the page.', ); }); }); describe('SET_ACTIVE_ID', () => { const expected = { id: 1, sidebarType: '' }; beforeEach(() => { mutations.SET_ACTIVE_ID(state, expected); }); it('updates activeListId to be the value that is passed', () => { expect(state.activeId).toBe(expected.id); }); it('updates sidebarType to be the value that is passed', () => { expect(state.sidebarType).toBe(expected.sidebarType); }); }); describe('SET_FILTERS', () => { it('updates filterParams to be the value that is passed', () => { const filterParams = { labelName: 'label' }; mutations.SET_FILTERS(state, filterParams); expect(state.filterParams).toBe(filterParams); }); }); describe('CREATE_LIST_FAILURE', () => { it('sets error message', () => { mutations.CREATE_LIST_FAILURE(state); expect(state.error).toEqual('An error occurred while creating the list. Please try again.'); }); }); describe('RECEIVE_LABELS_REQUEST', () => { it('sets labelsLoading on state', () => { mutations.RECEIVE_LABELS_REQUEST(state); expect(state.labelsLoading).toEqual(true); }); }); describe('RECEIVE_LABELS_SUCCESS', () => { it('sets labels on state', () => { mutations.RECEIVE_LABELS_SUCCESS(state, labels); expect(state.labels).toEqual(labels); expect(state.labelsLoading).toEqual(false); }); }); describe('RECEIVE_LABELS_FAILURE', () => { it('sets error message', () => { mutations.RECEIVE_LABELS_FAILURE(state); expect(state.error).toEqual( 'An error occurred while fetching labels. Please reload the page.', ); expect(state.labelsLoading).toEqual(false); }); }); describe('GENERATE_DEFAULT_LISTS_FAILURE', () => { it('sets error message', () => { mutations.GENERATE_DEFAULT_LISTS_FAILURE(state); expect(state.error).toEqual( 'An error occurred while generating lists. Please reload the page.', ); }); }); describe('RECEIVE_ADD_LIST_SUCCESS', () => { it('adds list to boardLists state', () => { mutations.RECEIVE_ADD_LIST_SUCCESS(state, mockLists[0]); expect(state.boardLists).toEqual({ [mockLists[0].id]: mockLists[0], }); }); }); describe('MOVE_LISTS', () => { it('updates the positions of board lists', () => { state = { ...state, boardLists: initialBoardListsState, }; mutations.MOVE_LISTS(state, [ { listId: mockLists[0].id, position: 1, }, { listId: mockLists[1].id, position: 0, }, ]); expect(state.boardLists[mockLists[0].id].position).toBe(1); expect(state.boardLists[mockLists[1].id].position).toBe(0); }); }); describe('TOGGLE_LIST_COLLAPSED', () => { it('updates collapsed attribute of list in boardLists state', () => { const listId = 'gid://gitlab/List/1'; state = { ...state, boardLists: { [listId]: mockLists[0], }, }; expect(state.boardLists[listId].collapsed).toEqual(false); mutations.TOGGLE_LIST_COLLAPSED(state, { listId, collapsed: true }); expect(state.boardLists[listId].collapsed).toEqual(true); }); }); describe('REMOVE_LIST', () => { it('removes list from boardLists', () => { const [list, secondList] = mockLists; const expected = { [secondList.id]: secondList, }; state = { ...state, boardLists: { ...initialBoardListsState }, }; mutations[types.REMOVE_LIST](state, list.id); expect(state.boardLists).toEqual(expected); }); }); describe('REMOVE_LIST_FAILURE', () => { it('restores lists from backup', () => { const backupLists = { ...initialBoardListsState }; mutations[types.REMOVE_LIST_FAILURE](state, backupLists); expect(state.boardLists).toEqual(backupLists); }); it('sets error state', () => { const backupLists = { ...initialBoardListsState }; state = { ...state, error: undefined, }; mutations[types.REMOVE_LIST_FAILURE](state, backupLists); expect(state.error).toEqual('An error occurred while removing the list. Please try again.'); }); }); describe('RESET_ISSUES', () => { it('should remove issues from boardItemsByListId state', () => { const boardItemsByListId = { 'gid://gitlab/List/1': [mockIssue.id], }; state = { ...state, boardItemsByListId, }; mutations[types.RESET_ISSUES](state); expect(state.boardItemsByListId).toEqual({ 'gid://gitlab/List/1': [] }); }); }); describe('REQUEST_ITEMS_FOR_LIST', () => { const listId = 'gid://gitlab/List/1'; const boardItemsByListId = { [listId]: [mockIssue.id], }; it.each` fetchNext | isLoading | isLoadingMore ${true} | ${undefined} | ${true} ${false} | ${true} | ${undefined} `( 'sets isLoading to $isLoading and isLoadingMore to $isLoadingMore when fetchNext is $fetchNext', ({ fetchNext, isLoading, isLoadingMore }) => { state = { ...state, boardItemsByListId, listsFlags: { [listId]: {}, }, }; mutations[types.REQUEST_ITEMS_FOR_LIST](state, { listId, fetchNext }); expect(state.listsFlags[listId].isLoading).toBe(isLoading); expect(state.listsFlags[listId].isLoadingMore).toBe(isLoadingMore); }, ); }); describe('RECEIVE_ITEMS_FOR_LIST_SUCCESS', () => { it('updates boardItemsByListId and issues on state', () => { const listIssues = { 'gid://gitlab/List/1': [mockIssue.id], }; const issues = { 1: mockIssue, }; state = { ...state, boardItemsByListId: { 'gid://gitlab/List/1': [], }, boardItems: {}, boardLists: initialBoardListsState, }; const listPageInfo = { 'gid://gitlab/List/1': { endCursor: '', hasNextPage: false, }, }; mutations.RECEIVE_ITEMS_FOR_LIST_SUCCESS(state, { listItems: { listData: listIssues, boardItems: issues }, listPageInfo, listId: 'gid://gitlab/List/1', }); expect(state.boardItemsByListId).toEqual(listIssues); expect(state.boardItems).toEqual(issues); }); }); describe('RECEIVE_ITEMS_FOR_LIST_FAILURE', () => { it('sets error message', () => { state = { ...state, boardLists: initialBoardListsState, error: undefined, }; const listId = 'gid://gitlab/List/1'; mutations.RECEIVE_ITEMS_FOR_LIST_FAILURE(state, listId); expect(state.error).toEqual( 'An error occurred while fetching the board issues. Please reload the page.', ); }); }); describe('UPDATE_BOARD_ITEM_BY_ID', () => { const issueId = '1'; const prop = 'id'; const value = '2'; const issue = { [issueId]: { id: 1, title: 'Issue' } }; beforeEach(() => { state = { ...state, error: undefined, boardItems: { ...issue, }, }; }); describe('when the issue is in state', () => { it('updates the property of the correct issue', () => { mutations.UPDATE_BOARD_ITEM_BY_ID(state, { itemId: issueId, prop, value, }); expect(state.boardItems[issueId]).toEqual({ ...issue[issueId], id: '2' }); }); }); describe('when the issue is not in state', () => { it('throws an error', () => { expect(() => { mutations.UPDATE_BOARD_ITEM_BY_ID(state, { itemId: '3', prop, value, }); }).toThrow(new Error('No issue found.')); }); }); }); describe('MUTATE_ISSUE_SUCCESS', () => { it('updates issue in issues state', () => { const issues = { [rawIssue.id]: { id: rawIssue.id }, }; state = { ...state, boardItems: issues, }; mutations.MUTATE_ISSUE_SUCCESS(state, { issue: rawIssue, }); expect(state.boardItems).toEqual({ [mockIssue.id]: mockIssue }); }); }); describe('UPDATE_BOARD_ITEM', () => { it('updates the given issue in state.boardItems', () => { const updatedIssue = { id: 'some_gid', foo: 'bar' }; state = { boardItems: { some_gid: { id: 'some_gid' } } }; mutations.UPDATE_BOARD_ITEM(state, updatedIssue); expect(state.boardItems.some_gid).toEqual(updatedIssue); }); }); describe('REMOVE_BOARD_ITEM', () => { it('removes the given issue from state.boardItems', () => { state = { boardItems: { some_gid: {}, some_gid2: {} } }; mutations.REMOVE_BOARD_ITEM(state, 'some_gid'); expect(state.boardItems).toEqual({ some_gid2: {} }); }); }); describe('ADD_BOARD_ITEM_TO_LIST', () => { beforeEach(() => { setBoardsListsState(); }); it.each([ [ 'at position 0 by default', { payload: { itemId: mockIssue2.id, listId: mockList.id, }, listState: [mockIssue2.id, mockIssue.id], }, ], [ 'at a given position', { payload: { itemId: mockIssue2.id, listId: mockList.id, atIndex: 1, }, listState: [mockIssue.id, mockIssue2.id], }, ], [ "below the issue with id of 'moveBeforeId'", { payload: { itemId: mockIssue2.id, listId: mockList.id, moveBeforeId: mockIssue.id, }, listState: [mockIssue.id, mockIssue2.id], }, ], [ "above the issue with id of 'moveAfterId'", { payload: { itemId: mockIssue2.id, listId: mockList.id, moveAfterId: mockIssue.id, }, listState: [mockIssue2.id, mockIssue.id], }, ], ])(`inserts an item into a list %s`, (_, { payload, listState }) => { mutations.ADD_BOARD_ITEM_TO_LIST(state, payload); expect(state.boardItemsByListId[payload.listId]).toEqual(listState); }); it("updates the list's items count", () => { expect(state.boardLists['gid://gitlab/List/1'].issuesCount).toBe(1); mutations.ADD_BOARD_ITEM_TO_LIST(state, { itemId: mockIssue2.id, listId: mockList.id, }); expect(state.boardLists['gid://gitlab/List/1'].issuesCount).toBe(2); }); }); describe('REMOVE_BOARD_ITEM_FROM_LIST', () => { beforeEach(() => { setBoardsListsState(); }); it("removes an item from a list and updates the list's items count", () => { expect(state.boardLists['gid://gitlab/List/1'].issuesCount).toBe(1); expect(state.boardItemsByListId['gid://gitlab/List/1']).toContain(mockIssue.id); mutations.REMOVE_BOARD_ITEM_FROM_LIST(state, { itemId: mockIssue.id, listId: mockList.id, }); expect(state.boardItemsByListId['gid://gitlab/List/1']).not.toContain(mockIssue.id); expect(state.boardLists['gid://gitlab/List/1'].issuesCount).toBe(0); }); }); describe('SET_ASSIGNEE_LOADING', () => { it('sets isSettingAssignees to the value passed', () => { mutations.SET_ASSIGNEE_LOADING(state, true); expect(state.isSettingAssignees).toBe(true); }); }); describe('REQUEST_GROUP_PROJECTS', () => { it('Should set isLoading in groupProjectsFlags to true in state when fetchNext is false', () => { mutations[types.REQUEST_GROUP_PROJECTS](state, false); expect(state.groupProjectsFlags.isLoading).toBe(true); }); it('Should set isLoadingMore in groupProjectsFlags to true in state when fetchNext is true', () => { mutations[types.REQUEST_GROUP_PROJECTS](state, true); expect(state.groupProjectsFlags.isLoadingMore).toBe(true); }); }); describe('RECEIVE_GROUP_PROJECTS_SUCCESS', () => { it('Should set groupProjects and pageInfo to state and isLoading in groupProjectsFlags to false', () => { mutations[types.RECEIVE_GROUP_PROJECTS_SUCCESS](state, { projects: mockGroupProjects, pageInfo: { hasNextPage: false }, }); expect(state.groupProjects).toEqual(mockGroupProjects); expect(state.groupProjectsFlags.isLoading).toBe(false); expect(state.groupProjectsFlags.pageInfo).toEqual({ hasNextPage: false }); }); it('Should merge projects in groupProjects in state when fetchNext is true', () => { state = { ...state, groupProjects: [mockGroupProjects[0]], }; mutations[types.RECEIVE_GROUP_PROJECTS_SUCCESS](state, { projects: [mockGroupProjects[1]], fetchNext: true, }); expect(state.groupProjects).toEqual(mockGroupProjects); }); }); describe('RECEIVE_GROUP_PROJECTS_FAILURE', () => { it('Should set error in state and isLoading in groupProjectsFlags to false', () => { mutations[types.RECEIVE_GROUP_PROJECTS_FAILURE](state); expect(state.error).toEqual( 'An error occurred while fetching group projects. Please try again.', ); expect(state.groupProjectsFlags.isLoading).toBe(false); }); }); describe('SET_SELECTED_PROJECT', () => { it('Should set selectedProject to state', () => { mutations[types.SET_SELECTED_PROJECT](state, mockGroupProjects[0]); expect(state.selectedProject).toEqual(mockGroupProjects[0]); }); }); describe('ADD_BOARD_ITEM_TO_SELECTION', () => { it('Should add boardItem to selectedBoardItems state', () => { expect(state.selectedBoardItems).toEqual([]); mutations[types.ADD_BOARD_ITEM_TO_SELECTION](state, mockIssue); expect(state.selectedBoardItems).toEqual([mockIssue]); }); }); describe('REMOVE_BOARD_ITEM_FROM_SELECTION', () => { it('Should remove boardItem to selectedBoardItems state', () => { state.selectedBoardItems = [mockIssue]; mutations[types.REMOVE_BOARD_ITEM_FROM_SELECTION](state, mockIssue); expect(state.selectedBoardItems).toEqual([]); }); }); describe('RESET_BOARD_ITEM_SELECTION', () => { it('Should reset selectedBoardItems state', () => { state.selectedBoardItems = [mockIssue]; mutations[types.RESET_BOARD_ITEM_SELECTION](state, mockIssue); expect(state.selectedBoardItems).toEqual([]); }); }); describe('SET_ERROR', () => { it('Should set error state', () => { state.error = undefined; mutations[types.SET_ERROR](state, 'mayday'); expect(state.error).toBe('mayday'); }); }); });