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

Improve uninstaller check function #3197

Merged
merged 3 commits into from
Jan 25, 2025

Conversation

Jack251970
Copy link
Contributor

Improve uninstaller check function

This comment has been minimized.

Copy link

gitstream-cm bot commented Jan 24, 2025

🥷 Code experts: no user matched threshold 10

VictoriousRaptor, jjw24 have most 🧠 knowledge in the files.

See details

Plugins/Flow.Launcher.Plugin.Program/Main.cs

Knowledge based on git-blame:
VictoriousRaptor: 18%
jjw24: 12%

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

Copy link

gitstream-cm bot commented Jan 24, 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 Jan 24, 2025

📝 Walkthrough

Walkthrough

The pull request enhances the uninstaller detection mechanism in the Flow Launcher Program Plugin. The changes introduce a more comprehensive approach to identifying uninstallers by expanding the filtering logic to support multiple languages and file types. The modifications include adding new static arrays for uninstaller prefixes, updating the suffix naming, and implementing a more robust checking mechanism for both executable and link files.

Changes

File Change Summary
Plugins/Flow.Launcher.Plugin.Program/Main.cs - Added commonUninstallerPrefixs static array for multilingual uninstaller prefix support
- Renamed CommonUninstallerSuffix to ExeUninstallerSuffix
- Added InkUninstallerSuffix
- Enhanced HideUninstallersFilter method with more comprehensive filtering logic

Possibly related PRs

Suggested labels

Dev branch only

Poem

🐰 Uninstallers, oh uninstallers so sly,
With prefixes dancing from language to sky,
No longer shall you hide in plain sight,
Flow Launcher's new logic brings filtering delight!
A rabbit's code, precise and bright! 🔍


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 (2)
Plugins/Flow.Launcher.Plugin.Program/Main.cs (2)

72-73: Clarify “Ink” vs. “Lnk.”
InkUninstallerSuffix is set to .lnk. This might be confusing. If it represents the Windows shortcut extension, consider renaming the constant to LnkUninstallerSuffix for clarity.


127-137: Consolidate uninstaller name checks.
The logic is clear and understandable. However, the checks for uninstaller prefixes (StartsWith + EndsWith) could benefit from a small helper method to avoid repetition, enhance clarity, and reduce potential errors if this logic must be updated later.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0b8db59 and 71dad9f.

📒 Files selected for processing (1)
  • Plugins/Flow.Launcher.Plugin.Program/Main.cs (2 hunks)
🧰 Additional context used
🪛 GitHub Check: Check Spelling
Plugins/Flow.Launcher.Plugin.Program/Main.cs

[notice] 51-51:
Line matches candidate pattern [a-zA-Z]*[ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź][a-zA-Z]{3}[a-zA-ZÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź]* (candidate-pattern)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: gitStream.cm
🔇 Additional comments (3)
Plugins/Flow.Launcher.Plugin.Program/Main.cs (3)

44-71: Use correct English plural and verify translations.
The field name commonUninstallerPrefixs is misspelled; consider renaming it to commonUninstallerPrefixes. Also, ensure that each localized prefix is accurately spelled and that language-specific characters are properly supported in file system operations.

🧰 Tools
🪛 GitHub Check: Check Spelling

[notice] 51-51:
Line matches candidate pattern [a-zA-Z]*[ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź][a-zA-Z]{3}[a-zA-ZÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź]* (candidate-pattern)


139-150: Verify .lnk filename vs. resolved path usage.
The code checks the .lnk filename itself rather than the target of win32.LnkResolvedPath. If the intention is to hide uninstallers that are references to an EXE, you may need to check the resolved path’s filename. Otherwise, this logic is correct if you're strictly matching the .lnk file’s own name.


152-152: Looks good.
Returning true at the end ensures all non-matching items are displayed. No concerns here.

Copy link

@check-spelling-bot Report

🔴 Please review

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

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

See ❌ Event descriptions for more information.

Pattern suggestions ✂️ (1)

You could add these patterns to .github/actions/spelling/patterns.txt:

# Automatically suggested patterns

# hit-count: 3 file-count: 1
# Non-English
[a-zA-Z]*[ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź][a-zA-Z]{3}[a-zA-ZÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź]*

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

🧹 Nitpick comments (2)
Plugins/Flow.Launcher.Plugin.Program/Main.cs (2)

44-71: Fix spelling in array name and standardize language codes in comments.

The array name has a spelling error and the language codes in comments could be more consistent.

Apply this diff to fix the spelling and standardize comments:

