feat: show exception message from filters in the user interface

[felipemontoya]

Description

This PR connects the output from the org.openedx.learning.course.enrollment.started.v1 or CourseEnrollmentStarted into the API that responds to the user action in the UI.

Useful information to include:

• This impacts developers that are using open edX filters to create their own rules for enrollment.

Testing instructions

In tutor:

• Use a tutor environment with edx-platform with this branch
• create a filter in your_package.pipeline with this code:

from openedx_filters import PipelineStep
from openedx_filters.learning.filters import CourseEnrollmentStarted

class MyFilterToStopEnrollment(PipelineStep):   # pylint: disable=too-few-public-methods
    """
    Stop enrollment process raising PreventEnrollment exception
    """

    def run_filter(self, user, course_key, mode):
        """Filter."""
        raise CourseEnrollmentStarted.PreventEnrollment(_("You can't enroll on this course as there is custom code preventing it"))

• You need to add the following settings to your settings

OPEN_EDX_FILTERS_CONFIG = {
        "org.openedx.learning.course.enrollment.started.v1": {
            "fail_silently": False,
            "pipeline": [
                "your_package.pipeline.MyFilterToStopEnrollment",
            ],
        },
    }

• Go to any course-about page in the platform and try to enroll. The message "you can't enroll on this course as there is custom code preventing it" should be visible.

Deadline

Ideally soon, but there is no great rush as this has been present for a while.

[openedx-webhooks]

Thanks for the pull request, @felipemontoya!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[mariajgrimaldi]

Why would the pylint disable be needed in this case?

[mphilbrick211]

Hi @felipemontoya and @mariajgrimaldi! Just checking in to see if this pull request is still in progress?

[mphilbrick211]

Hi @felipemontoya and @mariajgrimaldi! Just checking in to see if this pull request is still in progress?

Friendly ping on this, @felipemontoya!

[mariajgrimaldi]

@mphilbrick211: I can take this. Once I've fixed the quality issues, I'll ask for a review again. In the meantime, I'll convert this into a draft.

I'm taking this over.

[mariajgrimaldi]

Hey, @MaferMazu, can you help us with a review? Thanks!