Skip to content

feat: add Student Onboarding Status and Review Dashboard to Special Exams#219

Open
Anas12091101 wants to merge 1 commit into
openedx:mainfrom
mitodl:anas/special-exams-onboarding-review
Open

feat: add Student Onboarding Status and Review Dashboard to Special Exams#219
Anas12091101 wants to merge 1 commit into
openedx:mainfrom
mitodl:anas/special-exams-onboarding-review

Conversation

@Anas12091101

@Anas12091101 Anas12091101 commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Description

Restores the two Special Exams sections that exist on the legacy (Django-rendered) instructor
dashboard but were missing from this MFE: Student Onboarding Status and Review Dashboard.
The Special Exams tab previously shipped only Exam Attempts and Allowances; this adds the
remaining two as additional tabs.

  • Onboarding — a DataTable (username, enrollment mode, onboarding status, last updated) with
    username search and pagination, backed by the edx-proctoring v1 endpoint
    GET /api/edx_proctoring/v1/user_onboarding/status/course_id/{courseId}. This endpoint is called
    directly (the same way the existing "resume attempt" action already calls edx-proctoring v1)
    because the onboarding logic is provider-specific and lives in edx-proctoring rather than in a
    wrappable library function.
  • Review Dashboard — an <iframe> pointed at GET /api/edx_proctoring/v1/instructor/{courseId},
    which the LMS redirects into the proctoring provider's hosted review dashboard. This mirrors the
    legacy dashboard's behavior exactly (same iframe/redirect mechanism the Learning and Authoring
    MFEs use for embedded LMS content).

Both tabs are provider-gated: they only render when the course's proctoring backend supports
them. Gating uses two new capability flags (supportsOnboarding, reviewDashboardAvailable)
returned by the v2 proctoring_settings endpoint (see the dependent backend PR). This matches the
legacy dashboard, which showed these sections only for backends that support onboarding / expose a
review dashboard (e.g. Verificient's Proctortrack).

Impacted user roles: Course Team / Instructors (staff) — they regain the two sections in the
new dashboard. Operators — no config change required; behavior is driven entirely by the
course's proctoring provider.

Screenshots:
Screenshot 2026-07-10 at 3 15 15 PM

Screenshot 2026-07-10 at 3 15 43 PM

Supporting information

Testing instructions

  1. Have a course with proctoring enabled whose backend supports onboarding and a review
    dashboard
    (e.g. Proctortrack). The course needs an onboarding (practice proctored) exam and
    some proctoring-eligible (e.g. verified) enrollments, ideally with onboarding attempts in a few
    statuses.
  2. As course staff/admin, open the instructor dashboard MFE → Special Exams.
  3. Confirm four tabs appear: Exam Attempts, Allowances, Onboarding, Review Dashboard.
  4. Onboarding: confirm the table lists learners with username, enrollment mode, onboarding
    status, and last-updated; verify username search and pagination work.
  5. Review Dashboard: confirm the iframe loads and redirects into the provider's dashboard.
  6. Open a course whose backend does not support these (e.g. the null backend) and confirm the
    two tabs are hidden and only Exam Attempts / Allowances show.

Other information

  • Depends on the backend PR adding the two capability flags to the v2 proctoring_settings
    endpoint. Without it, supportsOnboarding / reviewDashboardAvailable are undefined and the two
    tabs stay hidden (graceful degradation).
  • Cross-origin note: the Review Dashboard iframe loads an LMS URL that redirects to the provider.
    When the MFE and LMS share a parent domain (the standard Open edX cookie-domain setup), the session
    flows through as it does for the Learning MFE's courseware iframe. If the MFE is served from an
    unrelated origin, the provider's own X-Frame-Options/CSP frame-ancestors governs whether it can
    be embedded.
  • This repo's src/testUtils.tsx exposes renderWithIntl / renderWithQueryClient (there is no
    initializeMocks helper here yet); the new tests use these, consistent with every existing suite.
  • No deprecations, migrations, or new dependencies.

Best Practices Checklist

  • Any new files are using TypeScript (.ts, .tsx).
  • Deprecated propTypes, defaultProps, and injectIntl patterns are not used in any new or modified code.
  • Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
  • Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
  • All new i18n messages in messages.ts files have a description for translators to use.
  • Imports avoid using ../. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 10, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @Anas12091101!

This repository is currently maintained by @openedx/committers-frontend-app-instructor-dashboard.

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.

@codecov

codecov Bot commented Jul 10, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 95.52239% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.30%. Comparing base (6c1e290) to head (cba9fd8).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/specialExams/components/OnboardingList.tsx 85.71% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #219      +/-   ##
==========================================
+ Coverage   91.20%   91.30%   +0.10%     
==========================================
  Files         148      150       +2     
  Lines        2716     2782      +66     
  Branches      618      649      +31     
==========================================
+ Hits         2477     2540      +63     
- Misses        231      234       +3     
  Partials        8        8              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Anas12091101
Anas12091101 force-pushed the anas/special-exams-onboarding-review branch from 58c1dec to cba9fd8 Compare July 10, 2026 12:07
@Anas12091101 Anas12091101 moved this from Needs Triage to Ready for Review in Contributions Jul 10, 2026

@diana-villalvazo-wgu diana-villalvazo-wgu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@diana-villalvazo-wgu

Copy link
Copy Markdown
Contributor

Please let me know when the backend PR that this one depends on is merged, so we can merge it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

3 participants