Skip to content

Conversation

Jack251970
Copy link
Member

@Jack251970 Jack251970 commented Apr 11, 2025

Check directory before saving storage to fix System.IO.DirectoryNotFoundException: Could not find a part of the path.
Add old constructor for old Program plugin.

Fix #3451.

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

gitstream-cm bot commented Apr 11, 2025

🚨 Warning: Approaching Monthly Automation Limit

Monthly PRs automated: 233/250

Your organization has used over 90% of its monthly quota for gitStream automations. Once the quota is reached, new pull requests for this month will not trigger gitStream automations and will be marked as “Skipped”.

To avoid interruptions, consider optimizing your automation usage or upgrading your plan by contacting LinearB.

@Jack251970 Jack251970 added this to the 1.20.0 milestone Apr 11, 2025
@Jack251970 Jack251970 requested a review from onesounds April 11, 2025 08:49
@Jack251970 Jack251970 enabled auto-merge April 11, 2025 08:49
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.

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (3)

Flow.Launcher.Infrastructure/Storage/JsonStorage.cs:187

  • Confirm that FilesFolders.ValidateDirectory creates the directory if it does not exist; otherwise, File.WriteAllText might still fail if the directory is missing.
FilesFolders.ValidateDirectory(DirectoryPath);

Flow.Launcher.Infrastructure/Storage/BinaryStorage.cs:86

  • Ensure that ValidateDirectory creates the directory as needed to avoid potential issues when File.WriteAllBytes is called.
FilesFolders.ValidateDirectory(DirectoryPath);

Flow.Launcher.Infrastructure/Storage/BinaryStorage.cs:109

  • Verify that ValidateDirectory creates the directory; otherwise, FileStream creation in SaveAsync could fail if the directory does not exist.
FilesFolders.ValidateDirectory(DirectoryPath);

This comment has been minimized.

Copy link

gitstream-cm bot commented Apr 11, 2025

🥷 Code experts: no user but you matched threshold 10

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

See details

Flow.Launcher.Infrastructure/Storage/BinaryStorage.cs

Activity based on git-commit:

Jack251970
APR 64 additions & 28 deletions
MAR
FEB 9 additions & 16 deletions
JAN
DEC
NOV

Knowledge based on git-blame:
Jack251970: 51%

Flow.Launcher.Infrastructure/Storage/JsonStorage.cs

Activity based on git-commit:

Jack251970
APR 7 additions & 4 deletions
MAR
FEB 1 additions & 1 deletions
JAN
DEC
NOV

Knowledge based on git-blame:
Jack251970: 4%

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

Copy link

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

Look good to me.

Copy link
Contributor

coderabbitai bot commented Apr 11, 2025

📝 Walkthrough

Walkthrough

The pull request enhances the robustness of file operations by introducing directory validation in the storage classes. Both the BinaryStorage<T> and the JsonStorage<T> classes now perform a check to ensure the directory exists before proceeding with serialization and data writing. The change affects both synchronous and asynchronous save methods, including a new obsolete constructor for BinaryStorage<T> to specify a custom directory path.

Changes

Files Change Summary
Flow.Launcher.Infrastructure/Storage/BinaryStorage.cs Added a new constructor for BinaryStorage<T> that allows specifying a custom directory path, marked as obsolete. Added directory validation in Save and SaveAsync methods.
Flow.Launcher.Infrastructure/Storage/JsonStorage.cs Added directory validation in Save and SaveAsync methods to ensure the directory exists before saving data.

Sequence Diagram(s)

sequenceDiagram
    participant C as Caller
    participant S as Storage (Binary/Json)
    participant D as FilesFolders
    participant F as File System

    C->>S: Save(Data)
    S->>D: ValidateDirectory(DirectoryPath)
    D-->>S: Directory exists
    S->>F: Serialize & Write Data
    F-->>S: Write Confirmation
    S-->>C: Return Confirmation
Loading

Assessment against linked issues

Objective Addressed Explanation
Ensure directory existence before saving data (#3451)

Poem

I'm a hopping rabbit, swift and spry,
Ensuring directories exist before we try.
With a hop and a skip, I check the path,
Saving data safely to avoid any wrath.
CodeRabbit's fixes make our system sing,
A joyful leap into a bug-free spring! 🐰🎶


📜 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 5c43dd4 and e6377d0.

📒 Files selected for processing (1)
  • Flow.Launcher.Infrastructure/Storage/BinaryStorage.cs (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: gitStream workflow automation
  • GitHub Check: gitStream.cm
  • GitHub Check: gitStream.cm
🔇 Additional comments (3)
Flow.Launcher.Infrastructure/Storage/BinaryStorage.cs (3)

44-52: New constructor provides backward compatibility while guiding future usage.

The new constructor is appropriately marked as obsolete to discourage new usages while still supporting existing code. Good implementation of the null-coalescing operator to handle the default directory path and ensuring directory validation before file path construction.


96-97: Good defensive programming to prevent DirectoryNotFoundException.

Adding directory validation before saving is an excellent defensive programming practice that directly addresses the issue in the PR objectives. This prevents failures when users might have deleted the directory between operations.


119-121: Consistent implementation in async method.

The same directory validation has been correctly applied to the async version of the save method, ensuring consistent behavior across both synchronous and asynchronous operations.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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

@check-spelling-bot Report

🔴 Please review

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

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

@Jack251970 Jack251970 added Dev branch only An issue or fix for the Dev branch build and removed bug Something isn't working labels Apr 11, 2025
@Jack251970 Jack251970 merged commit 578079c into dev Apr 11, 2025
15 checks passed
@Jack251970 Jack251970 deleted the json_save_directory_issue branch April 11, 2025 10: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.

BUG: Program Plugin Save Issue with build 10765 When Exiting

2 participants