Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert "fix: add test in CourseOutlineTray" and "fix: only one in-course experience sidebar can be open at a time failing" #1547

Merged
merged 1 commit into from
Dec 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ import messages from './messages';

const CourseOutlineTray = ({ intl }) => {
const [selectedSection, setSelectedSection] = useState(null);
const [openSequenceId, setOpenSequenceId] = useState(null);
const [isDisplaySequenceLevel, setDisplaySequenceLevel, setDisplaySectionLevel] = useToggle(true);

const dispatch = useDispatch();
Expand Down Expand Up @@ -63,10 +62,6 @@ const CourseOutlineTray = ({ intl }) => {
setSelectedSection(id);
};

const handleToggleSequence = (sequenceId) => {
setOpenSequenceId((prevOpenSequenceId) => (prevOpenSequenceId === sequenceId ? null : sequenceId));
};

const sidebarHeading = (
<div className="outline-sidebar-heading-wrapper sticky d-flex justify-content-between align-self-start align-items-center bg-light-200 p-2.5 pl-4">
{isDisplaySequenceLevel && backButtonTitle ? (
Expand Down Expand Up @@ -134,8 +129,7 @@ const CourseOutlineTray = ({ intl }) => {
key={sequenceId}
courseId={courseId}
sequence={sequences[sequenceId]}
isOpen={sequenceId === openSequenceId}
onToggle={() => handleToggleSequence(sequenceId)}
defaultOpen={sequenceId === activeSequenceId}
activeUnitId={unitId}
/>
))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ describe('<CourseOutlineTray />', () => {
let store;
let section = {};
let sequence = {};
let unit;
let unitId;
let courseId;
let mockData;
Expand All @@ -31,6 +32,7 @@ describe('<CourseOutlineTray />', () => {
const activeSectionId = Object.keys(state.courseware.courseOutline.sections)[0];
section = state.courseware.courseOutline.sections[activeSectionId];
[unitId] = sequence.unitIds;
unit = state.courseware.courseOutline.units[unitId];
}

mockData = {
Expand Down Expand Up @@ -82,6 +84,7 @@ describe('<CourseOutlineTray />', () => {
expect(screen.getByRole('button', { name: section.title })).toBeInTheDocument();
expect(screen.getByRole('button', { name: messages.toggleCourseOutlineTrigger.defaultMessage })).toBeInTheDocument();
expect(screen.getByRole('button', { name: `${sequence.title} , ${courseOutlineMessages.incompleteAssignment.defaultMessage}` })).toBeInTheDocument();
expect(screen.getByText(unit.title)).toBeInTheDocument();
});

it('collapses sidebar correctly when toggle button is clicked', async () => {
Expand All @@ -99,30 +102,6 @@ describe('<CourseOutlineTray />', () => {
expect(mockToggleSidebar).toHaveBeenCalledWith(null);
});

it('toggles openSequenceId correctly when a sequence is clicked', async () => {
const user = userEvent.setup();
await initTestStore();
renderWithProvider();
const sequenceButton = screen.getByRole('button', { name: `${sequence.title} , ${courseOutlineMessages.incompleteAssignment.defaultMessage}` });
expect(sequenceButton).toBeInTheDocument();
await user.click(sequenceButton);
expect(screen.getByRole('button', { name: `${sequence.title} , ${courseOutlineMessages.incompleteAssignment.defaultMessage}` })).toHaveAttribute('aria-expanded', 'true');
await user.click(sequenceButton);
expect(screen.getByRole('button', { name: `${sequence.title} , ${courseOutlineMessages.incompleteAssignment.defaultMessage}` })).toHaveAttribute('aria-expanded', 'false');
});

it('updates setOpenSequenceId correctly when toggling sequences', async () => {
const user = userEvent.setup();
await initTestStore();
renderWithProvider();
const sequenceButton = screen.getByRole('button', { name: `${sequence.title} , ${courseOutlineMessages.incompleteAssignment.defaultMessage}` });
expect(sequenceButton).toBeInTheDocument();
await user.click(sequenceButton);
expect(sequenceButton).toHaveAttribute('aria-expanded', 'true');
await user.click(sequenceButton);
expect(sequenceButton).toHaveAttribute('aria-expanded', 'false');
});

it('navigates to section or sequence level correctly on click by back/section button', async () => {
const user = userEvent.setup();
await initTestStore();
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { useState } from 'react';
import { useSelector } from 'react-redux';
import classNames from 'classnames';
import PropTypes from 'prop-types';
Expand All @@ -13,8 +14,7 @@ import { UNIT_ICON_TYPES } from './UnitIcon';
const SidebarSequence = ({
intl,
courseId,
isOpen,
onToggle,
defaultOpen,
sequence,
activeUnitId,
}) => {
Expand All @@ -28,6 +28,7 @@ const SidebarSequence = ({
completionStat,
} = sequence;

const [open, setOpen] = useState(defaultOpen);
const { units = {} } = useSelector(getCourseOutline);
const activeSequenceId = useSelector(getSequenceId);
const isActiveSequence = id === activeSequenceId;
Expand All @@ -52,11 +53,11 @@ const SidebarSequence = ({
return (
<li>
<Collapsible
className={classNames('mb-2', { 'active-section': isActiveSequence, 'bg-info-100': isActiveSequence && !isOpen })}
className={classNames('mb-2', { 'active-section': isActiveSequence, 'bg-info-100': isActiveSequence && !open })}
styling="card-lg text-break"
title={sectionTitle}
open={isOpen}
onToggle={onToggle}
open={open}
onToggle={() => setOpen(!open)}
>
<ol className="list-unstyled">
{unitIds.map((unitId, index) => (
Expand All @@ -81,8 +82,7 @@ const SidebarSequence = ({
SidebarSequence.propTypes = {
intl: intlShape.isRequired,
courseId: PropTypes.string.isRequired,
isOpen: PropTypes.bool.isRequired,
onToggle: PropTypes.func.isRequired,
defaultOpen: PropTypes.bool.isRequired,
sequence: PropTypes.shape({
complete: PropTypes.bool,
id: PropTypes.string,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import { MemoryRouter } from 'react-router-dom';
import { render, screen } from '@testing-library/react';
import { render, screen, waitFor } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { AppProvider } from '@edx/frontend-platform/react';
import { IntlProvider } from '@edx/frontend-platform/i18n';

import courseOutlineMessages from '@src/course-home/outline-tab/messages';
import { initializeMockApp, initializeTestStore } from '@src/setupTest';
import messages from '../messages';
import SidebarSequence from './SidebarSequence';

initializeMockApp();
Expand All @@ -14,6 +15,7 @@ describe('<SidebarSequence />', () => {
let courseId;
let store;
let sequence;
let unit;
const sequenceDescription = 'sequence test description';

const initTestStore = async (options) => {
Expand All @@ -23,6 +25,8 @@ describe('<SidebarSequence />', () => {
let activeSequenceId = '';
[activeSequenceId] = Object.keys(state.courseware.courseOutline.sequences);
sequence = state.courseware.courseOutline.sequences[activeSequenceId];
const unitId = sequence.unitIds[0];
unit = state.courseware.courseOutline.units[unitId];
};

function renderWithProvider(props = {}) {
Expand Down Expand Up @@ -51,6 +55,7 @@ describe('<SidebarSequence />', () => {
expect(screen.getByText(sequence.title)).toBeInTheDocument();
expect(screen.queryByText(sequenceDescription)).not.toBeInTheDocument();
expect(screen.getByText(`, ${courseOutlineMessages.incompleteAssignment.defaultMessage}`)).toBeInTheDocument();
expect(screen.queryByText(unit.title)).not.toBeInTheDocument();
});

it('renders correctly when sequence is not collapsed and complete', async () => {
Expand All @@ -68,6 +73,13 @@ describe('<SidebarSequence />', () => {
expect(screen.getByText(sequence.title)).toBeInTheDocument();
expect(screen.getByText(sequenceDescription)).toBeInTheDocument();
expect(screen.getByText(`, ${courseOutlineMessages.completedAssignment.defaultMessage}`)).toBeInTheDocument();
expect(screen.getByText(unit.title)).toBeInTheDocument();
expect(screen.getByText(`, ${messages.incompleteUnit.defaultMessage}`)).toBeInTheDocument();

await user.click(screen.getByText(sequence.title));
await waitFor(() => {
expect(screen.queryByText(unit.title)).not.toBeInTheDocument();
expect(screen.queryByText(`, ${messages.incompleteUnit.defaultMessage}`)).not.toBeInTheDocument();
});
});
});
Loading