Merge pull request #27554 from edx/ddumesnil/start-end-date-comments

refactor: Switch to using course_overview start and end everywhere

common/djangoapps/util/course.py

@@ -76,12 +76,11 @@ def has_certificates_enabled(course):
 def should_display_grade(course_overview):
     """
     Returns True or False depending upon either certificate available date
-    or course-end-date
+    or course end date
     """
-    course_end_date = course_overview.end_date
     cert_available_date = course_overview.certificate_available_date
     current_date = now().replace(hour=0, minute=0, second=0, microsecond=0)
     if cert_available_date:
         return cert_available_date < current_date
 
-    return course_end_date and course_end_date < current_date
+    return course_overview.end and course_overview.end < current_date

lms/djangoapps/courseware/course_tools.py

@@ -107,7 +107,7 @@ class FinancialAssistanceTool(CourseTool):
             return False
 
         # hide link for archived courses
-        if course_overview is not None and course_overview.end_date is not None and now > course_overview.end_date:
+        if course_overview is not None and course_overview.end is not None and now > course_overview.end:
             return False
 
         # hide link if not logged in or user not enrolled in the course

lms/djangoapps/courseware/tests/test_course_tools.py

@@ -179,7 +179,7 @@ class FinancialAssistanceToolTest(SharedModuleStoreTestCase):
         assert not FinancialAssistanceTool().is_enabled(self.request, self.course.id)
 
     def test_tool_not_visible_when_end_date_passed(self):
-        self.course_overview.end_date = self.now - datetime.timedelta(days=30)
+        self.course_overview.end = self.now - datetime.timedelta(days=30)
         self.course_overview.save()
         assert not FinancialAssistanceTool().is_enabled(self.request, self.course_overview.id)
 

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

@@ -76,12 +76,15 @@ class CourseOverview(TimeStampedModel):
     display_number_with_default = TextField()
     display_org_with_default = TextField()
 
-    # Start/end dates
-    # TODO Remove 'start' & 'end' in removing field in column renaming, DE-1822
     start = DateTimeField(null=True)
     end = DateTimeField(null=True)
+
+    # These are deprecated and unused, but cannot be dropped via simple migration due to the size of the downstream
+    # history table. See DENG-19 for details.
+    # Please use start and end above for these values.
     start_date = DateTimeField(null=True)
     end_date = DateTimeField(null=True)
+
     advertised_start = TextField(null=True)
     announcement = DateTimeField(null=True)
 
@@ -194,10 +197,7 @@ class CourseOverview(TimeStampedModel):
         course_overview.display_org_with_default = course.display_org_with_default
 
         course_overview.start = start
-        # Add writes to new fields 'start_date' & 'end_date'.
-        course_overview.start_date = start
         course_overview.end = end
-        course_overview.end_date = end
         course_overview.advertised_start = course.advertised_start
         course_overview.announcement = course.announcement
 

openedx/core/djangoapps/credit/services.py

@@ -103,7 +103,7 @@ class CreditService:
             course_overview = CourseOverview.get_from_id(course_key)
             result.update({
                 'course_name': course_overview.display_name,
-                'course_end_date': course_overview.end_date,
+                'course_end_date': course_overview.end,
             })
         return result
 

openedx/features/course_experience/utils.py

@@ -172,11 +172,9 @@ def dates_banner_should_display(course_key, user):
         return False, False
 
     course_overview = CourseOverview.objects.get(id=str(course_key))
-    course_end_date = getattr(course_overview, 'end_date', None)
-    is_self_paced = getattr(course_overview, 'self_paced', False)
 
     # Only display the banner for self-paced courses
-    if not is_self_paced:
+    if not course_overview.self_paced:
         return False, False
 
     # Only display the banner for enrolled users
@@ -184,7 +182,7 @@ def dates_banner_should_display(course_key, user):
         return False, False
 
     # Don't display the banner if the course has ended
-    if course_end_date and course_end_date < timezone.now():
+    if course_overview.end and course_overview.end < timezone.now():
         return False, False
 
     store = modulestore()