8000 fix: Remove need for timeout to close modal by fsbraun · Pull Request #8183 · django-cms/django-cms · GitHub
[go: up one dir, main page]
Skip to content

fix: Remove need for timeout to close modal #8183

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 8 commits into from
Mar 26, 2025
Merged

fix: Remove need for timeout to close modal #8183

merged 8 commits into from
Mar 26, 2025

Conversation

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

Description

This PR takes 100 to 150ms out of the closing time of the modal by eliminating the need for a timeout.

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

Removes the need for a timeout when closing the modal, improving the closing time.

Enhancements:

  • Removes a 100-150ms timeout when closing the modal.
  • Moves the data bridge logic from admin.base.js to cms.modal.js to avoid the need for a timeout.

@sourcery-ai Sourcery AI
Copy link
Contributor
sourcery-ai bot commented Mar 20, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This PR optimizes the modal closing process by removing a 150ms timeout and relocating the data bridge handling logic to cms.modal.js. This change improves the modal closing time and simplifies the codebase by removing the need for a separate script in admin.base.js and the close_frame.html template.

Sequence diagram for modal closing process (before)

sequenceDiagram
    participant Browser
    participant admin.base.js
    participant close_frame.html

    Browser->>close_frame.html: Triggers modal close
    close_frame.html->>admin.base.js: Loads data bridge script
    admin.base.js->>admin.base.js: Sets timeout (100-150ms)
    admin.base.js->>admin.base.js: Executes data bridge after timeout
    admin.base.js-->>Browser: Closes modal
Loading

Sequence diagram for modal closing process (after)

sequenceDiagram
    participant Browser
    participant cms.modal.js
    participant close_frame.html

    Browser->>close_frame.html: Triggers modal close
    close_frame.html->>cms.modal.js: Passes data bridge
    cms.modal.js->>cms.modal.js: Executes data bridge immediately
    cms.modal.js-->>Browser: Closes modal
Loading

File-Level Changes

Change Details Files
Eliminated the timeout when closing the modal, resulting in faster closing times.
  • Removed the 150ms timeout in cms.modal.js.
  • Moved the data bridge handling logic from admin.base.js to cms.modal.js.
  • Removed the script inclusion for bundle.admin.base.min.js from close_frame.html.
 cms/static/cms/js/modules/cms.modal.js
cms/static/cms/js/admin.base.js
cms/templates/admin/cms/page/close_frame.html
Handled the data bridge script directly within the modal's JavaScript.
  • The data bridge script is now handled directly within the modal's JavaScript.
  • The data bridge is used to access plugin information from different resources.
  • The onPluginSave method is called after parsing the data bridge content.
 cms/static/cms/js/modules/cms.modal.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

@fsbraun fsbraun marked this pull request as ready for review March 20, 2025 12:16
sourcery-ai[bot]
sourcery-ai bot reviewed Mar 20, 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:

  • It might be worth adding a comment explaining why the dataBridge check is necessary.
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 26, 2025
View reviewed changes
@vinitkumar vinitkumar merged commit c37fa0b into develop-4 Mar 26, 2025
64 checks passed
@fsbraun fsbraun deleted the fix/modal-response-time branch April 5, 2025 06:04
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