Skip to content

Fix unix directory seperator issue #3231

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

Merged
merged 3 commits into from
Feb 8, 2025

Conversation

Jack251970
Copy link
Member

Fix issue when user uses forward slash as directory seperator, like C:\Test/Test.

Related issue in #3229.

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

This comment has been minimized.

Copy link

gitstream-cm bot commented Feb 7, 2025

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

@Jack251970
Copy link
Member Author

@cibere Does this work for you?

@Jack251970 Jack251970 requested a review from cibere February 7, 2025 08:09
Copy link
Contributor

coderabbitai bot commented Feb 7, 2025

📝 Walkthrough

Walkthrough

This pull request adds a new constant, UnixDirectorySeparator, in the Constants class to represent the Unix directory separator. Additionally, the PathSearchAsync method in the SearchManager class now includes a line that converts Unix-style separators to Windows-style separators. These changes ensure that path strings are correctly formatted across different operating systems. No other aspects of the classes were altered.

Changes

File(s) Summary of Changes
Plugins/Flow.Launcher.Plugin.Explorer/.../Constants.cs Added new constant "UnixDirectorySeparator" representing the Unix directory separator.
Plugins/Flow.Launcher.Plugin.Explorer/.../SearchManager.cs Modified PathSearchAsync to convert Unix-style path separators to Windows-style by replacing characters.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant SM as SearchManager
    participant C as Constants

    U->>SM: Request path search
    SM->>SM: Receive input path with Unix separators
    SM->>C: Access UnixDirectorySeparator constant
    SM->>SM: Replace Unix separators with Windows separators
    SM->>U: Return formatted search results
Loading

Possibly related PRs

Suggested reviewers

  • Garulf
  • jjw24
  • Yusyuriv
  • VictoriousRaptor
  • taooceros

Poem

I'm a keen little rabbit on the code trail,
Hopping over separators without fail.
Unix becomes Windows with a simple swap,
Each path now neat from start to top.
In lines and bytes, I dance with delight!
🐇✨


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.

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: 0

🧹 Nitpick comments (1)
Plugins/Flow.Launcher.Plugin.Explorer/Search/DirectoryInfo/DirectoryInfoSearch.cs (1)

15-16: LGTM! Consider adding input validation.

The changes effectively address the Unix separator issue. However, consider adding validation for edge cases.

Consider adding validation to handle cases like multiple consecutive separators:

 // if user uses the unix directory separator, we need to convert it to windows directory separator
-search = search.Replace(Constants.UnixDirectorySeparator, Constants.DirectorySeparator);
+// Normalize path by replacing consecutive separators with a single separator
+while (search.Contains(Constants.UnixDirectorySeparator + Constants.UnixDirectorySeparator) ||
+       search.Contains(Constants.DirectorySeparator + Constants.DirectorySeparator))
+{
+    search = search.Replace(Constants.UnixDirectorySeparator + Constants.UnixDirectorySeparator, Constants.UnixDirectorySeparator)
+                   .Replace(Constants.DirectorySeparator + Constants.DirectorySeparator, Constants.DirectorySeparator);
+}
+// Convert Unix separators to Windows separators
+search = search.Replace(Constants.UnixDirectorySeparator, Constants.DirectorySeparator);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 38eb07a and a3cc5e2.

📒 Files selected for processing (2)
  • Plugins/Flow.Launcher.Plugin.Explorer/Search/Constants.cs (1 hunks)
  • Plugins/Flow.Launcher.Plugin.Explorer/Search/DirectoryInfo/DirectoryInfoSearch.cs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
🔇 Additional comments (1)
Plugins/Flow.Launcher.Plugin.Explorer/Search/Constants.cs (1)

34-34: LGTM!

The new constant is well-named, appropriately scoped, and logically placed near the related DirectorySeparator constant.

Copy link
Contributor

coderabbitai bot commented Feb 7, 2025

📝 Walkthrough

Walkthrough

The changes update the Explorer plugin by introducing a new internal constant for the Unix directory separator in the constants file and modifying the top-level directory search method to replace Unix directory separators with Windows ones. This ensures consistency in handling directory paths across different OS formats.

Changes

File(s) Change Summary
Plugins/Flow.Launcher.Plugin.Explorer/.../Search/Constants.cs Added internal constant UnixDirectorySeparator (char '/') to represent the Unix directory separator.
Plugins/Flow.Launcher.Plugin.Explorer/.../Search/DirectoryInfo/DirectoryInfoSearch.cs Inserted code in TopLevelDirectorySearch to replace Unix directory separators with Windows directory separators.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller
    participant Search as TopLevelDirectorySearch Method
    participant Logic as Directory Search Logic

    Caller->>Search: Call TopLevelDirectorySearch(searchString)
    Note over Search: Convert Unix '/' to Windows '\\'
    Search->>Logic: Process standardized search path
    Logic-->>Search: Return search results
    Search-->>Caller: Return results
Loading

Suggested reviewers

  • jjw24

Poem

I’m just a happy rabbit, hopping along the code,
With new separators making each search method glow.
Unix to Windows, a simple, nifty twist,
Making directory paths hard to resist!
Hop, hop, hooray for changes we now ace! 🐰


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.

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: 0

🧹 Nitpick comments (1)
Plugins/Flow.Launcher.Plugin.Explorer/Search/DirectoryInfo/DirectoryInfoSearch.cs (1)

15-16: Consider adding null check for robustness.

The implementation looks good and directly addresses the Unix directory separator issue. However, consider adding a null check for additional robustness.

 internal static IEnumerable<SearchResult> TopLevelDirectorySearch(Query query, string search, CancellationToken token)
 {
+    if (string.IsNullOrEmpty(search))
+        return Enumerable.Empty<SearchResult>();
+
     // if user uses the unix directory separator, we need to convert it to windows directory separator
     search = search.Replace(Constants.UnixDirectorySeparator, Constants.DirectorySeparator);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 38eb07a and a3cc5e2.

📒 Files selected for processing (2)
  • Plugins/Flow.Launcher.Plugin.Explorer/Search/Constants.cs (1 hunks)
  • Plugins/Flow.Launcher.Plugin.Explorer/Search/DirectoryInfo/DirectoryInfoSearch.cs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
🔇 Additional comments (2)
Plugins/Flow.Launcher.Plugin.Explorer/Search/Constants.cs (1)

34-34: LGTM!

The new constant is well-named, follows the existing naming convention, and correctly represents the Unix directory separator.

Plugins/Flow.Launcher.Plugin.Explorer/Search/DirectoryInfo/DirectoryInfoSearch.cs (1)

13-29: Add unit tests to verify the directory separator handling.

To ensure the directory separator handling remains correct, consider adding unit tests that verify:

  1. Paths with Unix separators are correctly converted
  2. Paths with Windows separators remain unchanged
  3. Mixed separator paths are handled correctly
  4. Empty/null paths are handled gracefully

Would you like me to help generate the unit test cases?

@cibere
Copy link
Contributor

cibere commented Feb 7, 2025

@cibere Does this work for you?

It indeed works for me, however I'm still able to reproduce the second error I mentioned in the comments. However I'm still unsure how related the two errors are, and if it would be best to split them up

@Jack251970
Copy link
Member Author

@cibere Does this work for you?

It indeed works for me, however I'm still able to reproduce the second error I mentioned in the comments. However I'm still unsure how related the two errors are, and if it would be best to split them up

Sure this path c:\test\test is valid?

@cibere
Copy link
Contributor

cibere commented Feb 7, 2025

@cibere Does this work for you?

It indeed works for me, however I'm still able to reproduce the second error I mentioned in the comments. However I'm still unsure how related the two errors are, and if it would be best to split them up

Sure this path c:\test\test is valid?

It doesn't exist. However, I feel like flow should treat it the same way it does if you only use backslashes (which is to return no results instead of an error)

image
image

@Jack251970
Copy link
Member Author

@cibere Does this work for you?

It indeed works for me, however I'm still able to reproduce the second error I mentioned in the comments. However I'm still unsure how related the two errors are, and if it would be best to split them up

Sure this path c:\test\test is valid?

It doesn't exist. However, I feel like flow should treat it the same way it does if you only use backslashes (which is to return no results instead of an error)

image image

I see. I should handle this in a more external function. Now it works fine for me.

Copy link

github-actions bot commented Feb 7, 2025

@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

gitstream-cm bot commented Feb 7, 2025

🥷 Code experts: jjw24

Jack251970 has most 👩‍💻 activity in the files.
jjw24 has most 🧠 knowledge in the files.

See details

Plugins/Flow.Launcher.Plugin.Explorer/Search/Constants.cs

Activity based on git-commit:

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

Knowledge based on git-blame:
jjw24: 76%

Plugins/Flow.Launcher.Plugin.Explorer/Search/SearchManager.cs

Activity based on git-commit:

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

Knowledge based on git-blame:
jjw24: 20%

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

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: 0

🧹 Nitpick comments (1)
Plugins/Flow.Launcher.Plugin.Explorer/Search/SearchManager.cs (1)

190-192: LGTM! Consider enhancing the comment and adding validation.

The implementation correctly handles the conversion of forward slashes to backslashes. However, consider these improvements:

  1. Make the comment more descriptive:
-    // if user uses the unix directory separator, we need to convert it to windows directory separator
+    // Convert forward slashes to backslashes to handle mixed path formats (e.g., "C:\Test/Test")
+    // This ensures consistent path handling regardless of the separator style used
  1. Add validation to ensure it's a Windows path:
+    // Skip conversion for non-Windows paths (e.g., UNC paths)
+    if (!path.StartsWith("\\\\") && path.Length >= 2 && path[1] == ':') {
         path = path.Replace(Constants.UnixDirectorySeparator, Constants.DirectorySeparator);
+    }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a3cc5e2 and 5ee110b.

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

Copy link
Contributor

@cibere cibere left a comment

Choose a reason for hiding this comment

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

I can't reproduce either of the errors on this

@cibere cibere linked an issue Feb 7, 2025 that may be closed by this pull request
2 tasks
@Jack251970
Copy link
Member Author

@taooceros Ready to merge💪

@taooceros taooceros merged commit e463292 into Flow-Launcher:dev Feb 8, 2025
7 checks passed
@jjw24 jjw24 added this to the 1.20.0 milestone Feb 24, 2025
@jjw24 jjw24 added bug Something isn't working and removed bug Something isn't working labels Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BUG: Explorer Plugin: Error when query ends with a forward slash
4 participants