feat: use async in watch file changes (#4026)

bytemain · web-flow · commit acc8715a04d2 · 2024-09-23T17:55:42.000+08:00
diff --git a/packages/extension/src/browser/vscode/api/main.thread.file-system-event.ts b/packages/extension/src/browser/vscode/api/main.thread.file-system-event.ts
@@ -9,6 +9,7 @@ import {
   ILogger,
   ProgressLocation,
   URI,
+  Uri,
   formatLocalize,
   localize,
   raceCancellation,
@@ -77,15 +78,15 @@ export class MainThreadFileSystemEvent extends Disposable {
         for (const change of changes) {
           switch (change.type) {
             case FileChangeType.ADDED:
-              events.created.push(new URI(change.uri).codeUri);
+              events.created.push(Uri.parse(change.uri));
               hasResult = true;
               break;
             case FileChangeType.UPDATED:
-              events.changed.push(new URI(change.uri).codeUri);
+              events.changed.push(Uri.parse(change.uri));
               hasResult = true;
               break;
             case FileChangeType.DELETED:
-              events.deleted.push(new URI(change.uri).codeUri);
+              events.deleted.push(Uri.parse(change.uri));
               hasResult = true;
               break;
           }
diff --git a/packages/file-service/src/node/recursive/file-service-watcher.ts b/packages/file-service/src/node/recursive/file-service-watcher.ts
@@ -22,6 +22,7 @@ import {
 
 import { FileChangeType, FileSystemWatcherClient, IFileSystemWatcherServer, INsfw, WatchOptions } from '../../common';
 import { FileChangeCollection } from '../file-change-collection';
+import { shouldIgnorePath } from '../shared';
 
 export interface WatcherOptions {
   excludesPattern: ParsedPattern[];
@@ -45,7 +46,7 @@ export interface NsfwFileSystemWatcherOption {
 }
 
 @Injectable({ multiple: true })
-export class FileSystemWatcherServer implements IFileSystemWatcherServer {
+export class FileSystemWatcherServer extends Disposable implements IFileSystemWatcherServer {
   private static readonly PARCEL_WATCHER_BACKEND = isWindows ? 'windows' : isLinux ? 'inotify' : 'fs-events';
 
   private WATCHER_HANDLERS = new Map<
@@ -57,8 +58,6 @@ export class FileSystemWatcherServer implements IFileSystemWatcherServer {
 
   protected client: FileSystemWatcherClient | undefined;
 
-  protected readonly toDispose = new DisposableCollection(Disposable.create(() => this.setClient(undefined)));
-
   protected changes = new FileChangeCollection();
 
   @Autowired(ILogServiceManager)
@@ -67,12 +66,14 @@ export class FileSystemWatcherServer implements IFileSystemWatcherServer {
   private logger: ILogService;
 
   constructor(@Optional() private readonly excludes: string[] = []) {
+    super();
     this.logger = this.loggerManager.getLogger(SupportLogNamespace.Node);
-  }
 
-  dispose(): void {
-    this.toDispose.dispose();
-    this.WATCHER_HANDLERS.clear();
+    this.addDispose(
+      Disposable.create(() => {
+        this.WATCHER_HANDLERS.clear();
+      }),
+    );
   }
 
   /**
@@ -150,7 +151,7 @@ export class FileSystemWatcherServer implements IFileSystemWatcherServer {
     });
     toDisposeWatcher.push(Disposable.create(() => this.WATCHER_HANDLERS.delete(watcherId as number)));
     toDisposeWatcher.push(await this.start(watcherId, watchPath, options));
-    this.toDispose.push(toDisposeWatcher);
+    this.addDispose(toDisposeWatcher);
     return watcherId;
   }
 
@@ -180,24 +181,10 @@ export class FileSystemWatcherServer implements IFileSystemWatcherServer {
    * @param events
    */
   protected trimChangeEvent(events: ParcelWatcher.Event[]): ParcelWatcher.Event[] {
-    events = events.filter((event: ParcelWatcher.Event) => {
-      if (event.path) {
-        if (this.isTempFile(event.path)) {
-          // write-file-atomic 源文件xxx.xx 对应的临时文件为 xxx.xx.22243434
-          // 这类文件的更新应当完全隐藏掉
-          return false;
-        }
-      }
-      return true;
-    });
-
+    events = events.filter((event: ParcelWatcher.Event) => !shouldIgnorePath(event.path));
     return events;
   }
 
-  private isTempFile(path: string) {
-    return /\.\d{7}\d+$/.test(path);
-  }
-
   private getDefaultWatchExclude() {
     return ['**/.git/objects/**', '**/.git/subtree-cache/**', '**/node_modules/**/*', '**/.hg/store/**'];
   }
@@ -251,20 +238,14 @@ export class FileSystemWatcherServer implements IFileSystemWatcherServer {
       return undefined; // watch 失败则返回 undefined
     };
 
-    /**
-     * 由于 parcel/watcher 在 Linux 下存在内存越界访问问题触发了 sigsegv 导致 crash，所以在 Linux 下仍旧使用 nsfw
-     * 社区相关 issue: https://github.com/parcel-bundler/watcher/issues/49
-     * 后续这里的 watcher 模块需要重构掉，先暂时这样处理
-     *
-     * 代码来自 issue: https://github.com/opensumi/core/pull/1437/files?diff=split&w=0#diff-9de963117a88a70d7c58974bf2b092c61a196d6eef719846d78ca5c9d100b796 的旧代码处理
-     */
     if (this.isEnableNSFW()) {
       const nsfw = await this.withNSFWModule();
       const watcher: INsfw.NSFW = await nsfw(
         realPath,
         (events: INsfw.ChangeEvent[]) => this.handleNSFWEvents(events, watcherId),
         {
-          errorCallback: (error: any) => {
+          errorCallback: (err) => {
+            this.logger.error('NSFW watcher encountered an error and will stop watching.', err);
             // see https://github.com/atom/github/issues/342
             this.unwatchFileChanges(watcherId);
           },
@@ -314,15 +295,15 @@ export class FileSystemWatcherServer implements IFileSystemWatcherServer {
   }
 
   setClient(client: FileSystemWatcherClient | undefined) {
-    if (client && this.toDispose.disposed) {
+    if (client && this.disposed) {
       return;
     }
     this.client = client;
   }
 
   /**
-   * @deprecated
-   * 主要是用来跳过 jest 测试
+   * 由于 parcel/watcher 在 Linux 下存在内存越界访问问题触发了 sigsegv 导致 crash，所以在 Linux 下仍旧使用 nsfw
+   * 社区相关 issue: https://github.com/parcel-bundler/watcher/issues/49
    */
   private isEnableNSFW(): boolean {
     return isLinux;
@@ -347,9 +328,9 @@ export class FileSystemWatcherServer implements IFileSystemWatcherServer {
         return true;
       }
 
-      return !this.isTempFile(event.file!);
+      return !shouldIgnorePath(event.file);
     });
-    // 合并下事件，由于 resolvePath 耗时较久，这里只用当前事件路径及文件名去重，后续处理事件再获取真实路径
+
     const mergedEvents = uniqBy(filterEvents, (event) => {
       if (event.action === INsfw.actions.RENAMED) {
         const deletedPath = paths.join(event.directory, event.oldFile!);
@@ -360,47 +341,58 @@ export class FileSystemWatcherServer implements IFileSystemWatcherServer {
       return event.action + paths.join(event.directory, event.file!);
     });
 
-    for (const event of mergedEvents) {
-      if (event.action === INsfw.actions.RENAMED) {
-        const deletedPath = this.resolvePath(event.directory, event.oldFile!);
-        if (isIgnored(watcherId, deletedPath)) {
-          continue;
-        }
+    await Promise.all(
+      mergedEvents.map(async (event) => {
+        switch (event.action) {
+          case INsfw.actions.RENAMED:
+            {
+              const deletedPath = await this.resolvePath(event.directory, event.oldFile!);
+              if (isIgnored(watcherId, deletedPath)) {
+                return;
+              }
 
-        this.pushDeleted(deletedPath);
+              this.pushDeleted(deletedPath);
 
-        if (event.newDirectory) {
-          const path = this.resolvePath(event.newDirectory, event.newFile!);
-          if (isIgnored(watcherId, path)) {
-            continue;
-          }
+              if (event.newDirectory) {
+                const path = await this.resolvePath(event.newDirectory, event.newFile!);
+                if (isIgnored(watcherId, path)) {
+                  return;
+                }
 
-          this.pushAdded(path);
-        } else {
-          const path = this.resolvePath(event.directory, event.newFile!);
-          if (isIgnored(watcherId, path)) {
-            continue;
-          }
+                this.pushAdded(path);
+              } else {
+                const path = await this.resolvePath(event.directory, event.newFile!);
+                if (isIgnored(watcherId, path)) {
+                  return;
+                }
 
-          this.pushAdded(path);
-        }
-      } else {
-        const path = this.resolvePath(event.directory, event.file!);
-        if (isIgnored(watcherId, path)) {
-          continue;
-        }
+                this.pushAdded(path);
+              }
+            }
+            break;
+          default:
+            {
+              const path = await this.resolvePath(event.directory, event.file!);
+              if (isIgnored(watcherId, path)) {
+                return;
+              }
 
-        if (event.action === INsfw.actions.CREATED) {
-          this.pushAdded(path);
-        }
-        if (event.action === INsfw.actions.DELETED) {
-          this.pushDeleted(path);
-        }
-        if (event.action === INsfw.actions.MODIFIED) {
-          this.pushUpdated(path);
+              switch (event.action) {
+                case INsfw.actions.CREATED:
+                  this.pushAdded(path);
+                  break;
+                case INsfw.actions.DELETED:
+                  this.pushDeleted(path);
+                  break;
+                case INsfw.actions.MODIFIED:
+                  this.pushUpdated(path);
+                  break;
+              }
+            }
+            break;
         }
-      }
-    }
+      }),
+    );
   }
 
   private async withNSFWModule(): Promise<typeof import('nsfw')> {
@@ -426,16 +418,16 @@ export class FileSystemWatcherServer implements IFileSystemWatcherServer {
     this.fireDidFilesChanged();
   }
 
-  protected resolvePath(directory: string, file: string): string {
+  protected async resolvePath(directory: string, file: string): Promise<string> {
     const path = paths.join(directory, file);
     // 如果是 linux 则获取一下真实 path，以防返回的是软连路径被过滤
     if (isLinux) {
       try {
-        return fs.realpathSync.native(path);
+        return await fs.realpath.native(path);
       } catch (_e) {
         try {
           // file does not exist try to resolve directory
-          return paths.join(fs.realpathSync.native(directory), file);
+          return paths.join(await fs.realpath.native(directory), file);
         } catch (_e) {
           // directory does not exist fall back to symlink
           return path;
diff --git a/packages/file-service/src/node/shared/index.ts b/packages/file-service/src/node/shared/index.ts
@@ -0,0 +1,13 @@
+export function shouldIgnorePath(path?: string) {
+  if (!path) {
+    return true;
+  }
+
+  if (/\.\d{7}\d+$/.test(path)) {
+    // write-file-atomic 源文件xxx.xx 对应的临时文件为 xxx.xx.22243434
+    // 这类文件的更新应当完全隐藏掉
+    return true;
+  }
+
+  return false;
+}
diff --git a/packages/file-service/src/node/un-recursive/file-service-watcher.ts b/packages/file-service/src/node/un-recursive/file-service-watcher.ts
@@ -16,6 +16,7 @@ import {
 
 import { FileChangeType, FileSystemWatcherClient, IFileSystemWatcherServer } from '../../common/index';
 import { FileChangeCollection } from '../file-change-collection';
+import { shouldIgnorePath } from '../shared';
 const { join, basename, normalize } = path;
 @Injectable({ multiple: true })
 export class UnRecursiveFileSystemWatcher implements IFileSystemWatcherServer {
@@ -96,7 +97,7 @@ export class UnRecursiveFileSystemWatcher implements IFileSystemWatcherServer {
       });
 
       watcher.on('change', (type: string, filename: string | Buffer) => {
-        if (this.isTemporaryFile(filename as string)) {
+        if (shouldIgnorePath(filename as string)) {
           return;
         }
 
@@ -248,15 +249,4 @@ export class UnRecursiveFileSystemWatcher implements IFileSystemWatcherServer {
     }
     this.client = client;
   }
-
-  protected isTemporaryFile(path: string): boolean {
-    if (path) {
-      if (/\.\d{7}\d+$/.test(path)) {
-        // write-file-atomic 源文件xxx.xx 对应的临时文件为 xxx.xx.22243434
-        // 这类文件的更新应当完全隐藏掉
-        return true;
-      }
-    }
-    return false;
-  }
 }
diff --git a/packages/utils/src/async.ts b/packages/utils/src/async.ts
@@ -8,6 +8,8 @@ export type MaybePromise<T> = T | Promise<T> | PromiseLike<T>;
 export const FRAME_ONE = 16;
 export const FRAME_TWO = FRAME_ONE * 2;
 export const FRAME_THREE = FRAME_ONE * 3;
+export const FRAME_FOUR = FRAME_ONE * 4;
+export const FRAME_FIVE = FRAME_ONE * 5;
 
 export interface CancelablePromise<T> extends Promise<T> {
   cancel(): void;
diff --git a/tools/playwright/src/app.ts b/tools/playwright/src/app.ts
@@ -65,7 +65,7 @@ export class OpenSumiApp extends Disposable {
   protected async load(workspace: OpenSumiWorkspace): Promise<void> {
     this.disposables.push(workspace);
     const now = Date.now();
-    await this.loadOrReload(this.page, `/#${workspace.workspace.codeUri.fsPath}`);
+    await this.loadOrReload(this.page, `/?workspaceDir=${workspace.workspace.codeUri.fsPath}`);
     await this.page.waitForSelector(this.appData.loadingSelector, { state: 'detached' });
     const time = Date.now() - now;
     // eslint-disable-next-line no-console
