Remove unneccessary CreateSettingPanel by introducing need check

[Jack251970]

Remove unneccessary CreateSettingPanel by introducing need check

Follow on with #3260, we can use NeedCreateSettingPanel function to check if we need to create settings panel to remove unnecessary calling of CreateSettingPanel.

Test

• JsonRPC plugins can create settings panels correctly.
• JsonRPC plugins will not call CreateSettingPanel when their SettingsTemplate.yaml files do not have any configurations.

[github-actions]

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

❌ Errors	Count
❌ forbidden-pattern	22
⚠️ ignored-expect-variant	1
⚠️ non-alpha-in-dictionary	19

See ❌ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

• binary file (or some other file you wouldn't want to check at all).

  Please add a file path to the excludes.txt file matching the containing file.

  File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

  ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

• well-formed pattern.

  If you can write a pattern that would match it,
  try adding it to the patterns.txt file.

  Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

  Note that patterns can't match multiline strings.

[gitstream-cm]

🥷 Code experts: no user matched threshold 10

See details

To learn more about /:\ gitStream - Visit our Docs

[gitstream-cm]

Be a legend 🏆 by adding a before and after screenshot of the changes you made, especially if they are around UI/UX.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request modifies three components to enhance settings panel handling. The JsonRPCPluginBase class is now public and provides a new method, NeedCreateSettingPanel(), to check for settings panel creation. Similarly, the JsonRPCPluginSettings class gains a corresponding method to encapsulate its validation logic. Additionally, the PluginViewModel adjusts its properties to conditionally create the settings panel based on whether the plugin (particularly if it is a JsonRPCPluginBase) requires one.

Changes

File(s)	Change Summary
Flow.Launcher.Core/Plugin/JsonRPCPluginBase.cs, Flow.Launcher.Core/Plugin/JsonRPCPluginSettings.cs	Changed class visibility (JsonRPCPluginBase is now public) and added a new public method NeedCreateSettingPanel() to provide a clear check for settings panel creation.
Flow.Launcher/…/PluginViewModel.cs	Updated HasSettingControl and SettingControl properties with added conditions to determine if a settings panel should be created, including specific handling for JsonRPCPluginBase.

Sequence Diagram(s)

sequenceDiagram
    participant PV as PluginViewModel
    participant P as Plugin (ISettingProvider)
    note over PV,P: Evaluate settings panel requirement
    PV->>P: Check HasSettingControl
    alt Plugin is JsonRPCPluginBase
        P->>P: Call NeedCreateSettingPanel()
    end
    alt If panel creation is required
        PV->>P: Call CreateSettingPanel()
    else No panel needed
        PV-->>P: Skip panel creation
    end

Loading

Possibly related PRs

• Remove Useless Separate Line for Blank Settings Panel #3260: Addresses similar functionality by integrating the NeedCreateSettingPanel method across related classes for settings panel management.

Suggested labels

kind/ui

Suggested reviewers

• jjw24
• taooceros

Poem

I’m just a rabbit with a joyful hop,
Enhancing settings so the code won’t stop,
With panels checked by a method so bright,
My burrow of code leaps with delight,
Hop along, dear coders, through the tech night!

---

📜 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 57f20ae and 4e47586.

📒 Files selected for processing (3)

• Flow.Launcher.Core/Plugin/JsonRPCPluginBase.cs (2 hunks)
• Flow.Launcher.Core/Plugin/JsonRPCPluginSettings.cs (1 hunks)
• Flow.Launcher/ViewModel/PluginViewModel.cs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: gitStream.cm
• GitHub Check: gitStream.cm

🔇 Additional comments (6)

Flow.Launcher.Core/Plugin/JsonRPCPluginSettings.cs (2)

112-116: LGTM! Well-designed method for checking setting panel requirements

The implementation checks all necessary conditions (Settings not null, Configuration not null, and Configuration.Body not empty) to determine if a setting panel is needed. This helps avoid unnecessary panel creation.

---

120-120: Clear explanation of control flow

Good comment explaining that the previous validation logic was moved to NeedCreateSettingPanel() which will be called before this method.

Flow.Launcher.Core/Plugin/JsonRPCPluginBase.cs (2)

160-163: LGTM! Good delegation to Settings implementation

Simple and clean implementation that delegates to the corresponding method in the Settings class.

---

37-37:

✅ Verification successful

Verify the impact of changing class access modifier

The class is now public instead of internal. While this is necessary for the improvements in PluginViewModel.cs, consider whether this has any API stability implications as it exposes the class more broadly.

---

🏁 Script executed:

#!/bin/bash
# Check if JsonRPCPluginBase is used by any code outside of the current project
rg -A 3 -B 3 "JsonRPCPluginBase" --type cs | grep -v "Flow.Launcher.Core/Plugin/JsonRPCPluginBase.cs"

Length of output: 1929

---

API Exposure Impact Check: Verified No External Dependence

The investigation confirms that JsonRPCPluginBase is referenced only within internal components:

• In both JsonRPCPlugin.cs and JsonRPCPluginV2.cs, the base class is extended by internal plugin classes.
• In PluginViewModel.cs, it’s used solely for type checking in controlling UI behavior.

No external dependencies or unintended exposures were detected. While making the class public was necessary for the improvement in PluginViewModel.cs, this change does not appear to risk API stability at this time.

Flow.Launcher/ViewModel/PluginViewModel.cs (2)

93-93: LGTM! Well-designed conditional logic

This property now correctly handles both regular setting providers and the special case for JsonRPCPluginBase plugins. The condition ensures that JsonRPC plugins only create settings panels when needed.

---

97-99: LGTM! Improved implementation

The code now properly leverages the HasSettingControl property for a cleaner implementation. This ensures that CreateSettingPanel() is only called when actually needed.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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.