feat(surveys): add course user selector tabs to response index page

Author: adi-herwana-nus

app/controllers/course/survey/responses_controller.rb

@@ -4,7 +4,8 @@ class Course::Survey::ResponsesController < Course::Survey::Controller
 
   def index
     authorize!(:manage, @survey)
-    @course_students = current_course.course_users.students.order_alphabetically
+    @course_users = current_course.course_users.order_alphabetically
+    @my_students = current_course_user.try(:my_students) || []
   end
 
   def create

app/controllers/course/survey/surveys_controller.rb

@@ -5,6 +5,11 @@ class Course::Survey::SurveysController < Course::Survey::Controller
   skip_load_and_authorize_resource :survey, only: [:new, :create]
   build_and_authorize_new_lesson_plan_item :survey, class: Course::Survey, through: :course, only: [:new, :create]
 
+  COURSE_USERS = { my_students: 'my_students',
+                   my_students_w_phantom: 'my_students_w_phantom',
+                   students: 'students',
+                   students_w_phantom: 'students_w_phantom' }.freeze
+
   def index
     @surveys = @surveys.includes(responses: { experience_points_record: :course_user })
     preload_student_submitted_responses_counts
@@ -45,8 +50,14 @@ def results
 
   def remind
     authorize!(:manage, @survey)
+    return head :bad_request unless student_course_users
+
     Course::Survey::ReminderService.
-      send_closing_reminder(@survey, include_phantom: params[:include_phantom], include_unsubscribed: true)
+      send_closing_reminder(
+        @survey,
+        student_course_users.pluck(:id),
+        include_unsubscribed: true
+      )
     head :ok
   end
 
@@ -61,6 +72,21 @@ def download
 
   private
 
