import MockAdapter from 'axios-mock-adapter'; import { act, render, waitFor, fireEvent, within, } from '@testing-library/react'; import userEvent from '@testing-library/user-event'; import { IntlProvider } from '@edx/frontend-platform/i18n'; import { AppProvider } from '@edx/frontend-platform/react'; import { initializeMockApp } from '@edx/frontend-platform'; import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth'; import { cloneDeep, set } from 'lodash'; import { getCourseSectionVerticalApiUrl, getCourseUnitApiUrl, getCourseVerticalChildrenApiUrl, getXBlockBaseApiUrl, postXBlockBaseApiUrl, } from './data/api'; import { editCourseUnitVisibilityAndData, fetchCourseSectionVerticalData, fetchCourseUnitQuery, fetchCourseVerticalChildrenData, } from './data/thunk'; import initializeStore from '../store'; import { courseCreateXblockMock, courseSectionVerticalMock, courseUnitIndexMock, courseUnitMock, courseVerticalChildrenMock, } from './__mocks__'; import { executeThunk } from '../utils'; import CourseUnit from './CourseUnit'; import headerNavigationsMessages from './header-navigations/messages'; import headerTitleMessages from './header-title/messages'; import courseSequenceMessages from './course-sequence/messages'; import sidebarMessages from './sidebar/messages'; import { extractCourseUnitId } from './sidebar/utils'; import deleteModalMessages from '../generic/delete-modal/messages'; import courseXBlockMessages from './course-xblock/messages'; import addComponentMessages from './add-component/messages'; import { PUBLISH_TYPES, UNIT_VISIBILITY_STATES } from './constants'; let axiosMock; let store; const courseId = '123'; const blockId = '567890'; const unitDisplayName = courseUnitIndexMock.metadata.display_name; const mockedUsedNavigate = jest.fn(); const userName = 'edx'; jest.mock('react-router-dom', () => ({ ...jest.requireActual('react-router-dom'), useParams: () => ({ blockId }), useNavigate: () => mockedUsedNavigate, })); const RootWrapper = () => ( ); describe('', () => { beforeEach(async () => { initializeMockApp({ authenticatedUser: { userId: 3, username: 'abc123', administrator: true, roles: [], }, }); store = initializeStore(); axiosMock = new MockAdapter(getAuthenticatedHttpClient()); axiosMock .onGet(getCourseUnitApiUrl(courseId)) .reply(200, courseUnitIndexMock); await executeThunk(fetchCourseUnitQuery(courseId), store.dispatch); axiosMock .onGet(getCourseSectionVerticalApiUrl(blockId)) .reply(200, courseSectionVerticalMock); await executeThunk(fetchCourseSectionVerticalData(blockId), store.dispatch); axiosMock .onGet(getCourseVerticalChildrenApiUrl(blockId)) .reply(200, courseVerticalChildrenMock); await executeThunk(fetchCourseVerticalChildrenData(blockId), store.dispatch); }); it('render CourseUnit component correctly', async () => { const { getByText, getByRole } = render(); const currentSectionName = courseUnitIndexMock.ancestor_info.ancestors[1].display_name; const currentSubSectionName = courseUnitIndexMock.ancestor_info.ancestors[1].display_name; await waitFor(() => { expect(getByText(unitDisplayName)).toBeInTheDocument(); expect(getByRole('button', { name: headerTitleMessages.altButtonEdit.defaultMessage })).toBeInTheDocument(); expect(getByRole('button', { name: headerTitleMessages.altButtonSettings.defaultMessage })).toBeInTheDocument(); expect(getByRole('button', { name: headerNavigationsMessages.viewLiveButton.defaultMessage })).toBeInTheDocument(); expect(getByRole('button', { name: headerNavigationsMessages.previewButton.defaultMessage })).toBeInTheDocument(); expect(getByRole('button', { name: currentSectionName })).toBeInTheDocument(); expect(getByRole('button', { name: currentSubSectionName })).toBeInTheDocument(); }); }); it('handles CourseUnit header action buttons', async () => { const { open } = window; window.open = jest.fn(); const { getByRole } = render(); const { draft_preview_link: draftPreviewLink, published_preview_link: publishedPreviewLink, } = courseSectionVerticalMock; await waitFor(() => { const viewLiveButton = getByRole('button', { name: headerNavigationsMessages.viewLiveButton.defaultMessage }); userEvent.click(viewLiveButton); expect(window.open).toHaveBeenCalled(); expect(window.open).toHaveBeenCalledWith(publishedPreviewLink, '_blank'); const previewButton = getByRole('button', { name: headerNavigationsMessages.previewButton.defaultMessage }); userEvent.click(previewButton); expect(window.open).toHaveBeenCalled(); expect(window.open).toHaveBeenCalledWith(draftPreviewLink, '_blank'); }); window.open = open; }); it('checks courseUnit title changing when edit query is successfully', async () => { const { findByText, queryByRole, getByRole, } = render(); let editTitleButton = null; let titleEditField = null; const newDisplayName = `${unitDisplayName} new`; axiosMock .onPost(getXBlockBaseApiUrl(blockId, { metadata: { display_name: newDisplayName, }, })) .reply(200, { dummy: 'value' }); axiosMock .onGet(getCourseUnitApiUrl(blockId)) .reply(200, { ...courseUnitIndexMock, metadata: { ...courseUnitIndexMock.metadata, display_name: newDisplayName, }, }); await waitFor(() => { editTitleButton = getByRole('button', { name: headerTitleMessages.altButtonEdit.defaultMessage }); titleEditField = queryByRole('textbox', { name: headerTitleMessages.ariaLabelButtonEdit.defaultMessage }); }); expect(titleEditField).not.toBeInTheDocument(); fireEvent.click(editTitleButton); titleEditField = getByRole('textbox', { name: headerTitleMessages.ariaLabelButtonEdit.defaultMessage }); fireEvent.change(titleEditField, { target: { value: newDisplayName } }); await act(async () => { fireEvent.blur(titleEditField); }); expect(titleEditField).toHaveValue(newDisplayName); titleEditField = queryByRole('textbox', { name: headerTitleMessages.ariaLabelButtonEdit.defaultMessage }); expect(titleEditField).not.toBeInTheDocument(); expect(await findByText(newDisplayName)).toBeInTheDocument(); }); it('doesn\'t handle creating xblock and displays an error message', async () => { const { courseKey, locator } = courseCreateXblockMock; axiosMock .onPost(postXBlockBaseApiUrl({ type: 'video', category: 'video', parentLocator: blockId })) .reply(500, {}); const { getByRole } = render(); await waitFor(() => { const videoButton = getByRole('button', { name: new RegExp(`${addComponentMessages.buttonText.defaultMessage} Video`, 'i'), }); userEvent.click(videoButton); expect(mockedUsedNavigate).not.toHaveBeenCalledWith(`/course/${courseKey}/editor/video/${locator}`); }); }); it('handle creating Problem xblock and navigate to editor page', async () => { const { courseKey, locator } = courseCreateXblockMock; axiosMock .onPost(postXBlockBaseApiUrl({ type: 'problem', category: 'problem', parentLocator: blockId })) .reply(200, courseCreateXblockMock); const { getByRole } = render(); await waitFor(() => { const problemButton = getByRole('button', { name: new RegExp(`${addComponentMessages.buttonText.defaultMessage} Problem`, 'i'), }); userEvent.click(problemButton); expect(mockedUsedNavigate).toHaveBeenCalled(); expect(mockedUsedNavigate).toHaveBeenCalledWith(`/course/${courseKey}/editor/problem/${locator}`); }); }); it('correct addition of a new course unit after click on the "Add new unit" button', async () => { const { getByRole, getAllByTestId } = render(); let units = null; const updatedCourseSectionVerticalData = cloneDeep(courseSectionVerticalMock); const updatedAncestorsChild = updatedCourseSectionVerticalData.xblock_info.ancestor_info.ancestors[0]; set(updatedCourseSectionVerticalData, 'xblock_info.ancestor_info.ancestors[0].child_info.children', [ ...updatedAncestorsChild.child_info.children, courseUnitMock, ]); await waitFor(async () => { units = getAllByTestId('course-unit-btn'); const courseUnits = courseSectionVerticalMock.xblock_info.ancestor_info.ancestors[0].child_info.children; expect(units.length).toEqual(courseUnits.length); }); axiosMock .onPost(postXBlockBaseApiUrl(), { parent_locator: blockId, category: 'vertical', display_name: 'Unit' }) .reply(200, { dummy: 'value' }); axiosMock.reset(); axiosMock .onGet(getCourseSectionVerticalApiUrl(blockId)) .reply(200, { ...updatedCourseSectionVerticalData, }); await executeThunk(fetchCourseSectionVerticalData(blockId), store.dispatch); const addNewUnitBtn = getByRole('button', { name: courseSequenceMessages.newUnitBtnText.defaultMessage }); units = getAllByTestId('course-unit-btn'); const updatedCourseUnits = updatedCourseSectionVerticalData .xblock_info.ancestor_info.ancestors[0].child_info.children; userEvent.click(addNewUnitBtn); expect(units.length).toEqual(updatedCourseUnits.length); expect(mockedUsedNavigate).toHaveBeenCalled(); expect(mockedUsedNavigate) .toHaveBeenCalledWith(`/course/${courseId}/container/${blockId}/${updatedAncestorsChild.id}`, { replace: true }); }); it('the sequence unit is updated after changing the unit header', async () => { const { getAllByTestId, getByRole } = render(); const updatedCourseSectionVerticalData = cloneDeep(courseSectionVerticalMock); const updatedAncestorsChild = updatedCourseSectionVerticalData.xblock_info.ancestor_info.ancestors[0]; set(updatedCourseSectionVerticalData, 'xblock_info.ancestor_info.ancestors[0].child_info.children', [ ...updatedAncestorsChild.child_info.children, courseUnitMock, ]); const newDisplayName = `${unitDisplayName} new`; axiosMock .onPost(getXBlockBaseApiUrl(blockId, { metadata: { display_name: newDisplayName, }, })) .reply(200, { dummy: 'value' }) .onGet(getCourseUnitApiUrl(blockId)) .reply(200, { ...courseUnitIndexMock, metadata: { ...courseUnitIndexMock.metadata, display_name: newDisplayName, }, }) .onGet(getCourseSectionVerticalApiUrl(blockId)) .reply(200, { ...updatedCourseSectionVerticalData, }); await executeThunk(fetchCourseSectionVerticalData(blockId), store.dispatch); const editTitleButton = getByRole('button', { name: headerTitleMessages.altButtonEdit.defaultMessage }); fireEvent.click(editTitleButton); const titleEditField = getByRole('textbox', { name: headerTitleMessages.ariaLabelButtonEdit.defaultMessage }); fireEvent.change(titleEditField, { target: { value: newDisplayName } }); await act(async () => fireEvent.blur(titleEditField)); await waitFor(async () => { const units = getAllByTestId('course-unit-btn'); expect(units.some(unit => unit.title === newDisplayName)).toBe(true); }); }); it('handles creating Video xblock and navigates to editor page', async () => { const { courseKey, locator } = courseCreateXblockMock; axiosMock .onPost(postXBlockBaseApiUrl({ type: 'video', category: 'video', parentLocator: blockId })) .reply(200, courseCreateXblockMock); const { getByRole } = render(); await waitFor(() => { const videoButton = getByRole('button', { name: new RegExp(`${addComponentMessages.buttonText.defaultMessage} Video`, 'i'), }); userEvent.click(videoButton); expect(mockedUsedNavigate).toHaveBeenCalled(); expect(mockedUsedNavigate).toHaveBeenCalledWith(`/course/${courseKey}/editor/video/${locator}`); }); }); it('renders course unit details for a draft with unpublished changes', async () => { const { getByText } = render(); await waitFor(() => { expect(getByText(sidebarMessages.sidebarTitleDraftUnpublishedChanges.defaultMessage)).toBeInTheDocument(); expect(getByText(sidebarMessages.visibilityStaffAndLearnersTitle.defaultMessage)).toBeInTheDocument(); expect(getByText(sidebarMessages.releaseStatusTitle.defaultMessage)).toBeInTheDocument(); expect(getByText(sidebarMessages.sidebarBodyNote.defaultMessage)).toBeInTheDocument(); expect(getByText(sidebarMessages.visibilityWillBeVisibleToTitle.defaultMessage)).toBeInTheDocument(); expect(getByText(sidebarMessages.visibilityCheckboxTitle.defaultMessage)).toBeInTheDocument(); expect(getByText(sidebarMessages.actionButtonPublishTitle.defaultMessage)).toBeInTheDocument(); expect(getByText(sidebarMessages.actionButtonDiscardChangesTitle.defaultMessage)).toBeInTheDocument(); expect(getByText(courseUnitIndexMock.release_date)).toBeInTheDocument(); expect(getByText( sidebarMessages.publishInfoDraftSaved.defaultMessage .replace('{editedOn}', courseUnitIndexMock.edited_on) .replace('{editedBy}', courseUnitIndexMock.edited_by), )).toBeInTheDocument(); expect(getByText( sidebarMessages.releaseInfoWithSection.defaultMessage .replace('{sectionName}', courseUnitIndexMock.release_date_from), )).toBeInTheDocument(); }); }); it('renders course unit details in the sidebar', async () => { const { getByText } = render(); const courseUnitLocationId = extractCourseUnitId(courseUnitIndexMock.id); await waitFor(() => { expect(getByText(sidebarMessages.sidebarHeaderUnitLocationTitle.defaultMessage)).toBeInTheDocument(); expect(getByText(sidebarMessages.unitLocationTitle.defaultMessage)).toBeInTheDocument(); expect(getByText(courseUnitLocationId)).toBeInTheDocument(); expect(getByText(sidebarMessages.unitLocationDescription.defaultMessage .replace('{id}', courseUnitLocationId))).toBeInTheDocument(); }); }); it('checks whether xblock is deleted when corresponding delete button is clicked', async () => { axiosMock .onDelete(getXBlockBaseApiUrl(courseVerticalChildrenMock.children[0].block_id)) .replyOnce(200, { dummy: 'value' }); const { getByText, getAllByLabelText, getByRole, getAllByTestId, } = render(); await waitFor(() => { expect(getByText(unitDisplayName)).toBeInTheDocument(); const [xblockActionBtn] = getAllByLabelText(courseXBlockMessages.blockActionsDropdownAlt.defaultMessage); userEvent.click(xblockActionBtn); const deleteBtn = getByRole('button', { name: courseXBlockMessages.blockLabelButtonDelete.defaultMessage }); userEvent.click(deleteBtn); expect(getByText(/Delete this component?/)).toBeInTheDocument(); const deleteConfirmBtn = getByRole('button', { name: deleteModalMessages.deleteButton.defaultMessage }); userEvent.click(deleteConfirmBtn); expect(getAllByTestId('course-xblock')).toHaveLength(1); }); }); it('checks whether xblock is duplicate when corresponding delete button is clicked', async () => { axiosMock .onPost(postXBlockBaseApiUrl({ parent_locator: blockId, duplicate_source_locator: courseVerticalChildrenMock.children[0].block_id, })) .replyOnce(200, { locator: '1234567890' }); axiosMock .onGet(getCourseVerticalChildrenApiUrl(blockId)) .reply(200, { ...courseVerticalChildrenMock, children: [ ...courseVerticalChildrenMock.children, { name: 'New Cloned XBlock', block_id: '1234567890', block_type: 'drag-and-drop-v2', }, ], }); const { getByText, getAllByLabelText, getAllByTestId, } = render(); await waitFor(() => { expect(getByText(unitDisplayName)).toBeInTheDocument(); const [xblockActionBtn] = getAllByLabelText(courseXBlockMessages.blockActionsDropdownAlt.defaultMessage); userEvent.click(xblockActionBtn); const duplicateBtn = getByText(courseXBlockMessages.blockLabelButtonDuplicate.defaultMessage); userEvent.click(duplicateBtn); expect(getAllByTestId('course-xblock')).toHaveLength(3); expect(getByText('New Cloned XBlock')).toBeInTheDocument(); }); }); it('should toggle visibility and update course unit state accordingly', async () => { const { getByRole, getByTestId } = render(); let courseUnitSidebar; let draftUnpublishedChangesHeading; let visibilityCheckbox; await waitFor(() => { courseUnitSidebar = getByTestId('course-unit-sidebar'); draftUnpublishedChangesHeading = within(courseUnitSidebar) .getByText(sidebarMessages.sidebarTitleDraftUnpublishedChanges.defaultMessage); expect(draftUnpublishedChangesHeading).toBeInTheDocument(); visibilityCheckbox = within(courseUnitSidebar) .getByLabelText(sidebarMessages.visibilityCheckboxTitle.defaultMessage); expect(visibilityCheckbox).not.toBeChecked(); userEvent.click(visibilityCheckbox); }); axiosMock .onPost(getXBlockBaseApiUrl(blockId), { publish: PUBLISH_TYPES.republish, metadata: { visible_to_staff_only: true }, }) .reply(200, { dummy: 'value' }); axiosMock .onGet(getCourseUnitApiUrl(blockId)) .reply(200, { ...courseUnitIndexMock, visibility_state: UNIT_VISIBILITY_STATES.staffOnly, has_explicit_staff_lock: true, }); await executeThunk(editCourseUnitVisibilityAndData(blockId, PUBLISH_TYPES.republish, true), store.dispatch); expect(visibilityCheckbox).toBeChecked(); expect(within(courseUnitSidebar) .getByText(sidebarMessages.sidebarTitleVisibleToStaffOnly.defaultMessage)).toBeInTheDocument(); expect(within(courseUnitSidebar) .getByText(sidebarMessages.visibilityStaffOnlyTitle.defaultMessage)).toBeInTheDocument(); userEvent.click(visibilityCheckbox); const modalNotification = getByRole('dialog'); const makeVisibilityBtn = within(modalNotification).getByRole('button', { name: sidebarMessages.modalMakeVisibilityActionButtonText.defaultMessage }); const cancelBtn = within(modalNotification).getByRole('button', { name: sidebarMessages.modalMakeVisibilityCancelButtonText.defaultMessage }); const headingElement = within(modalNotification).getByRole('heading', { name: sidebarMessages.modalMakeVisibilityTitle.defaultMessage, class: 'pgn__modal-title' }); expect(makeVisibilityBtn).toBeInTheDocument(); expect(cancelBtn).toBeInTheDocument(); expect(headingElement).toBeInTheDocument(); expect(within(modalNotification) .getByText(sidebarMessages.modalMakeVisibilityDescription.defaultMessage)).toBeInTheDocument(); userEvent.click(makeVisibilityBtn); axiosMock .onPost(getXBlockBaseApiUrl(blockId), { publish: PUBLISH_TYPES.republish, metadata: { visible_to_staff_only: null }, }) .reply(200, { dummy: 'value' }); axiosMock .onGet(getCourseUnitApiUrl(blockId)) .reply(200, courseUnitIndexMock); await executeThunk(editCourseUnitVisibilityAndData(blockId, PUBLISH_TYPES.republish, null), store.dispatch); expect(within(courseUnitSidebar) .getByText(sidebarMessages.visibilityStaffAndLearnersTitle.defaultMessage)).toBeInTheDocument(); expect(visibilityCheckbox).not.toBeChecked(); expect(draftUnpublishedChangesHeading).toBeInTheDocument(); }); it('should publish course unit after click on the "Publish" button', async () => { const { getByTestId } = render(); let courseUnitSidebar; let publishBtn; await waitFor(() => { courseUnitSidebar = getByTestId('course-unit-sidebar'); publishBtn = within(courseUnitSidebar).queryByRole('button', { name: sidebarMessages.actionButtonPublishTitle.defaultMessage }); expect(publishBtn).toBeInTheDocument(); userEvent.click(publishBtn); }); axiosMock .onPost(getXBlockBaseApiUrl(blockId), { publish: PUBLISH_TYPES.makePublic, }) .reply(200, { dummy: 'value' }); axiosMock .onGet(getCourseUnitApiUrl(blockId)) .reply(200, { ...courseUnitIndexMock, visibility_state: UNIT_VISIBILITY_STATES.live, has_changes: false, published_by: userName, }); await executeThunk(editCourseUnitVisibilityAndData(blockId, PUBLISH_TYPES.makePublic, true), store.dispatch); expect(within(courseUnitSidebar) .getByText(sidebarMessages.sidebarTitlePublishedAndLive.defaultMessage)).toBeInTheDocument(); expect(within(courseUnitSidebar).getByText( sidebarMessages.publishLastPublished.defaultMessage .replace('{publishedOn}', courseUnitIndexMock.published_on) .replace('{publishedBy}', userName), )).toBeInTheDocument(); expect(publishBtn).not.toBeInTheDocument(); }); it('should discard changes after click on the "Discard changes" button', async () => { const { getByTestId, getByRole } = render(); let courseUnitSidebar; let discardChangesBtn; await waitFor(() => { courseUnitSidebar = getByTestId('course-unit-sidebar'); const draftUnpublishedChangesHeading = within(courseUnitSidebar) .getByText(sidebarMessages.sidebarTitleDraftUnpublishedChanges.defaultMessage); expect(draftUnpublishedChangesHeading).toBeInTheDocument(); discardChangesBtn = within(courseUnitSidebar).queryByRole('button', { name: sidebarMessages.actionButtonDiscardChangesTitle.defaultMessage }); expect(discardChangesBtn).toBeInTheDocument(); userEvent.click(discardChangesBtn); const modalNotification = getByRole('dialog'); expect(modalNotification).toBeInTheDocument(); expect(within(modalNotification) .getByText(sidebarMessages.modalDiscardUnitChangesDescription.defaultMessage)).toBeInTheDocument(); expect(within(modalNotification) .getByText(sidebarMessages.modalDiscardUnitChangesCancelButtonText.defaultMessage)).toBeInTheDocument(); const headingElement = within(modalNotification).getByRole('heading', { name: sidebarMessages.modalDiscardUnitChangesTitle.defaultMessage, class: 'pgn__modal-title' }); expect(headingElement).toBeInTheDocument(); const actionBtn = within(modalNotification).getByRole('button', { name: sidebarMessages.modalDiscardUnitChangesActionButtonText.defaultMessage }); expect(actionBtn).toBeInTheDocument(); userEvent.click(actionBtn); }); axiosMock .onPost(getXBlockBaseApiUrl(blockId), { publish: PUBLISH_TYPES.discardChanges, }) .reply(200, { dummy: 'value' }); axiosMock .onGet(getCourseUnitApiUrl(blockId)) .reply(200, { ...courseUnitIndexMock, published: true, has_changes: false, }); await executeThunk(editCourseUnitVisibilityAndData( blockId, PUBLISH_TYPES.discardChanges, true, ), store.dispatch); expect(within(courseUnitSidebar) .getByText(sidebarMessages.sidebarTitlePublishedNotYetReleased.defaultMessage)).toBeInTheDocument(); expect(discardChangesBtn).not.toBeInTheDocument(); }); });