MFE Rewrite Tracker
- Feanil Patel
- Kyle McCormick
- Dave Ormsbee (Axim)
See also: this initiative and its child tickets.
Table of contents:
Replacement Statuses
More than one can apply!
Not started
needs improvement
in development
parity achieved
Live on edx.org
Default in Open edX
LEGACY REMOVED!
The Big List: All Known Legacy Pages, With and Without MFEs Replacements
Page | Old (Backend Service & Path) | New (MFE & Path) | Toggle (Waffle Flag) | Status, DEPR Link, Repo Links, Product Review Links, Other Notes |
|---|---|---|---|---|
Studio: Logged-out Landing Page | CMS
|
| TBD | Not started |
Studio: Preview | LMS-Preview
| frontend-app-learning OR frontend-app-authoring
| TBD | Live on edx.orgDefault in Open edX Preview site not in MFE · Issue #1455 · openedx/frontend-app-learning This is the only thing blocking the removal of legacy Courseware Sequence view. But to remove this, we would need to one of several things, none of which would be trivial:
|
Studio: Course Custom Pages | CMS
|
|
| parity achievedLive on edx.orgDefault in Open edX Should be part of 2Us DEPR around Studio Frontend MFE
|
Studio: Course advanced settings | CMS
|
|
| parity achievedLive on edx.orgDefault in Open edX Should be part of 2Us DEPR around Studio Frontend MFE |
Studio: Course Schedule & Details | CMS
|
|
| parity achievedLive on edx.orgDefault in Open edX Should be part of 2Us DEPR around Studio Frontend MFE |
Studio: Course grading | CMS
|
|
| parity achievedLive on edx.orgDefault in Open edX Should be part of 2Us DEPR around Studio Frontend MFE |
Studio: Course updates | CMS
|
|
| parity achievedLive on edx.orgDefault in Open edX Should be part of 2Us DEPR around Studio Frontend MFE |
Studio: Course Import | CMS
|
|
| parity achievedLive on edx.orgDefault in Open edX Should be part of 2Us DEPR around Studio Frontend MFE |
Studio: Course Export | CMS
|
|
| parity achievedLive on edx.orgDefault in Open edX Should be part of 2Us DEPR around Studio Frontend MFE |
Studio: Course Video Uploads | CMS
|
|
EXTRA CONFIG IN .env
| parity achievedLive on edx.orgDefault in Open edX Should be part of 2Us DEPR around Studio Frontend MFE |
Studio: Course Files & Uploads | CMS
|
|
| parity achievedLive on edx.orgDefault in Open edX [DEPR]: studio-frontend repo · Issue #381 · openedx/studio-frontend Should also be part of 2Us DEPR around Studio Frontend MFE |
Studio: Logged-in Home Page | CMS
|
|
| parity achievedLive on edx.orgDefault in Open edX Should be part of 2Us DEPR around Studio Frontend MFE |
Studio: Course content outline editor | CMS
|
| parity achievedDefault in Open edX As of May-2024:
| |
Studio: Unit editor | CMS
|
|
| in development [DEPR]: Legacy Unit Editor · Issue #35261 · openedx/edx-platform |
Studio: Course Team | CMS
|
|
| parity achievedLive on edx.org Should be part of 2Us DEPR around Studio Frontend MFE |
Studio: Course Textbooks | CMS
|
|
| parity achievedDefault in Open edX Should be part of 2Us DEPR around Studio Frontend MFE |
Studio: Course Group Configurations | CMS
|
|
| parity achievedDefault in Open edX Should be part of 2Us DEPR around Studio Frontend MFE |
Studio: Page & Resources | CMS
|
|
| parity achievedLive on edx.orgDefault in Open edX [DEPR]: discussions.pages_and_resources_mfe waffle flag · Issue #35254 · openedx/edx-platform |
Studio: Text (HTML) Editor | CMS
|
|
| needs improvementLive on edx.org [DEPR]: Legacy Text Editor · Issue #34692 · openedx/edx-platform |
Studio: Problem (CAPA) Editor |
|
|
| needs improvementLive on edx.org [DEPR]: Legacy Problem Editor · Issue #35256 · openedx/edx-platform |
Studio: Video Editor |
|
|
| parity achievedLive on edx.org [DEPR]: Legacy Video Editor · Issue #35257 · openedx/edx-platform |
Studio: Library Authoring (all pages) | CMS
|
| In Django settings:
| in development In development: Schema, OpenCraft, and Axim. (Slack: #content-libraries-relaunch-dev) [DEPR]: Legacy ("V1") Content Libraries · Issue #32457 · openedx/edx-platform |
Studio: Maintenance | CMS
| frontend-app-authoring ??? |
| Not started |
Studio: Maintenance: Announcements | CMS
| frontend-app-authoring ??? |
| Not started |
Studio: Maintenance: Force Publish Course | CMS
| frontend-app-authoring ??? |
| Not started |
Studio: Update Preview Language | CMS
| frontend-app-authoring ??? |
| Not started Note: This doesn’t seem to be accessed on studio.edx.org ? |
Course Dashboard aka Learner Dashboard aka Learner Home | LMS
| frontend-app-learner-dashboard
|
| Live on edx.orgDefault in Open edX [BD-08] B2C Learner Dashboard MFE Conversion [DEPR]: old Learner Course Dashboard · Issue #35326 · openedx/edx-platform Note: This is only the learner course dashboard. The learner programs dashboard does not have an MFE replacement yet.
|
Login/Registration | LMS
|
|
| needs improvementLive on edx.orgDefault in Open edX [DEPR]: Logistration Pages -> micro-frontend · Issue #81 · openedx/public-engineering MISSING FEATURE IN MFE: Custom registration fields.
|
Profile | LMS
|
| ??? | Live on edx.orgDefault in Open edX [DEPR]: Account pages -> micro-frontend · Issue #71 · openedx/public-engineering |
Account Settings | LMS
|
| ??? | Live on edx.orgDefault in Open edX [DEPR]: Account pages -> micro-frontend · Issue #71 · openedx/public-engineering |
ID Verification | LMS
| frontend-app-???
| ??? | parity achievedLive on edx.org Unclear whether live in named release. Needs DEPR. |
Course Home: Dates | LMS
| frontend-app-learning
| N/A | Legacy removed!parity achievedLive on edx.orgDefault in Open edX |
Course Home: Outline | `LMS
| frontend-app-learning
| N/A | Legacy removed! parity achievedLive on edx.orgDefault in Open edX |
Course Home: Progress | LMS
| frontend-app-learning
|
| parity achievedLive on edx.orgDefault in Open edX Needs a DEPR The MFE displays grades under some circumstances where the old progress page did not. MIT is using the course waffle flag to disable the MFE for some courses on edx.org. |
Course Home: Custom Pages | LMS
| frontend-app-learning
| TBD | Not started This is low hanging fruit! We just need to make a course home tab view that iframes in the CustomTabBlock, which is just an HtmlBlock subclass! This could be done at parity quickly. I don’t think it warrants a DEPR. We should ticket this up with the |
Courseware: Sequence | LMS
| frontend-app-learning
| N/A | parity achievedLive on edx.orgDefault in Open edX Legacy is partially removed. Full removal is blocked by studio course preview, which doesn’t yet work in learning mfe. |
Courseware: render_xblock | LMS
| LMS
| N/A | Not started This is the endpoint that renders a “chromeless” (nav-free) xblock. This will never be removed entirely but, eventually, we can seriously simplify it to the point where it’s just a thin wrapper around the next item (built-in XBlock views). |
Courseware: Built-in XBlock Views | edx-platform
| xblocks-contrib
|
| in development https://github.com/openedx/edx-platform/issues/34827 These views will not be turned into MFE pages, but they will be extracted out of edx-platform and into: https://github.com/openedx/xblocks-contrib/ |
Courseware: Proctored Exam | LMS
| frontend-app-learning (via frontend-lib-special-exams)
|
| needs improvementLive on edx.org https://github.com/openedx/edx-proctoring/issues/1226 Replacement repo: |
Courseware: Search | LMS Dave: I don’t think this is actually reachable any longer, since we force you into the MFE experience for that courseware page view. | frontend-app-learning
|
| NEED DISCOVERY: is this at parity? is it live for edx.org, open edx?
|
Program Dashboard | LMS
| TBD
|
| Not started |
Course Certificates | LMS
| TBD
|
| Not started |
Program Certificates | Credentials
| TBD
|
| Not started |
Track Selection | LMS
| TBD
|
| NEEDS DISCOVERY: What is the status? Do we rewrite or DEPR? |
Course Messaging | LMS
| TBD
|
| NEEDS DISCOVERY: What is the status? |
Basket / Payment | Ecommerce
| frontend-app-order-history
|
| Live on edx.org NEEDS DISCOVERY: Is replacement enabled in open edx? Is it at parity? |
Order History | Ecommerce
| frontend-app-ecommerce
|
| Live on edx.org NEEDS DISCOVERY: Is replacement enabled in open edx? Is it at parity? [DEPR]: Account pages -> micro-frontend · Issue #71 · openedx/public-engineering |
Discussions | LMS
|
|
| Live on edx.orgDefault in Open edX NEEDS DEPR NEEDS DISCOVERY: Is this sufficiently at parity? |
Learner Record | Credentials
|
|
| Live on edx.orgDefault in Open edX Replacement: |
Instructor Dashboard (all pages) | LMS
| frontend-app-gradebook (should be renamed to frontend-app-instruction, or something) |
| Not started Should subsume |
Discover New Courses | LMS
| frontend-app-catalog?
|
| Not started |
Course About | LMS
| frontend-app-catalog?
|
| Not started |
Reference: What MFEs are there?
The full list of Open edX MFEs, including ones that are experimental or under development, can be found by searching “frontend-app-” in the openedx GitHub org: https://github.com/orgs/openedx/repositories?q=frontend-app-
The list of Open edX MFEs that run out-of-the-box in Tutor can be found by looking at the CORE_MFE_APPS variable in the tutor-mfe plugin’s plugin.py file:
[upcoming release / tutor nightly] https://github.com/overhangio/tutor-mfe/blob/nightly/tutormfe/plugin.py#L33
[latest release / tutor master] https://github.com/overhangio/tutor-mfe/blob/master/tutormfe/plugin.py#L33
Reference: MFE Base URLs
MFEs follow a simple naming pattern. Given some lowercase hyphen based name{APPNAME} (for example, learning)….
The repo is
https://github.com/openedx/frontend-app-{APPNAME}Example:
https://github.com/openedx/frontend-app-learning
The base URL in Tutor is
https://apps.{LMS}/{APPNAME}Example:
https://apps.myopenedx.site/learning
The base URL on edX is
https://{APPNAME}.edx.orgExample:
https://learning.edx.orgEXCEPTION: For
learner-dashboard, the URL is nothttps://learner-dashboard.edx.org. Instead, it’shttps://home.edx.org.
Robert’s DataDog Query for CMS Frontends
2U is contributing some monitoring findings to help us determine the legacy frontends that are still in the platform…
-@view.url_path:(/course/course-v1\:* OR /c4x/* OR /container/block-v1\:* OR /library/library-v1\:* OR /preview/xblock/block-v1\:* OR /asset-v1\:* OR /course_team/course-v1\:* OR /certificates/course-v1\:* OR /settings/grading/* OR /settings/details/* OR /settings/advanced/* OR /group_configurations/course-v1\:* OR /import/library-v1\:* OR /import/course-v1\:* OR /textbooks/course-v1\:* OR /tabs/course-v1\:* OR /export/course-v1\:* OR /admin/split_modulestore_django/* OR /admin/*)edX.org CMS Result:
/
/home_library
/admin
/maintenance
/maintenance/announcementsMore References
Old archived Version of this: https://openedx.atlassian.net/wiki/spaces/FEDX/pages/1920270629
https://docs.google.com/spreadsheets/d/1X81NJB20hcBHcfsswenP5FhECe1w1LzXWrBlga4RmX4/edit?gid=0#gid=0 - these are edx-platform views seen/accessed on edx.org
Great question.
Feature parity isn’t always achieved before the target removal date. In those cases, we’d be penalizing end users if we removed the old frontend before achieving parity or at least DEPRing the features that were dropped.
But in the cases where feature parity IS achieved, I’m inclined to agree with you. I’ll bring this up to the maintenance and depr WGs.
Question: many of these waffle flags, like this one, have target removal dates in the past. This one has “
toggle_target_removal_date: 2023-8-31".So: why do we need a DEPR? Can’t we just remove the flag if it’s well past the previously-published removal date?
Otherwise, what’s the point of having the removal date?