+  def student_course_users
+    case params[:course_users]
+    when COURSE_USERS[:my_students]
+      current_course_user.my_students.without_phantom_users
+    when COURSE_USERS[:my_students_w_phantom]
+      current_course_user.my_students
+    when COURSE_USERS[:students_w_phantom]
+      @survey.course.course_users.students
+    when COURSE_USERS[:students]
+      @survey.course.course_users.students.without_phantom_users
+    else
+      false
+    end
+  end
+
   def render_survey_with_questions_json
     load_sections
     render partial: 'survey_with_questions', locals: {

app/services/course/survey/reminder_service.rb

@@ -15,8 +15,8 @@ def closing_reminder(survey, token)
     send_closing_reminder(survey)
   end
 
-  def send_closing_reminder(survey, include_phantom: true, include_unsubscribed: false)
-    students = uncompleted_subscribed_students(survey, include_phantom, include_unsubscribed)
+  def send_closing_reminder(survey, course_user_ids = [], include_unsubscribed: false)
+    students = uncompleted_subscribed_students(survey, course_user_ids, include_unsubscribed)
     unless students.empty?
       closing_reminder_students(survey, students)
       closing_reminder_staff(survey, students)
@@ -55,19 +55,22 @@ def closing_reminder_staff(survey, students)
   # Returns a Set of students who have not completed the given survey and subscribe to the survey email.
   #
   # @param [Course::Survey] survey The survey to query.
-  # @param [Boolean] include_phantom Whether to include phantom students in the reminder email.
+  # @param [Array<Integer>] course_user_ids Course user ids of intended recipients (if specified).
+  #   If empty, all students will be selected.
   # @param [Boolean] include_unsubscribed Whether to include unsubscribed students in the reminder (forced reminder).
   # @return [Set<CourseUser>] Set of CourseUsers who have not finished the survey.
-  def uncompleted_subscribed_students(survey, include_phantom, include_unsubscribed)
-    course_users = survey.course.course_users.student
+  # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+  def uncompleted_subscribed_students(survey, course_user_ids, include_unsubscribed)
+    course_users = survey.course.course_users
+    course_users = course_users.where(id: course_user_ids) unless course_user_ids.empty?
     email_enabled = survey.course.email_enabled(:surveys, :closing_reminder)
     # Eager load :user as it's needed for the recipient email.
-    students = if (email_enabled.regular && !email_enabled.phantom) || !include_phantom
-                 course_users.without_phantom_users.includes(:user)
+    students = if email_enabled.regular && !email_enabled.phantom
+                 course_users.student.without_phantom_users.includes(:user)
                elsif email_enabled.phantom && !email_enabled.regular
-                 course_users.phantom.includes(:user)
+                 course_users.student.phantom.includes(:user)
                else
-                 course_users.includes(:user)
+                 course_users.student.includes(:user)
                end
 
     submitted =
@@ -79,4 +82,5 @@ def uncompleted_subscribed_students(survey, include_phantom, include_unsubscribe
                    where('course_user_email_unsubscriptions.course_settings_email_id = ?', email_enabled.id)
     Set.new(students) - Set.new(unsubscribed) - Set.new(submitted)
   end
+  # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 end

app/views/course/survey/responses/index.json.jbuilder

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
+my_students_set = Set.new(@my_students.map(&:id))
 responses = @responses.to_h { |r| [r.course_user_id, r] }
-json.responses @course_students do |student|
-  response = responses[student.id]
+json.responses @course_users do |course_user|
+  response = responses[course_user.id]
   can_read_answers = response.present? && can?(:read_answers, response)
 
   json.course_user do
-    json.(student, :id, :name)
-    json.phantom student.phantom?
-    json.path course_user_path(current_course, student)
+    json.(course_user, :id, :name)
+    json.phantom course_user.phantom?
+    json.path course_user_path(current_course, course_user)
+    json.isStudent course_user.student?
+    json.myStudent my_students_set.include?(course_user.id) if course_user.student?
   end
 
   json.present !response.nil?

client/app/api/course/Survey/Surveys.js

@@ -131,9 +131,9 @@ export default class SurveysAPI extends BaseSurveyAPI {
    * success response: {}
    * error response: {}
    */
-  remind(includePhantom) {
+  remind(courseUsers) {
     return this.client.post(`${this.#urlPrefix}/${this.getSurveyId()}/remind`, {
-      include_phantom: includePhantom,
+      course_users: courseUsers,
     });
   }
 

client/app/bundles/course/assessment/submission/constants.ts

@@ -39,15 +39,6 @@ export const TestCaseTypes = {
   Evaluation: 'evaluation_test',
 };
 
-export const CourseUserTypeDisplayMapper = {
-  my_students: 'MY STUDENTS',
-  my_students_w_phantom: 'MY STUDENTS INCL. PHANTOM',
-  students: 'STUDENTS',
-  students_w_phantom: 'STUDENTS INCL. PHANTOM',
-  staff: 'STAFF',
-  staff_w_phantom: 'STAFF INCL. PHANTOM',
-};
-
 export const scribingPopoverTypes = mirrorCreator([
   'TYPE',
   'DRAW',

client/app/bundles/course/assessment/submission/pages/SubmissionsIndex/index.tsx

@@ -10,6 +10,7 @@ import {
 import { MainSubmissionInfo } from 'types/course/statistics/assessmentStatistics';
 
 import SubmissionStatusChart from 'course/assessment/pages/AssessmentStatistics/SubmissionStatus/SubmissionStatusChart';
+import CourseUserTypeFragment from 'lib/components/core/CourseUserTypeFragment';
 import CourseUserTypeTabs, {
   CourseUserType,
   CourseUserTypeTabValue,
@@ -38,7 +39,7 @@ import {
   sendAssessmentReminderEmail,
   unsubmitAllSubmissions,
 } from '../../actions/submissions';
-import { CourseUserTypeDisplayMapper, workflowStates } from '../../constants';
+import { workflowStates } from '../../constants';
 import translations from '../../translations';
 
 import SubmissionsTable from './SubmissionsTable';
@@ -204,7 +205,9 @@ const AssessmentSubmissionsIndex: FC = () => {
       attempting: shownSubmissions.filter(
         (s) => s.workflowState === workflowStates.Attempting,
       ).length,
-      selectedUsers: CourseUserTypeDisplayMapper[currentSelectedUserType],
+      selectedUsers: (
+        <CourseUserTypeFragment userType={currentSelectedUserType} />
+      ),
     };
     const message = assessment.autograded
       ? translations.forceSubmitConfirmationAutograded
@@ -360,7 +363,9 @@ const AssessmentSubmissionsIndex: FC = () => {
       graded: shownSubmissions.filter(
         (s) => s.workflowState === workflowStates.Graded,
       ).length,
-      selectedUsers: CourseUserTypeDisplayMapper[currentSelectedUserType],
+      selectedUsers: (
+        <CourseUserTypeFragment userType={currentSelectedUserType} />
+      ),
     };
 
     return (
@@ -384,7 +389,9 @@ const AssessmentSubmissionsIndex: FC = () => {
       attempting: shownSubmissions.filter(
         (s) => s.workflowState === workflowStates.Attempting,
       ).length,
-      selectedUsers: CourseUserTypeDisplayMapper[currentSelectedUserType],
+      selectedUsers: (
+        <CourseUserTypeFragment userType={currentSelectedUserType} />
+      ),
     };
 
     return (

client/app/bundles/course/survey/actions/surveys.js

@@ -169,15 +169,11 @@ export function fetchResults(surveyId) {
   };
 }
 
-export function sendReminderEmail(
-  successMessage,
-  failureMessage,
-  includePhantom,
-) {
+export function sendReminderEmail(successMessage, failureMessage, courseUsers) {
   return (dispatch) => {
     dispatch({ type: actionTypes.SEND_REMINDER_REQUEST });
     return CourseAPI.survey.surveys
-      .remind(includePhantom)
+      .remind(courseUsers)
       .then(() => {
         dispatch({ type: actionTypes.SEND_REMINDER_SUCCESS });
         setNotification(successMessage)(dispatch);

client/app/bundles/course/survey/pages/ResponseIndex/RemindButton.jsx

@@ -5,6 +5,7 @@ import { Button } from '@mui/material';
 import PropTypes from 'prop-types';
 
 import { sendReminderEmail } from 'course/survey/actions/surveys';
+import CourseUserTypeFragment from 'lib/components/core/CourseUserTypeFragment';
 import ConfirmationDialog from 'lib/components/core/dialogs/ConfirmationDialog';
 
 const translations = defineMessages({
@@ -21,12 +22,7 @@ const translations = defineMessages({
   confirmation: {
     id: 'course.survey.ResponseIndex.RemindButton.confirmation',
     defaultMessage:
-      'Send emails to all students (excluding phantoms) who have not completed the survey?',
-  },
-  confirmationAll: {
-    id: 'course.survey.ResponseIndex.RemindButton.confirmationAll',
-    defaultMessage:
-      'Send emails to all students (including phantoms) who have not completed the survey?',
+      'Send reminder emails to all {selectedUsers} who have not completed the survey?',
   },
   success: {
     id: 'course.survey.ResponseIndex.RemindButton.success',
@@ -48,11 +44,7 @@ class RemindButton extends Component {
     const successMessage = <FormattedMessage {...translations.success} />;
     const failureMessage = <FormattedMessage {...translations.failure} />;
     this.props.dispatch(
-      sendReminderEmail(
-        successMessage,
-        failureMessage,
-        this.props.includePhantom,
-      ),
+      sendReminderEmail(successMessage, failureMessage, this.props.userType),
     );
     this.setState({ open: false });
   };
@@ -72,11 +64,14 @@ class RemindButton extends Component {
               <FormattedMessage {...translations.explanation} />
               <br />
               <br />
-              {this.props.includePhantom ? (
-                <FormattedMessage {...translations.confirmationAll} />
-              ) : (
-                <FormattedMessage {...translations.confirmation} />
-              )}
+              <FormattedMessage
+                {...translations.confirmation}
+                values={{
+                  selectedUsers: (
+                    <CourseUserTypeFragment userType={this.props.userType} />
+                  ),
+                }}
+              />
             </>
           }
           onCancel={() => this.setState({ open: false })}
@@ -90,7 +85,7 @@ class RemindButton extends Component {
 
 RemindButton.propTypes = {
   dispatch: PropTypes.func.isRequired,
-  includePhantom: PropTypes.bool.isRequired,
+  userType: PropTypes.string.isRequired,
 };
 
 export default connect()(RemindButton);

client/app/bundles/course/survey/pages/ResponseIndex/__test__/RemindButton.test.tsx

@@ -1,13 +1,14 @@
 import { fireEvent, render } from 'test-utils';
 
 import CourseAPI from 'api/course';
+import { CourseUserType } from 'lib/components/core/CourseUserTypeTabs';
 
 import RemindButton from '../RemindButton';
 
 describe('<RemindButton />', () => {
   it('renders confirmation dialog that triggers the reminder', () => {
     const spyRemind = jest.spyOn(CourseAPI.survey.surveys, 'remind');
-    const page = render(<RemindButton includePhantom />);
+    const page = render(<RemindButton userType={CourseUserType.STUDENTS} />);
 
     const button = page.getByRole('button');
     fireEvent.click(button);