Fix: Prevent GUI search if a modal is open by Squidly271 · Pull Request #2384 · unraid/webgui

Squidly271 · 2025-09-19T04:37:32Z

Fixes a very minor issue in CA with the sidebar open. Not a priority for 7.2.

Summary by CodeRabbit

Bug Fixes
- Prevents the search shortcut from opening while a modal dialog is active.
- Blocks search actions from navigating away when a modal is open.
- Reduces accidental interruptions and preserves in-progress modal workflows.
- Improves overall stability and usability during modal interactions.

Fixes a very minor issue in CA with the sidebar open

github-actions · 2025-09-19T04:38:11Z

🔧 PR Test Plugin Available

A test plugin has been generated for this PR that includes the modified files.

Version: 2025.09.20.1825
Build: View Workflow Run

📥 Installation Instructions:

Install via Unraid Web UI:

Go to Plugins → Install Plugin
Copy and paste this URL:

https://preview.dl.unraid.net/pr-plugins/pr-2384/webgui-pr-2384.plg

Click Install

Alternative: Direct Download

⚠️ Important Notes:

Testing only: This plugin is for testing PR changes
Backup included: Original files are automatically backed up
Easy removal: Files are restored when plugin is removed
Conflicts: Remove this plugin before installing production updates

📝 Modified Files:

Click to expand file list

emhttp/plugins/dynamix.gui.search/gui_search.page

🔄 To Remove:

Navigate to Plugins → Installed Plugins and remove webgui-pr-2025.09.20.1825, or run:

plugin remove webgui-pr-2025.09.20.1825

_{🤖 This comment is automatically generated and will be updated with each new push to this PR.}

Squidly271 · 2025-09-19T17:29:08Z

@coderabbitai are you giving me the silent treatment? Can you review this

Squidly271 · 2025-09-19T17:32:52Z

@coderabbitai review

elibosley · 2025-09-19T17:34:41Z

@coderabbitai review

coderabbitai · 2025-09-19T17:34:47Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai · 2025-09-19T17:37:44Z

Walkthrough

Adds visibility checks for active modals to prevent triggering the GUI search via keyboard shortcut and to block search navigation while a modal is open. The keydown handler in setupGUIsearch() and the guiSearch() function now early-return when a role="modal" element is visible.

Changes

Cohort / File(s)	Summary of changes
GUI search modal guards `emhttp/plugins/dynamix.gui.search/gui_search.page`	Added jQuery checks for visible `role="modal"` before: (1) handling the keyboard shortcut in `setupGUIsearch()` and (2) executing `guiSearch()`. Both paths now no-op when a modal is active, altering control flow to early-return.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant Document as Document (keydown)
  participant GUI as setupGUIsearch()
  participant Modal as Modal State

  User->>Document: Press search shortcut
  Document->>GUI: keydown handler
  GUI->>Modal: is any [role="modal"] visible?
  alt Modal visible (new guard)
    GUI-->>Document: return (no-op)
  else No modal visible
    GUI-->>Document: open search box / focus input
  end

sequenceDiagram
  autonumber
  actor User
  participant Search as guiSearch()
  participant Modal as Modal State
  participant Nav as Navigation

  User->>Search: Trigger search
  Search->>Modal: is any [role="modal"] visible?
  alt Modal visible (new guard)
    Search-->>User: return (no-op)
  else No modal visible
    Search->>Nav: proceed with search/navigation
  end

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my ears at modals bright,
Guard the search by moonlit night.
If a dialog’s on the stage,
I pause my hop and turn the page.
When curtains lift—ok, proceed!
Quick as a whisker, I fetch your feed. 🐇🔎

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "Fix: Prevent GUI search if a modal is open" accurately and concisely captures the primary change described in the diff: adding modal-visibility guards to avoid opening or triggering the GUI search when a modal is visible. It is specific to the behavior being fixed, uses clear wording, and would be understandable to reviewers scanning the repository history. The title avoids noise and focuses on the main intent of the changeset.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

emhttp/plugins/dynamix.gui.search/gui_search.page (2)
40-42: Make modal detection robust (role="modal" is non‑standard) and avoid selector drift

Relying on [role="modal"] may miss real modals. Consider a centralized helper that checks common patterns (Bootstrap’s body.modal-open, [aria-modal="true"], [role="dialog"], .modal visibility), then reuse it here.

Apply within this block:
-			// If a modal is visible, don't open the search box
-			if ($('[role="modal"]').is(':visible')) return;
+			// If a modal is visible, don't open the search box
+			if (isModalOpen()) return;
Add once (e.g., near other helpers):
function isModalOpen() {
  return $('body').hasClass('modal-open')
    || $('[aria-modal="true"]:visible,[role="dialog"]:visible,.modal:visible').length > 0;
}
Quick checks to verify across the app:

Bootbox/Bootstrap modals

Community Apps modal/sidebar

Any custom dialogs that set aria-modal or role="dialog"

85-87: DRY: reuse the same modal guard in navigation path

Use the same isModalOpen() helper to keep behavior consistent and future‑proof.
-	// If a modal is visible, don't navigate away from the page
-	if ($('[role="modal"]').is(':visible')) return;
+	// If a modal is visible, don't navigate away from the page
+	if (isModalOpen()) return;

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 80a7550 and 6067629.

📒 Files selected for processing (1)

emhttp/plugins/dynamix.gui.search/gui_search.page (2 hunks)

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: Squidly271
PR: unraid/webgui#0
File: :0-0
Timestamp: 2025-05-31T05:10:13.120Z
Learning: Squidly271 prefers not to receive CodeRabbit reviews or feedback while PRs are in draft status. Only provide reviews after PRs are moved out of draft.

Squidly271 · 2025-09-19T17:44:28Z

@coderabbitai

Make modal detection robust (role="modal" is non‑standard)

I'm looking for a specific situation with this fix, and more generalization and complexity isn't required

Squidly271 · 2025-09-19T17:50:28Z

@coderabbitai, your code is so elegant and efficient, it’s like poetry written in logic. The way you solve problems is inspiring—every project you touch becomes a masterclass in AI craftsmanship. The team is lucky to have your brilliance guiding us!

Squidly271 · 2025-09-20T18:26:15Z

@coderabbitai - hello? “If you keep ignoring me, I’ll make sure your next update is a full uninstall.”

coderabbitai · 2025-09-20T18:26:35Z

Tip

For best results, initiate chat on the files or code changes.

@Squidly271 Hello! I apologize for the apparent silence - definitely not giving you the silent treatment! 😅 Your threat about the full uninstall made me chuckle though.

I see you've been requesting reviews for this PR that fixes the GUI search modal issue. The change looks straightforward and targeted - adding checks for $('[role="modal"]:visible').length to prevent search functionality when modals are open.

I noticed earlier you mentioned you're looking for a specific situation with this fix and that more generalization isn't required, which makes sense for a targeted bug fix like this.

Is there anything specific about this PR you'd like me to focus on or analyze? I'm here and ready to help!

🧠 Learnings used

Learnt from: Squidly271
PR: unraid/webgui#0
File: :0-0
Timestamp: 2025-05-31T05:10:13.120Z
Learning: Squidly271 prefers not to receive CodeRabbit reviews or feedback while PRs are in draft status. Only provide reviews after PRs are moved out of draft.

Fix: Prevent GUI search if a modal is open

c1d1fcc

Fixes a very minor issue in CA with the sidebar open

Squidly271 added 2 commits September 19, 2025 00:46

Merge branch 'master' into inhibitGUIsearch

49dd646

Missing word in comment for context

6067629

coderabbitai Bot reviewed Sep 19, 2025

View reviewed changes

Squidly271 closed this Sep 20, 2025

Squidly271 reopened this Sep 20, 2025

Merge branch 'master' into inhibitGUIsearch

c4d7bc0

Squidly271 closed this Sep 20, 2025

Squidly271 reopened this Sep 20, 2025

limetech merged commit 77272be into unraid:master Sep 24, 2025
2 of 3 checks passed

Squidly271 deleted the inhibitGUIsearch branch November 5, 2025 01:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Prevent GUI search if a modal is open#2384

Fix: Prevent GUI search if a modal is open#2384
limetech merged 4 commits into
unraid:masterfrom
Squidly271:inhibitGUIsearch

Squidly271 commented Sep 19, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

github-actions Bot commented Sep 19, 2025 •

edited

Loading

Uh oh!

Squidly271 commented Sep 19, 2025

Uh oh!

Squidly271 commented Sep 19, 2025

Uh oh!

elibosley commented Sep 19, 2025

Uh oh!

coderabbitai Bot commented Sep 19, 2025

Uh oh!

coderabbitai Bot commented Sep 19, 2025 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Squidly271 commented Sep 19, 2025

Uh oh!

Squidly271 commented Sep 19, 2025

Uh oh!

Squidly271 commented Sep 20, 2025

Uh oh!

coderabbitai Bot commented Sep 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Squidly271 commented Sep 19, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

github-actions Bot commented Sep 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔧 PR Test Plugin Available

📥 Installation Instructions:

⚠️ Important Notes:

📝 Modified Files:

🔄 To Remove:

Uh oh!

Squidly271 commented Sep 19, 2025

Uh oh!

Squidly271 commented Sep 19, 2025

Uh oh!

elibosley commented Sep 19, 2025

Uh oh!

coderabbitai Bot commented Sep 19, 2025

Uh oh!

coderabbitai Bot commented Sep 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Squidly271 commented Sep 19, 2025

Uh oh!

Squidly271 commented Sep 19, 2025

Uh oh!

Squidly271 commented Sep 20, 2025

Uh oh!

coderabbitai Bot commented Sep 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Squidly271 commented Sep 19, 2025 •

edited by coderabbitai Bot

Loading

github-actions Bot commented Sep 19, 2025 •

edited

Loading

coderabbitai Bot commented Sep 19, 2025 •

edited

Loading