Fix: Don't reload page if modal is open

[Squidly271]

Summary by CodeRabbit

• New Features

  • Improved page auto-reload behavior to avoid reloading when modal dialogs are open.
  • Reload timer now resets with any user click to prevent reloads immediately after user interaction.

• Bug Fixes

  • Prevented unwanted page reloads during active modal dialogs, ensuring smoother user experience.

[coderabbitai]

Walkthrough

This change updates the page auto-reload logic in the DefaultPageLayout.php file to prevent automatic page reloads when modal dialogs (specifically SweetAlert modals) are open. A new function detects if a modal is visible, and the reload timer only triggers if no modal is open and live updates are not paused. Additionally, user clicks reset the reload timer, and the reload-on-visibility logic is updated to avoid disrupting users interacting with modals. No exported or public function or variable declarations were altered.

Changes

File(s)	Change Summary
emhttp/plugins/dynamix/include/DefaultPageLayout.php	Enhanced auto-reload logic: added checks to prevent reloads when modal dialogs are open, introduced dialogOpen() function, reset reload timer on user click, and updated visibility change behavior to coordinate reloads with modal visibility and user interaction.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Browser
    participant PageScript

    User->>Browser: Interacts with page (clicks, opens modal)
    Browser->>PageScript: User action event
    PageScript->>PageScript: Reset reload timer

    Note over PageScript: Periodic reload timer fires
    PageScript->>PageScript: Check if modal is open and live updates paused
    alt Modal open or updates paused
        PageScript-->>PageScript: Do not reload
    else No modal and updates active
        PageScript-->>Browser: Reload page
    end

    Browser->>PageScript: Visibility change (tab regains focus)
    PageScript->>PageScript: If reload interval set
    alt Modal open
        PageScript-->>PageScript: Reset reload timer, resume updates
    else No modal
        PageScript-->>Browser: Reload page
    end

Loading

Possibly related PRs

• Refactor: Reload Dash/Main pages when visibility becomes visible #2152: Modifies page reload behavior on visibility change in the same file, with both PRs enhancing reload logic to handle modal dialogs.
• Refactor: Honour page reload timer when live updates disabled #2087: Adjusts reload timer conditions based on live update settings, related as both PRs refine reload control logic in the same file.

Poem

A modal pops up, the page takes a pause,
No reloads to interrupt—now that’s a good cause!
Clicks reset the timer, the user’s in charge,
No more surprise refreshes, no modals at large.
With careful new logic, the dialogs stay king—
The page waits politely, as SweetAlerts sing!
🐰✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d687dce and 50643c7.

📒 Files selected for processing (1)

• emhttp/plugins/dynamix/include/DefaultPageLayout.php (2 hunks)

🔇 Additional comments (4)

emhttp/plugins/dynamix/include/DefaultPageLayout.php (4)

772-795: Excellent enhancement to prevent reloads during user interactions!

This is a great improvement to the page auto-reload logic. The new setTimerReload() function now checks two conditions before triggering a page reload:

1. Live updates are not paused (nchanPaused === false)
2. No modal dialog is open (!dialogOpen())

This prevents interruptions when users are interacting with modal dialogs.

---

788-790: Good implementation of modal detection function.

The dialogOpen() function correctly checks for both types of SweetAlert modals using their respective CSS selectors. This is a proper way to detect if a dialog is currently open.

---

783-786: Smart UX improvement with reload timer reset.

Resetting the reload timer on user clicks prevents the page from reloading immediately after user interaction. This leads to a better user experience, particularly during form filling or when reviewing information.

---

1318-1324: Good conditional handling for visibility change events.

The modified visibility change handler now checks if a modal dialog is open before deciding whether to reload the page. This prevents disruption when users return to the tab while interacting with a modal.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.