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

Not found paths in prefix fs always treated as dir #2002

Merged
merged 6 commits into from
Feb 22, 2025

Conversation

esimkowitz
Copy link
Member

@esimkowitz esimkowitz commented Feb 20, 2025

Gracefully handle prefix paths that don't exist, representing them as directories so they can be escaped from.

Also removes the ".." file info from the backend, instead only creating it on the frontend

Copy link
Contributor

coderabbitai bot commented Feb 20, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces changes to the handling of non-existent objects and empty directories across various file system implementations. In the S3 file system, the ReadStream method is modified to return a parent directory entry when a requested object is not found, while the Stat method updates the IsDir field to true in such cases. The Wave file system's Read method is enhanced to return a FileData object indicating that a directory exists but contains no entries if the list of entries is empty. Additionally, the DirectoryPreview component in the frontend has been optimized by removing a state variable and refactoring the data-fetching logic. The OpenFileModal component has been removed from the PreviewView, streamlining the file opening process. Lastly, a block of code that retrieved parent directory information has been removed from the remoteStreamFileDir method in the ServerImpl struct, affecting directory listing responses.


📜 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 8fc10d9 and 7aef341.

📒 Files selected for processing (1)
  • frontend/app/view/preview/directorypreview.tsx (1 hunks)

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)
pkg/remote/fileshare/wavefs/wavefs.go (1)

108-129: LGTM! The changes align well with the PR objective.

The implementation correctly handles non-existent paths by representing them as empty directories, including a parent directory entry. This provides a consistent interface for directory navigation.

Consider extracting the parent directory entry creation into a helper function since this pattern might be reused elsewhere:

+func createParentDirEntry(dirPath string) *wshrpc.FileInfo {
+    return &wshrpc.FileInfo{
+        Path:     dirPath,
+        Dir:      fspath.Dir(dirPath),
+        Name:     "..",
+        IsDir:    true,
+        Size:     0,
+        ModTime:  time.Now().Unix(),
+        MimeType: "directory",
+    }
+}

 if len(list) == 0 {
     dirPath := fspath.Dir(fileName)
     return &wshrpc.FileData{
         Info: &wshrpc.FileInfo{
             Name:     fspath.Base(fileName),
             Path:     fileName,
             Dir:      fspath.Dir(fileName),
             NotFound: true,
             IsDir:    true,
         },
-        Entries: []*wshrpc.FileInfo{
-            {
-                Path:     dirPath,
-                Dir:      fspath.Dir(dirPath),
-                Name:     "..",
-                IsDir:    true,
-                Size:     0,
-                ModTime:  time.Now().Unix(),
-                MimeType: "directory",
-            },
-        }}, nil
+        Entries: []*wshrpc.FileInfo{createParentDirEntry(dirPath)}}, nil
pkg/remote/fileshare/s3fs/s3fs.go (1)

65-78: LGTM! Consistent implementation with wavefs.

The changes handle non-existent paths similarly to wavefs, maintaining consistency across different file system implementations.

Consider using the same helper function suggested for wavefs to maintain consistency:

+func createParentDirEntry(dirPath string) *wshrpc.FileInfo {
+    return &wshrpc.FileInfo{
+        Path:     dirPath,
+        Dir:      fspath.Dir(dirPath),
+        Name:     "..",
+        IsDir:    true,
+        Size:     0,
+        ModTime:  time.Now().Unix(),
+        MimeType: "directory",
+    }
+}

 if finfo.NotFound {
-    rtn <- wshrpc.RespOrErrorUnion[wshrpc.FileData]{Response: wshrpc.FileData{Entries: []*wshrpc.FileInfo{
-        {
-            Path:     finfo.Dir,
-            Dir:      fspath.Dir(finfo.Dir),
-            Name:     "..",
-            IsDir:    true,
-            Size:     0,
-            ModTime:  time.Now().Unix(),
-            MimeType: "directory",
-        },
-    }}}
+    rtn <- wshrpc.RespOrErrorUnion[wshrpc.FileData]{Response: wshrpc.FileData{Entries: []*wshrpc.FileInfo{createParentDirEntry(finfo.Dir)}}}
     return
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b0e3b6d and fcb7757.

📒 Files selected for processing (2)
  • pkg/remote/fileshare/s3fs/s3fs.go (2 hunks)
  • pkg/remote/fileshare/wavefs/wavefs.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Build for TestDriver.ai
  • GitHub Check: Analyze (go)
🔇 Additional comments (1)
pkg/remote/fileshare/s3fs/s3fs.go (1)

592-592: LGTM! Consistent with PR objective.

Setting IsDir to true for non-existent paths ensures consistent behavior with the ReadStream changes and aligns with the PR's goal of treating non-existent paths as directories.

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)
frontend/app/view/preview/preview.tsx (1)

1080-1085: Consider removing the debug log statement.

The console log statement appears to be for debugging purposes and should be removed before merging to production.

-        console.log("fileInfo or connection changed", fileInfo, connection);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fcb7757 and dd7c57d.

📒 Files selected for processing (5)
  • frontend/app/view/preview/directorypreview.tsx (1 hunks)
  • frontend/app/view/preview/preview.tsx (3 hunks)
  • pkg/remote/fileshare/s3fs/s3fs.go (2 hunks)
  • pkg/remote/fileshare/wavefs/wavefs.go (1 hunks)
  • pkg/wshrpc/wshremote/wshremote.go (0 hunks)
💤 Files with no reviewable changes (1)
  • pkg/wshrpc/wshremote/wshremote.go
🚧 Files skipped from review as they are similar to previous changes (1)
  • pkg/remote/fileshare/s3fs/s3fs.go
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Analyze (go)
  • GitHub Check: Build for TestDriver.ai
🔇 Additional comments (3)
pkg/remote/fileshare/wavefs/wavefs.go (1)

108-117: LGTM! The changes improve the handling of non-existent paths.

The implementation correctly represents non-existent paths as directories by returning a FileData object with appropriate flags (NotFound and IsDir set to true). This enhancement allows for better management and escaping of such paths.

frontend/app/view/preview/directorypreview.tsx (2)

778-812: LGTM! The data fetching logic is well-implemented.

The changes improve the directory content fetching by:

  • Using fireAndForget for clean async operation handling
  • Ensuring the parent directory ("..") is always included in the displayed data
  • Properly handling and displaying errors to the user

814-827: LGTM! The filtering logic is optimized.

The changes improve performance by:

  • Moving filtering logic into a useMemo hook
  • Eliminating unnecessary state management
  • Maintaining the same filtering functionality (hidden files and search)

@esimkowitz esimkowitz merged commit d51ff87 into main Feb 22, 2025
5 of 7 checks passed
@esimkowitz esimkowitz deleted the evan/prefix-not-found branch February 22, 2025 00:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant