feat: Remove all proctortrack references and add support for requires_escalation_email and show_review_rules configs by mlabeeb03 · Pull Request #37576 · openedx/openedx-platform

mlabeeb03 · 2025-10-30T11:18:33Z

Description

All references to the hardcoded 'proctortrack' string have been removed from the codebase in addition to the SHOW_REVIEW_RULES waffle flag. It was used to determine whether an escalation email is required and whether review rules should be shown. These decisions are now made based on the value of 'requires_escalation_email' and 'show_review_rules' config in the course's proctoring backend.

Removed translation commands, mock variables and user facing strings that contained 'proctortrack'.

Updated all test cases that were using proctortrack to use the new config variables.

Add a test case that verifies the functionality of the new show_review_rules config.

Testing information

Test cms/djangoapps/contentstore/api/views/course_validation.py by making a get request and verifying the correct value of requires_escalation_email:

Test cms/djangoapps/models/settings/course_metadata.py by making sure the the Proctoring exam escalation contact is not visible when requires_escalation_email is not set in the proctoring backend:

Also test that if you do not provide the escalation email when requires_escalation_email is set, you should see an error message in API call:

You can see this error on the main course page as well as while updating the Proctoring provider in the advanced course settings.

Supporting information

More details available here: #36329

openedx-webhooks · 2025-10-30T11:18:38Z

Thanks for the pull request, @mlabeeb03!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

mlabeeb03 · 2025-10-31T13:12:47Z

@kdmccormick the initial draft PR is ready, just FYI.

…email and show_review_rules configs All references to the hardcoded 'proctortrack' string have been removed from the codebase in addition to the SHOW_REVIEW_RULES waffle flag. It was used to determince whether an escalation email is required and whether review rules should be shown. These decisions are now made based on the value of 'requires_escalation_email' and 'show_review_rules' config in the default proctoring backend. Removed translation commands, mock variables and user facing strings that contained 'proctortrack'. Updated all test cases that were using proctortrack to use the new config variables. See this ticket for further information: openedx#36329

…n escalation email This change is a requirement for frontend-app-learning. It will no longer use hardcoded strings to check if an escalation email is required or not. Instead the api will return the list of proctoring backends that require and escalation email.

mlabeeb03 · 2025-11-13T09:50:20Z

Hey @kdmccormick I added a new commit. Updated the API because frontend-app-authoring now requires a list of proctoring backends that have requires_escalation_email set.

kdmccormick

Thanks for the work so far @mlabeeb03

Co-authored-by: Kyle McCormick <kyle@kylemccormick.me>

mlabeeb03 · 2025-11-24T15:41:54Z

@kdmccormick I've fixed the unit tests. You may review the PR.

kdmccormick

looks great, thanks!

mlabeeb03 · 2025-11-25T08:23:03Z

@kdmccormick you can merge it now.

