feat: enable markdown to olx conversion by Anas12091101 · Pull Request #2518 · openedx/frontend-app-authoring

Anas12091101 · 2025-10-07T14:29:25Z

Description

This PR enables the conversion from Markdown to OLX. The reverse conversion (OLX to Markdown) has been deferred for now, as it would require implementing a dedicated OLX-to-Markdown converter, which may take additional time. We plan to address that in a future update to ensure this change is merged before the Ulmo cut.

Useful information to include:

Which user roles will this change impact? "Course Author", "Developer"
Include screenshots for changes to the UI (ideally, both "before" and "after" screenshots, if applicable).

In Course
https://github.com/user-attachments/assets/cafee2fe-5445-4ec5-b90a-8b2d9b54d9f3

In Library
https://github.com/user-attachments/assets/98f45954-2d11-4dec-abcc-cc75d537882a

Supporting information

#1920
https://github.com/mitodl/hq/issues/8729

Testing instructions

Create a new problem or edit an existing one that was originally created using the Markdown editor.
Verify that the "Switch to Advanced Editor" button is displayed in the Settings sidebar on the right.
Make some edits to the Markdown content, then click the "Switch to Advanced Editor" button and confirm the action in the confirmation modal.
Verify that the editor switches to the OLX editor, and that the content is correctly converted to OLX format.

Other information

Include anything else that will help reviewers and consumers understand the change.

Does this change depend on other changes elsewhere?
Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility.

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

Any new files are using TypeScript (.ts, .tsx).
Deprecated propTypes, defaultProps, and injectIntl patterns are not used in any new or modified code.
Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
All new i18n messages in messages.ts files have a description for translators to use.
Imports avoid using ../. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

openedx-webhooks · 2025-10-07T14:29:31Z

Thanks for the pull request, @Anas12091101!

This repository is currently maintained by @bradenmacdonald.

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.

codecov · 2025-10-07T15:09:50Z

Codecov Report

❌ Patch coverage is 98.07692% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 94.71%. Comparing base (8fe5fb6) to head (85011a8).
⚠️ Report is 26 commits behind head on master.

Files with missing lines	Patch %	Lines
...omponents/EditProblemView/ProblemEditorContext.tsx	90.90%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2518      +/-   ##
==========================================
+ Coverage   94.68%   94.71%   +0.02%     
==========================================
  Files        1203     1208       +5     
  Lines       26865    27113     +248     
  Branches     6026     6097      +71     
==========================================
+ Hits        25438    25679     +241     
- Misses       1357     1376      +19     
+ Partials       70       58      -12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

bradenmacdonald

This seems to work fine if I haven't saved the problem, but when I edit an existing (saved, published) markdown problem in a library, I don't see the option to convert it:

bradenmacdonald · 2025-10-15T22:08:34Z

-  const state = getState();
+export const switchToAdvancedEditor = (editorRef) => (dispatch, getState) => {
+  const { problem } = getState();
  const editorObject = fetchEditorContent({ format: '' });


Can we move this editorObject down inside the else { clause?

bradenmacdonald · 2025-10-15T22:11:16Z

  problemType: PropTypes.string.isRequired,
  editorType: PropTypes.string.isRequired,
+  // eslint-disable-next-line react/forbid-prop-types
+  editorRef: PropTypes.object.isRequired,


This is fine, but I would have preferred we pass the editorRef around using a ProblemEditorContext instead of prop drilling.

open-craft-grove · 2025-10-16T16:32:00Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Configuration information unavailable

open-craft-grove · 2025-10-16T18:14:28Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Configuration information unavailable

bradenmacdonald · 2025-10-16T21:29:35Z

@Anas12091101 Is this ready for another review? Please let me know whenever you'd like.

Anas12091101 · 2025-10-17T01:28:34Z

Yes, it's ready for review

arslanashraf7

I did the testing of this PR. It mostly looked good to me. I only noticed a few things but most of those are not related to this PR.

What did I test:

I was able to create a new markdown problem and I was able to convert it to OLX.
I was able to convert an existing markdown problem to OLX (e.g,. If a problem was created on the master branch first and then opened in this branch).
I was able to create markdown problems in libraries and their conversion to OLX
I tested the rendering of both the Markdown problems and the OLX converted problems in LMS/Learning MFE and they worked fine there as well
I was able to do the runtime testing to of Markdown to OLX conversion (e.g. I created a new problem converted it to markdown, then without saving it, I then converted it to OLX and it worked fine)

Things I noticed

I think the dialogue message that appears when you convert a problem to markdown might be incorrect because it still says that you can not convert it back to the simple editor/OLX

2. (Not related to this PR) The problem simple editor still opens up when a problem is converted to OLX. e.g. convert any problem to the advanced/OLX editor, save it, and then edit it again - The simple editor will be opened instead of opening the problem in OLX editor.

Anas12091101 · 2025-10-17T12:41:15Z

think the dialogue message that appears when you convert a problem to markdown might be incorrect because it still says that you can not convert it back to the simple editor/OLX

@bradenmacdonald, could you recommend an updated version of this message?

bradenmacdonald · 2025-10-17T21:55:23Z

think the dialogue message that appears when you convert a problem to markdown might be incorrect because it still says that you can not convert it back to the simple editor/OLX

@bradenmacdonald, could you recommend an updated version of this message?

@Anas12091101 I think something like this:

Some edits that are possible with the markdown editor are not supported by the simple editor, so you may not be able to change back to the simple editor.

bradenmacdonald · 2025-10-17T22:07:25Z

I think we should change the "Convert to OLX" message too:

If you use the advanced editor, this problem will be converted to OLX. Depending on what edits you make to the OLX, you may not be able to return to the simple editor.

bradenmacdonald

Thanks, looks good! Please just make this one change to TypeScript for the new file, and update those messages, and then I'll approve and merge.

bradenmacdonald · 2025-10-17T21:57:17Z

@@ -0,0 +1,30 @@
+import React, { createContext, useContext, useMemo } from 'react';
+import PropTypes from 'prop-types';


prop-types is deprecated. Since this is a new file, can you please use TypeScript .tsx and avoid propTypes or defaultProps?

…o tsx

open-craft-grove · 2025-10-20T11:51:36Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Configuration information unavailable

feat: enable markdown to olx conversion

b065ec0

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 7, 2025

openedx-webhooks added this to Contributions Oct 7, 2025

github-project-automation Bot moved this to Needs Triage in Contributions Oct 7, 2025

fix: lint issues

f3e2511

Anas12091101 force-pushed the anas/add-markdown-to-olx-btn branch from 82428e5 to f3e2511 Compare October 7, 2025 15:31

Anas12091101 requested a review from bradenmacdonald October 8, 2025 06:04

Anas12091101 mentioned this pull request Oct 8, 2025

Cannot convert from Markdown to Advanced editor #1920

Closed

Anas12091101 moved this from Needs Triage to Ready for Review in Contributions Oct 8, 2025

bradenmacdonald reviewed Oct 15, 2025

View reviewed changes

temp: testing

86c1977

Anas12091101 force-pushed the anas/add-markdown-to-olx-btn branch from 208886b to 86c1977 Compare October 16, 2025 12:41

fix: issues

ac117d4

kdmccormick added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Oct 16, 2025

fix: lint issues

c7e9f32

Anas12091101 requested a review from bradenmacdonald October 17, 2025 01:27

arslanashraf7 reviewed Oct 17, 2025

View reviewed changes

bradenmacdonald reviewed Oct 17, 2025

View reviewed changes

fix: update the editor conversion messages and convert context file t…

85011a8

…o tsx

Anas12091101 requested a review from bradenmacdonald October 20, 2025 10:58

bradenmacdonald approved these changes Oct 21, 2025

View reviewed changes

bradenmacdonald merged commit 82a3c28 into openedx:master Oct 21, 2025
7 checks passed

github-project-automation Bot moved this from Ready for Review to Done in Contributions Oct 21, 2025

Faraz32123 pushed a commit to edx/frontend-app-authoring that referenced this pull request Oct 24, 2025

feat: enable markdown to OLX conversion (openedx#2518)

86e1874

Faraz32123 pushed a commit to edx/frontend-app-authoring that referenced this pull request Oct 24, 2025

feat: enable markdown to OLX conversion (openedx#2518)

3bfb7ff

		@@ -0,0 +1,30 @@
		import React, { createContext, useContext, useMemo } from 'react';
		import PropTypes from 'prop-types';

Conversation

Anas12091101 commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Other information

Best Practices Checklist

Uh oh!

openedx-webhooks commented Oct 7, 2025

Uh oh!

codecov Bot commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

bradenmacdonald left a comment

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

open-craft-grove commented Oct 16, 2025

Uh oh!

open-craft-grove commented Oct 16, 2025

Uh oh!

bradenmacdonald commented Oct 16, 2025

Uh oh!

Anas12091101 commented Oct 17, 2025

Uh oh!

arslanashraf7 left a comment

Choose a reason for hiding this comment

Uh oh!

Anas12091101 commented Oct 17, 2025

Uh oh!

bradenmacdonald commented Oct 17, 2025

Uh oh!

bradenmacdonald commented Oct 17, 2025

Uh oh!

bradenmacdonald left a comment

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

open-craft-grove commented Oct 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Anas12091101 commented Oct 7, 2025 •

edited

Loading

codecov Bot commented Oct 7, 2025 •

edited

Loading