Merge pull request #633 from openedx/ENT-9890/fix-course-run-metadata

hamzawaleed01 · web-flow · commit 942bd29faee5 · 2025-02-11T11:40:22.000+05:00
fix: use course-run specific metadata
diff --git a/enterprise_access/apps/content_assignments/tasks.py b/enterprise_access/apps/content_assignments/tasks.py
@@ -20,6 +20,7 @@
 from enterprise_access.tasks import LoggedTaskWithRetry
 from enterprise_access.utils import (
     get_automatic_expiration_date_and_reason,
+    get_course_run_metadata_for_assignment,
     get_normalized_metadata_for_assignment,
     localized_utcnow
 )
@@ -217,14 +218,14 @@ def get_start_date(self):
         """
         start_date = self.normalized_metadata.get('start_date')
         end_date = self.normalized_metadata.get('end_date')
-        course_metadata = self.course_metadata
+        course_run_metadata = get_course_run_metadata_for_assignment(self.assignment, self.course_metadata)
         logger.info(
             f"[get_start_date] Assignment UUID: {self.assignment.uuid} - start_date: {start_date}, "
             f"end_date: {end_date}, "
-            f"course_metadata: {course_metadata}"
+            f"course_run_metadata: {course_run_metadata}"
         )
         return get_human_readable_date(
-            get_self_paced_normalized_start_date(start_date, end_date, course_metadata)
+            get_self_paced_normalized_start_date(start_date, end_date, course_run_metadata)
         )
 
     def get_action_required_by_timestamp(self):
diff --git a/enterprise_access/apps/content_assignments/tests/test_tasks.py b/enterprise_access/apps/content_assignments/tests/test_tasks.py
@@ -232,6 +232,17 @@ def setUpTestData(cls):
         }
         cls.mock_content_metadata = {
             'key': TEST_COURSE_KEY,
+            'course_runs': [
+                {
+                    'key': TEST_COURSE_RUN_KEY,
+                    'start': '2020-01-01T12:00:00Z',
+                    'end': '2022-01-01 12:00:00Z',
+                    'enrollment_start': None,
+                    'enrollment_end': '2023-09-11T19:00:00Z',
+                    'pacing_type': 'self_paced',
+                    'weeks_to_complete': 8,
+                }
+            ],
             'normalized_metadata': {
                 'start_date': '2020-01-01T12:00:00Z',
                 'end_date': '2022-01-01 12:00:00Z',
@@ -275,6 +286,7 @@ def setUp(self):
             parent_content_key=TEST_COURSE_KEY,
             is_assigned_course_run=True,
             learner_email='learner@example.com',
+            preferred_course_run_key=TEST_COURSE_RUN_KEY,
             lms_user_id=TEST_LMS_USER_ID_2,
             assignment_configuration=self.assignment_configuration,
         )
@@ -403,7 +415,18 @@ def test_send_reminder_email_for_pending_assignment(
                 {'name': 'Good People', 'logo_image_url': 'http://pictures.nice'},
                 {'name': 'Fast Learners', 'logo_image_url': 'http://pictures.totally'},
             ],
-            'card_image_url': 'https://itsanimage.com'
+            'card_image_url': 'https://itsanimage.com',
+            'course_runs': [
+                {
+                    'key': TEST_COURSE_RUN_KEY,
+                    'start': '2020-01-01 12:00:00Z',
+                    'end': '2022-01-01 12:00:00Z',
+                    'enrollment_start': None,
+                    'enrollment_end': '2023-09-11T19:00:00Z',
+                    'pacing_type': 'self_paced',
+                    'weeks_to_complete': 8,
+                }
+            ],
         }
         mock_catalog_client.return_value.catalog_content_metadata.return_value = {
             'count': 1,
diff --git a/enterprise_access/apps/content_assignments/tests/test_utils.py b/enterprise_access/apps/content_assignments/tests/test_utils.py
@@ -2,6 +2,8 @@
 Tests for Enterprise Access content_assignments utils.
 """
 
+import uuid
+
 import ddt
 from django.test import TestCase
 
@@ -13,7 +15,12 @@
     has_time_to_complete,
     is_within_minimum_start_date_threshold
 )
-from enterprise_access.utils import _curr_date, _days_from_now, get_normalized_metadata_for_assignment
+from enterprise_access.utils import (
+    _curr_date,
+    _days_from_now,
+    get_course_run_metadata_for_assignment,
+    get_normalized_metadata_for_assignment
+)
 
 mock_course_run_1 = {
     'start_date': _days_from_now(-370, DATE_FORMAT_ISO_8601),
@@ -39,6 +46,9 @@
     'content_price': 100,
 }
 
+assignment_uuid = uuid.uuid4()
+advertised_course_run_uuid = uuid.uuid4()
+
 
 @ddt.ddt
 class UtilsTests(TestCase):
