Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: AA-797 switch course home flag to opt out by replacing it with a course home use legacy frontend flag

Browse Source
This commit is contained in:
Sofia Yoon
2021-06-09 11:22:00 -04:00
parent ff5b3d532d
commit e645d11bba
17 changed files with 88 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
common/test/acceptance/tests/lms/test_lms.py
View File

@@ -2,6 +2,7 @@
End-to-end tests for the LMS.
"""
import pytest
from common.test.acceptance.fixtures.course import CourseFixture
from common.test.acceptance.pages.common.auto_auth import AutoAuthPage
@@ -55,6 +56,7 @@ class CourseWikiA11yTest(UniqueCourseTest):
self.course_wiki_page.open_editor()
self.course_wiki_edit_page.wait_for_page()
@pytest.mark.skip(reason='This test fails when using the new coursehome MFE.')
def test_view(self):
"""
Verify the basic accessibility of the wiki page as initially displayed.
@@ -67,6 +69,7 @@ class CourseWikiA11yTest(UniqueCourseTest):
})
self.course_wiki_page.a11y_audit.check_for_accessibility_errors()
@pytest.mark.skip(reason='This test fails when using the new coursehome MFE.')
def test_edit(self):
"""
Verify the basic accessibility of edit wiki page.
@@ -80,6 +83,7 @@ class CourseWikiA11yTest(UniqueCourseTest):
})
self.course_wiki_edit_page.a11y_audit.check_for_accessibility_errors()
@pytest.mark.skip(reason='This test fails when using the new coursehome MFE.')
def test_changes(self):
"""
Verify the basic accessibility of changes wiki page.
@@ -95,6 +99,7 @@ class CourseWikiA11yTest(UniqueCourseTest):
history_page.wait_for_page()
history_page.a11y_audit.check_for_accessibility_errors()
@pytest.mark.skip(reason='This test fails when using the new coursehome MFE.')
def test_children(self):
"""
Verify the basic accessibility of changes wiki page.

3
common/test/acceptance/tests/lms/test_lms_course_home.py
View File

@@ -2,6 +2,8 @@
End-to-end tests for the LMS that utilize the course home page and course outline.
"""
import pytest
from openedx.core.lib.tests import attr
from ...fixtures.course import CourseFixture, XBlockFixtureDesc
@@ -61,6 +63,7 @@ class CourseHomeA11yTest(CourseHomeBaseTest):
Tests the accessibility of the course home page
"""
@pytest.mark.skip(reason='This test fails when using the new coursehome MFE.')
def test_course_home_a11y(self):
"""
Test the accessibility of the course home page with course outline.

8
lms/djangoapps/course_home_api/dates/v1/tests/test_views.py
View File

@@ -10,8 +10,6 @@ from django.urls import reverse
from common.djangoapps.course_modes.models import CourseMode
from common.djangoapps.student.models import CourseEnrollment
from lms.djangoapps.course_home_api.tests.utils import BaseCourseHomeTests
from lms.djangoapps.course_home_api.toggles import COURSE_HOME_MICROFRONTEND
from lms.djangoapps.experiments.testutils import override_experiment_waffle_flag
from openedx.features.content_type_gating.models import ContentTypeGatingConfig
@@ -25,7 +23,6 @@ class DatesTabTestViews(BaseCourseHomeTests):
self.url = reverse('course-home-dates-tab', args=[self.course.id])
ContentTypeGatingConfig.objects.create(enabled=True, enabled_as_of=datetime(2017, 1, 1))
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@ddt.data(CourseMode.AUDIT, CourseMode.VERIFIED)
def test_get_authenticated_enrolled_user(self, enrollment_mode):
CourseEnrollment.enroll(self.user, self.course.id, enrollment_mode)
@@ -37,7 +34,6 @@ class DatesTabTestViews(BaseCourseHomeTests):
assert response.data.get('learner_is_full_access') == (enrollment_mode == CourseMode.VERIFIED)
assert all(block.get('learner_has_access') for block in date_blocks)
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@ddt.data(True, False)
def test_get_authenticated_user_not_enrolled(self, has_previously_enrolled):
if has_previously_enrolled:
@@ -47,19 +43,16 @@ class DatesTabTestViews(BaseCourseHomeTests):
response = self.client.get(self.url)
assert response.status_code == 401
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
def test_get_unauthenticated_user(self):
self.client.logout()
response = self.client.get(self.url)
assert response.status_code == 401
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
def test_get_unknown_course(self):
url = reverse('course-home-dates-tab', args=['course-v1:unknown+course+2T2020'])
response = self.client.get(url)
assert response.status_code == 404
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
def test_banner_data_is_returned(self):
CourseEnrollment.enroll(self.user, self.course.id)
response = self.client.get(self.url)
@@ -69,7 +62,6 @@ class DatesTabTestViews(BaseCourseHomeTests):
self.assertContains(response, 'content_type_gating_enabled')
self.assertContains(response, 'verified_upgrade_link')
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
def test_masquerade(self):
self.switch_to_staff()
CourseEnrollment.enroll(self.user, self.course.id, 'audit')

4
lms/djangoapps/course_home_api/dates/v1/views.py
View File

@@ -13,7 +13,7 @@ from rest_framework.response import Response
from common.djangoapps.student.models import CourseEnrollment
from lms.djangoapps.course_home_api.dates.v1.serializers import DatesTabSerializer
from lms.djangoapps.course_home_api.toggles import course_home_mfe_is_active
from lms.djangoapps.course_home_api.toggles import course_home_legacy_is_active
from lms.djangoapps.courseware.access import has_access
from lms.djangoapps.courseware.context_processor import user_timezone_locale_prefs
from lms.djangoapps.courseware.courses import get_course_date_blocks, get_course_with_access
@@ -75,7 +75,7 @@ class DatesTabView(RetrieveAPIView):
course_key_string = kwargs.get('course_key_string')
course_key = CourseKey.from_string(course_key_string)
if not course_home_mfe_is_active(course_key):
if course_home_legacy_is_active(course_key):
raise Http404
# Enable NR tracing for this view based on course

22
lms/djangoapps/course_home_api/outline/v1/tests/test_views.py
View File

@@ -16,7 +16,7 @@ from common.djangoapps.student.models import CourseEnrollment
from common.djangoapps.student.roles import CourseInstructorRole
from common.djangoapps.student.tests.factories import UserFactory
from lms.djangoapps.course_home_api.tests.utils import BaseCourseHomeTests
from lms.djangoapps.course_home_api.toggles import COURSE_HOME_MICROFRONTEND
from lms.djangoapps.course_home_api.toggles import COURSE_HOME_USE_LEGACY_FRONTEND
from lms.djangoapps.experiments.testutils import override_experiment_waffle_flag
from openedx.core.djangoapps.course_date_signals.utils import MIN_DURATION
from openedx.core.djangoapps.user_api.preferences.api import set_user_preference
@@ -43,7 +43,6 @@ class OutlineTabTestViews(BaseCourseHomeTests):
self.url = reverse('course-home-outline-tab', args=[self.course.id])
@override_waffle_flag(ENABLE_COURSE_GOALS, active=True)
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@ddt.data(CourseMode.AUDIT, CourseMode.VERIFIED)
def test_get_authenticated_enrolled_user(self, enrollment_mode):
CourseEnrollment.enroll(self.user, self.course.id, enrollment_mode)
@@ -75,7 +74,6 @@ class OutlineTabTestViews(BaseCourseHomeTests):
if resume_course_url:
assert 'http://' in resume_course_url
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@ddt.data(True, False)
def test_get_authenticated_user_not_enrolled(self, has_previously_enrolled):
if has_previously_enrolled:
@@ -97,7 +95,6 @@ class OutlineTabTestViews(BaseCourseHomeTests):
assert all((block.get('title') != '') for block in date_blocks)
assert all(block.get('date') for block in date_blocks)
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
def test_get_unauthenticated_user(self):
self.client.logout()
response = self.client.get(self.url)
@@ -114,7 +111,6 @@ class OutlineTabTestViews(BaseCourseHomeTests):
date_blocks = dates_widget.get('course_date_blocks')
assert len(date_blocks) == 0
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
def test_masquerade(self):
user = UserFactory()
set_user_preference(user, 'time_zone', 'Asia/Tokyo')
@@ -129,7 +125,6 @@ class OutlineTabTestViews(BaseCourseHomeTests):
self.update_masquerade(username=user.username)
assert self.client.get(self.url).data['dates_widget']['user_timezone'] == 'Asia/Tokyo'
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
def test_course_staff_can_see_non_user_specific_content_in_masquerade(self):
"""
Test that course staff can see the outline and other non-user-specific content when masquerading as a learner
@@ -151,27 +146,24 @@ class OutlineTabTestViews(BaseCourseHomeTests):
assert response.data['course_blocks'] is not None
assert response.data['handouts_html'] is not None
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@override_waffle_flag(COURSE_ENABLE_UNENROLLED_ACCESS_FLAG, active=True)
def test_handouts(self):
CourseEnrollment.enroll(self.user, self.course.id)
self.store.create_item(self.user.id, self.course.id, 'course_info', 'handouts', fields={'data': '<p>Hi</p>'})
assert self.client.get(self.url).data['handouts_html'] == '<p>Hi</p>'
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
def test_get_unknown_course(self):
url = reverse('course-home-outline-tab', args=['course-v1:unknown+course+2T2020'])
response = self.client.get(url)
assert response.status_code == 404
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=False)
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
@ddt.data(CourseMode.AUDIT, CourseMode.VERIFIED)
def test_waffle_flag_disabled(self, enrollment_mode):
def test_legacy_view_enabled(self, enrollment_mode):
CourseEnrollment.enroll(self.user, self.course.id, enrollment_mode)
response = self.client.get(self.url)
assert response.status_code == 404
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@ddt.data(True, False)
def test_welcome_message(self, welcome_message_is_dismissed):
CourseEnrollment.enroll(self.user, self.course.id)
@@ -197,7 +189,6 @@ class OutlineTabTestViews(BaseCourseHomeTests):
welcome_message_html = self.client.get(self.url).data['welcome_message_html']
assert welcome_message_html == (None if welcome_message_is_dismissed else '<p>Welcome</p>')
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
def test_offer(self):
CourseEnrollment.enroll(self.user, self.course.id)
@@ -210,7 +201,6 @@ class OutlineTabTestViews(BaseCourseHomeTests):
# Just a quick spot check that the dictionary looks like what we expect
assert response.data['offer']['code'] == 'EDXWELCOME'
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
def test_access_expiration(self):
enrollment = CourseEnrollment.enroll(self.user, self.course.id, CourseMode.VERIFIED)
CourseDurationLimitConfig.objects.create(enabled=True, enabled_as_of=datetime(2018, 1, 1))
@@ -226,7 +216,6 @@ class OutlineTabTestViews(BaseCourseHomeTests):
assert response.data['access_expiration']['expiration_date'] == deadline
@override_waffle_flag(ENABLE_COURSE_GOALS, active=True)
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
def test_post_course_goal(self):
CourseEnrollment.enroll(self.user, self.course.id, CourseMode.AUDIT)
@@ -245,7 +234,6 @@ class OutlineTabTestViews(BaseCourseHomeTests):
assert selected_goal is not None
assert selected_goal['key'] == 'certify'
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@patch.dict('django.conf.settings.FEATURES', {'ENABLE_SPECIAL_EXAMS': True})
@patch('lms.djangoapps.course_api.blocks.transformers.milestones.get_attempt_status_summary')
def test_proctored_exam(self, mock_summary):
@@ -288,7 +276,6 @@ class OutlineTabTestViews(BaseCourseHomeTests):
assert exam_data['due'] is not None
assert exam_data['icon'] == 'fa-foo-bar'
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
def test_assignment(self):
course = CourseFactory.create()
with self.store.bulk_operations(course.id):
@@ -314,7 +301,6 @@ class OutlineTabTestViews(BaseCourseHomeTests):
assert ungraded_data['display_name'] == 'Ungraded'
assert ungraded_data['icon'] is None
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@override_waffle_flag(COURSE_ENABLE_UNENROLLED_ACCESS_FLAG, active=True)
@patch('lms.djangoapps.course_home_api.outline.v1.views.generate_offer_data', new=Mock(return_value={'a': 1}))
@patch('lms.djangoapps.course_home_api.outline.v1.views.get_access_expiration_data', new=Mock(return_value={'b': 1}))
@@ -352,14 +338,12 @@ class OutlineTabTestViews(BaseCourseHomeTests):
assert (data['access_expiration'] is not None) == show_enrolled
assert (data['resume_course']['url'] is not None) == show_enrolled
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@ddt.data(True, False)
def test_can_show_upgrade_sock(self, sock_enabled):
with override_waffle_flag(DISPLAY_COURSE_SOCK_FLAG, active=sock_enabled):
response = self.client.get(self.url)
assert response.data['can_show_upgrade_sock'] == sock_enabled
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
def test_verified_mode(self):
enrollment = CourseEnrollment.enroll(self.user, self.course.id)
CourseDurationLimitConfig.objects.create(enabled=True, enabled_as_of=datetime(2018, 1, 1))

9
lms/djangoapps/course_home_api/outline/v1/views.py
View File

@@ -29,7 +29,7 @@ from lms.djangoapps.course_goals.api import (
)
from lms.djangoapps.course_home_api.outline.v1.serializers import OutlineTabSerializer
from lms.djangoapps.course_home_api.toggles import (
course_home_mfe_is_active
course_home_legacy_is_active,
)
from lms.djangoapps.courseware.access import has_access
from lms.djangoapps.courseware.context_processor import user_timezone_locale_prefs
@@ -161,7 +161,7 @@ class OutlineTabView(RetrieveAPIView):
course_key = CourseKey.from_string(course_key_string)
course_usage_key = modulestore().make_course_usage_key(course_key)
if not course_home_mfe_is_active(course_key):
if course_home_legacy_is_active(course_key):
raise Http404
# Enable NR tracing for this view based on course
@@ -190,8 +190,9 @@ class OutlineTabView(RetrieveAPIView):
user_timezone_locale = user_timezone_locale_prefs(request)
user_timezone = user_timezone_locale['user_timezone']
dates_tab_link = request.build_absolute_uri(reverse('dates', args=[course.id]))
if course_home_mfe_is_active(course.id):
if course_home_legacy_is_active(course.id):
dates_tab_link = request.build_absolute_uri(reverse('dates', args=[course.id]))
else:
dates_tab_link = get_learning_mfe_home_url(course_key=course.id, view_name='dates')
# Set all of the defaults

14
lms/djangoapps/course_home_api/progress/v1/tests/test_views.py
View File

@@ -17,7 +17,7 @@ from common.djangoapps.student.models import CourseEnrollment
from common.djangoapps.student.tests.factories import UserFactory
from lms.djangoapps.course_home_api.tests.utils import BaseCourseHomeTests
from lms.djangoapps.course_home_api.models import DisableProgressPageStackedConfig
from lms.djangoapps.course_home_api.toggles import COURSE_HOME_MICROFRONTEND, COURSE_HOME_MICROFRONTEND_PROGRESS_TAB
from lms.djangoapps.course_home_api.toggles import COURSE_HOME_MICROFRONTEND_PROGRESS_TAB
from lms.djangoapps.experiments.testutils import override_experiment_waffle_flag
from lms.djangoapps.verify_student.models import ManualVerification
from openedx.core.djangoapps.content.course_overviews.models import CourseOverview
@@ -29,7 +29,6 @@ from xmodule.modulestore.tests.factories import ItemFactory
CREDIT_SUPPORT_URL = 'https://support.edx.org/hc/en-us/sections/115004154688-Purchasing-Academic-Credit'
@override_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@ddt.ddt
class ProgressTabTestViews(BaseCourseHomeTests):
"""
@@ -39,7 +38,6 @@ class ProgressTabTestViews(BaseCourseHomeTests):
super().setUp()
self.url = reverse('course-home-progress-tab', args=[self.course.id])
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@override_waffle_flag(COURSE_HOME_MICROFRONTEND_PROGRESS_TAB, active=True)
@ddt.data(CourseMode.AUDIT, CourseMode.VERIFIED)
def test_get_authenticated_enrolled_user(self, enrollment_mode):
@@ -61,7 +59,6 @@ class ProgressTabTestViews(BaseCourseHomeTests):
elif enrollment_mode == CourseMode.AUDIT:
assert response.data['certificate_data']['cert_status'] == 'audit_passing'
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@override_waffle_flag(COURSE_HOME_MICROFRONTEND_PROGRESS_TAB, active=True)
@ddt.data(True, False)
def test_get_authenticated_user_not_enrolled(self, has_previously_enrolled):
@@ -72,21 +69,18 @@ class ProgressTabTestViews(BaseCourseHomeTests):
response = self.client.get(self.url)
assert response.status_code == 401
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@override_waffle_flag(COURSE_HOME_MICROFRONTEND_PROGRESS_TAB, active=True)
def test_get_unauthenticated_user(self):
self.client.logout()
response = self.client.get(self.url)
assert response.status_code == 401
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@override_waffle_flag(COURSE_HOME_MICROFRONTEND_PROGRESS_TAB, active=True)
def test_get_unknown_course(self):
url = reverse('course-home-progress-tab', args=['course-v1:unknown+course+2T2020'])
response = self.client.get(url)
assert response.status_code == 404
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@override_waffle_flag(COURSE_HOME_MICROFRONTEND_PROGRESS_TAB, active=False)
@ddt.data(CourseMode.AUDIT, CourseMode.VERIFIED)
def test_waffle_flag_disabled(self, enrollment_mode):
@@ -94,7 +88,6 @@ class ProgressTabTestViews(BaseCourseHomeTests):
response = self.client.get(self.url)
assert response.status_code == 404
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@override_waffle_flag(COURSE_HOME_MICROFRONTEND_PROGRESS_TAB, active=True)
def test_masquerade(self):
# Enroll a verified user
@@ -114,7 +107,6 @@ class ProgressTabTestViews(BaseCourseHomeTests):
assert self.client.get(self.url).data.get('enrollment_mode') == 'verified'
@patch.dict('django.conf.settings.FEATURES', {'DISABLE_START_DATES': False})
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@override_waffle_flag(COURSE_HOME_MICROFRONTEND_PROGRESS_TAB, active=True)
def test_has_scheduled_content_data(self):
CourseEnrollment.enroll(self.user, self.course.id)
@@ -124,7 +116,6 @@ class ProgressTabTestViews(BaseCourseHomeTests):
assert response.status_code == 200
assert response.json()['has_scheduled_content']
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@override_waffle_flag(COURSE_HOME_MICROFRONTEND_PROGRESS_TAB, active=True)
def test_end(self):
CourseEnrollment.enroll(self.user, self.course.id)
@@ -136,7 +127,6 @@ class ProgressTabTestViews(BaseCourseHomeTests):
end = dateutil.parser.parse(response.json()['end']).replace(tzinfo=UTC)
assert end.date() == future.date()
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@override_waffle_flag(COURSE_HOME_MICROFRONTEND_PROGRESS_TAB, active=True)
def test_user_has_passing_grade(self):
CourseEnrollment.enroll(self.user, self.course.id)
@@ -146,7 +136,6 @@ class ProgressTabTestViews(BaseCourseHomeTests):
assert response.status_code == 200
assert response.json()['user_has_passing_grade']
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@override_waffle_flag(COURSE_HOME_MICROFRONTEND_PROGRESS_TAB, active=True)
def test_verified_mode(self):
enrollment = CourseEnrollment.enroll(self.user, self.course.id)
@@ -158,7 +147,6 @@ class ProgressTabTestViews(BaseCourseHomeTests):
'currency': 'USD', 'currency_symbol': '$', 'price': 149,
'sku': 'ABCD1234', 'upgrade_url': '/dashboard'}
@override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=True)
@override_waffle_flag(COURSE_HOME_MICROFRONTEND_PROGRESS_TAB, active=True)
def test_page_respects_stacked_config(self):
CourseEnrollment.enroll(self.user, self.course.id)

35
lms/djangoapps/course_home_api/toggles.py
View File

@@ -4,39 +4,36 @@ Toggles for course home experience.
from edx_toggles.toggles import LegacyWaffleFlagNamespace
from lms.djangoapps.experiments.flags import ExperimentWaffleFlag
from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag
WAFFLE_FLAG_NAMESPACE = LegacyWaffleFlagNamespace(name='course_home')
# .. toggle_name: course_home.course_home_mfe
# .. toggle_implementation: ExperimentWaffleFlag
# .. toggle_default: False
# .. toggle_description: This experiment flag enables the use of the learning microfrontend (frontend-app-learning)
# as the default course frontend.
# .. toggle_warnings: For this flag to have an effect, the LEARNING_MICROFRONTEND_URL setting must be configured, too.
# .. toggle_use_cases: temporary
# .. toggle_creation_date: 2020-05-29
# .. toggle_target_removal_date: 2021-10-09
# .. toggle_tickets: https://openedx.atlassian.net/browse/AA-117
COURSE_HOME_MICROFRONTEND = ExperimentWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'course_home_mfe', __name__)
COURSE_HOME_MICROFRONTEND_PROGRESS_TAB = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'course_home_mfe_progress_tab', # lint-amnesty, pylint: disable=toggle-missing-annotation
__name__)
# .. toggle_name: course_home.course_home_use_legacy_frontend
# .. toggle_implementation: CourseWaffleFlag
# .. toggle_default: False
# .. toggle_description: This flag enables the use of the legacy view of course home as the default course frontend.
# .. Learning microfrontend (frontend-app-learning) is now an opt-out view, where if this flag is
# .. enabled the default changes from the learning microfrontend to legacy.
# .. toggle_warnings: None
# .. toggle_use_cases: temporary
# .. toggle_creation_date: 2021-06-11
# .. toggle_target_removal_date: 2022-05-15
# .. toggle_tickets: https://openedx.atlassian.net/browse/AA-797
COURSE_HOME_USE_LEGACY_FRONTEND = CourseWaffleFlag(WAFFLE_FLAG_NAMESPACE, 'course_home_use_legacy_frontend', __name__)
def course_home_mfe_is_active(course_key):
return (
COURSE_HOME_MICROFRONTEND.is_enabled(course_key) and
not course_key.deprecated
)
def course_home_legacy_is_active(course_key):
return COURSE_HOME_USE_LEGACY_FRONTEND.is_enabled(course_key) or course_key.deprecated
def course_home_mfe_progress_tab_is_active(course_key):
# Avoiding a circular dependency
from .models import DisableProgressPageStackedConfig
return (
course_home_mfe_is_active(course_key) and
(not course_home_legacy_is_active(course_key)) and
COURSE_HOME_MICROFRONTEND_PROGRESS_TAB.is_enabled(course_key) and
not DisableProgressPageStackedConfig.current(course_key=course_key).disabled
)

14
lms/djangoapps/courseware/tabs.py
View File

@@ -10,7 +10,7 @@ from django.utils.translation import ugettext_noop
from lms.djangoapps.courseware.access import has_access
from lms.djangoapps.courseware.entrance_exams import user_can_skip_entrance_exam
from lms.djangoapps.course_home_api.toggles import course_home_mfe_is_active, course_home_mfe_progress_tab_is_active
from lms.djangoapps.course_home_api.toggles import course_home_legacy_is_active, course_home_mfe_progress_tab_is_active
from openedx.core.lib.course_tabs import CourseTabPluginManager
from openedx.features.course_experience import DISABLE_UNIFIED_COURSE_TAB_FLAG, default_course_url_name
from openedx.features.course_experience.url_helpers import get_learning_mfe_home_url
@@ -42,12 +42,12 @@ class CoursewareTab(EnrolledTab):
def __init__(self, tab_dict):
def link_func(course, reverse_func):
if course_home_mfe_is_active(course.id):
return get_learning_mfe_home_url(course_key=course.id, view_name='home')
else:
if course_home_legacy_is_active(course.id):
reverse_name_func = lambda course: default_course_url_name(course.id)
url_func = course_reverse_func_from_name_func(reverse_name_func)
return url_func(course, reverse_func)
else:
return get_learning_mfe_home_url(course_key=course.id, view_name='home')
tab_dict['link_func'] = link_func
super().__init__(tab_dict)
@@ -334,10 +334,10 @@ class DatesTab(EnrolledTab):
def __init__(self, tab_dict):
def link_func(course, reverse_func):
if course_home_mfe_is_active(course.id):
return get_learning_mfe_home_url(course_key=course.id, view_name=self.view_name)
else:
if course_home_legacy_is_active(course.id):
return reverse_func(self.view_name, args=[str(course.id)])
else:
return get_learning_mfe_home_url(course_key=course.id, view_name=self.view_name)
tab_dict['link_func'] = link_func
super().__init__(tab_dict)

