feat: adds CourseAboutPageURLRequested and LMSPageURLRequested filters

[jignaciopm]

Description

This PR introduces two new openedx-filters event org.openedx.course_authoring.lms.page.url.requested.v1 and org.openedx.learning.course_about.page.url.requested.v1. This is implemented to guaranty multi tenancy in eox-tenant in LMS_ROOT_URL from Studio to LMS, but eox-tenant is only an example would consider use.

Impact by the change on:

• cms/djangoapps/contentstore/views/assets.py
• common/djangoapps/util/course.py

Supporting information

There are not openedx related tickets. The related PR are:

• openedx/openedx-filters: feat: adds CourseAboutPageURLRequested and LMSPageURLRequested filters openedx-filters#200
• eduNEXT/eox-tenant: feat: adds FilterTenantAwareLinksFromStudio in filters pipeline eduNEXT/eox-tenant#219

Testing instructions

The change can be tested with testing instructions in eduNEXT/eox-tenant#219.

Deadline

"None"

Other information

⚠️

Warning: Once accepted this PR, it has to be merged only after openedx/openedx-filters#200 is merged and the requirements in this PR are updated.

⚠️

Settings

EDXAPP_EXTRA_REQUIREMENTS:
  - name: git+https://github.com/eduNEXT/eox-tenant.git@jipm/add_tenant_aware_filter

[openedx-webhooks]

Thanks for the pull request, @jignaciopm!

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.

[mphilbrick211]

Hi @jignaciopm! Just flagging there are some failing checks here.

[e0d]

@jignaciopm Looks like there's a failed check.

[mariajgrimaldi]

Hey, @jignaciopm, thanks for contributing this! Those testing instructions are a bit out of date. Could you please include them directly in the cover letter, update and simplify them? Thanks!

[mariajgrimaldi]

I'll review this in detail once you apply the changes from the openedx-filters PR and all comments there are resolved. Thank you!

[mariajgrimaldi]

I'm preparing my environment to test this. Thanks!

[mariajgrimaldi]

@jignaciopm: Could you make the necessary adjustments so I can test this locally, mainly in eox-tenant? Or please update the testing instructions so I can test another way. Thank you!

[mariajgrimaldi]

Here's how I've been testing this:

• Tutor in-line plugin with the filters configurations for both LMS/CMS:

from tutor import hooks

hooks.Filters.ENV_PATCHES.add_item(
    (
        "openedx-lms-common-settings",
"""
OPEN_EDX_FILTERS_CONFIG = {
    "org.openedx.learning.course_about.page.url.requested.v1": {
        "fail_silently": False,
        "pipeline": [
            "common.djangoapps.util.course.ChangeCourseAboutURL"
        ]
    },
    "org.openedx.course_authoring.lms.page.url.requested.v1": {
        "fail_silently": False,
        "pipeline": [
            "common.djangoapps.util.course.ChangeLMSBaseURL"
        ]
    }
}
"""
    )
)

hooks.Filters.ENV_PATCHES.add_item(
    (
        "openedx-cms-common-settings",
"""
OPEN_EDX_FILTERS_CONFIG = {
    "org.openedx.learning.course_about.page.url.requested.v1": {
        "fail_silently": False,
        "pipeline": [
            "common.djangoapps.util.course.ChangeCourseAboutURL"
        ]
    },
    "org.openedx.course_authoring.lms.page.url.requested.v1": {
        "fail_silently": False,
        "pipeline": [
            "common.djangoapps.util.course.ChangeLMSBaseURL"
        ]
    }
}
"""
    )
)

To save configuration time, instead of using eox-tenant as you suggested in the test instructions, I created a simple step that replaces the URL for different domain another-lms.local.edly.io:

# common/djangoapps/util/course.py
from openedx_filters import PipelineStep
class ChangeLMSBaseURL(PipelineStep):

    def run_filter(self, url, org):  # pylint: disable=arguments-differ,unused-argument
        return {
            "url": "http://another-lms.local.edly.io:8000",
            "org": org
        }
        
class ChangeCourseAboutURL(PipelineStep):

    def run_filter(self, url, org):  # pylint: disable=arguments-differ,unused-argument
        return {
            "url": "http://another-lms.local.edly.io:8000/courses/course-v1:OpenedX+DemoX+DemoCourse/about",
            "org": org
        }
        

By doing a quick search I found the list of places these two filters should cover. Please, let me know if I missed one.

CourseAboutPageURLRequested here's what I found by searching get_link_for_about_page

Coverage	How to test
Settings context	GET http://studio.local.edly.io:8001/api/contentstore/v1/course_settings/<COURSE_ID> or go to Schedule & Details (invite your students, course summary)
Course share URL	GET http://local.edly.io:8000/api/learner_home/init
The mobile API	GET http://local.edly.io:8000/api/mobile/v4/course_info/blocks/?course_id=<COURSE_ID>&username=admin

LMSPageURLRequested here's what I found by searching get_asset_json

Coverage	How to test
Assets handler	GET http://studio.local.edly.io:8001/assets/<COURSE_ID>/?page=0 or Go to Content > Files

@jignaciopm: please, let me know in a comment once you address the suggestions so I can test again.

[jignaciopm]

@mariajgrimaldi do can you try again please?

[mariajgrimaldi]

Thank you, @jignaciopm, for addressing all my comments. I tested this again following the instructions I left here, and it seems to work fine. Now, please update the test docstrings because they seem to be out of date. I'll leave my approval afterward.

[mariajgrimaldi]

Thank you so much for adding more extension points to enable seamless integrations!

While this solution, along with the pipeline steps you've implemented in your plugin, addresses the lack of org-awareness, it also raises a broader question of whether Studio should be more organization-aware overall. In some places, configurations are applied site-wide, while the organization context is considered in others. Although this discussion goes beyond the scope of this proposal, it’s an important conversation to have.

For now, let's put a pin in that and move forward with this solution.

[edx-pipeline-bot]

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

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.

[edx-pipeline-bot]

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

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.