Settings: fix creating/editing custom shortcuts #2796

Yusyuriv · 2024-06-20T03:58:18Z

When splitting the settings window, I forgot to re-add the correct check for already existing shortcuts. It was always displaying a message saying that the shortcut already exists. This PR fixes that.

Summary by CodeRabbit

New Features
- Enhanced custom shortcut settings with improved shortcut validation to prevent duplicate shortcuts.
Bug Fixes
- Improved internal handling of shortcut settings to ensure consistency and reliability.

coderabbitai · 2024-06-20T03:58:26Z

Walkthrough

The changes primarily enhance the management of custom shortcuts in Flow Launcher by integrating a SettingsPaneHotkeyViewModel to handle shortcut existence checks. Enhancements include constructor modifications and method adjustments for improved shortcut validation, ensuring more robust and error-free shortcut management.

Changes

File & Path	Summary
`Flow.Launcher/CustomShortcutSetting.xaml.cs`	Added `_hotkeyVm` field, modified `originalKey`/`originalValue`/`update` access to read-only, updated constructor for `SettingsPaneHotkeyViewModel`, enhanced `BtnAdd_OnClick` logic.
`Flow.Launcher/SettingPages/ViewModels/SettingsPaneHotkeyViewModel.cs`	Included `System.Linq`, modified `CustomShortcutEdit` and `CustomShortcutAdd` to pass `SettingsPaneHotkeyViewModel`, added `DoesShortcutExist` internal method.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CustomShortcutSetting
    participant SettingsPaneHotkeyViewModel

    User ->> CustomShortcutSetting: Click 'Add Shortcut'
    CustomShortcutSetting ->> SettingsPaneHotkeyViewModel: DoesShortcutExist(shortcutKey)
    SettingsPaneHotkeyViewModel -->> CustomShortcutSetting: Shortcut Exists / Not Exist
    CustomShortcutSetting ->> User: Display Success/Error Message

Poem

In code where shortcuts bloom and glow,
A HotkeyViewModel we bestow. 🌟
With checks so fine and logic tight,
Flow Launcher’s shortcuts feel just right. ✨
No clash or chaos, smooth like art,
A rabbit’s touch in every part. 🐇🖥️

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a26cdc4 and 79ce505.

Files selected for processing (2)

Flow.Launcher/CustomShortcutSetting.xaml.cs (2 hunks)
Flow.Launcher/SettingPages/ViewModels/SettingsPaneHotkeyViewModel.cs (3 hunks)

Additional comments not posted (7)

Flow.Launcher/CustomShortcutSetting.xaml.cs (3)

11-16: Ensuring immutability by making properties read-only is a good practice, especially in multi-threaded environments where mutable shared state can lead to issues. The introduction of _hotkeyVm as a readonly field is also a good practice for dependency injection.

18-20: Proper dependency injection in the constructor. This ensures that the CustomShortcutSetting class is decoupled from the creation of its dependencies, facilitating easier unit testing and maintenance.

24-31: This constructor overload is well-implemented for handling updates to existing shortcuts. It initializes properties based on passed parameters and correctly sets the update flag to true, which is crucial for the logic in BtnAdd_OnClick.

Flow.Launcher/SettingPages/ViewModels/SettingsPaneHotkeyViewModel.cs (4)

1-1: The addition of the System.Linq namespace is justified by its use in the DoesShortcutExist method to simplify checking for existing shortcuts.

118-118: Passing this as a parameter to CustomShortcutSetting ensures that the view model's state can be accessed directly in the dialog, which is a good practice for maintaining state consistency between the view and the model.

128-128: Creating a new instance of CustomShortcutSetting with this as a parameter is consistent with the changes in CustomShortcutEdit. This maintains uniformity and ensures that the view model's methods and properties are accessible in the shortcut setting context.

136-140: The method DoesShortcutExist is efficiently using LINQ to check for the existence of a shortcut key across both custom and built-in shortcuts. This is a clean and effective way to perform this check.

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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 resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

github-actions · 2024-06-20T03:59:27Z

@check-spelling-bot Report

🔴 Please review

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

❌ Errors	Count
❌ ignored-expect-variant	1
⚠️ non-alpha-in-dictionary	13

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 · 2024-06-20T03:59:41Z

🥷 Code experts: VictoriousRaptor

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

See details

Flow.Launcher/CustomShortcutSetting.xaml.cs

Activity based on git-commit:

	Yusyuriv
JUN
MAY	3 additions & 7 deletions
APR
MAR
FEB
JAN

Knowledge based on git-blame:
VictoriousRaptor: 51%
Yusyuriv: 3%

Flow.Launcher/SettingPages/ViewModels/SettingsPaneHotkeyViewModel.cs

Activity based on git-commit:

	Yusyuriv
JUN
MAY	135 additions & 1 deletions
APR
MAR
FEB
JAN

Knowledge based on git-blame:
Yusyuriv: 100%

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

gitstream-cm · 2024-06-20T03:59:52Z

This PR is 66.66666666666666% new code.

gitstream-cm · 2024-06-20T04:00:02Z

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

coderabbitai

Actionable comments posted: 1

coderabbitai · 2024-06-20T04:01:25Z

Flow.Launcher/CustomShortcutSetting.xaml.cs

            }
            // Check if key is modified or adding a new one
-            if ((update && originalKey != Key) || !update)
+            if (((update && originalKey != Key) || !update) && _hotkeyVm.DoesShortcutExist(Key))


The logic to check for duplicate shortcuts is well-placed. However, consider adding a null check for _hotkeyVm to prevent potential runtime exceptions if the dependency is not properly injected.

if (_hotkeyVm != null && ((update && originalKey != Key) || !update) && _hotkeyVm.DoesShortcutExist(Key))

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

if (((update && originalKey != Key) || !update) && _hotkeyVm.DoesShortcutExist(Key))

if (_hotkeyVm != null && ((update && originalKey != Key) || !update) && _hotkeyVm.DoesShortcutExist(Key))

Settings: fix creating/editing custom shortcuts

79ce505

Yusyuriv added bug Something isn't working Dev branch only An issue or fix for the Dev branch build labels Jun 20, 2024

Yusyuriv requested a review from onesounds June 20, 2024 03:58

Yusyuriv self-assigned this Jun 20, 2024

github-actions bot added this to the 1.19.0 milestone Jun 20, 2024

prlabeler bot added the enhancement New feature or request label Jun 20, 2024

gitstream-cm bot added the 1 min review label Jun 20, 2024

Yusyuriv removed enhancement New feature or request 1 min review labels Jun 20, 2024

gitstream-cm bot added the 1 min review label Jun 20, 2024

coderabbitai bot reviewed Jun 20, 2024

View reviewed changes

onesounds approved these changes Jun 20, 2024

View reviewed changes

onesounds merged commit c65ac7b into dev Jun 20, 2024

onesounds deleted the fix-custom-shortcuts-not-working-after-settings-split branch June 20, 2024 08:35

jjw24 removed bug Something isn't working 1 min review labels Jul 22, 2024

coderabbitai bot mentioned this pull request Feb 17, 2025

Fix Custom Query Hotkey / Shortcuts Preview Issue #3248

Merged

coderabbitai bot mentioned this pull request Oct 11, 2025

Fix ArgumentOutOfRangeException in WebSearch Plugin #4041

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Settings: fix creating/editing custom shortcuts #2796

Settings: fix creating/editing custom shortcuts #2796

Uh oh!

Yusyuriv commented Jun 20, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 20, 2024 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

github-actions bot commented Jun 20, 2024

Uh oh!

gitstream-cm bot commented Jun 20, 2024

Uh oh!

gitstream-cm bot commented Jun 20, 2024

Uh oh!

gitstream-cm bot commented Jun 20, 2024

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Jun 20, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	if (((update && originalKey != Key) \|\| !update) && _hotkeyVm.DoesShortcutExist(Key))
	if (_hotkeyVm != null && ((update && originalKey != Key) \|\| !update) && _hotkeyVm.DoesShortcutExist(Key))

Uh oh!

Settings: fix creating/editing custom shortcuts #2796

Settings: fix creating/editing custom shortcuts #2796

Uh oh!

Conversation

Yusyuriv commented Jun 20, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jun 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Jun 20, 2024

@check-spelling-bot Report

🔴 Please review

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

Uh oh!

gitstream-cm bot commented Jun 20, 2024

Uh oh!

gitstream-cm bot commented Jun 20, 2024

Uh oh!

gitstream-cm bot commented Jun 20, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Jun 20, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Yusyuriv commented Jun 20, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 20, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)