Skip to content

feat: support access function for custom fs provider#4496

Merged
hacke2 merged 2 commits intomainfrom
fix/support-access-function-for-custom-fs
Mar 25, 2025
Merged

feat: support access function for custom fs provider#4496
hacke2 merged 2 commits intomainfrom
fix/support-access-function-for-custom-fs

Conversation

@erha19
Copy link
Copy Markdown
Member

@erha19 erha19 commented Mar 25, 2025

Types

  • 🐛 Bug Fixes

Background or solution

当采用插件进程提供的 vscode.FileSystem 时,在 mode === FileAccess.Constants.F_OK 情况下使用等价的 stat 判断文件是否存在

Changelog

support access function for custom fs provider

Summary by CodeRabbit

  • Bug Fixes

    • 改进了文件访问检查逻辑:在检测文件存在性时,如果常规方法不可用,将自动采用备用检测方式,从而更可靠地判断文件是否存在,并避免不必要的错误。
  • 新特性

    • 增强了文件树组件的响应能力:在组件准备就绪时,初始化文件树服务的上下文键,以改善组件与服务之间的交互。

@erha19
Copy link
Copy Markdown
Member Author

erha19 commented Mar 25, 2025

/next

@opensumi opensumi Bot added the 🎨 feature feature required label Mar 25, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 25, 2025

Walkthrough

修改引入了对 FileServiceClient 类中 access 方法的新逻辑。当 mode 参数为 FileAccess.Constants.F_OK 时,如果提供者不支持 access 方法,则改为调用提供者的 stat 方法来检测文件是否存在。此过程中使用了 try-catch 语句处理可能出现的错误,成功调用时返回 true,失败时返回 false。其他模式下仍保持原有抛出错误的逻辑不变。同时,FileTree 组件的 useEffect 钩子中增加了对 wrapperRef.current 的检查,以便在组件准备就绪时初始化文件树服务的上下文键。

Changes

文件 更改说明
packages/.../file-service-client.ts access 方法中增加条件:当 mode 为 F_OK 且 provider 不支持 access 方法时,通过调用 stat 方法检测文件存在性,并使用 try-catch 处理错误。
packages/.../file-tree.tsx useEffect 钩子中增加条件判断,检查 wrapperRef.current 是否已定义,并在 isReady 为 true 时调用 fileTreeService.initContextKey 方法,更新依赖数组以包含 wrapperRef.currentfileTreeService

Sequence Diagram(s)

sequenceDiagram
    participant C as 客户端
    participant F as FileServiceClient
    participant P as Provider

    C->>F: 调用 access(uri, F_OK)
    F->>P: 检查是否支持 access 方法?
    alt 支持 access
        F->>P: 调用 access(uri, F_OK)
        P->>F: 返回结果
    else 不支持 access
        F->>P: 尝试调用 stat(uri)
        alt stat 调用成功
            P->>F: 返回文件状态
            F->>C: 返回 true
        else 发生错误
            P->>F: 返回错误信息
            F->>C: 返回 false
        end
    end
Loading

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

yarn install v1.22.22
[1/4] Resolving packages...
warning eslint@8.57.1: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning eslint > @humanwhocodes/config-array@0.13.0: Use @eslint/config-array instead
warning eslint > @humanwhocodes/config-array > @humanwhocodes/object-schema@2.0.3: Use @eslint/object-schema instead
warning eslint > file-entry-cache > flat-cache > rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob@7.2.3: Glob versions prior to v9 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob > inflight@1.0.6: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning eslint-import-resolver-typescript > glob@7.2.3: Glob versions prior to v9 are no longer supported
error Couldn't find any versions for "@opensumi/ide-dev-tool" that matches "workspace:*"
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.


📜 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 e9e2b31 and 4c4f5fb.

📒 Files selected for processing (1)
  • packages/file-tree-next/src/browser/file-tree.tsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: 🚀🚀🚀 Next Version for pull request
  • GitHub Check: unittest (ubuntu-latest, 18.x, node)
  • GitHub Check: unittest (macos-latest, 18.x, node)
  • GitHub Check: build (macos-latest, 20.x)
  • GitHub Check: unittest (ubuntu-latest, 18.x, jsdom)
  • GitHub Check: build-windows
  • GitHub Check: build (ubuntu-latest, 20.x)
  • GitHub Check: ubuntu-latest, Node.js 20.x
  • GitHub Check: unittest (macos-latest, 18.x, jsdom)
🔇 Additional comments (2)
packages/file-tree-next/src/browser/file-tree.tsx (2)

149-152: 确保模型变更后正确初始化上下文键

这个条件块确保了在文件树模型发生变化后,如果 wrapperRef.current 存在,则初始化上下文键。这是一个良好的安全检查,可以确保在模型更新时上下文键的持续有效性。这也与 ensureIsReady 函数中的类似逻辑保持一致。


158-158: 依赖数组更新合理

wrapperRef.currentfileTreeService 添加到依赖数组中是正确的,确保了当这些依赖项发生变化时 useEffect 会重新执行。这样可以确保当包装器引用或文件树服务更新时,上下文键能够正确重新初始化。

✨ 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.

@opensumi
Copy link
Copy Markdown
Contributor

opensumi Bot commented Mar 25, 2025

🎉 PR Next publish successful!

3.8.3-next-1742885210.0

@erha19
Copy link
Copy Markdown
Member Author

erha19 commented Mar 25, 2025

/next

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 25, 2025

Codecov Report

Attention: Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.

Project coverage is 53.12%. Comparing base (32faed7) to head (4c4f5fb).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
...es/file-service/src/browser/file-service-client.ts 0.00% 4 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4496      +/-   ##
==========================================
- Coverage   53.13%   53.12%   -0.01%     
==========================================
  Files        1665     1665              
  Lines      102640   102645       +5     
  Branches    22215    22216       +1     
==========================================
- Hits        54535    54534       -1     
- Misses      40019    40024       +5     
- Partials     8086     8087       +1     
Flag Coverage Δ
jsdom 48.62% <0.00%> (-0.01%) ⬇️
node 12.12% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@opensumi
Copy link
Copy Markdown
Contributor

opensumi Bot commented Mar 25, 2025

🎉 PR Next publish successful!

3.8.3-next-1742887161.0

Copy link
Copy Markdown
Member

@hacke2 hacke2 left a comment

Choose a reason for hiding this comment

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

LGTM

@hacke2 hacke2 merged commit 5851e8d into main Mar 25, 2025
13 checks passed
@hacke2 hacke2 deleted the fix/support-access-function-for-custom-fs branch March 25, 2025 08:28
@erha19 erha19 mentioned this pull request May 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🎨 feature feature required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants