openedx / frontend-app-learning

Front-end for the Open edX course experience, implemented using React and Paragon.
GNU Affero General Public License v3.0
46 stars 207 forks source link

feat: create a sanitized html fragment component for reuse across MFEs #1512

Open rediris opened 2 weeks ago

rediris commented 2 weeks ago
openedx-webhooks commented 2 weeks ago

Thanks for the pull request, @rediris!

What's next?

Please work through the following steps to get your changes ready for engineering review:

:radio_button: Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

:radio_button: 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:

:radio_button: 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.

:radio_button: Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/committers-frontend-app-learning. Tag them in a comment and let them know that your changes are ready for review.

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:

:bulb: As a result it may take up to several weeks or months to complete a review and merge your PR.

rediris commented 2 weeks ago

@bradenmacdonald thoughts?

bradenmacdonald commented 2 weeks ago

@rediris Can you please provide more context for this change, as well as screenshots, etc?

I'm not sure I fully understand this, but if my assumptions are correct, this is a backwards-incompatible change. LmsHtmlFragment renders the given HTML (handouts) with the LMS legacy CSS stylesheet and no HTML sanitization. This PR renders the handouts with HTML sanitization and with the frontend-app-learning CSS, which is going to affect the content very differently.

So, I like your approach much better, but I need more information to decide if it makes sense, if it needs product review, and/or if it's going to break anyone's existing handouts content.

rediris commented 2 weeks ago

@rediris Can you please provide more context for this change, as well as screenshots, etc?

I'm not sure I fully understand this, but if my assumptions are correct, this is a backwards-incompatible change. LmsHtmlFragment renders the given HTML (handouts) with the LMS legacy CSS stylesheet and no HTML sanitization. This PR renders the handouts with HTML sanitization and with the frontend-app-learning CSS, which is going to affect the content very differently.

So, I like your approach much better, but I need more information to decide if it makes sense, if it needs product review, and/or if it's going to break anyone's existing handouts content.

Hi @bradenmacdonald, good thoughts. Perhaps one alternative would be to enable this feature with a waffle flag.

My reasoning behind this is somewhat personal - I have a deep disdain for IFRAMEs and the oft unwieldy code written to support their use. While the course units rely on IFRAMEs to deliver content, the handouts are (generally) static html and I see them as low-hanging fruit for this type of change.

Give me a couple of days to assemble some screenshots and double check the UX/UI for this change.

bradenmacdonald commented 2 weeks ago

Oh, I absolutely think your change is great, and removing this iframe would be great. I'm just worried it will be a breaking change and specifically a breaking change that affects content, and that's not something we can do without a lot of planning, consideration, and getting buy-in from whoever would be affected (if any).