fix: filter reset extensions from granted extensions table (#38394)

Author: brianjbuck-wgu

lms/djangoapps/instructor/tests/test_api_v2.py

@@ -2,7 +2,7 @@
 Unit tests for instructor API v2 endpoints.
 """
 import json
-from datetime import datetime
+from datetime import datetime, timedelta
 from unittest.mock import Mock, patch
 from urllib.parse import urlencode
 from uuid import uuid4
@@ -1848,6 +1848,107 @@ def test_extension_data_structure(self, mock_title_or_url, mock_get_units, mock_
         self.assertIsInstance(extension['unit_title'], str)  # noqa: PT009
         self.assertIsInstance(extension['unit_location'], str)  # noqa: PT009
 
+    def test_reset_extension_with_none_date_excluded(self):
+        """
+        Test that extensions reset via set_date_for_block(None) are excluded from results.
+        When an extension is reset, edx-when creates a UserDate with abs_date=None and rel_date=None,
+        causing actual_date to fall back to the original block due date. These reverted overrides
+        should not appear as granted extensions.
+        """
+        original_due = datetime.now(UTC).replace(microsecond=0)
+        extended = original_due + timedelta(days=60)
+        set_dates_for_course(self.course_key, [(self.subsection.location, {'due': original_due})])
+
+        # Grant extension to student1, then reset it by passing None
+        set_date_for_block(self.course_key, self.subsection.location, 'due', extended, user=self.student1)
+        set_date_for_block(self.course_key, self.subsection.location, 'due', None, user=self.student1)
+
+        # Grant a real extension to student2
+        set_date_for_block(self.course_key, self.subsection.location, 'due', extended, user=self.student2)
+
+        self.client.force_authenticate(user=self.instructor)
+        response = self.client.get(self._get_url())
+
+        assert response.status_code == 200
+        results = response.data['results']
+        assert len(results) == 1
+        assert results[0]['username'] == 'student2'
+        assert results[0]['extended_due_date'] == extended.strftime('%Y-%m-%dT%H:%M:%SZ')
+
+    def test_reset_extension_matching_original_date_excluded(self):
+        """
+        Test that extensions whose override date matches the original due date are excluded.
+        When an extension is reset, the override reverts to the original subsection date,
+        making it appear as if there's an active extension when there isn't one.
+        """
+        original_due = datetime.now(UTC).replace(microsecond=0)
+        extended = original_due + timedelta(days=60)
+        set_dates_for_course(self.course_key, [(self.subsection.location, {'due': original_due})])
+
+        # Grant extension to student1, then "reset" it by setting it back to the original date
+        set_date_for_block(self.course_key, self.subsection.location, 'due', extended, user=self.student1)
+        set_date_for_block(self.course_key, self.subsection.location, 'due', original_due, user=self.student1)
+
+        # Grant a real extension to student2
+        set_date_for_block(self.course_key, self.subsection.location, 'due', extended, user=self.student2)
+
+        self.client.force_authenticate(user=self.instructor)
+        response = self.client.get(self._get_url())
+
+        assert response.status_code == 200
+        results = response.data['results']
+        assert len(results) == 1
+        assert results[0]['username'] == 'student2'
+        assert results[0]['extended_due_date'] == extended.strftime('%Y-%m-%dT%H:%M:%SZ')
+
+    def test_reset_extension_excluded_with_block_id_filter(self):
+        """
+        Test that reset extensions are also excluded when filtering by block_id.
+        """
+        original_due = datetime.now(UTC).replace(microsecond=0)
+        extended = original_due + timedelta(days=60)
+        set_dates_for_course(self.course_key, [(self.subsection.location, {'due': original_due})])
+
+        # Grant extension to student1, then reset it
+        set_date_for_block(self.course_key, self.subsection.location, 'due', extended, user=self.student1)
+        set_date_for_block(self.course_key, self.subsection.location, 'due', None, user=self.student1)
+
+        # Grant a real extension to student2
+        set_date_for_block(self.course_key, self.subsection.location, 'due', extended, user=self.student2)
+
+        self.client.force_authenticate(user=self.instructor)
+        params = {'block_id': str(self.subsection.location)}
+        response = self.client.get(self._get_url(), params)
+
+        assert response.status_code == 200
+        results = response.data['results']
+        assert len(results) == 1
+        assert results[0]['username'] == 'student2'
+        assert results[0]['extended_due_date'] == extended.strftime('%Y-%m-%dT%H:%M:%SZ')
+
+    def test_active_extensions_still_returned(self):
+        """
+        Test that legitimate extensions (date differs from original) are still returned.
+        """
+        original_due = datetime.now(UTC).replace(microsecond=0)
+        extended1 = original_due + timedelta(days=30)
+        extended2 = original_due + timedelta(days=60)
+        set_dates_for_course(self.course_key, [(self.subsection.location, {'due': original_due})])
+
+        set_date_for_block(self.course_key, self.subsection.location, 'due', extended1, user=self.student1)
+        set_date_for_block(self.course_key, self.subsection.location, 'due', extended2, user=self.student2)
+
+        self.client.force_authenticate(user=self.instructor)
+        response = self.client.get(self._get_url())
+
+        assert response.status_code == 200
+        results = response.data['results']
+        assert len(results) == 2
+        results_by_username = {r['username']: r for r in results}
+        assert results_by_username['student1']['extended_due_date'] == extended1.strftime('%Y-%m-%dT%H:%M:%SZ')
+        assert results_by_username['student2']['extended_due_date'] == extended2.strftime('%Y-%m-%dT%H:%M:%SZ')
+
+
 @ddt.ddt
 class IssuedCertificatesViewTest(SharedModuleStoreTestCase):
     """

lms/djangoapps/instructor/views/api_v2.py

@@ -96,6 +96,7 @@
 from lms.djangoapps.instructor_task.models import InstructorTask, ReportStore
 from lms.djangoapps.instructor_task.tasks_helper.utils import upload_csv_file_to_report_store
 from openedx.core.djangoapps.course_groups.cohorts import is_course_cohorted
+from openedx.core.djangoapps.schedules.models import Schedule
 from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers
 from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin
 from openedx.core.lib.courses import get_course_by_id
@@ -581,6 +582,27 @@ def get_queryset(self):
                 if str(row[3]) in units_dict  # Ensure unit has due date
             ]
 
+        # TODO: This filtering should ideally live in edx-when get_overrides_for_block/get_overrides_for_course.
+        # See https://github.com/openedx/edx-when/issues/353
+        # Filter out reset extensions (None dates or dates matching the original due date)
+        if unit_due_date_extensions:
+            version = getattr(course, 'course_version', None)
+            schedule = Schedule(start_date=course.start)
+            base_dates = edx_when_api.get_dates_for_course(
+                course.id, schedule=schedule, published_version=version
+            )
+            relevant_locations = {str(ext.unit_location) for ext in unit_due_date_extensions}
+            original_due_dates = {
+                str(loc): date
+                for (loc, field), date in base_dates.items()
+                if field == 'due' and str(loc) in relevant_locations
+            }
+            unit_due_date_extensions = [
+                ext for ext in unit_due_date_extensions
+                if ext.extended_due_date is not None
+                and ext.extended_due_date != original_due_dates.get(str(ext.unit_location))
+            ]
+
         # Apply filters if any
         filter_value = email_or_username_filter.lower() if email_or_username_filter else None