2
lms/djangoapps/courseware/tests/test_about.py
View File

@@ -22,6 +22,7 @@ from lms.djangoapps.ccx.tests.factories import CcxFactory
from openedx.features.course_experience import COURSE_ENABLE_UNENROLLED_ACCESS_FLAG
from openedx.features.course_experience.waffle import ENABLE_COURSE_ABOUT_SIDEBAR_HTML
from openedx.features.course_experience.waffle import WAFFLE_NAMESPACE as COURSE_EXPERIENCE_WAFFLE_NAMESPACE
from lms.djangoapps.course_home_api.toggles import COURSE_HOME_USE_LEGACY_FRONTEND
from common.djangoapps.student.tests.factories import AdminFactory, CourseEnrollmentAllowedFactory, UserFactory
from common.djangoapps.track.tests import EventTrackingTestCase
from common.djangoapps.util.milestones_helpers import get_prerequisite_courses_display, set_prerequisite_courses
@@ -475,6 +476,7 @@ class CourseAboutTestCaseCCX(SharedModuleStoreTestCase, LoginEnrollmentTestCase)
self.coach = coach = AdminFactory.create(password="test")
self.client.login(username=coach.username, password="test")
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
def test_redirect_to_dashboard_unenrolled_ccx(self):
"""
Assert that when unenrolled user tries to access CCX do not allow the user to self-register.

24
lms/djangoapps/courseware/tests/test_date_summary.py
View File

@@ -17,7 +17,7 @@ from pytz import utc
from common.djangoapps.course_modes.models import CourseMode
from common.djangoapps.course_modes.tests.factories import CourseModeFactory
from lms.djangoapps.commerce.models import CommerceConfiguration
from lms.djangoapps.course_home_api.toggles import COURSE_HOME_MICROFRONTEND
from lms.djangoapps.course_home_api.toggles import COURSE_HOME_USE_LEGACY_FRONTEND
from lms.djangoapps.courseware.courses import get_course_date_blocks
from lms.djangoapps.courseware.date_summary import (
CertificateAvailableDate,
@@ -34,7 +34,6 @@ from lms.djangoapps.courseware.models import (
DynamicUpgradeDeadlineConfiguration,
OrgDynamicUpgradeDeadlineConfiguration
)
from lms.djangoapps.experiments.testutils import override_experiment_waffle_flag
from lms.djangoapps.verify_student.models import VerificationDeadline
from lms.djangoapps.verify_student.services import IDVerificationService
from lms.djangoapps.verify_student.tests.factories import SoftwareSecurePhotoVerificationFactory
@@ -83,6 +82,7 @@ class CourseDateSummaryTest(SharedModuleStoreTestCase):
response = self.client.get(url)
self.assertNotContains(response, 'date-summary', status_code=302)
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
def test_course_home_logged_out(self):
course = create_course_run()
url = reverse('openedx.course_experience.course_home', args=(course.id,))
@@ -428,6 +428,7 @@ class CourseDateSummaryTest(SharedModuleStoreTestCase):
'info',
'openedx.course_experience.course_home',
)
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
@override_waffle_flag(DISABLE_UNIFIED_COURSE_TAB_FLAG, active=False)
def test_todays_date_no_timezone(self, url_name):
with freeze_time('2015-01-02'):
@@ -450,6 +451,7 @@ class CourseDateSummaryTest(SharedModuleStoreTestCase):
'info',
'openedx.course_experience.course_home',
)
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
@override_waffle_flag(DISABLE_UNIFIED_COURSE_TAB_FLAG, active=False)
def test_todays_date_timezone(self, url_name):
with freeze_time('2015-01-02'):
@@ -480,6 +482,7 @@ class CourseDateSummaryTest(SharedModuleStoreTestCase):
'info',
'openedx.course_experience.course_home',
)
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
@override_waffle_flag(DISABLE_UNIFIED_COURSE_TAB_FLAG, active=False)
def test_start_date_render(self, url_name):
with freeze_time('2015-01-02'):
@@ -498,6 +501,7 @@ class CourseDateSummaryTest(SharedModuleStoreTestCase):
'info',
'openedx.course_experience.course_home',
)
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
@override_waffle_flag(DISABLE_UNIFIED_COURSE_TAB_FLAG, active=False)
def test_start_date_render_time_zone(self, url_name):
with freeze_time('2015-01-02'):
@@ -720,7 +724,7 @@ class CourseDateSummaryTest(SharedModuleStoreTestCase):
@ddt.unpack
@override_waffle_flag(DISABLE_UNIFIED_COURSE_TAB_FLAG, active=False)
@override_waffle_flag(RELATIVE_DATES_FLAG, active=True)
def test_dates_tab_link_render(self, url_name, mfe_active):
def test_dates_tab_link_render(self, url_name, legacy_active):
""" The dates tab link should only show for enrolled or staff users """
course = create_course_run()
html_elements = [
@@ -728,21 +732,21 @@ class CourseDateSummaryTest(SharedModuleStoreTestCase):
'View all course dates</a>',
]
# The url should change based on the mfe being active.
if mfe_active:
html_elements.append('/course/' + str(course.id) + '/dates')
else:
if legacy_active:
html_elements.append('/courses/' + str(course.id) + '/dates')
else:
html_elements.append('/course/' + str(course.id) + '/dates')
url = reverse(url_name, args=(course.id,))
def assert_html_elements(assert_function, user):
self.client.login(username=user.username, password=TEST_PASSWORD)
with override_experiment_waffle_flag(COURSE_HOME_MICROFRONTEND, active=mfe_active):
with override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=legacy_active):
response = self.client.get(url, follow=True)
if mfe_active and not user.is_staff:
assert 404 == response.status_code
else:
if legacy_active or user.is_staff:
for html in html_elements:
assert_function(response, html)
else:
assert 404 == response.status_code
self.client.logout()
with freeze_time('2015-01-02'):

4
lms/djangoapps/courseware/views/views.py
View File

@@ -55,7 +55,7 @@ from lms.djangoapps.certificates import api as certs_api
from lms.djangoapps.certificates.data import CertificateStatuses
from lms.djangoapps.commerce.utils import EcommerceService
from lms.djangoapps.course_home_api.toggles import (
course_home_mfe_is_active,
course_home_legacy_is_active,
course_home_mfe_progress_tab_is_active
)
from openedx.features.course_experience.url_helpers import get_learning_mfe_home_url, is_request_from_learning_mfe
@@ -1048,7 +1048,7 @@ def dates(request, course_id):
from lms.urls import COURSE_DATES_NAME, RESET_COURSE_DEADLINES_NAME
course_key = CourseKey.from_string(course_id)
if course_home_mfe_is_active(course_key) and not request.user.is_staff:
if not (course_home_legacy_is_active(course_key) or request.user.is_staff):
microfrontend_url = get_learning_mfe_home_url(course_key=course_key, view_name=COURSE_DATES_NAME)
raise Redirect(microfrontend_url)

4
lms/templates/dashboard/_dashboard_course_listing.html
View File

@@ -11,10 +11,12 @@ from django.utils.translation import ungettext
from django.urls import reverse
from common.djangoapps.course_modes.models import CourseMode
from common.djangoapps.course_modes.helpers import enrollment_mode_display
from lms.djangoapps.course_home_api.toggles import course_home_legacy_is_active
from lms.djangoapps.verify_student.services import IDVerificationService
from openedx.core.djangolib.js_utils import dump_js_escaped_json, js_escaped_string
from openedx.core.djangolib.markup import HTML, Text
from openedx.features.course_experience import course_home_url_name
from openedx.features.course_experience.url_helpers import get_learning_mfe_home_url
from common.djangoapps.student.helpers import (
VERIFY_STATUS_NEED_TO_VERIFY,
VERIFY_STATUS_SUBMITTED,
@@ -66,7 +68,7 @@ from lms.djangoapps.experiments.utils import UPSELL_TRACKING_FLAG
% endif
>
<article class="course${mode_class}" aria-labelledby="course-title-${enrollment.course_id}" id="course-card-${course_card_index}">
<% course_target = reverse(course_home_url_name(course_overview.id), args=[six.text_type(course_overview.id)]) %>
<% course_target = reverse(course_home_url_name(course_overview.id), args=[str(course_overview.id)]) if course_home_legacy_is_active(course_overview.id) else get_learning_mfe_home_url(course_key=course_overview.id, view_name="home") %>
<section class="details" aria-labelledby="details-heading-${enrollment.course_id}">
<h2 class="hd hd-2 sr" id="details-heading-${enrollment.course_id}">${_('Course details')}</h2>
<div class="wrapper-course-image" aria-hidden="true">

8
openedx/features/course_experience/api/v1/views.py
View File

@@ -20,7 +20,7 @@ from edx_rest_framework_extensions.auth.session.authentication import SessionAut
from opaque_keys.edx.keys import CourseKey
from lms.djangoapps.course_api.api import course_detail
from lms.djangoapps.course_home_api.toggles import course_home_mfe_is_active
from lms.djangoapps.course_home_api.toggles import course_home_legacy_is_active
from lms.djangoapps.courseware.access import has_access
from lms.djangoapps.courseware.courses import get_course_with_access
from lms.djangoapps.courseware.masquerade import is_masquerading, setup_masquerade
@@ -90,10 +90,10 @@ def reset_course_deadlines(request):
})
tracker.emit('edx.ui.lms.reset_deadlines.clicked', research_event_data)
if course_home_mfe_is_active(course_key):
body_link = get_learning_mfe_home_url(course_key=str(course_key), view_name='dates')
else:
if course_home_legacy_is_active(course_key):
body_link = '{}{}'.format(settings.LMS_ROOT_URL, reverse('dates', args=[str(course_key)]))
else:
body_link = get_learning_mfe_home_url(course_key=str(course_key), view_name='dates')
return Response({
'body': format_html('<a href="{}">{}</a>', body_link, _('View all dates')),

11
openedx/features/course_experience/tests/views/test_course_home.py
View File

@@ -28,6 +28,7 @@ from common.djangoapps.student.tests.factories import StaffFactory
from lms.djangoapps.commerce.models import CommerceConfiguration
from lms.djangoapps.commerce.utils import EcommerceService
from lms.djangoapps.course_goals.api import add_course_goal, get_course_goal
from lms.djangoapps.course_home_api.toggles import COURSE_HOME_USE_LEGACY_FRONTEND
from lms.djangoapps.courseware.tests.helpers import get_expiration_banner_text
from lms.djangoapps.discussion.django_comment_client.tests.factories import RoleFactory
from openedx.core.djangoapps.content.course_overviews.models import CourseOverview
@@ -158,6 +159,7 @@ class CourseHomePageTestCase(BaseCourseUpdatesTestCase):
class TestCourseHomePage(CourseHomePageTestCase): # lint-amnesty, pylint: disable=missing-class-docstring
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
def test_welcome_message_when_unified(self):
# Create a welcome message
self.create_course_update(TEST_WELCOME_MESSAGE)
@@ -166,6 +168,7 @@ class TestCourseHomePage(CourseHomePageTestCase): # lint-amnesty, pylint: disab
response = self.client.get(url)
self.assertContains(response, TEST_WELCOME_MESSAGE, status_code=200)
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
@override_waffle_flag(DISABLE_UNIFIED_COURSE_TAB_FLAG, active=True)
def test_welcome_message_when_not_unified(self):
# Create a welcome message
@@ -175,6 +178,7 @@ class TestCourseHomePage(CourseHomePageTestCase): # lint-amnesty, pylint: disab
response = self.client.get(url)
self.assertNotContains(response, TEST_WELCOME_MESSAGE, status_code=200)
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
def test_updates_tool_visibility(self):
"""
Verify that the updates course tool is visible only when the course
@@ -189,6 +193,7 @@ class TestCourseHomePage(CourseHomePageTestCase): # lint-amnesty, pylint: disab
response = self.client.get(url)
self.assertContains(response, TEST_COURSE_UPDATES_TOOL, status_code=200)
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
def test_queries(self):
"""
Verify that the view's query count doesn't regress.
@@ -270,6 +275,7 @@ class TestCourseHomePageAccess(CourseHomePageTestCase):
[True, COURSE_VISIBILITY_PUBLIC, CourseUserType.GLOBAL_STAFF, True, True],
)
@ddt.unpack
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
def test_home_page(
self, enable_unenrolled_access, course_visibility, user_type,
expected_enroll_message, expected_course_outline,
@@ -320,6 +326,7 @@ class TestCourseHomePageAccess(CourseHomePageTestCase):
self.assertContains(private_response,
'You must be enrolled in the course to see course content.')
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
@override_waffle_flag(DISABLE_UNIFIED_COURSE_TAB_FLAG, active=True)
@ddt.data(
[CourseUserType.ANONYMOUS, 'To see course content'],
@@ -356,6 +363,7 @@ class TestCourseHomePageAccess(CourseHomePageTestCase):
if expected_message:
self.assertContains(response, expected_message)
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
def test_sign_in_button(self):
"""
Verify that the sign in button will return to this page.
@@ -603,6 +611,7 @@ class TestCourseHomePageAccess(CourseHomePageTestCase):
response = self.client.get(url)
assert response.status_code == 404
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
@override_waffle_flag(COURSE_PRE_START_ACCESS_FLAG, active=True)
def test_masters_course_message(self):
enroll_button_html = "<button class=\"enroll-btn btn-link\">Enroll now</button>"
@@ -632,6 +641,7 @@ class TestCourseHomePageAccess(CourseHomePageTestCase):
self.assertContains(response, expected_message)
self.assertNotContains(response, enroll_button_html)
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
@override_waffle_flag(COURSE_PRE_START_ACCESS_FLAG, active=True)
def test_course_messaging(self):
"""
@@ -700,6 +710,7 @@ class TestCourseHomePageAccess(CourseHomePageTestCase):
self.assertContains(response, TEST_COURSE_HOME_MESSAGE)
self.assertContains(response, TEST_COURSE_HOME_MESSAGE_PRE_START)
@override_waffle_flag(COURSE_HOME_USE_LEGACY_FRONTEND, active=True)
def test_course_messaging_for_staff(self):
"""
Staff users will not see the expiration banner when course duration limits