-        private static readonly string[] commonUninstallerPrefixs =
+        private static readonly string[] commonUninstallerPrefixes =
         {
-            "uninstall",//en
-            "卸载",//zh-cn
-            "卸載",//zh-tw
-            "видалити",//uk-UA
-            "удалить",//ru
-            "désinstaller",//fr
-            "アンインストール",//ja
-            "deïnstalleren",//nl
-            "odinstaluj",//pl
-            "afinstallere",//da
-            "deinstallieren",//de
-            "삭제",//ko
-            "деинсталирај",//sr
-            "desinstalar",//pt-pt
-            "desinstalar",//pt-br
-            "desinstalar",//es
-            "desinstalar",//es-419
-            "disinstallare",//it
-            "avinstallere",//nb-NO
-            "odinštalovať",//sk
-            "kaldır",//tr
-            "odinstalovat",//cs
-            "إلغاء التثبيت",//ar
-            "gỡ bỏ",//vi-vn
-            "הסרה"//he
+            "uninstall",     // en-US
+            "卸载",          // zh-CN
+            "卸載",          // zh-TW
+            "видалити",      // uk-UA
+            "удалить",       // ru-RU
+            "désinstaller",  // fr-FR
+            "アンインストール", // ja-JP
+            "deïnstalleren", // nl-NL
+            "odinstaluj",    // pl-PL
+            "afinstallere",  // da-DK
+            "deinstallieren",// de-DE
+            "삭제",          // ko-KR
+            "деинсталирај",  // sr-RS
+            "desinstalar",   // pt-PT
+            "desinstalar",   // pt-BR
+            "desinstalar",   // es-ES
+            "desinstalar",   // es-419
+            "disinstallare", // it-IT
+            "avinstallere",  // nb-NO
+            "odinštalovať",  // sk-SK
+            "kaldır",        // tr-TR
+            "odinstalovat",  // cs-CZ
+            "إلغاء التثبيت", // ar-SA
+            "gỡ bỏ",         // vi-VN
+            "הסרה"          // he-IL
         };

Consider adding support for additional languages like Swedish (sv-SE), Finnish (fi-FI), and Hungarian (hu-HU) to improve coverage.

🧰 Tools
🪛 GitHub Check: Check Spelling

[notice] 51-51:
Line matches candidate pattern [a-zA-Z]*[ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź][a-zA-Z]{3}[a-zA-ZÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź]* (candidate-pattern)


126-152: Improve method organization and performance.

The method could benefit from better organization and performance optimizations:

  1. Split into smaller methods for better maintainability
  2. Use HashSet for faster lookups
  3. Add null check for ExecutablePath

Consider refactoring to:

         private bool HideUninstallersFilter(IProgram program)
         {
             if (!_settings.HideUninstallers) return true;
             if (program is not Win32 win32) return true;
+            if (string.IsNullOrEmpty(win32.ExecutablePath)) return true;
 
-            // First check the executable path
-            var fileName = Path.GetFileName(win32.ExecutablePath);
-            // For cases when the uninstaller is named like "uninst.exe"
-            if (commonUninstallerNames.Contains(fileName, StringComparer.OrdinalIgnoreCase)) return false;
-            // For cases when the uninstaller is named like "Uninstall Program Name.exe"
-            foreach (var prefix in commonUninstallerPrefixs)
-            {
-                if (fileName.StartsWith(prefix, StringComparison.OrdinalIgnoreCase) &&
-                    fileName.EndsWith(ExeUninstallerSuffix, StringComparison.OrdinalIgnoreCase))
-                    return false;
-            }
+            if (IsUninstallerExecutable(win32.ExecutablePath)) return false;
+            if (IsUninstallerShortcut(win32.LnkResolvedPath, win32.FullPath)) return false;
 
-            // Second check the lnk path
-            if (!string.IsNullOrEmpty(win32.LnkResolvedPath))
+            return true;
+        }
+
+        private static readonly HashSet<string> _commonUninstallerNames = 
+            new(commonUninstallerNames, StringComparer.OrdinalIgnoreCase);
+
+        private bool IsUninstallerExecutable(string executablePath)
+        {
+            var fileName = Path.GetFileName(executablePath);
+            
+            // Check for exact matches like "uninst.exe"
+            if (_commonUninstallerNames.Contains(fileName))
+                return true;
+
+            // Check for prefixed names like "Uninstall Program Name.exe"
+            return commonUninstallerPrefixes.Any(prefix =>
+                fileName.StartsWith(prefix, StringComparison.OrdinalIgnoreCase) &&
+                fileName.EndsWith(ExeUninstallerSuffix, StringComparison.OrdinalIgnoreCase));
+        }
+
+        private bool IsUninstallerShortcut(string resolvedPath, string fullPath)
+        {
+            if (string.IsNullOrEmpty(resolvedPath))
+                return false;
+
+            var shortcutName = Path.GetFileName(fullPath);
+            return commonUninstallerPrefixes.Any(prefix =>
+                shortcutName.StartsWith(prefix, StringComparison.OrdinalIgnoreCase) &&
+                shortcutName.EndsWith(InkUninstallerSuffix, StringComparison.OrdinalIgnoreCase));
+        }

This refactoring:

  1. Improves readability by extracting logic into well-named methods
  2. Uses HashSet for O(1) lookups of exact matches
  3. Adds null check for ExecutablePath
  4. Uses LINQ for more concise prefix checking
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 71dad9f and 0c7dc07.

📒 Files selected for processing (1)
  • Plugins/Flow.Launcher.Plugin.Program/Main.cs (2 hunks)
🧰 Additional context used
🪛 GitHub Check: Check Spelling
Plugins/Flow.Launcher.Plugin.Program/Main.cs

[notice] 51-51:
Line matches candidate pattern [a-zA-Z]*[ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź][a-zA-Z]{3}[a-zA-ZÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź]* (candidate-pattern)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm

@jjw24 jjw24 added bug Something isn't working and removed 1 min review labels Jan 25, 2025
@jjw24 jjw24 added this to the 1.20.0 milestone Jan 25, 2025
@jjw24 jjw24 enabled auto-merge January 25, 2025 22:38
@jjw24 jjw24 merged commit a0c915e into Flow-Launcher:dev Jan 25, 2025
7 checks passed
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.

2 participants