MFE Rewrite Tracker
- Feanil Patel
- Diana Huang
- Dave Ormsbee (Axim)
See also: this initiative and its child tickets.
Table of contents:
Replacement Statuses
More than one can apply!
Not started
REMOVE WITHOUT REplacement
in development
parity achieved
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) may be actual or suggested | Toggle (Waffle Flag) | Status, DEPR Link, Repo Links, Product Review Links, Other Notes |
|---|---|---|---|---|
Studio: Logged-out Landing Page (“Howitworks”) | CMS
|
| No replacemet | REMOVE WITHOUT REplacement [DEPR]: Logged-out Studio Landing Page · Issue #36269 · openedx/edx-platform |
Studio: Logged-in Home Page | CMS
|
|
| parity achievedDefault in Open edX |
Studio: Preview | LMS-Preview
| frontend-app-learning OR frontend-app-authoring
| TBD | Default 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 achievedDefault in Open edX |
Studio: Course advanced settings | CMS
|
|
| parity achievedDefault in Open edX |
Studio: Course Schedule & Details | CMS
|
|
| parity achievedDefault in Open edX |
Studio: Course grading | CMS
|
|
| parity achievedDefault in Open edX |
Studio: Course updates | CMS
|
|
| parity achievedDefault in Open edX |
Studio: Course Import | CMS
|
|
| parity achievedDefault in Open edX |
Studio: Course Export | CMS
|
|
| parity achievedDefault in Open edX |
Studio: Course Video Uploads | CMS
|
|
EXTRA CONFIG IN .env
| parity achievedDefault in Open edX |
Studio: Course Files & Uploads | CMS
|
|
| parity achievedDefault in Open edX [DEPR]: studio-frontend repo · Issue #381 · openedx/studio-frontend Should also be part of 2Us DEPR around Studio Frontend MFE |
Studio: Course content outline editor | CMS
|
| parity achievedDefault in Open edX | |
Studio: Unit editor | CMS
|
|
| in development [DEPR]: Legacy Unit Editor · Issue #35261 · openedx/edx-platform |
Studio: Course Team | CMS
|
|
| parity achieved |
Studio: Course Textbooks | CMS
|
|
| parity achievedDefault in Open edX |
Studio: Course Group Configurations | CMS
|
|
| parity achievedDefault in Open edX |
Studio: Page & Resources | CMS
|
|
| parity achievedDefault in Open edX |
Studio: Text (HTML) Editor | CMS
|
|
| in developmentDefault in Open edX |
Studio: Problem (CAPA) Editor |
|
|
| in developmentDefault in Open edX |
Studio: Video Editor |
|
|
| in developmentDefault in Open edX |
Studio: Library Authoring (all pages) | CMS
|
| In Django settings:
| in development In development: Schema, OpenCraft, and Axim. (Slack: #content-libraries-relaunch-dev) |
Studio: Maintenance | CMS
| frontend-app-authoring ??? | No replacement | REMOVE WITHOUT REplacement |
Studio: Maintenance: Announcements | CMS
| frontend-app-authoring ??? | No replacement | REMOVE WITHOUT REplacement https://github.com/openedx/edx-platform/issues/36263
|
Studio: Maintenance: Force Publish Course | CMS
| frontend-app-authoring ??? | No replacement | REMOVE WITHOUT REplacementLEGACY REMOVED!parity achieved This page has been completely broken since it was first introduced. |
Studio: Preview Language Setting (for dark_lang) | CMS
| N/A | No replacement | in developmentREMOVE WITHOUT REplacement We are replacing this with a redirect to the identical LMS page: https://github.com/openedx/edx-platform/pull/36271 It’s not clear whether this page is accessible through Studio, anyway, but we add the redirect out of caution. In LMS, it seems we need |
Studio: Certificates | CMS
| frontend-app-authoring
|
| Default in Open edX |
Studio: Checklists | CMS
| frontend-app-authoring
|
| Default in Open edX |
Course Dashboard aka Learner Dashboard aka Learner Home | LMS
| frontend-app-learner-dashboard
|
| Live on edx.orgDefault in Open edX https://openedx.atlassian.net/wiki/spaces/COMM/pages/1545044047 https://github.com/openedx/edx-platform/issues/35326 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 https://github.com/openedx/public-engineering/issues/81 MISSING FEATURE IN MFE: Custom registration fields.
|
Profile | LMS
|
| ??? | Live on edx.orgDefault in Open edXLegacy removed! |
Account Settings | LMS
|
| ??? | Live on edx.orgDefault in Open edXLegacy removed! |
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? |
Preview Language Setting (for dark_lang) | LMS
| frontend-app-account
|
| Not started |
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? |
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