Skip to content

refactor: remove deprecated sidebar toggles #37983

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.

Sign up for GitHub

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

Merged
brian-smith-tcril merged 1 commit into from
Feb 9, 2026
+4 −171
Merged

refactor: remove deprecated sidebar toggles #37983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
144 changes: 4 additions & 140 deletions lms/djangoapps/courseware/tests/test_views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,6 @@
from lms.djangoapps.courseware.tests.helpers import MasqueradeMixin, get_expiration_banner_text
from lms.djangoapps.courseware.testutils import RenderXBlockTestMixin
from lms.djangoapps.courseware.toggles import (
COURSEWARE_MICROFRONTEND_ALWAYS_OPEN_AUXILIARY_SIDEBAR,
COURSEWARE_MICROFRONTEND_ENABLE_NAVIGATION_SIDEBAR,
COURSEWARE_MICROFRONTEND_SEARCH_ENABLED,
COURSEWARE_OPTIMIZED_RENDER_XBLOCK,
)
Expand Down Expand Up @@ -3251,13 +3249,10 @@ def setUp(self):
self.client = APIClient()
self.apiUrl = reverse('courseware_navigation_sidebar_toggles_view', kwargs={'course_id': str(self.course.id)})

@override_waffle_flag(COURSEWARE_MICROFRONTEND_ENABLE_NAVIGATION_SIDEBAR, active=True)
@override_waffle_flag(COURSEWARE_MICROFRONTEND_ALWAYS_OPEN_AUXILIARY_SIDEBAR, active=False)
@override_waffle_switch(ENABLE_COMPLETION_TRACKING_SWITCH, active=False)
def test_courseware_mfe_navigation_sidebar_enabled_aux_disabled_completion_track_disabled(self):
def test_courseware_mfe_navigation_sidebar_completion_track_disabled(self):
"""
Getter to check if it is allowed to show the Courseware navigation sidebar to a user
and auxiliary sidebar doesn't open.
Getter to check if completion tracking is disabled.
"""
response = self.client.get(self.apiUrl, content_type='application/json')
body = json.loads(response.content.decode('utf-8'))
Expand All @@ -3266,19 +3261,14 @@ def test_courseware_mfe_navigation_sidebar_enabled_aux_disabled_completion_track
self.assertEqual(
body,
{
"enable_navigation_sidebar": True,
"always_open_auxiliary_sidebar": False,
"enable_completion_tracking": False,
},
)

@override_waffle_flag(COURSEWARE_MICROFRONTEND_ENABLE_NAVIGATION_SIDEBAR, active=True)
@override_waffle_flag(COURSEWARE_MICROFRONTEND_ALWAYS_OPEN_AUXILIARY_SIDEBAR, active=False)
@override_waffle_switch(ENABLE_COMPLETION_TRACKING_SWITCH, active=True)
def test_courseware_mfe_navigation_sidebar_enabled_aux_disabled_completion_track_enabled(self):
def test_courseware_mfe_navigation_sidebar_completion_track_enabled(self):
"""
Getter to check if it is allowed to show the Courseware navigation sidebar to a user
and auxiliary sidebar doesn't open.
Getter to check if completion tracking is enabled.
"""
response = self.client.get(self.apiUrl, content_type='application/json')
body = json.loads(response.content.decode('utf-8'))
Expand All @@ -3287,132 +3277,6 @@ def test_courseware_mfe_navigation_sidebar_enabled_aux_disabled_completion_track
self.assertEqual(
body,
{
"enable_navigation_sidebar": True,
"always_open_auxiliary_sidebar": False,
"enable_completion_tracking": True,
},
)

@override_waffle_flag(COURSEWARE_MICROFRONTEND_ENABLE_NAVIGATION_SIDEBAR, active=True)
@override_waffle_flag(COURSEWARE_MICROFRONTEND_ALWAYS_OPEN_AUXILIARY_SIDEBAR, active=True)
@override_waffle_switch(ENABLE_COMPLETION_TRACKING_SWITCH, active=False)
def test_courseware_mfe_navigation_sidebar_enabled_aux_enabled_completion_track_disabled(self):
"""
Getter to check if it is allowed to show the Courseware navigation sidebar to a user
and auxiliary sidebar should always open.
"""
response = self.client.get(self.apiUrl, content_type='application/json')
body = json.loads(response.content.decode('utf-8'))

self.assertEqual(response.status_code, 200)
self.assertEqual(
body,
{
"enable_navigation_sidebar": True,
"always_open_auxiliary_sidebar": True,
"enable_completion_tracking": False,
},
)

@override_waffle_flag(COURSEWARE_MICROFRONTEND_ENABLE_NAVIGATION_SIDEBAR, active=True)
@override_waffle_flag(COURSEWARE_MICROFRONTEND_ALWAYS_OPEN_AUXILIARY_SIDEBAR, active=True)
@override_waffle_switch(ENABLE_COMPLETION_TRACKING_SWITCH, active=True)
def test_courseware_mfe_navigation_sidebar_enabled_aux_enabled_completion_track_enabled(self):
"""
Getter to check if it is allowed to show the Courseware navigation sidebar to a user
and auxiliary sidebar should always open.
"""
response = self.client.get(self.apiUrl, content_type='application/json')
body = json.loads(response.content.decode('utf-8'))

self.assertEqual(response.status_code, 200)
self.assertEqual(
body,
{
"enable_navigation_sidebar": True,
"always_open_auxiliary_sidebar": True,
"enable_completion_tracking": True,
},
)

@override_waffle_flag(COURSEWARE_MICROFRONTEND_ENABLE_NAVIGATION_SIDEBAR, active=False)
@override_waffle_flag(COURSEWARE_MICROFRONTEND_ALWAYS_OPEN_AUXILIARY_SIDEBAR, active=True)
@override_waffle_switch(ENABLE_COMPLETION_TRACKING_SWITCH, active=False)
def test_courseware_mfe_navigation_sidebar_disabled_aux_enabled_completion_track_disabled(self):
"""
Getter to check if the Courseware navigation sidebar shouldn't be shown to a user
and auxiliary sidebar should always open.
"""
response = self.client.get(self.apiUrl, content_type='application/json')
body = json.loads(response.content.decode('utf-8'))

self.assertEqual(response.status_code, 200)
self.assertEqual(
body,
{
"enable_navigation_sidebar": False,
"always_open_auxiliary_sidebar": True,
"enable_completion_tracking": False,
},
)

@override_waffle_flag(COURSEWARE_MICROFRONTEND_ENABLE_NAVIGATION_SIDEBAR, active=False)
@override_waffle_flag(COURSEWARE_MICROFRONTEND_ALWAYS_OPEN_AUXILIARY_SIDEBAR, active=True)
@override_waffle_switch(ENABLE_COMPLETION_TRACKING_SWITCH, active=True)
def test_courseware_mfe_navigation_sidebar_disabled_aux_enabled_completion_track_enabled(self):
"""
Getter to check if the Courseware navigation sidebar shouldn't be shown to a user
and auxiliary sidebar should always open.
"""
response = self.client.get(self.apiUrl, content_type='application/json')
body = json.loads(response.content.decode('utf-8'))

self.assertEqual(response.status_code, 200)
self.assertEqual(
body,
{
"enable_navigation_sidebar": False,
"always_open_auxiliary_sidebar": True,
"enable_completion_tracking": True,
},
)

@override_waffle_flag(COURSEWARE_MICROFRONTEND_ENABLE_NAVIGATION_SIDEBAR, active=False)
@override_waffle_flag(COURSEWARE_MICROFRONTEND_ALWAYS_OPEN_AUXILIARY_SIDEBAR, active=False)
@override_waffle_switch(ENABLE_COMPLETION_TRACKING_SWITCH, active=False)
def test_courseware_mfe_navigation_sidebar_toggles_disabled_completion_track_disabled(self):
"""
Getter to check if neither navigation sidebar nor auxiliary sidebar is shown.
"""
response = self.client.get(self.apiUrl, content_type='application/json')
body = json.loads(response.content.decode('utf-8'))

self.assertEqual(response.status_code, 200)
self.assertEqual(
body,
{
"enable_navigation_sidebar": False,
"always_open_auxiliary_sidebar": False,
"enable_completion_tracking": False,
},
)

