[BD-32] feat: add filter before certificate rendering process starts

[mariajgrimaldi]

Description

As part of the Hooks Extension Framework implementation plan, this PR adds a filter before the certificate rendering process 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

1. Install openedx-filters library:

pip install openedx-filters==0.6.2

2. 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.
3. Install openedx-filters-samples

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

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

• Render a certificate. Instead, a different template will be rendered

OPEN_EDX_FILTERS_CONFIG = {
     "org.openedx.learning.certificate.render.started.v1": {
            "fail_silently": False,
            "pipeline": [
                "openedx_filters_samples.samples.pipeline.RenderAlternativeCertificate",
            ]
    },
}

And with this one, you'll be able to render dummy custom certificate if it doesn't already exist.

OPEN_EDX_FILTERS_CONFIG = {
    "org.openedx.learning.certificate.render.started.v1": {
        "fail_silently": False,
        "pipeline": [
            "openedx_filters_samples.samples.pipeline.RenderCustomCertificateStep"
        ]
    }
}

If you want to redirect to your custom certificate, then:

OPEN_EDX_FILTERS_CONFIG = {
    "org.openedx.learning.certificate.render.started.v1": {
        "fail_silently": False,
        "pipeline": [
            "openedx_filters_samples.samples.pipeline.RedirectToCustomCertificate"
        ]
    }
}

To override the response, use:

OPEN_EDX_FILTERS_CONFIG = {
    "org.openedx.learning.certificate.render.started.v1": {
        "fail_silently": False,
        "pipeline": [
            "openedx_filters_samples.samples.pipeline.RenderCustomResponseCertificate"
        ]
    }
}

[openedx-webhooks]

Thanks for the pull request, @mariajgrimaldi! I've created BLENDED-1114 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.

[felipemontoya]

looking at this, do you think that the control should necessary mean that if a filter developer wants to render an alternative template, this must mean that it is invalid?
Or is the case that if the template is valid, then I just answer the filter with a value for custom_template and don't raise anything?

[mariajgrimaldi]

is the case that if the template is valid, then I just answer the filter with a value for custom_template and don't raise anything?

That it's what I've been thinking. Should we change the name to RenderInvalidCertificate? Should we have these two possibilities in the other PR(s)? isn't that confusing? 🤔

[felipemontoya]

Probably the most correct would be then RenderAlternativeInvalidCertificate as the exeption and leave the custom-template with no exceptions as the way to render a valid certificate with a different path

[mariajgrimaldi]

Done! 🥳

[felipemontoya]

This is good, I think we are ready to merge

[felipemontoya]

Maybe a final squash

[openedx-webhooks]

@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.

[edx-pipeline-bot]

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

[edx-pipeline-bot]

EdX Release Notice: This PR has been deployed to the production environment.