openedx / frontend-lib-content-components

[Moved to openedx/frontend-app-course-authoring] A library of high-level components for content handling (viewing, editing, etc. of HTML, video, problems, etc.), to be shared by multiple MFEs.
GNU Affero General Public License v3.0
11 stars 33 forks source link

fix: don't accidentally bundle paragon CSS x2 #487

Closed bradenmacdonald closed 3 months ago

bradenmacdonald commented 4 months ago

This fixes a bug where 900 kB of redundant CSS was being accidentally built and included in any MFE that uses this.

I was working on the Course Authoring MFE and trying to remove all SCSS from the bundle as part of some experiments I was doing. But somehow there was still 900kB+ of CSS in the final bundle! After much head-scratching I finally traced it down to two lines of code buried deep in in this dependency, frontend-lib-content-components. Any time you write @import "@openedx/paragon/scss/core/core";, it adds a full copy of the entire Paragon CSS to the build (around 400kB).

FYI @ArturGaspar @0x29a

See https://github.com/openedx/frontend-app-learner-dashboard/issues/325 which is the same problem affecting learner-dashboard (but even worse).

openedx-webhooks commented 4 months ago

Thanks for the pull request, @bradenmacdonald!

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/2u-tnl. 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.

0x29a commented 4 months ago

Oof, great finding, @bradenmacdonald! I didn't look very close, but looking at results for this query the situation for other MFEs may be similar (especially for frontend-app-ora...).

bradenmacdonald commented 4 months ago

@0x29a Yeah, looks like the ORA MFEs have this problem too.

Do you know who I can ping for reviews in this repo?

openedx-webhooks commented 3 months ago

@bradenmacdonald 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.