Skip to content

Conversation

@taooceros
Copy link
Member

@taooceros taooceros commented Jan 9, 2025

fix #3011

cc helmesjo

@prlabeler prlabeler bot added the bug Something isn't working label Jan 9, 2025
@taooceros taooceros marked this pull request as draft January 9, 2025 18:50
@gitstream-cm
Copy link

gitstream-cm bot commented Jan 9, 2025

🥷 Code experts: jjw24

jjw24 has most 🧠 knowledge in the files.

See details

Flow.Launcher.Infrastructure/Storage/JsonStorage.cs

Knowledge based on git-blame:
jjw24: 12%

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

@github-actions

This comment has been minimized.

@gitstream-cm
Copy link

gitstream-cm bot commented Jan 9, 2025

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

📝 Walkthrough

Walkthrough

The changes in the JsonStorage<T> class enhance file storage handling, particularly regarding symbolic links. A new constructor is introduced to validate the directory path, while the serialization methods are reformatted for improved clarity. Additionally, the AtomicWriteSetting method has been updated to check the LinkTarget of the file, refining the file replacement logic to accommodate various file system scenarios.

Changes

File Change Summary
Flow.Launcher.Infrastructure/Storage/JsonStorage.cs - Added constructor JsonStorage(string filePath)
- Reformatted serialization options in Save and SaveAsync methods
- Enhanced AtomicWriteSetting to handle symbolic link file paths

Suggested reviewers

  • jjw24

Poem

🐰 A rabbit's tale of storage bright,
Symbolic links now dance with might!
JsonStorage learns a clever trick,
To handle paths both smooth and slick.
Code hops along with newfound grace! 🔗


📜 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 a62b222 and 4b38e0e.

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

35-41: LGTM! Well-structured constructor with proper validation.

The constructor correctly validates the file path and directory path, with appropriate error handling.


183-185: LGTM! Clean formatting.


207-208: Consider atomic link resolution.

While the code now correctly handles symbolic links, there's a potential race condition between checking LinkTarget and calling File.Replace. The link target could change between these operations.

Consider this more atomic approach:

-                var finalFilePath = new FileInfo(FilePath).LinkTarget ?? FilePath;
-                File.Replace(TempFilePath, finalFilePath, BackupFilePath);
+                try
+                {
+                    File.Replace(TempFilePath, FilePath, BackupFilePath);
+                }
+                catch (IOException ex) when (ex.Message.Contains("symbolic link"))
+                {
+                    // If the initial replace fails due to symbolic link, try with the link target
+                    var finalFilePath = new FileInfo(FilePath).LinkTarget;
+                    if (finalFilePath != null)
+                        File.Replace(TempFilePath, finalFilePath, BackupFilePath);
+                    else
+                        throw; // Re-throw if we can't handle it
+                }
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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

🔭 Outside diff range comments (1)
Flow.Launcher.Infrastructure/Storage/JsonStorage.cs (1)

Add test coverage for JsonStorage class

The JsonStorage class lacks test coverage for critical functionality:

  • JSON file operations (read/write)
  • Backup and restore mechanisms
  • Atomic write operations
  • New symbolic link handling

Please add tests in Flow.Launcher.Test directory covering these scenarios to ensure reliability.

🔗 Analysis chain

Line range hint 34-211: Verify test coverage for symbolic link scenarios.

The changes handle symbolic links, but we should ensure proper test coverage exists.

Run this script to check for test coverage:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for test files and symbolic link test scenarios
echo "Searching for JsonStorage test files..."
rg -l "JsonStorage.*Test" 

echo "Checking for symbolic link test scenarios..."
rg -i "symlink|linktar?get" --type cs

Length of output: 390


Script:

#!/bin/bash
# Broader search for related test files
echo "Searching for storage/settings related test files..."
rg -l "Storage.*Test|Settings.*Test" --type cs

echo "Searching for file system test utilities..."
rg -l "TestFile|FileSystem.*Test|Mock.*File" --type cs

echo "Checking test directory structure..."
fd -t d "test|Test" 

Length of output: 442


Script:

#!/bin/bash
# Examine test directory content
echo "Listing test directory files..."
fd . Flow.Launcher.Test/ -t f -e cs

echo "Searching test files for relevant content..."
rg -l "JsonStorage|Infrastructure.*Test|Settings|Json.*Test" Flow.Launcher.Test/

echo "Searching for JSON deserialization test scenarios..."
rg -C2 "JsonSerializer|Deserialize|WriteAllText|ReadAllText" Flow.Launcher.Test/

Length of output: 1722

🧹 Nitpick comments (2)
Flow.Launcher.Infrastructure/Storage/JsonStorage.cs (2)

34-41: LGTM! Consider improving the error message.

The constructor properly validates the file path and directory. However, the error message could be more specific.

-            DirectoryPath = Path.GetDirectoryName(filePath) ?? throw new ArgumentException("Invalid file path");
+            DirectoryPath = Path.GetDirectoryName(filePath) ?? throw new ArgumentException("File path must include a valid directory", nameof(filePath));

Line range hint 200-211: Enhance symbolic link handling robustness.

While the changes correctly handle basic symbolic link scenarios, consider adding additional safeguards and logging.

     private void AtomicWriteSetting()
     {
         if (!File.Exists(FilePath))
         {
             File.Move(TempFilePath, FilePath);
         }
         else
         {
-            var finalFilePath = new FileInfo(FilePath).LinkTarget ?? FilePath;
+            var fileInfo = new FileInfo(FilePath);
+            var finalFilePath = fileInfo.LinkTarget ?? FilePath;
+            
+            if (fileInfo.LinkTarget != null)
+            {
+                Log.Debug($"Resolving symbolic link: {FilePath} -> {finalFilePath}");
+                
+                if (!File.Exists(finalFilePath))
+                    throw new FileNotFoundException($"Symbolic link target not found: {finalFilePath}");
+            }
+            
             File.Replace(TempFilePath, finalFilePath, BackupFilePath);
         }
     }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7cccbb0 and a62b222.

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

184-190: LGTM! The Save method looks good.

The serialization options are properly configured, and the method correctly uses atomic write operations.

@github-actions
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
❌ 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.

@taooceros taooceros marked this pull request as ready for review February 23, 2025 13:57
@VictoriousRaptor VictoriousRaptor merged commit 3573580 into dev Feb 24, 2025
13 checks passed
@VictoriousRaptor VictoriousRaptor deleted the symlink branch February 24, 2025 01:21
@jjw24 jjw24 removed the 1 min review label Mar 4, 2025
@jjw24 jjw24 added this to the 1.20.0 milestone Mar 4, 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: application does not support the current operation on symbolic links

5 participants