Merge pull request #78 from edx/remove-zendesk-proctoring-setting

Remove "Create Zendesk tickets for suspicious attempts" from Proctoring Settings

Author: santhosh-apphelix-2u

README.rst

@@ -97,7 +97,7 @@ Troubleshooting
 
 * If tutor-mfe is not starting the authoring MFE in development mode (eg. `tutor dev start authoring` fails), it may be due to
   using a tutor version that expects the MFE name to be frontend-app-course-authoring (the previous name of this repo). To fix
-  this, you can rename the cloned repo directory to frontend-app-course-authoring. More information can be found in 
+  this, you can rename the cloned repo directory to frontend-app-course-authoring. More information can be found in
   `this forum post <https://discuss.openedx.org/t/repo-rename-frontend-app-course-authoring-frontend-app-authoring/13930/2>`__.
 
 
@@ -177,8 +177,6 @@ Requirements
 
 * ``edx-platform`` Django settings:
 
-  * ``ZENDESK_*``: necessary if automatic ZenDesk ticket creation is desired
-
 * `edx-exams <https://github.com/edx/edx-exams>`_: for this feature to work, the ``edx-exams`` IDA must be deployed and its API accessible by the browser
 
 Configuration
@@ -196,7 +194,6 @@ In Studio, a new item ("Proctored Exam Settings") is added to "Other Course Sett
 * Enable proctored exams for the course
 * Allow opting out of proctored exams
 * Select a proctoring provider
-* Enable automatic creation of Zendesk tickets for "suspicious" proctored exam attempts
 
 Feature: Advanced Settings
 ==========================
@@ -239,7 +236,7 @@ Configuration
 
 In additional to the standard settings, the following local configuration items are required:
 
-* ``ENABLE_TAGGING_TAXONOMY_PAGES``: must be enabled (which it is by default) in order to actually enable/show the new 
+* ``ENABLE_TAGGING_TAXONOMY_PAGES``: must be enabled (which it is by default) in order to actually enable/show the new
 Tagging/Taxonomy functionality.
 
 
@@ -273,7 +270,7 @@ Troubleshooting
 ========================
 
 * ``npm ERR! gyp ERR! build error`` while running npm install on Macs with M1 processors: Probably due to a compatibility issue of node-canvas with M1.
-  
+
   Run ``brew install pkg-config pixman cairo pango libpng jpeg giflib librsvg`` before ``npm install`` to get the correct versions of the dependencies.
   If there is still an error, look for "no package [...] found" in the error message and install missing package via brew.
   (https://github.com/Automattic/node-canvas/issues/1733)

plugins/course-apps/proctoring/Settings.jsx

@@ -32,7 +32,6 @@ const ProctoringSettings = ({ onClose }) => {
     proctoringProvider: false,
     escalationEmail: '',
     allowOptingOut: false,
-    createZendeskTickets: false,
   };
   const [formValues, setFormValues] = useState(initialFormValues);
   const [loading, setLoading] = useState(true);
@@ -78,17 +77,17 @@ const ProctoringSettings = ({ onClose }) => {
     const value = target.type === 'checkbox' ? target.checked : target.value;
     const { name } = target;
 
-    if (['allowOptingOut', 'createZendeskTickets'].includes(name)) {
+    if (name === 'allowOptingOut') {
       // Form.Radio expects string values, so convert back to a boolean here
       setFormValues({ ...formValues, [name]: value === 'true' });
     } else if (name === 'proctoringProvider') {
       const newFormValues = { ...formValues, proctoringProvider: value };
 
       if (value === 'proctortrack') {
-        setFormValues({ ...newFormValues, createZendeskTickets: false });
+        setFormValues(newFormValues);
         setShowEscalationEmail(true);
       } else if (value === 'software_secure') {
-        setFormValues({ ...newFormValues, createZendeskTickets: true });
+        setFormValues(newFormValues);
         setShowEscalationEmail(false);
       } else if (isLtiProvider(value)) {
         setFormValues(newFormValues);
@@ -116,7 +115,6 @@ const ProctoringSettings = ({ onClose }) => {
         enable_proctored_exams: formValues.enableProctoredExams,
         // lti providers are managed outside edx-platform, lti_external indicates this
         proctoring_provider: isLtiProviderSelected ? 'lti_external' : selectedProvider,
-        create_zendesk_tickets: formValues.createZendeskTickets,
       },
     };
     if (isEdxStaff) {
@@ -387,29 +385,6 @@ const ProctoringSettings = ({ onClose }) => {
             </Form.Group>
           </fieldset>
         )}
-
-        {/* CREATE ZENDESK TICKETS */}
-        { isEdxStaff && formValues.enableProctoredExams && !isLtiProviderSelected && (
-          <fieldset aria-describedby="createZendeskTicketsText">
-            <Form.Group controlId="formCreateZendeskTickets">
-              <Form.Label as="legend" className="font-weight-bold">
-                {intl.formatMessage(messages['authoring.proctoring.createzendesk.label'])}
-              </Form.Label>
-              <Form.RadioSet
-                name="createZendeskTickets"
-                value={formValues.createZendeskTickets.toString()}
-                onChange={handleChange}
-              >
-                <Form.Radio value="true" data-testid="createZendeskTicketsYes">
-                  {intl.formatMessage(messages['authoring.proctoring.yes'])}
-                </Form.Radio>
-                <Form.Radio value="false" data-testid="createZendeskTicketsNo">
-                  {intl.formatMessage(messages['authoring.proctoring.no'])}
-                </Form.Radio>
-              </Form.RadioSet>
-            </Form.Group>
-          </fieldset>
-        )}
       </>
     );
   }
@@ -570,7 +545,6 @@ const ProctoringSettings = ({ onClose }) => {
             proctoringProvider: selectedProvider,
             enableProctoredExams: proctoredExamSettings.enable_proctored_exams,
             allowOptingOut: proctoredExamSettings.allow_proctoring_opt_out,
-            createZendeskTickets: proctoredExamSettings.create_zendesk_tickets,
             // The backend API may return null for the proctoringEscalationEmail value, which is the default.
             // In order to keep our email input component controlled, we use the empty string as the default
             // and perform this conversion during GETs and POSTs.

plugins/course-apps/proctoring/Settings.test.jsx

@@ -85,7 +85,6 @@ describe('ProctoredExamSettings', () => {
         allow_proctoring_opt_out: false,
         proctoring_provider: 'mockproc',
         proctoring_escalation_email: '[email protected]',
-        create_zendesk_tickets: true,
       },
       available_proctoring_providers: ['software_secure', 'proctortrack', 'mockproc', 'lti_external'],
       course_start_date: '2070-01-01T00:00:00Z',
@@ -105,36 +104,6 @@ describe('ProctoredExamSettings', () => {
       await act(async () => render(intlWrapper(<IntlProctoredExamSettings {...defaultProps} />)));
     });
 
-    it('Updates Zendesk ticket field if proctortrack is provider', async () => {
-      await waitFor(() => {
-        screen.getByDisplayValue('mockproc');
-      });
-      const selectElement = screen.getByDisplayValue('mockproc');
-      fireEvent.change(selectElement, { target: { value: 'proctortrack' } });
-      const zendeskTicketInput = screen.getByTestId('createZendeskTicketsNo');
-      expect(zendeskTicketInput.checked).toEqual(true);
-    });
-
-    it('Updates Zendesk ticket field if software_secure is provider', async () => {
-      await waitFor(() => {
-        screen.getByDisplayValue('mockproc');
-      });
-      const selectElement = screen.getByDisplayValue('mockproc');
-      fireEvent.change(selectElement, { target: { value: 'software_secure' } });
-      const zendeskTicketInput = screen.getByTestId('createZendeskTicketsYes');
-      expect(zendeskTicketInput.checked).toEqual(true);
-    });
-
-    it('Does not update zendesk ticket field for any other provider', async () => {
-      await waitFor(() => {
-        screen.getByDisplayValue('mockproc');
-      });
-      const selectElement = screen.getByDisplayValue('mockproc');
-      fireEvent.change(selectElement, { target: { value: 'mockproc' } });
-      const zendeskTicketInput = screen.getByTestId('createZendeskTicketsYes');
-      expect(zendeskTicketInput.checked).toEqual(true);
-    });
-
     it('Hides all other fields when enabledProctorExam is false when first loaded', async () => {
       cleanup();
       // Overrides the handler defined in beforeEach.
@@ -146,7 +115,6 @@ describe('ProctoredExamSettings', () => {
           allow_proctoring_opt_out: false,
           proctoring_provider: 'mockproc',
           proctoring_escalation_email: '[email protected]',
-          create_zendesk_tickets: true,
         },
         available_proctoring_providers: ['software_secure', 'proctortrack', 'mockproc'],
         course_start_date: '2070-01-01T00:00:00Z',
@@ -161,8 +129,6 @@ describe('ProctoredExamSettings', () => {
       expect(screen.queryByText('Allow Opting Out of Proctored Exams')).toBeNull();
       expect(screen.queryByDisplayValue('mockproc')).toBeNull();
       expect(screen.queryByTestId('escalationEmail')).toBeNull();
-      expect(screen.queryByTestId('createZendeskTicketsYes')).toBeNull();
-      expect(screen.queryByTestId('createZendeskTicketsNo')).toBeNull();
     });
 
     it('Hides all other fields when enableProctoredExams toggled to false', async () => {
@@ -172,8 +138,6 @@ describe('ProctoredExamSettings', () => {
       expect(screen.queryByText('Allow opting out of proctored exams')).toBeDefined();
       expect(screen.queryByDisplayValue('mockproc')).toBeDefined();
       expect(screen.queryByTestId('escalationEmail')).toBeDefined();
-      expect(screen.queryByTestId('createZendeskTicketsYes')).toBeDefined();
-      expect(screen.queryByTestId('createZendeskTicketsNo')).toBeDefined();
 
       let enabledProctoredExamCheck = screen.getAllByLabelText('Proctored exams', { exact: false })[0];
       expect(enabledProctoredExamCheck.checked).toEqual(true);
@@ -183,8 +147,6 @@ describe('ProctoredExamSettings', () => {
       expect(screen.queryByText('Allow opting out of proctored exams')).toBeNull();
       expect(screen.queryByDisplayValue('mockproc')).toBeNull();
       expect(screen.queryByTestId('escalationEmail')).toBeNull();
-      expect(screen.queryByTestId('createZendeskTicketsYes')).toBeNull();
-      expect(screen.queryByTestId('createZendeskTicketsNo')).toBeNull();
     });
 
     it('Hides unsupported fields when lti provider is selected', async () => {
@@ -194,8 +156,6 @@ describe('ProctoredExamSettings', () => {
       const selectElement = screen.getByDisplayValue('mockproc');
       fireEvent.change(selectElement, { target: { value: 'test_lti' } });
       expect(screen.queryByTestId('allowOptingOutRadio')).toBeNull();
-      expect(screen.queryByTestId('createZendeskTicketsYes')).toBeNull();
-      expect(screen.queryByTestId('createZendeskTicketsNo')).toBeNull();
     });
   });
 
@@ -211,7 +171,6 @@ describe('ProctoredExamSettings', () => {
           allow_proctoring_opt_out: false,
           proctoring_provider: 'proctortrack',
           proctoring_escalation_email: '[email protected]',
-          create_zendesk_tickets: true,
         },
         available_proctoring_providers: ['software_secure', 'proctortrack', 'mockproc', 'lti_external'],
         course_start_date: '2070-01-01T00:00:00Z',
@@ -383,7 +342,6 @@ describe('ProctoredExamSettings', () => {
         allow_proctoring_opt_out: false,
         proctoring_provider: 'mockproc',
         proctoring_escalation_email: '[email protected]',
-        create_zendesk_tickets: true,
       },
       available_proctoring_providers: ['software_secure', 'proctortrack', 'mockproc'],
       course_start_date: '2099-01-01T00:00:00Z',
@@ -395,7 +353,6 @@ describe('ProctoredExamSettings', () => {
         allow_proctoring_opt_out: false,
         proctoring_provider: 'mockproc',
         proctoring_escalation_email: '[email protected]',
-        create_zendesk_tickets: true,
       },
       available_proctoring_providers: ['software_secure', 'proctortrack', 'mockproc'],
       course_start_date: '2013-01-01T00:00:00Z',
@@ -527,18 +484,16 @@ describe('ProctoredExamSettings', () => {
   });
 
   describe('Toggles field visibility based on user permissions', () => {
-    it('Hides opting out and zendesk tickets for non edX staff', async () => {
+    it('Hides opting out for non edX staff', async () => {
       setupApp(false);
       await act(async () => render(intlWrapper(<IntlProctoredExamSettings {...defaultProps} />)));
       expect(screen.queryByTestId('allowOptingOutYes')).toBeNull();
-      expect(screen.queryByTestId('createZendeskTicketsYes')).toBeNull();
     });
 
-    it('Shows opting out and zendesk tickets for edX staff', async () => {
+    it('Shows opting out for edX staff', async () => {
       setupApp(true);
       await act(async () => render(intlWrapper(<IntlProctoredExamSettings {...defaultProps} />)));
       expect(screen.queryByTestId('allowOptingOutYes')).not.toBeNull();
-      expect(screen.queryByTestId('createZendeskTicketsYes')).not.toBeNull();
     });
   });
 
@@ -624,7 +579,6 @@ describe('ProctoredExamSettings', () => {
           allow_proctoring_opt_out: false,
           proctoring_provider: 'proctortrack',
           proctoring_escalation_email: '[email protected]',
-          create_zendesk_tickets: false,
         },
       });
 
@@ -651,7 +605,6 @@ describe('ProctoredExamSettings', () => {
           enable_proctored_exams: true,
           allow_proctoring_opt_out: false,
           proctoring_provider: 'mockproc',
-          create_zendesk_tickets: true,
         },
       });
 
@@ -692,7 +645,6 @@ describe('ProctoredExamSettings', () => {
           enable_proctored_exams: true,
           allow_proctoring_opt_out: false,
           proctoring_provider: 'lti_external',
-          create_zendesk_tickets: true,
         },
       });
 
@@ -722,7 +674,6 @@ describe('ProctoredExamSettings', () => {
           enable_proctored_exams: true,
           allow_proctoring_opt_out: false,
           proctoring_provider: 'mockproc',
-          create_zendesk_tickets: true,
         },
       });
 
@@ -744,7 +695,6 @@ describe('ProctoredExamSettings', () => {
           allow_proctoring_opt_out: false,
           proctoring_provider: 'mockproc',
           proctoring_escalation_email: '[email protected]',
-          create_zendesk_tickets: true,
         },
         available_proctoring_providers: ['software_secure', 'proctortrack', 'mockproc'],
         course_start_date: '2070-01-01T00:00:00Z',
@@ -762,7 +712,6 @@ describe('ProctoredExamSettings', () => {
           enable_proctored_exams: true,
           allow_proctoring_opt_out: false,
           proctoring_provider: 'mockproc',
-          create_zendesk_tickets: true,
         },
       });
 
@@ -863,7 +812,7 @@ describe('ProctoredExamSettings', () => {
       });
     });
 
-    it('Include Zendesk ticket in post request if user is not an admin', async () => {
+    it('Posts valid payload if user is not an admin', async () => {
       // use non-admin user for test
       const isAdmin = false;
       setupApp(isAdmin);
@@ -880,7 +829,6 @@ describe('ProctoredExamSettings', () => {
           enable_proctored_exams: true,
           proctoring_provider: 'proctortrack',
           proctoring_escalation_email: '[email protected]',
-          create_zendesk_tickets: false,
         },
       });
     });

plugins/course-apps/proctoring/messages.js

@@ -81,11 +81,6 @@ const messages = defineMessages({
     defaultMessage: 'Allow learners to opt out of proctoring on proctored exams',
     description: 'Label for radio selection allowing proctored exam opt out',
   },
-  'authoring.proctoring.createzendesk.label': {
-    id: 'authoring.proctoring.createzendesk.label',
-    defaultMessage: 'Create Zendesk tickets for suspicious attempts',
-    description: 'Label for Zendesk ticket creation radio select.',
-  },
   'authoring.proctoring.error.single': {
     id: 'authoring.proctoring.error.single',
     defaultMessage: 'There is 1 error in this form.',

src/course-outline/__mocks__/courseOutlineIndex.js

@@ -62,7 +62,6 @@ module.exports = {
     highlightsPreviewOnly: false,
     highlightsDocUrl: 'https://docs.openedx.org/en/latest/educators/how-tos/course_development/manage_course_highlight_emails.html',
     enableProctoredExams: true,
-    createZendeskTickets: true,
     enableTimedExams: true,
     childInfo: {
       category: 'chapter',

src/course-unit/__mocks__/courseSectionVertical.js

@@ -1413,7 +1413,6 @@ module.exports = {
           highlights_preview_only: false,
           highlights_doc_url: 'https://docs.openedx.org/en/latest/educators/how-tos/course_development/manage_course_highlight_emails.html',
           enable_proctored_exams: false,
-          create_zendesk_tickets: true,
           enable_timed_exams: true,
           ancestor_has_staff_lock: false,
           user_partition_info: {