feat: instructor dash - change due date v2 endpoint (openedx#37685)

* feat: added extensions v2 endpoint

Author: holaontiveros

lms/djangoapps/instructor/tests/test_api.py

@@ -166,6 +166,7 @@
     'bulk_beta_modify_access',
     'calculate_grades_csv',
     'change_due_date',
+    'instructor_api_v2:change_due_date',
     'export_ora2_data',
     'export_ora2_submission_files',
     'export_ora2_summary',
@@ -4494,6 +4495,180 @@ def test_show_student_extensions(self):
                 'title': (f'Due date extensions for {self.user1.profile.name} ({self.user1.username})')}
 
 
+class TestChangeDueDateV2(SharedModuleStoreTestCase, LoginEnrollmentTestCase):
+    """
+    Tests for the V2 due date extension API endpoint.
+    """
+    MODULESTORE = TEST_DATA_SPLIT_MODULESTORE
+
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.course = CourseFactory.create()
+        cls.due = datetime.datetime(2010, 5, 12, 2, 42, tzinfo=UTC)
+
+        with cls.store.bulk_operations(cls.course.id, emit_signals=False):
+            cls.week1 = BlockFactory.create(due=cls.due)
+            cls.week2 = BlockFactory.create(due=cls.due)
+            cls.week3 = BlockFactory.create()  # No due date
+            cls.course.children = [
+                str(cls.week1.location),
+                str(cls.week2.location),
+                str(cls.week3.location)
+            ]
+            cls.homework = BlockFactory.create(
+                parent_location=cls.week1.location,
+                due=cls.due
+            )
+            cls.week1.children = [str(cls.homework.location)]
+
+    def setUp(self):
+        """
+        Fixtures.
+        """
+        super().setUp()
+
+        self.user1 = UserFactory.create()
+        self.user2 = UserFactory.create()
+
+        # Create StudentModule objects for tracking student progress
+        StudentModule(
+            state='{}',
+            student_id=self.user1.id,
+            course_id=self.course.id,
+            module_state_key=self.week1.location).save()
+        StudentModule(
+            state='{}',
+            student_id=self.user1.id,
+            course_id=self.course.id,
+            module_state_key=self.homework.location).save()
+        StudentModule(
+            state='{}',
+            student_id=self.user2.id,
+            course_id=self.course.id,
+            module_state_key=self.week1.location).save()
+        StudentModule(
+            state='{}',
+            student_id=self.user2.id,
+            course_id=self.course.id,
+            module_state_key=self.homework.location).save()
+
+        CourseEnrollmentFactory.create(user=self.user1, course_id=self.course.id)
+        CourseEnrollmentFactory.create(user=self.user2, course_id=self.course.id)
+        self.instructor = InstructorFactory(course_key=self.course.id)
+        self.client.login(username=self.instructor.username, password=self.TEST_PASSWORD)
+        extract_dates(None, self.course.id)
+
+    def test_change_due_date_v2_success(self):
+        """Test successful due date change using V2 API endpoint"""
+        url = reverse('instructor_api_v2:change_due_date', kwargs={'course_id': str(self.course.id)})
+        due_date = datetime.datetime(2013, 12, 30, tzinfo=UTC)
+        response = self.client.post(url, json.dumps({
+            'email_or_username': self.user1.username,
+            'block_id': str(self.homework.location),
+            'due_datetime': '12/30/2013 00:00',
+            'reason': 'Testing V2 API.'
+        }), content_type='application/json')
+
+        assert response.status_code == 200, response.content
+        response_data = json.loads(response.content.decode('utf-8'))
+        assert 'Successfully changed due date for learner' in response_data['message']
+
+        assert get_extended_due(self.course, self.homework, self.user1) == due_date
+
+    def test_change_due_date_v2_with_email(self):
+        """Test due date change using email instead of username"""
+        url = reverse('instructor_api_v2:change_due_date', kwargs={'course_id': str(self.course.id)})
+        due_date = datetime.datetime(2013, 12, 30, tzinfo=UTC)
+        response = self.client.post(url, json.dumps({
+            'email_or_username': self.user1.email,
+            'block_id': str(self.homework.location),
+            'due_datetime': '12/30/2013 00:00',
+            'reason': 'Testing V2 API with email.'
+        }), content_type='application/json')
+
+        assert response.status_code == 200, response.content
+        response_data = json.loads(response.content.decode('utf-8'))
+        assert 'Successfully changed due date for learner' in response_data['message']
+
+        assert get_extended_due(self.course, self.homework, self.user1) == due_date
+
+    def test_change_due_date_v2_invalid_user(self):
+        """Test error handling for invalid user"""
+        url = reverse('instructor_api_v2:change_due_date', kwargs={'course_id': str(self.course.id)})
+        response = self.client.post(url, json.dumps({
+            'email_or_username': 'nonexistent@example.com',
+            'block_id': str(self.homework.location),
+            'due_datetime': '12/30/2013 00:00'
+        }), content_type='application/json')
+
+        assert response.status_code == 400, response.content
+        response_data = json.loads(response.content.decode('utf-8'))
+        assert 'Invalid learner identifier' in response_data['error']['email_or_username'][0]
+
+    def test_change_due_date_v2_invalid_block(self):
+        """Test error handling for invalid block location"""
+        url = reverse('instructor_api_v2:change_due_date', kwargs={'course_id': str(self.course.id)})
+        # Invalid block location should cause an exception (500 error)
+        with self.assertRaises(Exception):
+            self.client.post(url, json.dumps({
+                'email_or_username': self.user1.username,
+                'block_id': 'i4x://invalid/block/location',
+                'due_datetime': '12/30/2013 00:00'
+            }), content_type='application/json')
+
+    def test_change_due_date_v2_invalid_date_format(self):
+        """Test error handling for invalid date format"""
+        url = reverse('instructor_api_v2:change_due_date', kwargs={'course_id': str(self.course.id)})
+        # V2 API accepts form data as well
+        response = self.client.post(url, {
+            'email_or_username': self.user1.username,
+            'block_id': self.homework.location,
+            'due_datetime': 'invalid-date-format'
+        })
+
+        self.assertEqual(response.status_code, 400)
+
+    def test_change_due_date_v2_missing_fields(self):
+        """Test error handling for missing required fields"""
+        url = reverse('instructor_api_v2:change_due_date', kwargs={'course_id': str(self.course.id)})
+        # V2 API accepts form data
+        response = self.client.post(url, {
+            'email_or_username': self.user1.username,
+            # Missing 'block_id' and 'due_datetime'
+        })
+
+        self.assertEqual(response.status_code, 400)
+
+    def test_change_due_date_v2_unenrolled_user(self):
+        """Test error handling for user not enrolled in course"""
+        unenrolled_user = UserFactory.create()
+        url = reverse('instructor_api_v2:change_due_date', kwargs={'course_id': str(self.course.id)})
+        # V2 API accepts form data
+        response = self.client.post(url, {
+            'email_or_username': unenrolled_user.username,
+            'block_id': self.homework.location,
+            'due_datetime': '12/30/2013 00:00'
+        })
+
+        self.assertEqual(response.status_code, 400)
+
+    def test_change_due_date_v2_json_content_type(self):
+        """Test that V2 API works with both JSON and form data"""
+        url = reverse('instructor_api_v2:change_due_date', kwargs={'course_id': str(self.course.id)})
+        # Send as form data instead of JSON
+        response = self.client.post(url, {
+            'email_or_username': self.user1.username,
+            'block_id': self.homework.location,
+            'due_datetime': '12/30/2013 00:00'
+        })
+
+        # The V2 endpoint works with form data and should succeed
+        self.assertEqual(response.status_code, 200)
+        response_data = json.loads(response.content.decode('utf-8'))
+        self.assertIn('Successfully changed due date for learner', response_data['message'])
+
+
 class TestDueDateExtensionsDeletedDate(ModuleStoreTestCase, LoginEnrollmentTestCase):
     """
     Tests for deleting due date extensions

lms/djangoapps/instructor/views/api_urls.py

@@ -31,6 +31,11 @@
         api_v2.InstructorTaskListView.as_view(),
         name='instructor_tasks'
     ),
+    re_path(
+        rf'^courses/{COURSE_ID_PATTERN}/change_due_date$',
+        api_v2.ChangeDueDateView.as_view(),
+        name='change_due_date'
+    ),
 ]
 
 urlpatterns = [

lms/djangoapps/instructor/views/api_v2.py

@@ -14,17 +14,27 @@
 from rest_framework.permissions import IsAuthenticated
 from rest_framework.response import Response
 from rest_framework.views import APIView
+from django.utils.decorators import method_decorator
+from django.views.decorators.cache import cache_control
+from django.utils.html import strip_tags
+from django.utils.translation import gettext as _
+from common.djangoapps.util.json_request import JsonResponse, JsonResponseBadRequest
 
 from lms.djangoapps.courseware.tabs import get_course_tab_list
 from lms.djangoapps.instructor import permissions
-from lms.djangoapps.instructor.views.api import get_student_from_identifier
+from lms.djangoapps.instructor.views.api import _display_unit, get_student_from_identifier
 from lms.djangoapps.instructor.views.instructor_task_helpers import extract_task_features
 from lms.djangoapps.instructor_task import api as task_api
 from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin
 from openedx.core.lib.courses import get_course_by_id
 from .serializers_v2 import (
     InstructorTaskListSerializer,
-    CourseInformationSerializer
+    CourseInformationSerializer,
+    BlockDueDateSerializerV2,
+)
+from .tools import (
+    find_unit,
+    set_due_date_extension,
 )
 
 log = logging.getLogger(__name__)
@@ -269,3 +279,45 @@ def get(self, request, course_id):
         tasks_data = [extract_task_features(task) for task in tasks]
         serializer = InstructorTaskListSerializer({'tasks': tasks_data})
         return Response(serializer.data, status=status.HTTP_200_OK)
+
+
+@method_decorator(cache_control(no_cache=True, no_store=True, must_revalidate=True), name='dispatch')
+class ChangeDueDateView(APIView):
+    """
+    Grants a due date extension to a student for a particular unit.
+    this version works with a new payload that is JSON and more up to date.
+    """
+    permission_classes = (IsAuthenticated, permissions.InstructorPermission)
+    permission_name = permissions.GIVE_STUDENT_EXTENSION
+    serializer_class = BlockDueDateSerializerV2
+
+    def post(self, request, course_id):
+        """
+        Grants a due date extension to a learner for a particular unit.
+
+        params:
+            blockId (str): The URL related to the block that needs the due date update.
+            due_datetime (str): The new due date and time for the block.
+            email_or_username (str): The email or username of the learner whose access is being modified.
+        """
+        serializer_data = self.serializer_class(data=request.data)
+        if not serializer_data.is_valid():
+            return JsonResponseBadRequest({'error': serializer_data.errors})
+
+        learner = serializer_data.validated_data.get('email_or_username')
+        due_date = serializer_data.validated_data.get('due_datetime')
+        course = get_course_by_id(CourseKey.from_string(course_id))
+        unit = find_unit(course, serializer_data.validated_data.get('block_id'))
+        reason = strip_tags(serializer_data.validated_data.get('reason', ''))
+        try:
+            set_due_date_extension(course, unit, learner, due_date, request.user, reason=reason)
+        except Exception as error:  # pylint: disable=broad-except
+            return JsonResponseBadRequest({'error': str(error)})
+
+        return JsonResponse(
+            {
+                'message': _(
+                    'Successfully changed due date for learner {0} for {1} '
+                    'to {2}').
+                format(learner.profile.name, _display_unit(unit), due_date.strftime('%Y-%m-%d %H:%M')
+                       )})

lms/djangoapps/instructor/views/serializers_v2.py

@@ -30,6 +30,8 @@
 from openedx.core.djangoapps.django_comment_common.models import FORUM_ROLE_ADMINISTRATOR
 from xmodule.modulestore.django import modulestore
 
+from .tools import get_student_from_identifier, parse_datetime, DashboardError
+
 
 class CourseInformationSerializer(serializers.Serializer):
     """
@@ -337,3 +339,46 @@ class InstructorTaskSerializer(serializers.Serializer):
 
 class InstructorTaskListSerializer(serializers.Serializer):
     tasks = InstructorTaskSerializer(many=True)
+
+
+class BlockDueDateSerializerV2(serializers.Serializer):
+    """
+    Serializer for handling block due date updates for a specific student.
+    Fields:
+        block_id (str): The ID related to the block that needs the due date update.
+        due_datetime (str): The new due date and time for the block.
+        email_or_username (str): The email or username of the student whose access is being modified.
+        reason (str): Reason why updating this.
+    """
+    block_id = serializers.CharField()
+    due_datetime = serializers.CharField()
+    email_or_username = serializers.CharField(
+        max_length=255,
+        help_text="Email or username of user to change access"
+    )
+    reason = serializers.CharField(required=False)
+
+    def validate_email_or_username(self, value):
+        """
+        Validate that the email_or_username corresponds to an existing user.
+        """
+        try:
+            user = get_student_from_identifier(value)
+        except Exception as exc:
+            raise serializers.ValidationError(
+                _('Invalid learner identifier: {0}').format(value)
+            ) from exc
+
+        return user
+
+    def validate_due_datetime(self, value):
+        """
+        Validate and parse the due_datetime string into a datetime object.
+        """
+        try:
+            parsed_date = parse_datetime(value)
+            return parsed_date
+        except DashboardError as exc:
+            raise serializers.ValidationError(
+                _('The extension due date and time format is incorrect')
+            ) from exc