fix: contentAnalyzer added to determine TinyMCE Editor type

[marslanabdulrauf]

Related Ticket (Internal)

https://github.com/mitodl/hq/issues/9166#event-20756793537

Description

This PR:

1. Fixes auto "You've made some changes" dialogue appearance by fixing the editorType for each content

Steps to Reproduce

1. Go to any course in Studio
2. Go to Settings -> Schedule & Details
3. As soon as the page loads, "You've made some changes" dialogue appears before any changes are made.

Supporting information

It happens because the default course over is in html e.g; <section>About ...</section> and when we serve it as text in TinyMCE Editor it changes the content which triggers the Alert to save the changes.
Adding editorType html fixes the issue however as the field is str in edx-platform we might not get html always.
So a simple utility function is added to analyze and identify editorType from content.

Testing instructions

1. Checkout master and follow Steps to Reproduce to identify the issue
2. Checkout to this branch and repeat the steps, Save settings alert shouldn't be visible before any change now

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).
• Avoid propTypes and defaultProps 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.
• Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

[openedx-webhooks]

Thanks for the pull request, @marslanabdulrauf!

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.

---

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.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.83%. Comparing base (6afe609) to head (9436441).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff            @@
##           master    #2609    +/-   ##
========================================
  Coverage   94.82%   94.83%            
========================================
  Files        1226     1232     +6     
  Lines       27559    27638    +79     
  Branches     6211     6056   -155     
========================================
+ Hits        26133    26210    +77     
- Misses       1355     1370    +15     
+ Partials       71       58    -13     

☔ 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]

Adding editorType html fixes the issue however as the field is str in edx-platform we might not get html always.

I don't quite understand this. When would it not be HTML? And even if it's just a string like "An interesting course." with no HTML, isn't that still HTML in a sense, just without tags?

[bradenmacdonald]

New files added to this repo should be using TypeScript - please see the "Best practices checklist" in your PR description.

[marslanabdulrauf]

Adding editorType html fixes the issue however as the field is str in edx-platform we might not get html always.

I don't quite understand this. When would it not be HTML? And even if it's just a string like "An interesting course." with no HTML, isn't that still HTML in a sense, just without tags?

I wasn't sure if I should hard code the editorType as html although in case of aboutSidebarHtml the name itself says html

I also agree that html editor should also cover simple text, so if you think its ok to hardcode html for editorType I can do that 👍

[bradenmacdonald]

I think it's fine to just hard-code it as HTML, as these are HTML fields. But if you can think of or find any bugs that would result from that, please let me know.

[marslanabdulrauf]

While testing with the hardcoded html editor type, I noticed one potential issue:

If we provide plain text like "hello world", the HTML editor automatically wraps it in a <p>hello world</p> tag. This makes the content different from the original text and triggers the “unsaved changes” banner on first load.

We were trying to avoid this same situation when the overview content is actually HTML, but the editor type is set to text.

If we’re certain that all overviews will be HTML-based, we can safely hardcode editorType to html.
However, if there’s still a possibility of having plain-text overviews, we’ll face the same “save alert without actual changes” issue when showing text content in an HTML editor.

[marslanabdulrauf]

@bradenmacdonald could you please take another look ?

[bradenmacdonald]

If we’re certain that all overviews will be HTML-based, we can safely hardcode editorType to html.
However, if there’s still a possibility of having plain-text overviews, we’ll face the same “save alert without actual changes” issue when showing text content in an HTML editor.

Yep, that makes sense. However, it would be a one-time problem, and would only affect courses that have plain text in their "About" section, and we don't know if there are courses like that or not. So I don't think it's a big deal.

Go to any course in Studio
Go to Settings -> Schedule & Details
As soon as the page loads, "You've made some changes" dialogue appears before any changes are made.

I am testing this with master now, but I see a different bug: if the "Course overview" HTML contains an image with a URL like /static/images/placeholder-faculty.png then I see the "You've made some changes" notice, because TinyMCE is rewriting the URLs to something like /asset-v1:BradenX+CP200+23+type@asset+block@images/placeholder-faculty.png . But once that happens and has been saved, I don't see this bug.

[marslanabdulrauf]

yes @bradenmacdonald that was the issue and it is because of the text editor trying to serve html content.

For all new courses it always shows "Save you changes" without any actual modification. And by saving it, it goes away -- As modified content is now stored.

And Upon investigation found this same issue that you noticed in master branch with image source. When we shift to html editor type it does not change/modify any content thus we don't see any "save you changes" on first load.

This PR fixes this issue by analyzing the content to try to identify the type of content for editor.
I think we can go with hard coded html as editor type as well because we always have html overview for courses.

The scenario I added in this #2609 (comment) could follow your path -- save it first time.

Why going with html -- I think as the default content is html and we only edit through TinyMCE editor which also wraps text in <p> tag. it is safe to assume that we have html content in most of the cases. So only courses with actual text(without html) will be seeing this alert and it will be gone when they save it.

[bradenmacdonald]

@marslanabdulrauf If changing the editor type to html prevents the image URL rewriting from happening, isn't that going to cause some other bug?

If the issue is because of the image URL rewriting, isn't there a more direct way to fix it? The culprit seems to be replaceStaticWithAsset. The code here seems to imply that this rewriting should not mark the HTML as "changed", yet it is still showing as changed so there is a bug somewhere in how we're handling the "dirty" state of the editor:

frontend-app-authoring/src/editors/sharedComponents/TinyMceWidget/hooks.ts

Lines 347 to 349 in 1d385c6

	// update content but mark as not dirty as user did not change anything
	updateContent(newContent, false);
	editor.setDirty(false);

[marslanabdulrauf]

@marslanabdulrauf If changing the editor type to html prevents the image URL rewriting from happening, isn't that going to cause some other bug?

I haven't seen any bugs, it actually fixes the issue with images. With text editor the url is replaced with assets and the images are broken then however with html we can see proper images in the editor. Attaching SS for both:

html editor:

text editor with modified url:

@bradenmacdonald I agree that we should look into this issue as well where we are changing the image src urls in text editor. I have explored and found this PR in which this function was added but there is not explanation on why we are converting static url into assets

However I suggest we should still use html for overview(html content) instead of text editor.

[bradenmacdonald]

@marslanabdulrauf I investigate this and put my findings here: #2668 . Please review that and let me know your thoughts.

Your PR does solve most of the bugs, but it basically prevents any URL rewriting from happening, so URLs like /static/example.jpg do not work at all. I think that's a regression.