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: remove unused JS requirement in CMS #34545

Merged

Conversation

bradenmacdonald
Copy link
Contributor

Description

In the legacy Studio UI's JS console on a tutor devstack, a couple 404 errors can be seen:

popp.js and bootstrap.js 404

I believe this error has been there for a long time, without causing any issues. That is, the legacy Studio UI does not seem to depend on the Bootstrap (or popper) JS.

Some LMS legacy UI pages do depend on bootstrap+popper, which they get from

% if uses_bootstrap:
## xss-lint: disable=mako-invalid-js-filter
<script type="text/javascript" src="${static.url('common/js/vendor/bootstrap.bundle.js')}"></script>
% endif

if needed. This file is not part of the repo's source code, but is created by

"$node_modules/bootstrap/dist/js/bootstrap.bundle.js" \

Testing instructions

You can go to the "bookmarks" page of a course in the legacy LMS UI (which is a page that uses bootstrap's JS), e.g. http://local.overhang.io:8000/courses/course-v1:A+B+C/bookmarks/ and in the JS console you can run $.fn.modal and $.fn.carousel to verify that Bootstrap's JS is active.

But, with or without the changes in this PR, if you run those same commands in any legacy Studio UI page, you'll see that Bootsrap's JS is not loaded, but the UI works fine.

Likewise on any production instance, you won't see the 404 error because popper/bootstrap are simply missing from the generated bundle cms-base-vendor.x.js. But you can open a JS console and verify that e.g. $.fn.modal and $.fn.carousel are not loaded on the page.

Deadline

None

Other information

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

openedx-webhooks commented Apr 18, 2024

Thanks for the pull request, @bradenmacdonald!

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/wg-maintenance-edx-platform. 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.

@bradenmacdonald
Copy link
Contributor Author

@brian-smith-tcril FYI

@mphilbrick211 mphilbrick211 added the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label May 16, 2024
@mphilbrick211
Copy link

@bradenmacdonald @brian-smith-tcril - is this still in progress?

@bradenmacdonald
Copy link
Contributor Author

@mphilbrick211 I would still like to merge this, if @brian-smith-tcril or maybe @kdmccormick could review it.

Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Braden!

@kdmccormick
Copy link
Member

nit: you could merge this in as a refactor:commit so that Chris doesn't see it when compiling release notes. Or perf: if you feel that's appropriate.

@bradenmacdonald
Copy link
Contributor Author

I'm planning to merge this on Tuesday.

@bradenmacdonald bradenmacdonald merged commit 4a12de7 into openedx:master Sep 3, 2024
49 checks passed
@bradenmacdonald bradenmacdonald deleted the braden/silence-bootstrap-404 branch September 3, 2024 17:40
@openedx-webhooks
Copy link

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

bradenmacdonald added a commit that referenced this pull request Sep 3, 2024
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@itsjeyd itsjeyd removed the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Sep 7, 2024
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
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants