feat: remove waffle flags for managing course outline sidebar

ihor-romaniuk · ihor-romaniuk · commit c18958a8034d · 2025-05-27T17:55:28.000+02:00
diff --git a/src/course-home/data/__snapshots__/redux.test.js.snap b/src/course-home/data/__snapshots__/redux.test.js.snap
@@ -18,7 +18,6 @@ exports[`Data layer integration tests Test fetchDatesTab Should fetch, normalize
     "courseOutlineShouldUpdate": false,
     "courseOutlineStatus": "loading",
     "courseStatus": "loading",
-    "coursewareOutlineSidebarSettings": {},
     "sequenceId": null,
     "sequenceMightBeUnit": false,
     "sequenceStatus": "loading",
@@ -410,7 +409,6 @@ exports[`Data layer integration tests Test fetchOutlineTab Should fetch, normali
     "courseOutlineShouldUpdate": false,
     "courseOutlineStatus": "loading",
     "courseStatus": "loading",
-    "coursewareOutlineSidebarSettings": {},
     "sequenceId": null,
     "sequenceMightBeUnit": false,
     "sequenceStatus": "loading",
@@ -682,7 +680,6 @@ exports[`Data layer integration tests Test fetchProgressTab Should fetch, normal
     "courseOutlineShouldUpdate": false,
     "courseOutlineStatus": "loading",
     "courseStatus": "loading",
-    "coursewareOutlineSidebarSettings": {},
     "sequenceId": null,
     "sequenceMightBeUnit": false,
     "sequenceStatus": "loading",
diff --git a/src/courseware/course/Course.jsx b/src/courseware/course/Course.jsx
@@ -1,14 +1,13 @@
 import { useEffect, useState } from 'react';
 import PropTypes from 'prop-types';
 import { Helmet } from 'react-helmet';
-import { useDispatch, useSelector } from 'react-redux';
+import { useDispatch } from 'react-redux';
 import { getConfig } from '@edx/frontend-platform';
 import { useLocation, useNavigate } from 'react-router-dom';
 import { breakpoints, useWindowSize } from '@openedx/paragon';
 
 import { AlertList } from '@src/generic/user-messages';
 import { useModel } from '@src/generic/model-store';
-import { getCoursewareOutlineSidebarSettings } from '../data/selectors';
 import Chat from './chat/Chat';
 import SidebarProvider from './sidebar/SidebarContextProvider';
 import NewSidebarProvider from './new-sidebar/SidebarContextProvider';
@@ -37,8 +36,6 @@ const Course = ({
   } = useModel('courseHomeMeta', courseId);
   const sequence = useModel('sequences', sequenceId);
   const section = useModel('sections', sequence ? sequence.sectionId : null);
-  const { enableNavigationSidebar } = useSelector(getCoursewareOutlineSidebarSettings);
-  const navigationDisabled = enableNavigationSidebar || (sequence?.navigationDisabled ?? false);
   const navigate = useNavigate();
   const { pathname } = useLocation();
 
@@ -84,17 +81,13 @@ const Course = ({
         <title>{`${pageTitleBreadCrumbs.join(' | ')} | ${getConfig().SITE_NAME}`}</title>
       </Helmet>
       <div className="position-relative d-flex align-items-xl-center mb-4 mt-1 flex-column flex-xl-row">
-        {navigationDisabled || (
-        <>
-          <CourseBreadcrumbsSlot
-            courseId={courseId}
-            sectionId={section ? section.id : null}
-            sequenceId={sequenceId}
-            isStaff={isStaff}
-            unitId={unitId}
-          />
-        </>
-        )}
+        <CourseBreadcrumbsSlot
+          courseId={courseId}
+          sectionId={section ? section.id : null}
+          sequenceId={sequenceId}
+          isStaff={isStaff}
+          unitId={unitId}
+        />
         {shouldDisplayChat && (
           <>
             <Chat
diff --git a/src/courseware/course/sequence/Sequence.jsx b/src/courseware/course/sequence/Sequence.jsx
@@ -6,6 +6,7 @@ import {
   sendTrackEvent,
   sendTrackingLogEvent,
 } from '@edx/frontend-platform/analytics';
+import { getConfig } from '@edx/frontend-platform';
 import { useIntl } from '@edx/frontend-platform/i18n';
 import { useSelector } from 'react-redux';
 import SequenceExamWrapper from '@edx/frontend-lib-special-exams';
@@ -15,7 +16,6 @@ import { useModel } from '@src/generic/model-store';
 import { useSequenceBannerTextAlert, useSequenceEntranceExamAlert } from '@src/alerts/sequence-alerts/hooks';
 import SequenceContainerSlot from '../../../plugin-slots/SequenceContainerSlot';
 
-import { getCoursewareOutlineSidebarSettings } from '../../data/selectors';
 import CourseLicense from '../course-license';
 import { NotificationsDiscussionsSidebarSlot } from '../../../plugin-slots/NotificationsDiscussionsSidebarSlot';
 import messages from './messages';
@@ -47,7 +47,6 @@ const Sequence = ({
   const unit = useModel('units', unitId);
   const sequenceStatus = useSelector(state => state.courseware.sequenceStatus);
   const sequenceMightBeUnit = useSelector(state => state.courseware.sequenceMightBeUnit);
-  const { enableNavigationSidebar: isEnabledOutlineSidebar } = useSelector(getCoursewareOutlineSidebarSettings);
   const handleNext = () => {
     const nextIndex = sequence.unitIds.indexOf(unitId) + 1;
     const newUnitId = sequence.unitIds[nextIndex];
@@ -170,7 +169,7 @@ const Sequence = ({
         />
         <CourseOutlineSidebarSlot />
         <div className="sequence w-100">
-          {!isEnabledOutlineSidebar && (
+          {!getConfig().ENABLE_SEQUENCE_NAVIGATION && (
             <div className="sequence-navigation-container">
               <SequenceNavigation
                 sequenceId={sequenceId}
@@ -203,7 +202,6 @@ const Sequence = ({
               unitId={unitId}
               unitLoadedHandler={handleUnitLoaded}
               isOriginalUserStaff={originalUserIsStaff}
-              isEnabledOutlineSidebar={isEnabledOutlineSidebar}
               renderUnitNavigation={renderUnitNavigation}
             />
             {unitHasLoaded && renderUnitNavigation(false)}
diff --git a/src/courseware/course/sequence/Sequence.test.jsx b/src/courseware/course/sequence/Sequence.test.jsx
@@ -96,7 +96,6 @@ describe('Sequence', () => {
       unitBlocks,
       sequenceBlocks,
       sequenceMetadata,
-      enableNavigationSidebar: { enable_navigation_sidebar: true },
     }, false);
     const { container } = render(
       <SidebarWrapper overrideData={{ sequenceId: sequenceBlocks[0].id }} />,
diff --git a/src/courseware/course/sequence/SequenceContent.jsx b/src/courseware/course/sequence/SequenceContent.jsx
@@ -16,7 +16,6 @@ const SequenceContent = ({
   unitId,
   unitLoadedHandler,
   isOriginalUserStaff,
-  isEnabledOutlineSidebar,
   renderUnitNavigation,
 }) => {
   const intl = useIntl();
@@ -63,7 +62,6 @@ const SequenceContent = ({
       id={unitId}
       onLoaded={unitLoadedHandler}
       isOriginalUserStaff={isOriginalUserStaff}
-      isEnabledOutlineSidebar={isEnabledOutlineSidebar}
       renderUnitNavigation={renderUnitNavigation}
     />
   );
@@ -76,7 +74,6 @@ SequenceContent.propTypes = {
   unitId: PropTypes.string,
   unitLoadedHandler: PropTypes.func.isRequired,
   isOriginalUserStaff: PropTypes.bool.isRequired,
-  isEnabledOutlineSidebar: PropTypes.bool.isRequired,
   renderUnitNavigation: PropTypes.func.isRequired,
 };
 
diff --git a/src/courseware/course/sequence/SequenceContent.test.jsx b/src/courseware/course/sequence/SequenceContent.test.jsx
@@ -15,6 +15,7 @@ describe('Sequence Content', () => {
       sequenceId: courseware.sequenceId,
       unitId: models.sequences[courseware.sequenceId].unitIds[0],
       unitLoadedHandler: () => { },
+      renderUnitNavigation: () => { },
     };
   });
 
@@ -38,7 +39,7 @@ describe('Sequence Content', () => {
   });
 
   it('displays message for no content', () => {
-    render(<SequenceContent {...mockData} unitId={null} />, { wrapWithRouter: true });
+    render(<SequenceContent {...mockData} unitId="" />, { wrapWithRouter: true });
     expect(screen.getByText('There is no content here.')).toBeInTheDocument();
   });
 });
diff --git a/src/courseware/course/sequence/Unit/index.jsx b/src/courseware/course/sequence/Unit/index.jsx
@@ -22,7 +22,6 @@ const Unit = ({
   onLoaded,
   id,
   isOriginalUserStaff,
-  isEnabledOutlineSidebar,
   renderUnitNavigation,
 }) => {
   const { formatMessage } = useIntl();
@@ -48,7 +47,7 @@ const Unit = ({
 
   return (
     <div className="unit">
-      <UnitTitleSlot unitId={id} {...{ unit, isEnabledOutlineSidebar, renderUnitNavigation }} />
+      <UnitTitleSlot unitId={id} {...{ unit, renderUnitNavigation }} />
       <UnitSuspense {...{ courseId, id }} />
       <ContentIFrame
         elementId="unit-iframe"
@@ -70,7 +69,6 @@ Unit.propTypes = {
   id: PropTypes.string.isRequired,
   onLoaded: PropTypes.func,
   isOriginalUserStaff: PropTypes.bool.isRequired,
-  isEnabledOutlineSidebar: PropTypes.bool.isRequired,
   renderUnitNavigation: PropTypes.func.isRequired,
 };
 
diff --git a/src/courseware/course/sequence/Unit/index.test.jsx b/src/courseware/course/sequence/Unit/index.test.jsx
@@ -14,7 +14,6 @@ const defaultProps = {
   onLoaded: jest.fn().mockName('props.onLoaded'),
   id: 'unit-id',
   isOriginalUserStaff: false,
-  isEnabledOutlineSidebar: false,
   renderUnitNavigation: jest.fn(enabled => enabled && 'UnitNaviagtion'),
 };
 
@@ -68,16 +67,8 @@ describe('<Unit />', () => {
       expect(screen.getByText('Bookmark this page')).toBeInTheDocument();
     });
 
-    it('does not render unit navigation buttons', () => {
-      renderComponent(defaultProps);
-
-      const nextButton = screen.queryByText('UnitNaviagtion');
-
-      expect(nextButton).toBeNull();
-    });
-
-    it('renders unit navigation buttons when isEnabledOutlineSidebar is true', () => {
-      const props = { ...defaultProps, isEnabledOutlineSidebar: true };
+    it('renders unit navigation buttons', () => {
+      const props = { ...defaultProps };
       renderComponent(props);
 
       const nextButton = screen.getByText('UnitNaviagtion');
diff --git a/src/courseware/course/sequence/sequence-navigation/SequenceNavigation.jsx b/src/courseware/course/sequence/sequence-navigation/SequenceNavigation.jsx
@@ -100,13 +100,13 @@ const SequenceNavigation = ({
     );
   };
 
-  return sequenceStatus === LOADED && (
+  return sequenceStatus === LOADED ? (
     <nav id="courseware-sequence-navigation" data-testid="courseware-sequence-navigation" className={classNames('sequence-navigation', className, { 'mr-2': shouldDisplayNotificationTriggerInSequence })}>
       {renderPreviousButton()}
       {renderUnitButtons()}
       {renderNextButton()}
     </nav>
-  );
+  ) : null;
 };
 
 SequenceNavigation.propTypes = {
diff --git a/src/courseware/course/sidebar/SidebarContextProvider.jsx b/src/courseware/course/sidebar/SidebarContextProvider.jsx
@@ -1,13 +1,11 @@
 import { breakpoints, useWindowSize } from '@openedx/paragon';
 import PropTypes from 'prop-types';
-import { useSelector } from 'react-redux';
 import {
   useEffect, useState, useMemo, useCallback,
 } from 'react';
 
 import { useModel } from '@src/generic/model-store';
 import { getLocalStorage, setLocalStorage } from '@src/data/localStorage';
-import { getCoursewareOutlineSidebarSettings } from '../../data/selectors';
 
 import * as discussionsSidebar from './sidebars/discussions';
 import * as notificationsSidebar from './sidebars/notifications';
@@ -25,11 +23,10 @@ const SidebarProvider = ({
   const shouldDisplayFullScreen = useWindowSize().width < breakpoints.extraLarge.minWidth;
   const shouldDisplaySidebarOpen = useWindowSize().width > breakpoints.extraLarge.minWidth;
   const query = new URLSearchParams(window.location.search);
-  const { alwaysOpenAuxiliarySidebar } = useSelector(getCoursewareOutlineSidebarSettings);
   const isInitiallySidebarOpen = shouldDisplaySidebarOpen || query.get('sidebar') === 'true';
 
   let initialSidebar = shouldDisplayFullScreen ? getLocalStorage(`sidebar.${courseId}`) : null;
-  if (!shouldDisplayFullScreen && isInitiallySidebarOpen && alwaysOpenAuxiliarySidebar) {
+  if (!shouldDisplayFullScreen && isInitiallySidebarOpen) {
     initialSidebar = isUnitHasDiscussionTopics
       ? SIDEBARS[discussionsSidebar.ID].ID
       : verifiedMode && SIDEBARS[notificationsSidebar.ID].ID;
diff --git a/src/courseware/course/sidebar/sidebars/course-outline/CourseOutlineTray.jsx b/src/courseware/course/sidebar/sidebars/course-outline/CourseOutlineTray.jsx
@@ -24,7 +24,6 @@ const CourseOutlineTray = () => {
   const {
     courseId,
     unitId,
-    isEnabledSidebar,
     currentSidebar,
     handleToggleCollapse,
     isActiveEntranceExam,
@@ -78,7 +77,7 @@ const CourseOutlineTray = () => {
     </div>
   );
 
-  if (!isEnabledSidebar || isActiveEntranceExam || currentSidebar !== ID) {
+  if (isActiveEntranceExam || currentSidebar !== ID) {
     return null;
   }
 
diff --git a/src/courseware/course/sidebar/sidebars/course-outline/CourseOutlineTray.test.jsx b/src/courseware/course/sidebar/sidebars/course-outline/CourseOutlineTray.test.jsx
@@ -67,15 +67,6 @@ describe('<CourseOutlineTray />', () => {
     expect(screen.queryByRole('button', { name: 'Course outline' })).not.toBeInTheDocument();
   });
 
-  it('doesn\'t render when outline sidebar is disabled', async () => {
-    await initTestStore({ enableNavigationSidebar: { enable_navigation_sidebar: false } });
-    renderWithProvider();
-
-    await expect(screen.queryByText(messages.loading.defaultMessage)).not.toBeInTheDocument();
-    expect(screen.queryByRole('button', { name: section.title })).not.toBeInTheDocument();
-    expect(screen.queryByRole('button', { name: messages.toggleCourseOutlineTrigger.defaultMessage })).not.toBeInTheDocument();
-  });
-
   it('renders correctly when course outline is loaded', async () => {
     await initTestStore();
     renderWithProvider();
diff --git a/src/courseware/course/sidebar/sidebars/course-outline/CourseOutlineTrigger.jsx b/src/courseware/course/sidebar/sidebars/course-outline/CourseOutlineTrigger.jsx
@@ -15,13 +15,12 @@ const CourseOutlineTrigger = ({ isMobileView }) => {
     shouldDisplayFullScreen,
     handleToggleCollapse,
     isActiveEntranceExam,
-    isEnabledSidebar,
   } = useCourseOutlineSidebar();
 
   const isDisplayForDesktopView = !isMobileView && !shouldDisplayFullScreen && currentSidebar !== ID;
   const isDisplayForMobileView = isMobileView && shouldDisplayFullScreen;
 
-  if ((!isDisplayForDesktopView && !isDisplayForMobileView) || !isEnabledSidebar || isActiveEntranceExam) {
+  if ((!isDisplayForDesktopView && !isDisplayForMobileView) || isActiveEntranceExam) {
     return null;
   }
 
diff --git a/src/courseware/course/sidebar/sidebars/course-outline/CourseOutlineTrigger.test.jsx b/src/courseware/course/sidebar/sidebars/course-outline/CourseOutlineTrigger.test.jsx
@@ -45,7 +45,7 @@ describe('<CourseOutlineTrigger />', () => {
   it('renders correctly for desktop when sidebar is enabled', async () => {
     const user = userEvent.setup();
     const mockToggleSidebar = jest.fn();
-    await initTestStore({ enableNavigationSidebar: { enable_navigation_sidebar: true } });
+    await initTestStore();
     renderWithProvider({ toggleSidebar: mockToggleSidebar }, { isMobileView: false });
 
     const toggleButton = await screen.getByRole('button', {
@@ -62,7 +62,7 @@ describe('<CourseOutlineTrigger />', () => {
   it('renders correctly for mobile when sidebar is enabled', async () => {
     const user = userEvent.setup();
     const mockToggleSidebar = jest.fn();
-    await initTestStore({ enableNavigationSidebar: { enable_navigation_sidebar: true } });
+    await initTestStore();
     renderWithProvider({
       toggleSidebar: mockToggleSidebar,
       shouldDisplayFullScreen: true,
@@ -82,7 +82,7 @@ describe('<CourseOutlineTrigger />', () => {
   it('changes current sidebar value on click', async () => {
     const user = userEvent.setup();
     const mockToggleSidebar = jest.fn();
-    await initTestStore({ enableNavigationSidebar: { enable_navigation_sidebar: true } });
+    await initTestStore();
     renderWithProvider({
       toggleSidebar: mockToggleSidebar,
       shouldDisplayFullScreen: true,
@@ -99,14 +99,4 @@ describe('<CourseOutlineTrigger />', () => {
     expect(mockToggleSidebar).toHaveBeenCalledTimes(1);
     expect(mockToggleSidebar).toHaveBeenCalledWith(null);
   });
-
-  it('does not render when isEnabled is false', async () => {
-    await initTestStore({ enableNavigationSidebar: { enable_navigation_sidebar: false } });
-    renderWithProvider({}, { isMobileView: false });
-
-    const toggleButton = await screen.queryByRole('button', {
-      name: messages.toggleCourseOutlineTrigger.defaultMessage,
-    });
-    expect(toggleButton).not.toBeInTheDocument();
-  });
 });
diff --git a/src/courseware/course/sidebar/sidebars/course-outline/hooks.jsx b/src/courseware/course/sidebar/sidebars/course-outline/hooks.jsx
@@ -9,7 +9,6 @@ import { checkBlockCompletion, getCourseOutlineStructure } from '@src/courseware
 import OldSidebarContext from '@src/courseware/course/sidebar/SidebarContext';
 import NewSidebarContext from '@src/courseware/course/new-sidebar/SidebarContext';
 import {
-  getCoursewareOutlineSidebarSettings,
   getCourseOutlineShouldUpdate,
   getCourseOutlineStatus,
   getSequenceId,
@@ -22,7 +21,6 @@ import { ID } from './constants';
 export const useCourseOutlineSidebar = () => {
   const dispatch = useDispatch();
   const isCollapsedOutlineSidebar = window.sessionStorage.getItem('hideCourseOutlineSidebar');
-  const { enableNavigationSidebar: isEnabledSidebar } = useSelector(getCoursewareOutlineSidebarSettings);
   const courseOutlineShouldUpdate = useSelector(getCourseOutlineShouldUpdate);
   const courseOutlineStatus = useSelector(getCourseOutlineStatus);
   const sequenceStatus = useSelector(getSequenceStatus);
@@ -42,7 +40,7 @@ export const useCourseOutlineSidebar = () => {
     shouldDisplayFullScreen,
   } = useContext(SidebarContext);
 
-  const isOpenSidebar = !initialSidebar && isEnabledSidebar && !isCollapsedOutlineSidebar;
+  const isOpenSidebar = !initialSidebar && !isCollapsedOutlineSidebar;
   const [isOpen, setIsOpen] = useState(true);
 
   const {
@@ -99,17 +97,16 @@ export const useCourseOutlineSidebar = () => {
   }, [initialSidebar, unitId]);
 
   useEffect(() => {
-    if ((isEnabledSidebar && courseOutlineStatus !== LOADED) || courseOutlineShouldUpdate) {
+    if (courseOutlineStatus !== LOADED || courseOutlineShouldUpdate) {
       dispatch(getCourseOutlineStructure(courseId));
     }
-  }, [courseId, isEnabledSidebar, courseOutlineShouldUpdate]);
+  }, [courseId, courseOutlineShouldUpdate]);
 
   return {
     courseId,
     unitId,
     currentSidebar,
     shouldDisplayFullScreen,
-    isEnabledSidebar,
     isOpen,
     setIsOpen,
     handleToggleCollapse,
diff --git a/src/courseware/data/api.js b/src/courseware/data/api.js
diff --git a/src/courseware/data/redux.test.js b/src/courseware/data/redux.test.js
diff --git a/src/courseware/data/selectors.js b/src/courseware/data/selectors.js
diff --git a/src/courseware/data/slice.js b/src/courseware/data/slice.js
diff --git a/src/courseware/data/thunks.js b/src/courseware/data/thunks.js
diff --git a/src/plugin-slots/UnitTitleSlot/index.jsx b/src/plugin-slots/UnitTitleSlot/index.jsx
diff --git a/src/setupTest.js b/src/setupTest.js
