feat: adds FilterTenantAwareLinksFromStudio in filters pipeline

[jignaciopm]

Description

This PR adds a custom filter pipeline to get LMS_ROOT_URL value for org from tenant site.

The idea is including some changes in openedx-filters and edx-platform repositories to anyone implement the filter function, and one clear example to use is this custom pipeline on eox-tenant plugin.

Dependencies:

• openedx/edx-platfom: feat: adds CourseAboutPageURLRequested and LMSPageURLRequested filters openedx/edx-platform#35142
• openedx/openedx-filters: feat: adds CourseAboutPageURLRequested and LMSPageURLRequested filters openedx/openedx-filters#200

Testing instructions

1. Install the plugin with the changes in openedx/edx-platform and openedx/openedx-filters branches. Use the Tutor instructions to install the eox-tenant django plugin with the changes in this branch.

2. Create a Tenant and import a certificate course (You need to create a tenant for Studio too). Go on to create sites: http://local.edly.io:8000/admin/eox_tenant/tenantconfig/

3. Add the following configurations to your configuration site and Studio tenant.

"OPEN_EDX_FILTERS_CONFIG": {
                "org.openedx.learning.course_about.page.url.requested.v1": {
                    "fail_silently": false,
                    "pipeline": [
                        "eox_tenant.filters.pipeline.OrgAwareCourseAboutPageURL"
                    ]
                },
                "org.openedx.course_authoring.lms.page.url.requested.v1": {
                    "fail_silently": false,
                    "pipeline": [
                        "eox_tenant.filters.pipeline.OrgAwareLMSURLStudio"
                    ]
                }
            }

or too you can add settings in /env/apps/openedx/settings/cms/development.py

4. Go to Settings-> Schedule & Details, click on the “Course Summary Page” link, which should direct you to the URL of the specific tenant
   

5. Verify that the link of the "Invite your students" button in the body refers to the URL of the specific tenant

6. Also check for a link to a course summary below the “course overview” text box.
   

7. Go to Content -> Files & uploads, verify the absolute links of any asset (In the Web button), which should lead to the URL of the specific tenant

Example Tenant Config

{
    "EDNX_USE_SIGNAL": true,
    "LMS_BASE": "tenant-a.local.edly.io:8000",
    "LMS_ROOT_URL": "tenant-a.local.edly.io:8000",
    "PLATFORM_NAME": "TEST-THEMING",
    "SITE_NAME": "tenant-a.local.edly.io",
    "THEME_OPTIONS": {
        "scripts": {
            "/login": [
                {
                    "content": "alert('This is a test for the inline script');",
                    "type": "inline"
                }
            ]
        },
        "theme": {
            "grandparent": "test-3",
            "name": "test-1",
            "parent": "test-2"
        }
    },
    "course_org_filter": [
        "DEMO"
    ]
}

Additional information

• Test cases file: https://docs.google.com/document/d/1lWlC1_xqO308oHNH0F4fOdyV3uBlVte0wQC6UOa_3SE/edit?usp=sharing

Checklist for Merge

• Tested in a remote environment
• Updated documentation
• Rebased master/main
• Squashed commits

[mariajgrimaldi]

Please, review these changes related to my last comment here: 08b320f

[jignaciopm]

@mariajgrimaldi about your comment #219 (comment) Don't you think the name should be FilterOrgAwareLMSURLStudio instead of just OrgAwareLMSURLStudio? 🤔

[mariajgrimaldi]

What do you think about using a more explicit name like: test_get_lms_url_based_for_org. Also, can we consider the case when the filter is not configured?

[mariajgrimaldi]

Consider these comments for the other test suite as well.

[jignaciopm]

@mariajgrimaldi I'm thinking that a test is not necessary for the case when the filter is not configured, because we are always testing run_filter. I'm think is not necessary @override_settings.OPEN_EDX_FILTERS_CONFIG. In other words, the tests work without having that configured.