feat: upgrading list_instructor_tasks to DRF ( 10th )

lms/djangoapps/instructor/views/api.py

@@ -105,7 +105,9 @@
 from lms.djangoapps.instructor_task.api_helper import AlreadyRunningError, QueueConnectionError
 from lms.djangoapps.instructor_task.data import InstructorTaskTypes
 from lms.djangoapps.instructor_task.models import ReportStore
-from lms.djangoapps.instructor.views.serializer import RoleNameSerializer, UserSerializer, AccessSerializer
+from lms.djangoapps.instructor.views.serializer import (
+    AccessSerializer, ListInstructorSerializer, RoleNameSerializer, UserSerializer
+)
 from openedx.core.djangoapps.content.course_overviews.models import CourseOverview
 from openedx.core.djangoapps.course_groups.cohorts import add_user_to_cohort, is_course_cohorted
 from openedx.core.djangoapps.course_groups.models import CourseUserGroup
@@ -2322,9 +2324,8 @@ def get(self, request, course_id):
         return _list_instructor_tasks(request=request, course_id=course_id)
 
 
-@require_POST
-@ensure_csrf_cookie
-def list_instructor_tasks(request, course_id):
+@method_decorator(cache_control(no_cache=True, no_store=True, must_revalidate=True), name='dispatch')
+class ListInstructorTasks(APIView):
     """
     List instructor tasks.
 
@@ -2334,7 +2335,21 @@ def list_instructor_tasks(request, course_id):
         - `problem_location_str` and `unique_student_identifier` lists task
             history for problem AND student (intersection)
     """
-    return _list_instructor_tasks(request=request, course_id=course_id)
+    permission_classes = (IsAuthenticated, permissions.InstructorPermission)
+    permission_name = permissions.SHOW_TASKS
+    serializer_class = ListInstructorSerializer
+
+    @method_decorator(ensure_csrf_cookie)
+    def post(self, request, course_id):
+        """
+        List instructor tasks.
+        """
+        serializer = self.serializer_class(data=request.data)
+        serializer.is_valid(raise_exception=True)
+
+        return _list_instructor_tasks(
+            request=request, course_id=course_id
+        )
 
 
 @cache_control(no_cache=True, no_store=True, must_revalidate=True)
@@ -2345,10 +2360,21 @@ def _list_instructor_tasks(request, course_id):
 
     Internal function with common code for both DRF and and tradition views.
     """
+    # This method is also used by other APIs with the GET method.
+    # The query_params attribute is utilized for GET requests,
+    # where parameters are passed as query strings.
+
     course_id = CourseKey.from_string(course_id)
     params = getattr(request, 'query_params', request.POST)
     problem_location_str = strip_if_string(params.get('problem_location_str', False))
     student = params.get('unique_student_identifier', None)
+
+    # For the DRF POST method, retrieve the data from request.data
+    if not student and not problem_location_str:
+        params = getattr(request, 'data', request.POST)
+        problem_location_str = strip_if_string(params.get('problem_location_str', False))
+        student = params.get('unique_student_identifier', None)
+
     if student is not None:
         student = get_student_from_identifier(student)
 

lms/djangoapps/instructor/views/api_urls.py

@@ -44,7 +44,7 @@
          name='list_entrance_exam_instructor_tasks'),
     path('mark_student_can_skip_entrance_exam', api.mark_student_can_skip_entrance_exam,
          name='mark_student_can_skip_entrance_exam'),
-    path('list_instructor_tasks', api.list_instructor_tasks, name='list_instructor_tasks'),
+    path('list_instructor_tasks', api.ListInstructorTasks.as_view(), name='list_instructor_tasks'),
     path('list_background_email_tasks', api.list_background_email_tasks, name='list_background_email_tasks'),
     path('list_email_content', api.list_email_content, name='list_email_content'),
     path('list_forum_members', api.list_forum_members, name='list_forum_members'),

lms/djangoapps/instructor/views/serializer.py

@@ -59,3 +59,40 @@ def validate_unique_student_identifier(self, value):
             return None
 
         return user
+
+
+class ListInstructorSerializer(serializers.Serializer):  # pylint: disable=abstract-method
+    """
+    Serializer for handling the input data for the problem response report generation API.
+
+Attributes:
+    unique_student_identifier (str): The email or username of the student.
+                                      This field is optional, but if provided, the `problem_location_str`
+                                      must also be provided.
+    problem_location_str (str): The string representing the location of the problem within the course.
+                                This field is optional, unless `unique_student_identifier` is provided.
+    """
+    unique_student_identifier = serializers.CharField(
+        max_length=255,
+        help_text="Email or username of student",
+        required=False
+    )
+    problem_location_str = serializers.CharField(
+        help_text="Problem location",
+        required=False
+    )
+
+    def validate(self, data):
+        """
+        Validate the data to ensure that if unique_student_identifier is provided,
+        problem_location_str must also be provided.
+        """
+        unique_student_identifier = data.get('unique_student_identifier')
+        problem_location_str = data.get('problem_location_str')
+
+        if unique_student_identifier and not problem_location_str:
+            raise serializers.ValidationError(
+                "unique_student_identifier must accompany problem_location_str"
+            )
+
+        return data