refactor: remove the hide dates course field

Author: Anas12091101

lms/djangoapps/courseware/plugins.py

@@ -8,8 +8,10 @@
 from opaque_keys.edx.keys import CourseKey
 
 from xmodule.modulestore.django import modulestore
+from xmodule.tabs import CourseTabList
+
+from openedx.core.djangoapps.content.course_overviews.models import CourseOverview, CourseTab
 
-from openedx.core.djangoapps.content.course_overviews.models import CourseOverview
 from openedx.core.djangoapps.course_apps.plugins import CourseApp
 from openedx.core.lib.courses import get_course_by_id
 
@@ -87,15 +89,22 @@ def is_enabled(cls, course_key: CourseKey) -> bool:
         """
         The dates course status is stored in the course block.
         """
-        return not CourseOverview.get_from_id(course_key).hide_dates_tab
+        course = get_course_by_id(course_key)
+        dates_tab = CourseTabList.get_tab_by_id(course.tabs, 'dates')
+        return bool(dates_tab and not dates_tab.is_hidden)
 
     @classmethod
     def set_enabled(cls, course_key: CourseKey, enabled: bool, user: 'User') -> bool:
         """
         The dates course enabled/disabled status is stored in the course block.
         """
         course = get_course_by_id(course_key)
-        course.hide_dates_tab = not enabled
+        dates_tab = CourseTabList.get_tab_by_id(course.tabs, 'dates')
+        if enabled and dates_tab is None:
+            dates_tab = CourseTab.load("dates")
+            course.tabs.append(dates_tab)
+        if dates_tab is not None:
+            dates_tab.is_hidden = not enabled
         modulestore().update_item(course, user.id)
         return enabled
 

lms/djangoapps/courseware/tabs.py

@@ -320,8 +320,8 @@ def link_func(course, _reverse_func):
     def is_enabled(cls, course, user=None):
         if not super().is_enabled(course, user=user):
             return False
-        return not getattr(course, 'hide_dates_tab', False)
-
+        dates_tab = CourseTabList.get_tab_by_id(course.tabs, 'dates')
+        return bool(dates_tab and not dates_tab.is_hidden)
 
 def get_course_tab_list(user, course):
     """

lms/djangoapps/courseware/tests/test_tabs.py

@@ -870,7 +870,6 @@ def test_singular_dates_tab(self):
         """Test cases for making sure no persisted dates tab is surfaced"""
         user = self.create_mock_user()
         self.course.tabs = self.all_valid_tab_list
-        self.course.hide_dates_tab = False
         self.course.save()
 
         # Verify that there is a dates tab in the modulestore
@@ -890,13 +889,18 @@ def test_singular_dates_tab(self):
 
     @patch('common.djangoapps.student.models.course_enrollment.CourseEnrollment.is_enrolled')
     def test_dates_tab_respects_hide_flag(self, is_enrolled):
-        tab = DatesTab({'type': DatesTab.type, 'name': 'dates'})
-
+        """Test that the dates tab respects the hide flag."""
         is_enrolled.return_value = True
         user = self.create_mock_user(is_staff=False, is_enrolled=True)
+        self.course.tabs = self.all_valid_tab_list
+        dates_tab = xmodule_tabs.CourseTabList.get_tab_by_id(self.course.tabs, 'dates')
+        assert dates_tab is not None
 
-        self.course.hide_dates_tab = False
-        assert self.is_tab_enabled(tab, self.course, user)
+        dates_tab.is_hidden = False
+        self.course.save()
+        tabs = get_course_tab_list(user, self.course)
+        assert any(tab.type == 'dates' for tab in tabs)
 
-        self.course.hide_dates_tab = True
-        assert not self.is_tab_enabled(tab, self.course, user)
+        dates_tab.is_hidden = True
+        tabs = get_course_tab_list(user, self.course)
+        assert not any(tab.type == 'dates' for tab in tabs)

lms/envs/common.py

@@ -2779,7 +2779,6 @@
 # .. setting_description: Content to replace spam posts with
 CONTENT_FOR_SPAM_POSTS = ""
 
-
 # .. toggle_name: ENABLE_AUTHN_RESET_PASSWORD_HIBP_POLICY
 # .. toggle_implementation: DjangoSetting
 # .. toggle_default: False

openedx/core/djangoapps/content/course_overviews/models.py

@@ -943,13 +943,6 @@ def hide_progress_tab(self):
         """
         return self._original_course.hide_progress_tab
 
-    @property
-    def hide_dates_tab(self):
-        """
-        TODO: move this to the model.
-        """
-        return self._original_course.hide_dates_tab
-
     @property
     def edxnotes(self):
         """

xmodule/course_block.py

@@ -727,13 +727,6 @@ class CourseFields:  # lint-amnesty, pylint: disable=missing-class-docstring
         deprecated=True
     )
 
-    hide_dates_tab = Boolean(
-        display_name=_("Hide Dates Tab"),
-        help=_("Allows hiding of the dates tab."),
-        scope=Scope.settings,
-        deprecated=True
-    )
-
     display_organization = String(
         display_name=_("Course Organization Display String"),
         help=_(