Skip to content

fix: resolve jQuery conflict breaking admin autocomplete fields in Django 5#4718

Open
iloveagent57 wants to merge 1 commit intoopenedx:masterfrom
edx:aed/fix-multi-select-jquery
Open

fix: resolve jQuery conflict breaking admin autocomplete fields in Django 5#4718
iloveagent57 wants to merge 1 commit intoopenedx:masterfrom
edx:aed/fix-multi-select-jquery

Conversation

@iloveagent57
Copy link
Copy Markdown
Contributor

The admin's SortedModelSelect2Multiple widgets were broken because:

  1. Django admin namespaces jQuery as django.jQuery and removes $ from global scope
  2. The Media class was loading bower's jQuery which overwrote $ with a new instance
  3. Select2 was attached to django.jQuery but code was calling $().select2()

This fix:

  • Adds jquery_shim.js to expose django.jQuery as global $ and jQuery
  • Wraps sortable_select.js in IIFE using django.jQuery
  • Removes conflicting bower jQuery from Media classes

ENT-11757

🤖 Generated with Claude Code

@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @iloveagent57!

This repository is currently maintained by @openedx/2u-phoenix.

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.

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

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Apr 13, 2026
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Apr 13, 2026
@iloveagent57 iloveagent57 requested a review from UsamaSadiq April 14, 2026 13:59
@rjv31
Copy link
Copy Markdown
Contributor

rjv31 commented Apr 15, 2026

@UsamaSadiq , @openedx/committers-course-discovery could anyone please check and help review/merge this PR

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Fixes Django 5 admin autocomplete/select2 sorting breakage caused by conflicting jQuery instances by ensuring Django admin’s django.jQuery is used consistently and isn’t overwritten.

Changes:

  • Added a jquery_shim.js that exposes django.jQuery as global $/jQuery for jQuery UI compatibility.
  • Wrapped sortable_select.js in an IIFE that explicitly uses django.jQuery.
  • Removed the bower-provided jQuery include from affected admin Media definitions (to prevent overwriting the admin jQuery instance).
  • Marked an API view test as skipped due to flaky query-count assertions.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
course_discovery/static/js/sortable_select.js Ensures sortable/select2 logic runs against django.jQuery via an IIFE wrapper.
course_discovery/static/js/jquery_shim.js Re-exposes django.jQuery as global $/jQuery so jQuery UI attaches to the correct instance.
course_discovery/apps/course_metadata/admin.py Updates admin Media JS ordering and removes conflicting bower jQuery include.
course_discovery/apps/api/v1/tests/test_views/test_courses.py Skips a flaky endpoint test (reduces coverage).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread course_discovery/static/js/sortable_select.js Outdated
Comment thread course_discovery/apps/api/v1/tests/test_views/test_courses.py Outdated
Copy link
Copy Markdown
Contributor

@jajjibhai008 jajjibhai008 left a comment

Choose a reason for hiding this comment

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

See the Copilot suggestions. Other than that looks good to me.

@skumargupta83
Copy link
Copy Markdown
Contributor

Hello @UsamaSadiq,
I request you to review this PR and do the needful.

@iloveagent57 iloveagent57 self-assigned this Apr 16, 2026
…ango 5

The admin's SortedModelSelect2Multiple widgets were broken because:
1. Django admin namespaces jQuery as django.jQuery and removes $ from global scope
2. The Media class was loading bower's jQuery which overwrote $ with a new instance
3. Select2 was attached to django.jQuery but code was calling $().select2()

This fix:
- Adds jquery_shim.js to expose django.jQuery as global $ and jQuery
- Wraps sortable_select.js in IIFE using django.jQuery
- Removes conflicting bower jQuery from Media classes

ENT-11757

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@iloveagent57 iloveagent57 force-pushed the aed/fix-multi-select-jquery branch from c639487 to 3114e62 Compare April 16, 2026 17:09
@iloveagent57
Copy link
Copy Markdown
Contributor Author

I just force pushed those changes suggested by copilot, thanks for taking a look @jajjibhai008

@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Contributions Apr 16, 2026
@iloveagent57 iloveagent57 reopened this Apr 16, 2026
@iloveagent57 iloveagent57 reopened this Apr 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). 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