8
openedx/features/course_experience/views/course_dates.py
View File

@@ -14,7 +14,7 @@ from web_fragments.fragment import Fragment
from lms.djangoapps.courseware.courses import get_course_date_blocks, get_course_with_access
from lms.djangoapps.courseware.tabs import DatesTab
from lms.djangoapps.course_home_api.toggles import course_home_mfe_is_active
from lms.djangoapps.course_home_api.toggles import course_home_legacy_is_active
from openedx.features.course_experience.url_helpers import get_learning_mfe_home_url
from openedx.core.djangoapps.plugin_api.views import EdxFragmentView
@@ -34,10 +34,10 @@ class CourseDatesFragmentView(EdxFragmentView):
course_date_blocks = get_course_date_blocks(course, request.user, request, num_assignments=1)
dates_tab_enabled = DatesTab.is_enabled(course, request.user)
if course_home_mfe_is_active(course_key):
dates_tab_link = get_learning_mfe_home_url(course_key=course.id, view_name='dates')
else:
if course_home_legacy_is_active(course_key):
dates_tab_link = reverse('dates', args=[course.id])
else:
dates_tab_link = get_learning_mfe_home_url(course_key=course.id, view_name='dates')
context = {
'course_date_blocks': [block for block in course_date_blocks if block.title != 'current_datetime'],

12
openedx/features/course_experience/views/course_home.py
View File

@@ -13,7 +13,7 @@ from django.views.decorators.csrf import ensure_csrf_cookie
from opaque_keys.edx.keys import CourseKey
from web_fragments.fragment import Fragment
from lms.djangoapps.course_home_api.toggles import course_home_mfe_is_active
from lms.djangoapps.course_home_api.toggles import course_home_legacy_is_active
from lms.djangoapps.courseware.access import has_access
from lms.djangoapps.courseware.courses import can_self_enroll_in_course, get_course_info_section, get_course_with_access
from lms.djangoapps.course_goals.api import (
@@ -67,11 +67,11 @@ class CourseHomeView(CourseTabView):
def render_to_fragment(self, request, course=None, tab=None, **kwargs): # lint-amnesty, pylint: disable=arguments-differ, unused-argument
course_id = str(course.id)
if course_home_mfe_is_active(course.id) and not request.user.is_staff:
microfrontend_url = get_learning_mfe_home_url(course_key=course_id, view_name="home")
raise Redirect(microfrontend_url)
home_fragment_view = CourseHomeFragmentView()
return home_fragment_view.render_to_fragment(request, course_id=course_id, **kwargs)
if course_home_legacy_is_active(course.id) or request.user.is_staff:
home_fragment_view = CourseHomeFragmentView()
return home_fragment_view.render_to_fragment(request, course_id=course_id, **kwargs)
microfrontend_url = get_learning_mfe_home_url(course_key=course_id, view_name="home")
raise Redirect(microfrontend_url)
class CourseHomeFragmentView(EdxFragmentView):