…and show_review_rules options (openedx#37576) BREAKING CHANGE: All references to the hardcoded 'proctortrack' string have been removed from the codebase, as well as the `studio.show_review_rules` waffle flag. These were used to determine whether an escalation email is required and whether review rules should be shown. These decisions are now made based on the value of 'requires_escalation_email' (default False) and 'show_review_rules' (default True) config items in the PROCTORING_BACKENDS entry. Additionally: * The proctoring info api will now return the list of providers which require an escalation email so that frontend-app-learning does not need to use a hardcoded check agaist the provider name 'proctortrack'. * Removed translation commands, mock variables and user facing strings that contained 'proctortrack'. * Updated all test cases that were using proctortrack to use fake providers names. Part of: openedx#36329

mlabeeb03 requested review from farhan, irtazaakram and salman2013 as code owners October 30, 2025 11:18

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 30, 2025

openedx-webhooks added this to Contributions Oct 30, 2025

github-project-automation Bot moved this to Needs Triage in Contributions Oct 30, 2025

mlabeeb03 marked this pull request as draft October 30, 2025 11:18

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Oct 30, 2025

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Oct 30, 2025

mlabeeb03 force-pushed the proctortrack-depr branch 2 times, most recently from 9b7db37 to 651c45d Compare October 31, 2025 11:40

mlabeeb03 removed request for farhan, irtazaakram and salman2013 October 31, 2025 11:42

mlabeeb03 changed the title ~~feat: Remove proctortrack and add support for requires_escalation_email and show_review_rules configs~~ feat: Remove proctortrack and add support for requires_escalation_email and show_review_rules configs (WIP) Oct 31, 2025

mlabeeb03 force-pushed the proctortrack-depr branch 3 times, most recently from deb96fc to 8416aa4 Compare November 3, 2025 10:40

mlabeeb03 changed the title ~~feat: Remove proctortrack and add support for requires_escalation_email and show_review_rules configs (WIP)~~ feat: Add support for requires_escalation_email and show_review_rules configs in proctoring backend Nov 3, 2025

mlabeeb03 force-pushed the proctortrack-depr branch 2 times, most recently from fb35fd6 to d500f5d Compare November 3, 2025 11:17

mlabeeb03 changed the title ~~feat: Add support for requires_escalation_email and show_review_rules configs in proctoring backend~~ feat: Remove proctortrack references and add support for requires_escalation_email and show_review_rules configs in proctoring backend Nov 3, 2025

mlabeeb03 force-pushed the proctortrack-depr branch from d500f5d to 98d50c5 Compare November 3, 2025 11:19

mlabeeb03 changed the title ~~feat: Remove proctortrack references and add support for requires_escalation_email and show_review_rules configs in proctoring backend~~ feat: Remove all proctortrack references and add support for requires_escalation_email and show_review_rules configs Nov 3, 2025

mlabeeb03 marked this pull request as ready for review November 3, 2025 13:38

mlabeeb03 requested a review from kdmccormick November 3, 2025 13:38

mlabeeb03 force-pushed the proctortrack-depr branch 2 times, most recently from 35ebb41 to 787a10e Compare November 3, 2025 16:12

mlabeeb03 force-pushed the proctortrack-depr branch 2 times, most recently from 529b623 to 7930891 Compare November 13, 2025 08:57

mlabeeb03 force-pushed the proctortrack-depr branch from 7930891 to ec4fcad Compare November 13, 2025 09:25

kdmccormick requested changes Nov 13, 2025

View reviewed changes

mphilbrick211 moved this from Waiting on Author to In Eng Review in Contributions Nov 13, 2025

mlabeeb03 force-pushed the proctortrack-depr branch 4 times, most recently from dfd6594 to 9de0380 Compare November 17, 2025 10:45

mlabeeb03 requested a review from kdmccormick November 17, 2025 11:27

mlabeeb03 force-pushed the proctortrack-depr branch from 9de0380 to bfae000 Compare November 18, 2025 10:16

feat: update proctoring helper functions, add test case and refactoring

2d700e1

Co-authored-by: Kyle McCormick <kyle@kylemccormick.me>

mlabeeb03 force-pushed the proctortrack-depr branch from bfae000 to 2d700e1 Compare November 24, 2025 15:16

kdmccormick requested changes Nov 24, 2025

View reviewed changes

Comment thread openedx/envs/common.py

Comment thread openedx/envs/common.py Outdated

Comment thread common/djangoapps/util/proctoring.py Outdated

mlabeeb03 force-pushed the proctortrack-depr branch from 6db178b to 2253607 Compare November 24, 2025 18:33

mlabeeb03 requested a review from kdmccormick November 24, 2025 19:07

kdmccormick mentioned this pull request Nov 24, 2025

refactor: Replace ProctorTrack references with Generic Checks openedx/frontend-app-authoring#2645

Merged

7 tasks

kdmccormick approved these changes Nov 24, 2025

View reviewed changes

Comment thread xmodule/course_block.py Outdated

Comment thread xmodule/course_block.py Outdated

feat: simplify proctoring util functions and update comments

0962b41

mlabeeb03 force-pushed the proctortrack-depr branch from 8d00a7b to 0962b41 Compare November 25, 2025 07:27

kdmccormick merged commit 8ad4d42 into openedx:master Nov 25, 2025
49 checks passed

github-project-automation Bot moved this from In Eng Review to Done in Contributions Nov 25, 2025

kdmccormick mentioned this pull request Nov 25, 2025

[DEPR]: edx-proctoring-proctortrack and create_zendesk_tickets #36329

Closed

17 tasks

Uh oh!

Conversation

mlabeeb03 commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing information

Supporting information

Uh oh!

openedx-webhooks commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mlabeeb03 commented Oct 31, 2025

Uh oh!

mlabeeb03 commented Nov 13, 2025

Uh oh!

kdmccormick left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mlabeeb03 commented Nov 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kdmccormick left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mlabeeb03 commented Nov 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mlabeeb03 commented Oct 30, 2025 •

edited

Loading

openedx-webhooks commented Oct 30, 2025 •

edited

Loading