[BD-32] feat: add 2nd batch of Open edX Filters #29840

mariajgrimaldi · 2022-01-28T16:55:08Z

Description

This PR adds the 2nd Open edX Filters batch as part of the implementation plan of Hooks Extension Framework:

CourseUnenrollmentStarted: intended to be executed before the un-enrollment process starts.
CertificateCreationRequested: intended to be executed before the certificate creation process starts.
CertificateRenderStarted: intended to be executed before the certificate template rendering process starts.
CohortChangeRequested: intended to be executed before the cohort change process starts.
CourseAboutRenderStarted: intended to be executed before course about template render starts.
CourseHomeRenderStarted: intended to be executed before course home template render starts.
DashboardRenderStarted: intended to be executed before the student's dashboard render starts.

Supporting information

Hooks Extension Framework OEP-50
ADR(s) on:
Open edX Filters naming and versioning: about how to identify filters and manage its versions
Open edX Filters configuration: how to configure filters
Open edX Filters tooling: what to use to run filters
Open edX Filters payload: input arguments for filters

Testing instructions

Install openedx-filters library:

pip install git+https://github.com/eduNEXT/openedx-filters.git@MJG/2nd_filters_batch#egg=openedx_filters==0.5.0_alpha

Implement your pipeline steps in your favorite plugin. We created some as illustration in openedx-filters-samples. We'll be using those in this example.
Install openedx-filters-samples

pip install git+https://github.com/eduNEXT/openedx-filters-samples.git@master#egg=openedx_filters_samples

Configure your filters:
With this configuration, you won't be able to:

Generate a certificate with org.openedx.learning.certificate.creation.requested.v1
Render certificate for org.openedx.learning.certificate.render.started.v1
Un-enroll from a course org.openedx.learning.course.unenrollment.started.v1
Rendering course about page (courses/COURSE_ID/about) org.openedx.learning.course_about.render.started.v1
Rendering course home page (courses/COURSE_ID/course) org.openedx.learning.course_home.render.started.v1
Rendering student's dashboard page (/dashboard) org.openedx.learning.course_home.render.started.v1
Change a student from cohort A to cohort B with org.openedx.learning.cohort.change.requested.v1
To change the behavior you can replace Stop<process> with NoopFilter or remove it completely.

OPEN_EDX_FILTERS_CONFIG = {
    "org.openedx.learning.certificate.creation.requested.v1": {
        "fail_silently": False,
        "pipeline": [
            "openedx_filters_samples.samples.pipeline.StopCertificateCreation"
        ]
    },
    "org.openedx.learning.course.unenrollment.started.v1": {
        "fail_silently": False,
        "pipeline": [
            "openedx_filters_samples.samples.pipeline.StopUnenrollment"
        ]
    },
    "org.openedx.learning.course_about.render.started.v1": {
        "fail_silently": False,
        "pipeline": [
            "openedx_filters_samples.samples.pipeline.StopCourseAboutRendering",
        ]
    },
    "org.openedx.learning.course_home.render.started.v1": {
        "fail_silently": False,
        "pipeline": [
            "openedx_filters_samples.samples.pipeline.StopCourseHomeRendering",
        ]
    },
    "org.openedx.learning.dashboard.render.started.v1": {
        "fail_silently": False,
        "pipeline": [
            "openedx_filters_samples.samples.pipeline.StopDashboardRender",
        ]
    },
     "org.openedx.learning.certificate.render.started.v1": {
            "fail_silently": False,
            "pipeline": [
                "openedx_filters_samples.samples.pipeline.StopCertificateRender",
            ]
    },
     "org.openedx.learning.cohort.change.requested.v1": {
            "fail_silently": False,
            "pipeline": [
                "openedx_filters_samples.samples.pipeline.StopCohortChange",
            ]
    },
}

Notes about the filters steps:

ModifyContextBeforeRender: changes context before rendering. As it is right now just adds a new variable.
The other ones halt the app execution.

Simple and straightforward implementations as a way of illustrating how they work. More complex steps are coming.

openedx-webhooks · 2022-01-28T16:55:15Z

Thanks for the pull request, @mariajgrimaldi! I've created BLENDED-1080 to keep track of it in Jira. More details are on the BD-32 project page.

When this pull request is ready, tag your edX technical lead.

mariajgrimaldi · 2022-01-28T22:16:33Z

common/djangoapps/student/views/dashboard.py

+    try:
+        context = DashboardRenderStarted.run_filter(context=context)
+    except DashboardRenderStarted.PreventDashboardRender as exc:
+        raise DashboardRenderNotAllowed(reverse(exc.redirect_to or 'account_settings')) from exc


What should happen when interacting with templates?

As it is right now, when filters that interact with templates (i.e they interact with template contexts) fail they raise an exception with the intent to redirect to some constant view (e.g if course about filter fails, then redirect to dashboard). If there's a handler that interprets this kind of exception, then the redirection occurs (as it happens when using CourseAccessRedirect here where this handler catches the exception and manages the redirection). If not, like in this case, then error 500 is thrown. So we can replicate this behavior we should implement a handler that manages exceptions in the student's dashboard, but that's probably out of the scope of this PR.

Either way, should be this way the standard when interacting with templates?

I like the idea that we should have a consistent way of interacting with templates when filters are involved. Having the ability to redirect somewhere and changing the template_name that should be rendered and naturally updating the context before rendering are the three that come to my mind now.

mariajgrimaldi · 2022-01-31T12:41:55Z

FYI 🥳 @felipemontoya @ormsbee @shadinaif @giovannicimolin

giovannicimolin · 2022-01-31T19:10:05Z

Awesome! 🚀

JuanDavidBuitrago · 2022-02-10T00:18:15Z

I tested some filters and make the BD-32 Open edx Filters document with the results of the testing from description. I hope it can help!!

mariajgrimaldi · 2022-02-16T18:15:42Z

Knowing that we are modifying multiple applications and this can be difficult to review all at once, I'll be dividing this PR into smaller chunks!

mariajgrimaldi · 2022-03-02T13:21:49Z

PR closed in favor of:

PR 29948:
CourseUnenrollmentStarted: intended to be executed before the un-enrollment process starts.

PR 29949:
CertificateCreationRequested: intended to be executed before the certificate creation process starts.

PR 29976:
CertificateRenderStarted: intended to be executed before the certificate template rendering process starts.

PR 29964:
CohortChangeRequested: intended to be executed before the cohort change process starts.

PR 29996:
CourseAboutRenderStarted: intended to be executed before course about template render starts.

PR 29995:
CourseHomeRenderStarted: intended to be executed before course home template render starts.

PR 29994:
DashboardRenderStarted: intended to be executed before the student's dashboard render starts.

openedx-webhooks · 2022-03-02T13:22:08Z

@mariajgrimaldi Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.

openedx-webhooks added blended PR is managed through 2U's blended developmnt program waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Jan 28, 2022

mariajgrimaldi mentioned this pull request Jan 28, 2022

feat: add 2nd batch of filters openedx/openedx-filters#22

Merged

10 tasks

mariajgrimaldi commented Jan 28, 2022

View reviewed changes

mariajgrimaldi marked this pull request as ready for review January 28, 2022 22:16

openedx-webhooks added needs triage and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Jan 28, 2022

mariajgrimaldi force-pushed the MJG/2nd_filters_batch branch from 6c3a77b to 8bd19c6 Compare February 3, 2022 20:17

feat: add second batch of Open edX Filters

aaf1789

mariajgrimaldi force-pushed the MJG/2nd_filters_batch branch from 8bd19c6 to aaf1789 Compare February 3, 2022 20:18

fix: change arguments for CohortChangeRequested

1f9e25a

mariajgrimaldi added 4 commits February 14, 2022 11:51

refactor: address PR comments (openedx-filters PR 22)

54bbcf0

chore: update openedx-filters from alpha to beta

9b97eac

chore: add extra argument to dashboard rendering

8f587d7

chore: change beta from gamma

51c4c46

mariajgrimaldi closed this Mar 2, 2022

openedx-webhooks added rejected and removed needs triage labels Mar 2, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BD-32] feat: add 2nd batch of Open edX Filters #29840

[BD-32] feat: add 2nd batch of Open edX Filters #29840

mariajgrimaldi commented Jan 28, 2022 •

edited

Loading

openedx-webhooks commented Jan 28, 2022 •

edited

Loading

mariajgrimaldi Jan 28, 2022

felipemontoya Feb 11, 2022

mariajgrimaldi commented Jan 31, 2022

giovannicimolin commented Jan 31, 2022

JuanDavidBuitrago commented Feb 10, 2022

mariajgrimaldi commented Feb 16, 2022

mariajgrimaldi commented Mar 2, 2022

openedx-webhooks commented Mar 2, 2022

[BD-32] feat: add 2nd batch of Open edX Filters #29840

[BD-32] feat: add 2nd batch of Open edX Filters #29840

Conversation

mariajgrimaldi commented Jan 28, 2022 • edited Loading

Description

Supporting information

Testing instructions

openedx-webhooks commented Jan 28, 2022 • edited Loading

mariajgrimaldi Jan 28, 2022

Choose a reason for hiding this comment

What should happen when interacting with templates?

felipemontoya Feb 11, 2022

Choose a reason for hiding this comment

mariajgrimaldi commented Jan 31, 2022

giovannicimolin commented Jan 31, 2022

JuanDavidBuitrago commented Feb 10, 2022

mariajgrimaldi commented Feb 16, 2022

mariajgrimaldi commented Mar 2, 2022

openedx-webhooks commented Mar 2, 2022

mariajgrimaldi commented Jan 28, 2022 •

edited

Loading

openedx-webhooks commented Jan 28, 2022 •

edited

Loading