Skip to content

Fix clean cache issue #3499

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 4 commits into from
Apr 30, 2025
Merged

Fix clean cache issue #3499

merged 4 commits into from
Apr 30, 2025

Conversation

Jack251970
Copy link
Contributor

@Jack251970 Jack251970 commented Apr 30, 2025

Follow on with #3411.

  • We should firstly delete plugin cache directories and then delete plugin directory, or the settings page will freeze.
  • Reverted original changes to set recursive to true.

Test

  • Clean logs & clean caches option can work.

@Jack251970 Jack251970 requested a review from Copilot April 30, 2025 11:24
@prlabeler prlabeler bot added the bug Something isn't working label Apr 30, 2025
Copy link

gitstream-cm bot commented Apr 30, 2025

🚨 gitStream Monthly Automation Limit Reached 🚨

Your organization has exceeded the number of pull requests allowed for automation with gitStream.
Monthly PRs automated: 270/250

To continue automating your PR workflows and unlock additional features, please contact LinearB.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes the cache clean-up issue by ensuring that plugin cache directories are deleted before the plugin directory is removed, preventing the settings page from freezing.

  • Deletes plugin cache directories before deleting the overall plugin directory
  • Adds a new helper method GetPluginCacheDir for clarity and separation of concerns

@Jack251970 Jack251970 requested a review from taooceros April 30, 2025 11:25
@Jack251970 Jack251970 enabled auto-merge April 30, 2025 11:25

This comment has been minimized.

Copy link

gitstream-cm bot commented Apr 30, 2025

🥷 Code experts: Yusyuriv, onesounds

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

See details

Flow.Launcher/SettingPages/ViewModels/SettingsPaneAboutViewModel.cs

Activity based on git-commit:

Jack251970 onesounds
APR 144 additions & 64 deletions 49 additions & 0 deletions
MAR 27 additions & 2 deletions
FEB 7 additions & 8 deletions
JAN 2 additions & 2 deletions
DEC
NOV 2 additions & 3 deletions

Knowledge based on git-blame:
Jack251970: 53%
Yusyuriv: 39%

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

Copy link

gitstream-cm bot commented Apr 30, 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 Apr 30, 2025

📝 Walkthrough

Walkthrough

The changes update the cache clearing logic in the SettingsPaneAboutViewModel class. The ClearCacheFolder method now deletes all subdirectories within the plugin cache directory recursively before attempting to delete the plugin cache directory itself non-recursively, with error handling and logging. The deletion of subdirectories in the main cache directory was removed. The ClearLogFolder method was adjusted to delete log directories non-recursively. A new private static method, GetPluginCacheDir, was introduced to provide the plugin cache directory reference. Comments were added to clarify the intent behind directory deletions.

Changes

File(s) Change Summary
Flow.Launcher/SettingPages/ViewModels/SettingsPaneAboutViewModel.cs Modified ClearCacheFolder to delete plugin cache subdirectories recursively and plugin cache directory non-recursively with error handling; changed ClearLogFolder to non-recursive deletion; added private static GetPluginCacheDir method; added clarifying comments.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SettingsPaneAboutViewModel
    participant FileSystem

    User->>SettingsPaneAboutViewModel: Trigger ClearCacheFolder()
    SettingsPaneAboutViewModel->>FileSystem: Enumerate plugin cache subdirectories
    loop For each plugin cache subdirectory
        SettingsPaneAboutViewModel->>FileSystem: Delete subdirectory recursively (handle exceptions)
    end
    SettingsPaneAboutViewModel->>FileSystem: Delete plugin cache directory non-recursively (handle exceptions)
Loading

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • taooceros
  • onesounds

Poem

In cache and log, the bunnies leap,
Sweeping out what we don’t keep.
Plugin crumbs and folders old,
Hopped away, so clean and bold!
With every sweep, the system cheers,
A tidy warren, free of fears.
🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7762c79 and 541e198.

📒 Files selected for processing (1)
  • Flow.Launcher/SettingPages/ViewModels/SettingsPaneAboutViewModel.cs (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Flow.Launcher/SettingPages/ViewModels/SettingsPaneAboutViewModel.cs
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: gitStream.cm
  • GitHub Check: build
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

jjw24
jjw24 previously approved these changes Apr 30, 2025

This comment has been minimized.

// Make sure directory clean
dir.Delete(true);
// Log folders are the last level of folders
dir.Delete(false);
Copy link
Member

Choose a reason for hiding this comment

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

can you show the parameter name so we know what option is set to false.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

okay

try
{
// Log folders are the last level of folders
GetPluginCacheDir().Delete(false);
Copy link
Member

Choose a reason for hiding this comment

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

same here please

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

♻️ Duplicate comments (1)
Flow.Launcher/SettingPages/ViewModels/SettingsPaneAboutViewModel.cs (1)

235-261: Consider refactoring repeated try-catch blocks for directory deletion.

There are multiple similar try-catch blocks for directory deletion throughout the code that could be refactored into a helper method.

You could create a helper method like:

private bool TryDeleteDirectory(DirectoryInfo directory, bool recursive)
{
    try
    {
        directory.Delete(recursive);
        return true;
    }
    catch (Exception e)
    {
        App.API.LogException(ClassName, $"Failed to delete directory: {directory.Name}", e);
        return false;
    }
}

This would simplify your deletion logic and reduce code duplication.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a964150 and c9e85a1.

📒 Files selected for processing (1)
  • Flow.Launcher/SettingPages/ViewModels/SettingsPaneAboutViewModel.cs (5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: gitStream workflow automation
  • GitHub Check: build
🔇 Additional comments (4)
Flow.Launcher/SettingPages/ViewModels/SettingsPaneAboutViewModel.cs (4)

189-190: Appropriate change to non-recursive deletion for log folders.

The comment and change to dir.Delete(false) makes sense since log folders are leaf nodes in the directory structure, so there's no need for recursive deletion.


218-218: Good addition of plugin cache directory reference.

The introduction of a dedicated variable for the plugin cache directory improves readability and provides a clear separation between the main cache and plugin cache operations.


234-249: Good implementation of recursive deletion for plugin cache subdirectories.

This change correctly implements the first step in the deletion process as mentioned in the PR description - deleting plugin subdirectories recursively. The comment explains the rationale clearly.


273-276: Good addition of the GetPluginCacheDir method.

The new method follows the same pattern as other directory accessor methods and provides a clean way to access the plugin cache directory.

@Jack251970 Jack251970 requested a review from jjw24 April 30, 2025 11:38

This comment has been minimized.

@prlabeler prlabeler bot added the bug Something isn't working label Apr 30, 2025
@Jack251970 Jack251970 removed the bug Something isn't working label Apr 30, 2025
Copy link

@check-spelling-bot Report

🔴 Please review

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

❌ Errors and Warnings Count
❌ forbidden-pattern 22
⚠️ 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.

@prlabeler prlabeler bot added the bug Something isn't working label Apr 30, 2025
@Jack251970 Jack251970 removed the bug Something isn't working label Apr 30, 2025
@Jack251970 Jack251970 merged commit 950a7f5 into dev Apr 30, 2025
11 checks passed
@Jack251970 Jack251970 deleted the clear_cache_freeze_page branch April 30, 2025 11:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dev branch only An issue or fix for the Dev branch build
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants