Improve windows index search with special character

[Jack251970]

PR

Improve windows index search with special character like \@\＠\#\＃\&\＆＊_;,\%\|\!\(\)\{\}\[\]\^\~\?\\""\/\:\=\-.

If you type Zotero & Obsidian in search bar, the command will look like this:

SELECT TOP 100 "System.FileName", "System.ItemUrl", "System.ItemType" FROM "SystemIndex"
WHERE CONTAINS(System.FileName,'"Zotero*" AND "&*" AND "Obsidian*"',2057)
AND scope='file:' ORDER BY System.FileName

And "&*" can cause issue like this:

17:34:42.0030+08:00 - ERROR - WindowsIndex.ExecuteWindowsIndexSearchAsync - Failed to execute windows index search query: SELECT TOP 100 "System.FileName", "System.ItemUrl", "System.ItemType" FROM "SystemIndex" WHERE (System.FileName LIKE '8+16%1%' OR CONTAINS(System.FileName,'"8+16*1*"',2057)) AND scope='file:' ORDER BY System.FileName
EXCEPTION OCCURS: System.Data.OleDb.OleDbException (0x80041607): Unspecified error: -2147215865(0x80041607)

So the outcome of windows index will be empty.

In this PR, ReplaceSpecialCharacterWithTwoSideWhiteSpace can handle those special character with white space on one side.
So "[special character]*" will not exist in the command and windows index can work in that occasion.

Test

Original:


After:

[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]

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 changes in this pull request focus on enhancing the QueryConstructor class within the Flow.Launcher.Plugin.Explorer.Search.WindowsIndex namespace. Two static Regex fields have been added to match special characters and multiple whitespace characters. A new method has been introduced to sanitize user input by replacing special characters with whitespace, improving the robustness of SQL query generation. The return statement in the FilesAndFolders method has been updated to utilize the sanitized search string, thereby reducing the risk of exceptions during query execution.

Changes

File Path	Change Summary
Plugins/Flow.Launcher.Plugin.Explorer/Search/WindowsIndex/QueryConstructor.cs	- Added static fields: _specialCharacterMatcher, _multiWhiteSpacesMatcher. - Added method: ReplaceSpecialCharacterWithTwoSideWhiteSpace. - Updated FilesAndFolders method to sanitize userSearchString and use replacedSearchString in SQL query.

Possibly related PRs

• [Add new public api function BackToQueryResults for chaning the query list back to query results list #3087] The changes in this PR involve modifications to the IPublicAPI interface and the addition of the BackToQueryResults method, which may relate to user input handling and navigation, similar to the enhancements made in the QueryConstructor class for sanitizing user input in SQL queries.

Suggested labels

enhancement

Suggested reviewers

• jjw24

Poem

In the realm of code, where bunnies hop,
We clean up strings, we make them stop!
With regex magic, we tidy the way,
For smoother queries, come what may.
So here’s to changes, both clever and bright,
A hop, skip, and jump into the light! 🐇✨

---

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

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

Plugins/Flow.Launcher.Plugin.Explorer/Search/WindowsIndex/QueryConstructor.cs (1)

90-115: Optimize the special character replacement method.

While the implementation is functional, it could be improved in several ways:

1. Reduce string allocations by using Span<char> more effectively
2. Add input validation
3. Simplify the whitespace checking logic
4. Consider a more concise name like SanitizeSpecialCharacters

-        private static string ReplaceSpecialCharacterWithTwoSideWhiteSpace(ReadOnlySpan<char> input)
+        private static string SanitizeSpecialCharacters(ReadOnlySpan<char> input)
         {
+            if (input.IsEmpty)
+                return string.Empty;
+
             const string whiteSpace = " ";
-
-            var inputString = input.ToString();
+            var inputString = input.ToString(); // Required for Regex operations

             // Use regex to match special characters with whitespace on one side
             // and replace them with a single space
             var result = _specialCharacterMatcher.Replace(inputString, match =>
             {
-                // Check if the match has whitespace on one side
-                bool hasLeadingWhitespace = match.Index > 0 && char.IsWhiteSpace(inputString[match.Index - 1]);
-                bool hasTrailingWhitespace = match.Index + match.Length < inputString.Length && char.IsWhiteSpace(inputString[match.Index + match.Length]);
-                if (hasLeadingWhitespace || hasTrailingWhitespace)
-                {
-                    return whiteSpace;
-                }
-                return match.Value;
+                // Replace special character with space if it has whitespace on either side
+                return (match.Index > 0 && char.IsWhiteSpace(inputString[match.Index - 1])) ||
+                       (match.Index + match.Length < inputString.Length && char.IsWhiteSpace(inputString[match.Index + match.Length]))
+                    ? whiteSpace
+                    : match.Value;
             });

             // Remove any extra spaces that might have been introduced
             return _multiWhiteSpacesMatcher.Replace(result, whiteSpace).Trim();
         }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1f81ea0 and 5b344fb.

📒 Files selected for processing (1)

• Plugins/Flow.Launcher.Plugin.Explorer/Search/WindowsIndex/QueryConstructor.cs (2 hunks)

🔇 Additional comments (2)

Plugins/Flow.Launcher.Plugin.Explorer/Search/WindowsIndex/QueryConstructor.cs (2)

83-88: LGTM! Clean integration of special character handling.

The changes effectively integrate the special character sanitization while maintaining the existing input validation logic.

---

83-115: Verify the special character handling implementation.

Let's ensure the changes handle special characters correctly and maintain existing functionality.

[jjw24]

Thanks for the well written PR 👍