feat: adds CourseAboutPageURLRequested and LMSPageURLRequested filters

jignaciopm commented 3 months ago

Description: Describe in a couple of sentences what this PR adds

This adds the TenantAwareLinkRenderStarted filter which receive a string context with LMS url to allowing the filter pipeline to return the information that we need to filter, in this case a tenant aware link from Studio to LMS.

An example of use is in eox-tenant custom filter step pipeline, where it takes the LMS_ROOT_URL and return only the tenant aware link in the respective site.

JIRA: DS-1003

Dependencies:

https://github.com/openedx/edx-platform/pull/35142

Merge deadline: N/A

Installation instructions:

Be sure to use edx-platform branch with changes https://github.com/openedx/edx-platform/pull/35142

Testing instructions:

The change can be tested with testing instructions in https://github.com/eduNEXT/eox-tenant/pull/156.

Reviewers:

[ ] @mariajgrimaldi

Merge checklist:

[ ] All reviewers approved
[ ] CI build is green
[ ] Version bumped
[ ] Changelog record added
[ ] Documentation updated (not only docstrings)
[ ] Commits are squashed

Post merge:

[ ] Create a tag
[ ] Check new version is pushed to PyPI after tag-triggered build is finished.
[ ] Delete working branch (if not needed anymore)

Author concerns: N/A

openedx-webhooks commented 3 months ago

Thanks for the pull request, @jignaciopm!

What's next?

Please work through the following steps to get your changes ready for engineering review:

:radio_button: 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.

:radio_button: 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

:radio_button: 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.

:radio_button: Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/hooks-extension-framework. 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:

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

:bulb: As a result it may take up to several weeks or months to complete a review and merge your PR.

mphilbrick211 commented 3 months ago

Hi @jignaciopm! Just flagging there's a failing check here.

mariajgrimaldi commented 1 month ago

@jignaciopm: Thanks again for addressing our comments! I reviewed this one last time and made some changes for you to review: https://github.com/openedx/openedx-filters/commit/4b77aaefe66fd18a529e29af783fd3f366bf757a. I'll approve this PR once you apply them.

The changes are mainly focused on using course_authoring instead of authoring, so we maintain parity with openedx-events and changing target_url to url to maintain parity with previous implementations. I think both were suggestions from my last review. Still, after reviewing them again, these changes seemed appropriate. The quality fix is also included there :)

I'm sorry for the back and forth.

jignaciopm commented 1 month ago

Thank you @mariajgrimaldi the change was applied there. Tell me if you agree how it looks now to apply this change in https://github.com/openedx/edx-platform/pull/35142

openedx / openedx-filters