feat [FC-86]: add redirects to mfe for catalog-related legacy pages

[Serj-N]

Note

Depends on: #37342

Description

This PR adds support for redirecting users from legacy catalog-related pages to their new Catalog MFE equivalents, based on a site configuration key (ENABLE_CATALOG_MICROFRONTEND) and the appropriate settings feature as a fallback.

Key changes:

• Adds redirect logic to the legacy index, courses, and course_about views:
  • Home/index page redirects to MFE when ENABLE_CATALOG_MICROFRONTEND is enabled.
  • Courses page redirects to MFE when ENABLE_CATALOG_MICROFRONTEND is enabled.
  • Course about page redirects to the Catalog MFE when ENABLE_CATALOG_MICROFRONTEND is enabled.
• Uses the newly added get_catalog_mfe_course_about_url helper for accurate about-page URL construction.
• Comprehensive tests are added for all redirection scenarios to ensure correct redirect behavior.

Testing Instructions

Before testing, make sure you have the changes from #37342.

Test Case 1: ENABLE_CATALOG_MICROFRONTEND=False

1. Go to Django Site Configurations in the admin panel.
2. Add the following code snippet to the local.openedx.io:8000 site configuration:

{
    "ENABLE_CATALOG_MICROFRONTEND": false
}

3. (Re)start the platform.
4. Go to the home page: http://local.openedx.io:8000/.
5. Ensure that no redirect occurred and the legacy page is displayed.
6. Repeat steps 4 and 5 for the course about page (http://local.openedx.io:8000/<course_id/about>) and the course catalog page (http://local.openedx.io:8000/courses).

Test Case 2: ENABLE_CATALOG_MICROFRONTEND=True

1. Go to Django Site Configurations in the admin panel.
2. Add the following code snippet to the local.openedx.io:8000 site configuration:

{
    "ENABLE_CATALOG_MICROFRONTEND": true
}

3. (Re)start the platform.
4. Go to the home page: http://local.openedx.io:8000/.
5. Ensure that a redirect occurred and the MFE url is seen in the browser's address bar (http://apps.local.openedx.io:1998/catalog/).
6. Repeat steps 4 and 5 for the course about page (http://apps.local.openedx.io:1998/catalog/<course_id/about>) and the course catalog page (http://apps.local.openedx.io:1998/catalog/courses).

[openedx-webhooks]

Thanks for the pull request, @Serj-N!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are 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.

Details

---

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.

[peterkulko]

@Serj-N currently, I have noticed the following problems that we should fix:

If ENABLE_CATALOG_MICROFRONTEND=false, the link http://local.edly.io:8000/courses redirects to http://apps.local.openedx.io:1998/catalog/courses

At http://local.openedx.io:8000/ there is a correct transition to http://local.openedx.io:8000/courses/<course_id>/about

---

If ENABLE_CATALOG_MICROFRONTEND=false at the link:

• http://local.openedx.io:8000/ -> legacy page (correct)
• http://local.edly.io:8000/ -> MFE page (incorrect)
• http://0.0.0.0:8000/ -> MFE page (incorrect)

---

If the user is logged in and ENABLE_CATALOG_MICROFRONTEND=true, when going to the home page http://apps.local.openedx.io:1998/catalog/, a redirect to http://apps.local.openedx.io:1996/learner-dashboard/ should occur.

[Serj-N]

@PKulkoRaccoonGang On local.openedx.io the redirects should be working correctly now.
As for local.edly.io and 0.0.0.0: these are considered different hostnames (aka Sites in the Django admin), and if we want them to have the same redirect behavior as local.openedx.io, we will need to add the same site configuration (with the ENABLE_CATALOG_MICROFRONTEND key) for each of those sites. However, as far as I know, local.edly.io is considered a legacy hostname, and 0.0.0.0 isn't normally used during development, so I believe using local.openedx.io (with a corresponding site configuration) should be enough.

[feanil]

Why do we need this new function? Why can't we use the get_link_for_about_page function that already exists and that you have already updated to work with the catalog MFE in #37342

[Serj-N]

Good observation, it does look like we can get rid of this function. However, to use the one from #37342, we will have to wait until that other PR is merged, so that we can pull the changes here.

[feanil]

That PR has now merged, so let me know when the new version of this PR is ready to go.

[Serj-N]

Thank you, I refactored this PR now:

• get_link_for_about_page - now using this function
• get_catalog_mfe_course_about_url - removed

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