Skip to content

fix: Added back jQuery and $ to the window object for plugin change forms #8191

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Mar 27, 2025
Merged

fix: Added back jQuery and $ to the window object for plugin change forms #8191

merged 2 commits into from
Mar 27, 2025

Conversation

fsbraun
Copy link
Member

@fsbraun fsbraun commented Mar 27, 2025 •
edited by sourcery-ai bot
Loading

Description

#8109 removed inline scripts effectively eliminating jQuery and $ from the plguin change form window namespace.

This PR restores them. Some 3rd party packages rely on $ instead of CMS.$, e.g. when using the select2 library.

Related resources

  • #...
  • #...

Checklist

  • I have opened this pull request against main
  • I have added or modified the tests when changing logic
  • I have followed the conventional commits guidelines to add meaningful information into the changelog
  • I have read the contribution guidelines and I have joined the channel #pr-reviews on our Discord Server to find a “pr review buddy” who is going to review my pull request.

Summary by Sourcery

Bug Fixes:

  • Reintroduce jQuery and $ global variables that were previously removed, ensuring compatibility with third-party packages like select2

@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Mar 27, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request re-introduces jQuery and $ to the window object in the CMS admin. This ensures compatibility with third-party libraries that depend on these global variables, particularly in plugin change forms. The change was implemented by adding a conditional check in cms/static/cms/js/admin.base.js to expose CMS.$ as jQuery and $ if they are not already defined.

Sequence diagram for jQuery and $ assignment

sequenceDiagram
  participant W as Window
  participant CMS
  W->>W: Check if jQuery exists
  alt jQuery does not exist
    W->>CMS: CMS.$ (jQuery instance)
    CMS->>W: Assign CMS.$ to window.jQuery
    W->>W: window.jQuery = CMS.$
    W->>W: Assign window.jQuery to $
    W->>W: $ = window.jQuery
  else jQuery exists
    W->>W: Do nothing
  end
Loading

File-Level Changes

Change Details Files
Expose jQuery and $ to the window object.
  • Added a conditional check to see if window.jQuery exists.
  • If window.jQuery does not exist, assign CMS.$ to window.jQuery.
  • Assign window.jQuery to window.$.
 cms/static/cms/js/admin.base.js
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Mar 27, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @fsbraun - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a comment explaining why window.jQuery might already be defined.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

vinitkumar
vinitkumar requested changes Mar 27, 2025
View reviewed changes
Copy link
Member

@vinitkumar vinitkumar left a comment

Choose a reason for hiding this comment

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

@fsbraun Made a small comment, if you agree, make the change, else, resolve and merge. It is correct either way.

vinitkumar
vinitkumar approved these changes Mar 27, 2025
View reviewed changes
Copy link
Member

@vinitkumar vinitkumar left a comment

Choose a reason for hiding this comment

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

Looks good to me. Let's get this merged and released 🚢 🚀

@vinitkumar vinitkumar merged commit f1cc413 into develop-4 Mar 27, 2025
64 checks passed
@fsbraun fsbraun deleted the fix/jquery-plugin-change-form branch April 5, 2025 06:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@vinitkumar vinitkumar vinitkumar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@fsbraun @vinitkumar