fix: redirect to account MFE when using any legacy account URL by mariajgrimaldi · Pull Request #36894 · openedx/openedx-platform

mariajgrimaldi · 2025-06-11T11:05:41Z

Description

Redirect to the account MFE URL configured each time a legacy account URL like http(s)://lms/account/ or http(s)://lms/account/settings is used to avoid 404 errors while linking SSO accounts or simply trying to access the account view via URLs.

Supporting information

This attempts to solve #36869

Testing instructions

Go to the account or account/settings page, you must be redirected to the account MFE.

Deadline

ASAP. This is a release blocker we are solving.

⚠️ I use copilot with Claude Sonnet 4 model for code suggestions.

Redirect to the account MFE URL configured each time a legacy account URL like http(s)://lms/account/ or http(s)://lms/account/settings is used to avoid 404 errors while linking SSO accounts or simply trying to access the account view via URLs.

openedx-webhooks · 2025-06-11T11:05:46Z

Thanks for the pull request, @mariajgrimaldi!

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:

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.

open-craft-grove · 2025-06-11T12:31:40Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

ghassanmas · 2025-06-11T13:24:56Z


 urlpatterns = [
+    re_path(r'^account(?:/settings)?/?$', RedirectView.as_view(url=settings.ACCOUNT_MICROFRONTEND_URL)),
    path('user_api/v1/', include(USER_API_ROUTER.urls)),


Why you made the suffix /settings in url path as optional? i

It looks like LMS/account also returns 404 which I think should also redirect to the account mfe. What do you think?

Note sure if it's suppose to redierct from /account, AFAIK lms_base/account on sumac didn't redirect to account mfe.

Mmm I see what you say. But when using LMS base domain == MFE domain, /account will redirect to the account MFE. Does that make sense?

I made a correction in my earlier comment, I meant from lms.base/account

Mmm I see what you say. But when using LMS base domain == MFE domain, /account will redirect to the account MFE. Does that make sense?

when/if (LMS base domain == MFE domain), then it will a add new diemension to the problem, of which I haven't tried or setup before. Is there a sandbox with such setup?

edunext has a few with that setup, it has another issues I think (not related to this, but to MFEs themselves) but all of them are solved here https://github.com/eduNEXT/tutor-contrib-mfe-extensions

Aha gotcha... I think then may be since redirection is at caddy level, it would get redirected before reaching django urls roles.

Nonetheless, the project provide an intresting solution for the multiesite and MFEs.

mariajgrimaldi · 2025-06-11T13:34:34Z

@BryanttV: since you were able to reproduce this issue, can you help me testing it in the remote environment?

Credentials are:
username: openedx
password: openedx

BryanttV · 2025-06-11T13:58:37Z

Hi @mariajgrimaldi!, I have just tested, and the redirection works correctly, both when accessing account/settings and account. I just wonder about the reason for doing this, and not removing the references to the path where it is being used.

mariajgrimaldi · 2025-06-16T12:50:47Z

Thanks for reviewing, @BryanttV!

Hi @mariajgrimaldi!, I have just tested, and the redirection works correctly, both when accessing account/settings and account. I just wonder about the reason for doing this, and not removing the references to the path where it is being used.

I agree that we should remove the references to all deprecated endpoints where it's possible, but I'm not sure how much that would impact other authentication flows from other providers. I'd prefer the most straightforward approach while we coordinate how to entirely deprecate the old URLs. This might be a simple change, but we don't have a lot of time for the release.

If how well this is done becomes a blocker for merging this, then we can discuss how the other solution might look like. I think replacing the redirects to be constructed considering the MFE endpoints instead of the default backed configurations would need to be done.

Another approach would be to create a DEPR ticket to properly investigate this issue instead of rushing a fix mid-release that could break other things. But that's just my take - I'm definitely open to hearing other solutions!

ormsbee · 2025-06-16T15:19:06Z

 USER_API_ROUTER.register(r'user_prefs', user_api_views.UserPreferenceViewSet)

 urlpatterns = [
+    re_path(r'^account(?:/settings)?/?$', RedirectView.as_view(url=settings.ACCOUNT_MICROFRONTEND_URL)),


Please add a comment here explaining why this exists. I'm generally fine with adding backwards compatibility redirects, even if we've already ripped out references to it in our own codebase (because URLs stick around for a long time in other systems).

Thank you, agreed!

open-craft-grove · 2025-06-17T10:08:12Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-06-18T00:26:12Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

* fix: redirect to account MFE when using any legacy account URL Redirect to the account MFE URL configured each time a legacy account URL like http(s)://lms/account/ or http(s)://lms/account/settings is used to avoid 404 errors while linking SSO accounts or simply trying to access the account view via URLs.

edx-pipeline-bot · 2025-06-18T14:55:32Z

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

edx-pipeline-bot · 2025-06-18T20:40:00Z

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

edx-pipeline-bot · 2025-06-18T20:40:00Z

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

* fix: redirect to account MFE when using any legacy account URL Redirect to the account MFE URL configured each time a legacy account URL like http(s)://lms/account/ or http(s)://lms/account/settings is used to avoid 404 errors while linking SSO accounts or simply trying to access the account view via URLs.

…dx#36894) * fix: redirect to account MFE when using any legacy account URL Redirect to the account MFE URL configured each time a legacy account URL like http(s)://lms/account/ or http(s)://lms/account/settings is used to avoid 404 errors while linking SSO accounts or simply trying to access the account view via URLs.

mariajgrimaldi requested a review from a team as a code owner June 11, 2025 11:05

openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Jun 11, 2025

openedx-webhooks added this to Contributions Jun 11, 2025

github-project-automation Bot moved this to Needs Triage in Contributions Jun 11, 2025

mariajgrimaldi added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Jun 11, 2025

mariajgrimaldi linked an issue Jun 11, 2025 that may be closed by this pull request

[Test failure] TC_LEARNER_12: Facebook sign in from account page returns 404 when linking account #36869

Closed

sarina added create-sandbox open-craft-grove should create a sandbox environment from this PR and removed create-sandbox open-craft-grove should create a sandbox environment from this PR labels Jun 11, 2025

ghassanmas reviewed Jun 11, 2025

View reviewed changes

mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Jun 12, 2025

mphilbrick211 moved this from Ready for Review to In Eng Review in Contributions Jun 12, 2025

itsjeyd mentioned this pull request Jun 12, 2025

openedx-webhooks only considers repo-specific info for labeling and rejects manual overrides openedx/wg-governance#159

Closed

ormsbee reviewed Jun 16, 2025

View reviewed changes

docs: add comment explaining why redirect is needed

8e6e32c

mariajgrimaldi requested a review from ormsbee June 17, 2025 09:17

ormsbee approved these changes Jun 18, 2025

View reviewed changes

mariajgrimaldi merged commit 31ef780 into master Jun 18, 2025

mariajgrimaldi deleted the MJG/redirect-to-account-mfe-authn branch June 18, 2025 13:44

github-project-automation Bot moved this from In Eng Review to Done in Contributions Jun 18, 2025

mariajgrimaldi mentioned this pull request Jun 18, 2025

fix: redirect to account MFE when using any legacy account URL (#36894) #36928

Merged

Copilot AI mentioned this pull request Mar 4, 2026

docs: add reusable cherry-pick prompt for automated agents AhtishamShahid/edx-platform#2

Draft

Uh oh!

Conversation

mariajgrimaldi commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Deadline

Uh oh!

openedx-webhooks commented Jun 11, 2025

Uh oh!

open-craft-grove commented Jun 11, 2025

Uh oh!

ghassanmas Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

mariajgrimaldi Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

ghassanmas Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mariajgrimaldi Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

ghassanmas Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

mariajgrimaldi Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ghassanmas Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

mariajgrimaldi commented Jun 11, 2025

Uh oh!

BryanttV commented Jun 11, 2025

Uh oh!

mariajgrimaldi commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ormsbee Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

mariajgrimaldi Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

open-craft-grove commented Jun 17, 2025

Uh oh!

open-craft-grove commented Jun 18, 2025

Uh oh!

edx-pipeline-bot commented Jun 18, 2025

Uh oh!

edx-pipeline-bot commented Jun 18, 2025

Uh oh!

edx-pipeline-bot commented Jun 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

mariajgrimaldi commented Jun 11, 2025 •

edited

Loading

ghassanmas Jun 11, 2025 •

edited

Loading

mariajgrimaldi Jun 18, 2025 •

edited

Loading

mariajgrimaldi commented Jun 16, 2025 •

edited

Loading