@@ -273,3 +283,66 @@ def test_get_normalized_metadata_for_assignment(self, assignment, expected_outpu
             content_metadata=self.mock_content_metadata
         )
         self.assertEqual(normalized_metadata, expected_output)
+
+    @ddt.data(
+        # Test case for preferred course run that exists
+        {
+            'assignment': {
+                'preferred_course_run_key': 'course-v1:edX+DemoX+1T60',
+                'uuid': assignment_uuid
+            },
+            'content_metadata': {
+                'course_runs': [
+                    {'key': 'course-v1:edX+DemoX+1T60', 'data': 'test1'},
+                    {'key': 'course-v1:edX+DemoX+1T360', 'data': 'test2'}
+                ],
+                'advertised_course_run_uuid': advertised_course_run_uuid,
+                'key': 'test-content-key'
+            },
+            'expected_output': {'key': 'course-v1:edX+DemoX+1T60', 'data': 'test1'}
+        },
+        # Test case for preferred course run that doesn't exist - should fall back to advertised run
+        {
+            'assignment': {
+                'preferred_course_run_key': 'non-existent-key',
+                'uuid': assignment_uuid
+            },
+            'content_metadata': {
+                'course_runs': [
+                    {'key': 'course-v1:edX+DemoX+1T60', 'uuid': advertised_course_run_uuid, 'data': 'test1'},
+                    {'key': 'course-v1:edX+DemoX+1T360', 'data': 'test2'}
+                ],
+                'advertised_course_run_uuid': advertised_course_run_uuid,
+                'key': 'test-content-key'
+            },
+            'expected_output': {'key': 'course-v1:edX+DemoX+1T60', 'uuid': advertised_course_run_uuid, 'data': 'test1'}
+        },
+        # Test case for no preferred course run - should return advertised run
+        {
+            'assignment': {
+                'preferred_course_run_key': None,
+                'uuid': assignment_uuid
+            },
+            'content_metadata': {
+                'course_runs': [
+                    {'key': 'course-v1:edX+DemoX+1T60', 'uuid': advertised_course_run_uuid, 'data': 'test1'},
+                    {'key': 'course-v1:edX+DemoX+1T360', 'data': 'test2'}
+                ],
+                'advertised_course_run_uuid': advertised_course_run_uuid,
+                'key': 'test-content-key'
+            },
+            'expected_output': {'key': 'course-v1:edX+DemoX+1T60', 'uuid': advertised_course_run_uuid, 'data': 'test1'}
+        }
+    )
+    @ddt.unpack
+    def test_get_course_run_metadata_for_assignment(self, assignment, content_metadata, expected_output):
+        """
+        Test get_course_run_metadata_for_assignment returns the correct course run metadata
+        based on assignment and content metadata.
+        """
+        assignment_obj = LearnerContentAssignmentFactory(**assignment)
+        course_run_metadata = get_course_run_metadata_for_assignment(
+            assignment=assignment_obj,
+            content_metadata=content_metadata
+        )
+        self.assertEqual(course_run_metadata, expected_output)
diff --git a/enterprise_access/utils.py b/enterprise_access/utils.py
@@ -245,3 +245,43 @@ def _days_from_now(days_from_now=0, date_format=None):
     if not date_format:
         return date
     return date.strftime(date_format)
+
+
+def get_advertised_course_run_metadata(content_metadata):
+    course_runs = content_metadata.get('course_runs', [])
+    advertised_course_run_uuid = content_metadata.get('advertised_course_run_uuid')
+    return next((run for run in course_runs if run.get('uuid') == advertised_course_run_uuid), None)
+
+
+def get_course_run_metadata_for_assignment(assignment, content_metadata):
+    """
+    Retrieves metadata for a specific course run associated with an assignment. If the assignment has
+    a preferred course run, returns the metadata for that run. If the preferred run metadata is not
+    found, returns normalized_metadata.
+
+    Args:
+        assignment (dict): The assignment object.
+        content_metadata (dict): The content metadata object.
+
+    Returns:
+        dict: Course run metadata if available, otherwise advertised_course_run.
+    """
+    course_runs = content_metadata.get('course_runs', [])
+
+    # For run-based assignments, return metadata for the preferred course run if
+    # available. If not, fallback to advertised run.
+    if preferred_course_run_key := assignment.preferred_course_run_key:
+        course_run = next((run for run in course_runs if run.get('key') == preferred_course_run_key), None)
+        if not course_run:
+            logger.warning(
+                'Metadata not found for preferred course run key %s in content metadata %s. Assignment UUID: %s',
+                preferred_course_run_key,
+                content_metadata.get('key'),
+                assignment.uuid
+            )
+            # Fallback to advertised course run if preferred course run metadata is missing
+            return get_advertised_course_run_metadata(content_metadata)
+        return course_run
+
+    # For course-based assignments, return metadata for the advertised course run
+    return get_advertised_course_run_metadata(content_metadata)
