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

fix: will watch same folder multiple times #3831

Merged
merged 2 commits into from
Jul 3, 2024

Conversation

bytemain
Copy link
Member

@bytemain bytemain commented Jul 3, 2024

Types

  • 🐛 Bug Fixes

Background or solution

之前的逻辑有判断要 watch 的路径是否已经被 watch 了,但是因为 async await 的原因,前端同时请求过来三四个一样的路径,后端会同时 watch 这些路径。

Changelog

fix file service will watch same folder multiple times

Summary by CodeRabbit

  • 新功能
    • 改进了文件系统监视器的初始化和事件处理功能,提升了文件变更监视的效率。

@bytemain bytemain requested review from erha19 and Ricbet July 3, 2024 08:30
Copy link
Contributor

coderabbitai bot commented Jul 3, 2024

Walkthrough

此更新改进了FileSystemWatcherServer类中的文件监视处理。主要变化包括添加了WATCHER_HANDLERS映射来存储监视处理程序,以及重构了watchFileChanges方法以更高效地处理监视初始化和事件处理。

Changes

文件路径 变更摘要
packages/file-service/src/node/recursive/file-service-watcher.ts FileSystemWatcherServer类中添加了WATCHER_HANDLERS映射,改进了watchFileChanges方法的逻辑及事件处理。

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant FileSystemWatcherServer
    participant FileUri
    participant fs
    
    Client->>FileSystemWatcherServer: watchFileChanges(uri, options)
    FileSystemWatcherServer->>FileUri: fsPath(uri)
    FileUri-->>FileSystemWatcherServer: basePath
    FileSystemWatcherServer->>fs: pathExists(basePath)
    fs-->>FileSystemWatcherServer: exist
    alt exist
        FileSystemWatcherServer->>Client: watcherId
        FileSystemWatcherServer->>WATCHER_HANDLERS: set(watcherId, handler)
    else exist not
        FileSystemWatcherServer->>Client: Error
    end
Loading

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

railway-app bot commented Jul 3, 2024

🚅 Previously deployed to Railway in the core project. Environment has been deleted.

@opensumi opensumi bot added the 🐞 bug Something isn't working label Jul 3, 2024
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 435f9df and d30603d.

Files selected for processing (1)
  • packages/file-service/src/node/recursive/file-service-watcher.ts (3 hunks)
Additional comments not posted (6)
packages/file-service/src/node/recursive/file-service-watcher.ts (6)

31-37: 引入watcherPlaceHolder常量对象。

这个对象用于在路径被异步检查期间临时占位,防止重复监听相同路径。


106-107: 使用watcherPlaceHolder占位。

在路径异步检查期间使用watcherPlaceHolder占位,防止重复监听相同路径。


109-111: 异步检查路径是否存在。

使用fs.pathExistsfs.lstat进行异步检查,提高性能并避免阻塞。


130-139: 使用switch-case处理事件。

将事件处理逻辑整合到switch-case块中,提高代码的可读性和可维护性。


Line range hint 190-191: 增强start方法的鲁棒性。

通过处理异步操作和重试机制,增强文件监视的鲁棒性。


Line range hint 334-339: 优化handleNSFWEvents方法。

通过过滤和合并事件,提高事件处理的效率,特别是在大量事件的场景下。

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 435f9df and 7bb07c5.

Files selected for processing (1)
  • packages/file-service/src/node/recursive/file-service-watcher.ts (3 hunks)
Additional comments not posted (4)
packages/file-service/src/node/recursive/file-service-watcher.ts (4)

31-36: 确保占位符 watcherPlaceHolder 的定义符合预期。

占位符 watcherPlaceHolder 定义了一个包含 disposablehandlers 的对象。请确保这些属性在使用时符合预期。


105-108: watcherPlaceHolder 用作初始值。

在这里将 watcherPlaceHolder 作为初始值传递给 WATCHER_HANDLERS。这确保了每个新的观察者都有一个初始的 disposablehandlers


111-112: 定义 watchPath 变量。

定义了 watchPath 变量,用于存储实际的观察路径。确保在后续代码中正确使用该变量。


132-141: 处理文件变化事件。

根据事件类型(创建、删除、更新)调用相应的处理函数。确保这些处理函数能够正确处理事件。

Copy link

codecov bot commented Jul 3, 2024

Codecov Report

Attention: Patch coverage is 73.33333% with 4 lines in your changes missing coverage. Please review.

Project coverage is 55.04%. Comparing base (e48311c) to head (7bb07c5).
Report is 1 commits behind head on main.

Files Patch % Lines
...service/src/node/recursive/file-service-watcher.ts 73.33% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3831      +/-   ##
==========================================
- Coverage   55.05%   55.04%   -0.02%     
==========================================
  Files        1553     1553              
  Lines       94640    94650      +10     
  Branches    19368    19378      +10     
==========================================
- Hits        52108    52101       -7     
- Misses      35334    35349      +15     
- Partials     7198     7200       +2     
Flag Coverage Δ
jsdom 50.48% <53.33%> (-0.02%) ⬇️
node 15.56% <73.33%> (+<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.

@bytemain bytemain merged commit a8a96d3 into main Jul 3, 2024
13 checks passed
@bytemain bytemain deleted the fix/watcher-watch-multiple-times branch July 3, 2024 09:13
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.

2 participants