Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

rediris
Copy link
Contributor

@rediris rediris commented Nov 5, 2024

  • specifically, this PR replaces the LmsHtmlFragment IFRAME with a SanitizedHtmlFragment in the CourseHandouts component.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 5, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @rediris!

What's next?

Please work through the following steps to get your changes 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.

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

  • 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.

@rediris
Copy link
Contributor Author

rediris commented Nov 5, 2024

@bradenmacdonald thoughts?

@bradenmacdonald
Copy link
Contributor

bradenmacdonald commented Nov 5, 2024

@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
Copy link
Contributor Author

rediris commented Nov 6, 2024

@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
Copy link
Contributor

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants