Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BD-32] feat: Open edX Filters backport #30583

Merged
merged 2 commits into from
Aug 8, 2022

Conversation

mariajgrimaldi
Copy link
Member

@mariajgrimaldi mariajgrimaldi commented Jun 14, 2022

Description

Backport filters that didn't make it to nutmeg release:

Add filter before certificate creation starts

(cherry picked from commit e8fa890)

Add cohort change filter before moving users from cohorts

(cherry picked from commit 465e5c0)

Add filter before certificate rendering process starts

(cherry picked from commit 7f974d1)

Add filter before course dashboard rendering process starts

(cherry picked from commit 895a649)

Add filter before course about rendering process starts

(cherry picked from commit ccfa0b4)

Integrate cohort assignment filter definition to cohort model

(cherry picked from commit ec69659)

Supporting information

Refer to the BTR wg github issue for the rationale behind this PR: openedx/wg-build-test-release#187

Testing instructions

  1. Install the needed library release: openedx-filters==0.7.0
  2. Install the samples library:
    pip install git+https://github.com/eduNEXT/openedx-filters-samples.git@master#egg=openedx_filters_samples
  3. Then, configure each filter. If you want to test all the filters simultaneously, use this configuration and try to do each operation the filter is related to; the filter sample step will stop the operation.
OPEN_EDX_FILTERS_CONFIG = {
    "org.openedx.learning.certificate.creation.requested.v1": {
        "fail_silently": False,
        "pipeline": [
            "openedx_filters_samples.samples.pipeline.StopCertificateCreation"
        ]
    },
    "org.openedx.learning.cohort.change.requested.v1": {
        "fail_silently": False,
        "pipeline": [
            "openedx_filters_samples.samples.pipeline.StopCohortChange"
        ]
    },
    "org.openedx.learning.certificate.render.started.v1": {
        "fail_silently": False,
        "pipeline": [
            "openedx_filters_samples.samples.pipeline.RenderAlternativeCertificate",
        ]
    },
    "org.openedx.learning.dashboard.render.started.v1": {
        "fail_silently": False,
        "pipeline": [
            "openedx_filters_samples.samples.pipeline.RenderAlternativeDashboard",
        ]
    },
    "org.openedx.learning.course_about.render.started.v1": {
        "fail_silently": False,
        "pipeline": [
            "openedx_filters_samples.samples.pipeline.RenderAlternativeCourseAbout",
        ]
    },
    "org.openedx.learning.cohort.assignment.requested.v1": {
        "fail_silently": False,
        "pipeline": [
            "openedx_filters_samples.samples.pipeline.StopCohortAssignment"
        ]
    },
}

Please, for detailed instructions on how to test each filter, refer to each of these PR(s):

Filter for certificate creation:
#29949
Filter for cohort change:
#29964
Filter for certificate rendering:
#29976
Filter for dashboard rendering:
#29994
Filter for course about rendering:
#29996
Filter for cohort assignment:
#30431

Deadline

For the next nutmeg release.

Backport filters that didn't make it to nutmeg release:

* Add filter before certificate creation starts

- Add filters interactions with code that used generate_certificate_task
- Add unit-testing for filters
- Upgrade to latest library update

(cherry picked from commit e8fa890)

* Add cohort change filter before moving users from cohorts

(cherry picked from commit 465e5c0)

* Add filter before certificate rendering process starts

(cherry picked from commit 7f974d1)

* Add filter before course dashboard rendering process starts

- Add dashboard filter to dashboard student's view
- Add tests/docs for filter's integration

(cherry picked from commit 895a649)

* Add filter before course about rendering process starts

(cherry picked from commit ccfa0b4)

* Integrate cohort assignment filter definition to cohort model

(cherry picked from commit ec69659)
@openedx-webhooks openedx-webhooks added the blended PR is managed through 2U's blended developmnt program label Jun 14, 2022
@openedx-webhooks
Copy link

Thanks for the pull request, @mariajgrimaldi!

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

@BbrSofiane
Copy link
Member

@openedx-community-bot merge

@github-actions github-actions bot merged commit 1d61805 into open-release/nutmeg.master Aug 8, 2022
@github-actions github-actions bot deleted the MJG/filters-backport branch August 8, 2022 17:55
@openedx-webhooks
Copy link

@mariajgrimaldi 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge blended PR is managed through 2U's blended developmnt program
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants