[BB-873] Support for filters, and multiple roots in problem response reports

lms/djangoapps/instructor/views/api.py

@@ -1003,30 +1003,62 @@ def get_problem_responses(request, course_id):
     Initiate generation of a CSV file containing all student answers
     to a given problem.
 
-    Responds with JSON
-        {"status": "... status message ...", "task_id": created_task_UUID}
+    **Example requests**
+
+        POST /courses/{course_id}/instructor/api/get_problem_responses {
+            "problem_location": "{usage_key1},{usage_key2},{usage_key3}""
+        }
+        POST /courses/{course_id}/instructor/api/get_problem_responses {
+            "problem_location": "{usage_key}",
+            "problem_types_filter": "problem"
+        }
+
+        **POST Parameters**
+
+        A POST request can include the following parameters:
 
-    if initiation is successful (or generation task is already running).
+        * problem_location: A comma-separated list of usage keys for the blocks
+          to include in the report. If the location is a block that contains
+          other blocks, (such as the course, section, subsection, or unit blocks)
+          then all blocks under that block will be included in the report.
+        * problem_types_filter: Optional. A comma-separated list of block types
+          to include in the repot. If set, only blocks of the specified types will
+          be included in the report.
+
+        To get data on all the poll and survey blocks in a course, you could
+        POST the usage key of the course for `problem_location`, and
+        "poll, survey" as the value for `problem_types_filter`.
+
+
+    **Example Response:**
+    If initiation is successful (or generation task is already running):
+    ```json
+    {
+        "status": "The problem responses report is being created. ...",
+        "task_id": "4e49522f-31d9-431a-9cff-dd2a2bf4c85a"
+    }
+    ```
 
-    Responds with BadRequest if problem location is faulty.
+    Responds with BadRequest if any of the provided problem locations are faulty.
     """
     course_key = CourseKey.from_string(course_id)
-    problem_location = request.POST.get('problem_location', '')
+    # A comma-separated list of problem locations
+    # The name of the POST parameter is `problem_location` (not pluralised) in
+    # order to preserve backwards compatibility with existing third-party
+    # scripts.
+    problem_locations = request.POST.get('problem_location', '')
+    # A comma-separated list of block types
+    problem_types_filter = request.POST.get('problem_types_filter', '')
     report_type = _('problem responses')
 
     try:
-        problem_key = UsageKey.from_string(problem_location)
-        # Are we dealing with an "old-style" problem location?
-        run = problem_key.run
-        if not run:
+        for problem_location in problem_locations.split(','):
             problem_key = UsageKey.from_string(problem_location).map_into_course(course_key)
-        if problem_key.course_key != course_key:
-            raise InvalidKeyError(type(problem_key), problem_key)
     except InvalidKeyError:
         return JsonResponseBadRequest(_("Could not find problem with this location."))
 
     task = task_api.submit_calculate_problem_responses_csv(
-        request, course_key, problem_location
+        request, course_key, problem_locations, problem_types_filter,
     )
     success_status = SUCCESS_MESSAGE_TEMPLATE.format(report_type=report_type)
 

lms/djangoapps/instructor_task/api.py

@@ -322,7 +322,9 @@ def submit_bulk_course_email(request, course_key, email_id):
     return submit_task(request, task_type, task_class, course_key, task_input, task_key)
 
 
-def submit_calculate_problem_responses_csv(request, course_key, problem_location):
+def submit_calculate_problem_responses_csv(
+    request, course_key, problem_locations, problem_types_filter=None,
+):
     """
     Submits a task to generate a CSV file containing all student
     answers to a given problem.
@@ -331,7 +333,11 @@ def submit_calculate_problem_responses_csv(request, course_key, problem_location
     """
     task_type = 'problem_responses_csv'
     task_class = calculate_problem_responses_csv
-    task_input = {'problem_location': problem_location, 'user_id': request.user.pk}
+    task_input = {
+        'problem_locations': problem_locations,
+        'problem_types_filter': problem_types_filter,
+        'user_id': request.user.pk,
+    }
     task_key = ""
 
     return submit_task(request, task_type, task_class, course_key, task_input, task_key)

lms/djangoapps/instructor_task/tasks.py

@@ -159,7 +159,11 @@ def send_bulk_course_email(entry_id, _xmodule_instance_args):
     return run_main_task(entry_id, visit_fcn, action_name)
 
 
-@task(base=BaseInstructorTask, routing_key=settings.GRADES_DOWNLOAD_ROUTING_KEY)
+@task(
+    name='lms.djangoapps.instructor_task.tasks.calculate_problem_responses_csv.v2',
+    base=BaseInstructorTask,
+    routing_key=settings.GRADES_DOWNLOAD_ROUTING_KEY,
+)
 def calculate_problem_responses_csv(entry_id, xmodule_instance_args):
     """
     Compute student answers to a given problem and upload the CSV to