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

feat: adds CourseAboutPageURLRequested and LMSPageURLRequested filters #200

Merged
merged 2 commits into from
Sep 30, 2024

Conversation

jignaciopm
Copy link
Contributor

@jignaciopm jignaciopm commented Jul 18, 2024

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:

openedx/edx-platform#35142

Merge deadline: N/A

Installation instructions:

Be sure to use edx-platform branch with changes openedx/edx-platform#35142

Testing instructions:

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

Reviewers:

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

@jignaciopm jignaciopm requested a review from a team as a code owner July 18, 2024 23:56
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 18, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Jul 18, 2024

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/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

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

@jignaciopm jignaciopm marked this pull request as draft July 19, 2024 00:00
@jignaciopm jignaciopm marked this pull request as ready for review July 19, 2024 01:07
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jul 24, 2024
@mphilbrick211
Copy link

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

@mphilbrick211 mphilbrick211 removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jul 25, 2024
@jignaciopm jignaciopm force-pushed the jipm/add_tenant_aware_filter branch 2 times, most recently from 0ba2879 to e95d591 Compare August 7, 2024 00:37
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Aug 23, 2024
@e0d e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Sep 6, 2024
openedx_filters/content_authoring/filters.py Outdated Show resolved Hide resolved
openedx_filters/content_authoring/filters.py Outdated Show resolved Hide resolved
openedx_filters/content_authoring/tests/test_filters.py Outdated Show resolved Hide resolved
openedx_filters/content_authoring/tests/test_filters.py Outdated Show resolved Hide resolved
@jignaciopm jignaciopm changed the title feat: adds LmsUrlCreationStarted filter feat: adds CourseAboutPageURLRequested and LMSPageURLRequested filters Sep 30, 2024
@mariajgrimaldi
Copy link
Member

@jignaciopm: Thanks again for addressing our comments! I reviewed this one last time and made some changes for you to review: 4b77aae. 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
Copy link
Contributor Author

jignaciopm commented Sep 30, 2024

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

Copy link
Member

@mariajgrimaldi mariajgrimaldi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you again for addressing all of our comments. Please, feel free to apply the changes in the places needed.

I'll merge this once you add an entry to the changelog and update the openedx_filters/__init__.py file with the new version.

@mariajgrimaldi mariajgrimaldi merged commit aab1217 into openedx:main Sep 30, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

6 participants