@override_waffle_flag(COURSEWARE_MICROFRONTEND_ENABLE_NAVIGATION_SIDEBAR, active=False)
@override_waffle_flag(COURSEWARE_MICROFRONTEND_ALWAYS_OPEN_AUXILIARY_SIDEBAR, active=False)
@override_waffle_switch(ENABLE_COMPLETION_TRACKING_SWITCH, active=True)
def test_courseware_mfe_navigation_sidebar_toggles_disabled_completion_track_enabled(self):
"""
Getter to check if neither navigation sidebar nor auxiliary sidebar is shown.
"""
response = self.client.get(self.apiUrl, content_type='application/json')
body = json.loads(response.content.decode('utf-8'))

self.assertEqual(response.status_code, 200)
self.assertEqual(
body,
{
"enable_navigation_sidebar": False,
"always_open_auxiliary_sidebar": False,
"enable_completion_tracking": True,
},
)
Expand Down
27 changes: 0 additions & 27 deletions lms/djangoapps/courseware/toggles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,33 +83,6 @@
f'{WAFFLE_FLAG_NAMESPACE}.disable_navigation_sidebar_blocks_caching', __name__
)

# .. toggle_name: courseware.enable_navigation_sidebar
# .. toggle_implementation: WaffleFlag
# .. toggle_default: False
# .. toggle_description: Enable navigation sidebar on Learning MFE
# .. toggle_use_cases: opt_out, open_edx
# .. toggle_creation_date: 2024-03-07
# .. toggle_target_removal_date: None
# .. toggle_tickets: FC-0056
COURSEWARE_MICROFRONTEND_ENABLE_NAVIGATION_SIDEBAR = CourseWaffleFlag(
f'{WAFFLE_FLAG_NAMESPACE}.enable_navigation_sidebar', __name__
)

# .. toggle_name: courseware.always_open_auxiliary_sidebar
# .. toggle_implementation: WaffleFlag
# .. toggle_default: True
# .. toggle_description: Waffle flag that determines whether the auxiliary sidebar,
# such as discussion or notification, should automatically expand
# on each course unit page within the Learning MFE, without preserving
# the previous state of the sidebar.
# .. toggle_use_cases: temporary
# .. toggle_creation_date: 2024-04-28
# .. toggle_target_removal_date: 2024-07-28
# .. toggle_tickets: FC-0056
COURSEWARE_MICROFRONTEND_ALWAYS_OPEN_AUXILIARY_SIDEBAR = CourseWaffleFlag(
f'{WAFFLE_FLAG_NAMESPACE}.always_open_auxiliary_sidebar', __name__
)

# .. toggle_name: courseware.mfe_progress_milestones_streak_discount_enabled
# .. toggle_implementation: CourseWaffleFlag
# .. toggle_default: False
Expand Down
4 changes: 0 additions & 4 deletions lms/djangoapps/courseware/views/views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,6 @@
from lms.djangoapps.courseware.toggles import (
course_is_invitation_only,
courseware_mfe_search_is_enabled,
COURSEWARE_MICROFRONTEND_ENABLE_NAVIGATION_SIDEBAR,
COURSEWARE_MICROFRONTEND_ALWAYS_OPEN_AUXILIARY_SIDEBAR,
)
from completion.waffle import ENABLE_COMPLETION_TRACKING_SWITCH
from lms.djangoapps.courseware.user_state_client import DjangoXBlockUserStateClient
Expand Down Expand Up @@ -2398,8 +2396,6 @@ def courseware_mfe_navigation_sidebar_toggles(request, course_id=None):
return JsonResponse({"error": "Invalid course_id"})

return JsonResponse({
"enable_navigation_sidebar": COURSEWARE_MICROFRONTEND_ENABLE_NAVIGATION_SIDEBAR.is_enabled(course_key),
"always_open_auxiliary_sidebar": COURSEWARE_MICROFRONTEND_ALWAYS_OPEN_AUXILIARY_SIDEBAR.is_enabled(course_key),
# Add completion tracking status for the sidebar use while a global place for switches is put in place
"enable_completion_tracking": ENABLE_COMPLETION_TRACKING_SWITCH.is_enabled()
Copy link
Member

@kdmccormick kdmccormick Feb 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's pretty silly to have a REST API just for as single switch. even siller that it's parameterized on the course_id while the switch is site-wide. it would make a lot more sense if this were a waffle flag which got fed to the MFE Config API. (no changes needed, not a problem for now--just writing down my thoughts while I'm here.)

})
Loading