Skip to content
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.

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

Fix Custom Query Hotkey / Shortcuts Preview Issue #3248

Merged
merged 3 commits into from
Feb 21, 2025

Conversation

Jack251970
Copy link
Contributor

@Jack251970 Jack251970 commented Feb 17, 2025

Fix hotkey preview issue for custom query hotkeys and custom query shortcuts

In CustomQueryHotkeySetting.cs & CustomShortcutSetting.cs, original codes are like these:

Application.Current.MainWindow.Show();
Application.Current.MainWindow.Opacity = 1;

Here we will not call the correct Show function for main window.
So we need to change to:

_mainViewModel.Show();

And it can help us to address preview issue that main window will not close when it is unfocused.

Test

Original:

2025-02-16.23-44-30.mp4

After:

2025-02-16.23-58-18.-.Copy.mp4

@prlabeler prlabeler bot added the bug Something isn't working label Feb 17, 2025

This comment has been minimized.

Copy link

gitstream-cm bot commented Feb 17, 2025

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

Copy link
Contributor

coderabbitai bot commented Feb 17, 2025

📝 Walkthrough

Walkthrough

This update revises two files in the Flow Launcher project. In CustomQueryHotkeySetting.xaml.cs, a private _settings field replaces the public property with updated access in methods, and the button click now calls App.API.ShowMainWindow(). Similarly, in CustomShortcutSetting.xaml.cs, a new dependency on MainViewModel is injected via a private field and the constructor signature is updated. The button click event in this file is also modified to use App.API.ShowMainWindow(), consolidating window management through the API.

Changes

File(s) Change Summary
Flow.Launcher/.../CustomQueryHotkeySetting.xaml.cs Replaced the public Settings property with a private _settings field; updated constructor and modified methods (btnAdd_OnClick, UpdateItem) to access _settings.CustomPluginHotkeys; changed BtnTestActionKeyword_OnClick to call App.API.ShowMainWindow().
Flow.Launcher/.../CustomShortcutSetting.xaml.cs Added a new private _mainViewModel field; updated the constructor to accept a MainViewModel instance; modified BtnTestShortcut_OnClick to invoke App.API.ShowMainWindow() instead of directly manipulating the main window.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Setting as CustomQueryHotkeySetting/CustomShortcutSetting
    participant API as App.API
    User->>Setting: Click Test Button
    Setting->>API: Call ShowMainWindow()
    API-->>User: Display Main Window
Loading

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • jjw24
  • onesounds

Poem

I'm a bunny with a hop so bright,
Updating code with joy and light,
Private fields and structures neat,
API calls now can't be beat,
In this garden of code I play—
Hoppy changes lead the way! 🐇


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
🪧 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. (Beta)
  • @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.

@@ -1368,7 +1368,8 @@ public void Show()
MainWindowOpacity = 1;

MainWindowVisibilityStatus = true;
VisibilityChanged?.Invoke(this, new VisibilityChangedEventArgs { IsVisible = true });
if (invokeEvent)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this important?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original codes does not invoke VisibliityChanged event, so I keep it here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@taooceros If you think we should invoke this event here, feel free to tell me and I will do it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure. I don't recall much things registered in this event. I just want to check as you introduce an api change to the method, which is not yet sure important.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure. I don't recall much things registered in this event. I just want to check as you introduce an api change to the method, which is not yet sure important.

Well, I think we should invoke visibility changed event here and I change the related codes.

This comment has been minimized.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🔭 Outside diff range comments (1)
Flow.Launcher/CustomShortcutSetting.xaml.cs (1)

28-37: ⚠️ Potential issue

Update second constructor to handle MainViewModel.

The second constructor doesn't initialize _mainViewModel, which could lead to null reference exceptions when BtnTestShortcut_OnClick is called.

Apply this diff to fix the issue:

-public CustomShortcutSetting(string key, string value, SettingsPaneHotkeyViewModel vm)
+public CustomShortcutSetting(string key, string value, SettingsPaneHotkeyViewModel vm, MainViewModel mainVM)
 {
     Key = key;
     Value = value;
     originalKey = key;
     originalValue = value;
     update = true;
     _hotkeyVm = vm;
+    _mainViewModel = mainVM;
     InitializeComponent();
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d73f3a1 and 0611340.

📒 Files selected for processing (2)
  • Flow.Launcher/CustomQueryHotkeySetting.xaml.cs (4 hunks)
  • Flow.Launcher/CustomShortcutSetting.xaml.cs (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Flow.Launcher/CustomQueryHotkeySetting.xaml.cs
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: gitStream.cm

Copy link

@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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0611340 and 6b032b3.

📒 Files selected for processing (2)
  • Flow.Launcher/CustomQueryHotkeySetting.xaml.cs (4 hunks)
  • Flow.Launcher/CustomShortcutSetting.xaml.cs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Flow.Launcher/CustomQueryHotkeySetting.xaml.cs
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Report (PR)
🔇 Additional comments (2)
Flow.Launcher/CustomShortcutSetting.xaml.cs (2)

1-73: Inconsistency detected in AI-generated summary.

The summary mentions changes to constructor signature and addition of MainViewModel dependency, but these changes are not present in the actual code.

Likely an incorrect or invalid review comment.


68-68: Pass false to ShowMainWindow() to prevent VisibilityChanged event.

According to the PR objectives, ShowMainWindow() should be called with false to prevent invoking the VisibilityChanged event, maintaining the original behavior.

Apply this diff to fix the issue:

-            App.API.ShowMainWindow();
+            App.API.ShowMainWindow(false);  // false to not invoke VisibilityChanged event as original

Copy link

gitstream-cm bot commented Feb 18, 2025

🥷 Code experts: no user but you matched threshold 10

Jack251970 has most 👩‍💻 activity in the files.
VictoriousRaptor, Yusyuriv have most 🧠 knowledge in the files.

See details

Flow.Launcher/CustomQueryHotkeySetting.xaml.cs

Activity based on git-commit:

Jack251970
FEB
JAN
DEC
NOV 2 additions & 2 deletions
OCT
SEP

Knowledge based on git-blame:
Yusyuriv: 19%

Flow.Launcher/CustomShortcutSetting.xaml.cs

Activity based on git-commit:

Jack251970
FEB
JAN
DEC
NOV 3 additions & 2 deletions
OCT
SEP

Knowledge based on git-blame:
VictoriousRaptor: 38%
Yusyuriv: 14%

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

@Jack251970
Copy link
Contributor Author

So sorry that I forget there is an api function for showing main window😢

@Jack251970 Jack251970 requested a review from taooceros February 18, 2025 03:37
@taooceros
Copy link
Member

taooceros commented Feb 18, 2025

So sorry that I forget there is an api function for showing main window😢

Haha no worries 😝. You are already doing really well!

@@ -13,14 +13,14 @@ namespace Flow.Launcher
public partial class CustomQueryHotkeySetting : Window
{
private SettingWindow _settingWidow;
private readonly Settings _settings;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any reason to change this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For code quality.😂 I prefer _ prefix for readonly properties and majority of codes in FL uses this way.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically this is a field instead of property (maybe it worth to figure out the difference). For here, I think it's fine.

@Jack251970 Jack251970 merged commit c137091 into Flow-Launcher:dev Feb 21, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 min review bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants