8000 fix: Apphook widget detection (#8263) by fsbraun · Pull Request #8264 · django-cms/django-cms · GitHub
[go: up one dir, main page]
Skip to content

fix: Apphook widget detection (#8263) #8264

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 1 commit into from
Jun 24, 2025
Merged

fix: Apphook widget detection (#8263) #8264

merged 1 commit into from
Jun 24, 2025

Conversation

fsbraun
Copy link
Member
@fsbraun fsbraun commented Jun 24, 2025 •
edited by sourcery-ai bot
Loading

Port forward of #8263

Description

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

Update the apphook widget JavaScript to correctly detect configuration data by querying the wrapper div, add event prevention for the config-add button, and modernize variable declarations

Bug Fixes:

  • Select the outer div rather than the script tag to parse widget configuration JSON
  • Prevent default action on the “add configuration” button to avoid unintended navigation

Enhancements:

  • Replace var with const/let throughout the widget code

@fsbraun
fix: Apphook widget detection (#8263)
db4d25e 
* fix: Apphook widget detection

* Fix: Add related
@sourcery-ai Sourcery AI
Copy link
Contributor
sourcery-ai bot commented Jun 24, 2025 •
edited
Loading

Reviewer's Guide

This PR refactors the apphook widget script to use ES6 declarations, corrects the data-element selector for loading configuration payloads, and ensures the add-configuration action prevents default navigation.

Class diagram for refactored apphook widget script

classDiagram
    class apphookData {
        +Object apphooks_configuration
        +any apphooks_configuration_value
        +Object apphooks_configuration_url
    }
    class ApphookWidget {
        +setupNamespaces()
    }
    apphookData <.. ApphookWidget : uses
Loading

File-Level Changes

Change Details Files
Modernize variable declarations and loop scoping
  • Replaced var with const/let for jQuery import and DOM references
  • Updated for loops to use let for index variables
  • Added ev parameter to click handler signature
 cms/static/cms/js/widgets/forms.apphookselect.js
Fix widget detection and data parsing
  • Changed selector from script[data-cms-widget-applicationconfigselect] to div[data-cms-widget-applicationconfigselect]
  • Moved dataElement lookup inside document ready callback for accurate runtime detection
  • Unified JSON.parse of nested script textContent
 cms/static/cms/js/widgets/forms.apphookselect.js
Prevent default link behavior on add-config click
  • Injected ev.preventDefault() in add-configuration click handler to stop navigation
  • Ensured showAddAnotherPopup is invoked without triggering full page load
 cms/static/cms/js/widgets/forms.apphookselect.js

Possibly linked issues

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!

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 Jun 24, 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 and they look great!

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 approved these changes Jun 24, 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.

LGTM :shipit:

@fsbraun fsbraun merged commit 9554e87 into main Jun 24, 2025
68 checks passed
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
0