Skip to content

fix: surface EnrollmentNotAllowed message to instructor dashboard#38674

Open
ccantillo wants to merge 1 commit into
openedx:masterfrom
eduNEXT:fix/surface-enrollment-not-allowed-message
Open

fix: surface EnrollmentNotAllowed message to instructor dashboard#38674
ccantillo wants to merge 1 commit into
openedx:masterfrom
eduNEXT:fix/surface-enrollment-not-allowed-message

Conversation

@ccantillo
Copy link
Copy Markdown

fix: surface EnrollmentNotAllowed message to instructor dashboard

Problem

When a pipeline filter blocks enrollment (e.g. FilterEnrollmentRequireNIF), the specific error message was never shown to the instructor. Instead, a generic error was returned with no explanation.

Two cases were broken in process_single_student_enrollment:

  1. Registered user blocked by a filterenroll_email() raises EnrollmentNotAllowed with a descriptive message, which was caught by the broad except Exception handler and replaced with a generic "Something went wrong" message.

  2. Unregistered email blocked by a pre_save signal guard — a ValidationError raised during enrollment was caught by the same except ValidationError used for email format validation, returning invalidIdentifier: True and "Invalid email address" — completely misleading.

Solution

  • Separated validate_email into its own try/except block so email format errors are handled independently from errors raised during enrollment.
  • Added except EnrollmentNotAllowed as exc to capture filter-blocked enrollments and surface str(exc) in the response.
  • Added except ValidationError as exc for ValidationError raised during the enrollment process itself, surfacing exc.messages[0] instead of a hardcoded message.

Testing

  1. Set up a course with a pipeline filter that blocks enrollment (e.g. a NIF requirement filter).
  2. Try to enroll a registered user who does not meet the filter requirement via the instructor dashboard.
  3. Verify the instructor sees the specific message from the filter instead of a generic error.
  4. Try to enroll an unregistered email on the same course.
  5. Verify the instructor sees the specific message from the pre_save guard instead of "Invalid email address".

@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @ccantillo!

This repository is currently maintained by @openedx/wg-maintenance-openedx-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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 28, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions May 28, 2026
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: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants