feat(file-service): add base driver and data store interfaces

Author: bytemain

packages/file-service/__tests__/browser/file-service-client.test.ts

@@ -1,7 +1,7 @@
 import fs from 'fs-extra';
 import temp from 'temp';
 
-import { DisposableCollection, FileUri, UTF8 } from '@opensumi/ide-core-common';
+import { DisposableCollection, FileUri, UTF8, injectGDataStores } from '@opensumi/ide-core-common';
 import { createBrowserInjector } from '@opensumi/ide-dev-tool/src/injector-helper';
 import { FileService } from '@opensumi/ide-file-service/lib/node';
 import { DiskFileSystemProvider } from '@opensumi/ide-file-service/lib/node/disk-file-system.provider';
@@ -29,6 +29,7 @@ describe('FileServiceClient should be work', () => {
       useClass: DiskFileSystemProvider,
     },
   );
+  injectGDataStores(injector);
 
   beforeAll(() => {
     // @ts-ignore

packages/file-service/__tests__/node/file-node-watcher.test.ts

@@ -1,31 +1,46 @@
 import * as fse from 'fs-extra';
 import temp from 'temp';
 
-import { FileUri, sleep } from '@opensumi/ide-core-node';
+import { Disposable, FileUri, URI, sleep } from '@opensumi/ide-core-node';
 import { createNodeInjector } from '@opensumi/ide-dev-tool/src/mock-injector';
 
 import { DidFilesChangedParams, FileChangeType } from '../../src/common/index';
+import { FileChangeCollectionManager, FileChangeCollectionManagerOptions } from '../../src/node/file-change-collection';
 import { UnRecursiveFileSystemWatcher } from '../../src/node/un-recursive/file-service-watcher';
 
 const sleepTime = 1000;
 
+async function generateWatcher(track: typeof temp, watchPathCb: (root: URI) => string) {
+  const injector = createNodeInjector([]);
+  const root = FileUri.create(await fse.realpath(await track.mkdir('unRecursive-test')));
+  injector.addProviders({
+    token: FileChangeCollectionManagerOptions,
+    useValue: { debounceTimeout: 0 },
+  });
+  const fileChangeCollectionManager = injector.get(FileChangeCollectionManager);
+  const watcherServer = injector.get(UnRecursiveFileSystemWatcher);
+  fse.mkdirpSync(FileUri.fsPath(root.resolve('for_rename_folder')));
+  fse.writeFileSync(FileUri.fsPath(root.resolve('for_rename')), 'rename');
+  const watcherId = await watcherServer.watchFileChanges(watchPathCb(root));
+
+  const setClient = (client: { onDidFilesChanged: (event: DidFilesChangedParams) => void }) =>
+    watcherServer.addDispose(fileChangeCollectionManager.setClientForTest(watcherId, client));
+  watcherServer.addDispose(
+    Disposable.create(() => {
+      // eslint-disable-next-line no-console
+      console.log('dispose watcher id', watcherId);
+      watcherServer.unwatchFileChanges(watcherId);
+    }),
+  );
+  return { root, watcherServer, setClient };
+}
+
 describe('unRecursively watch for folder additions, deletions, rename,and updates', () => {
   const track = temp.track();
-  async function generateWatcher() {
-    const injector = createNodeInjector([]);
-    const root = FileUri.create(fse.realpathSync(await temp.mkdir('unRecursive-test')));
-    const watcherServer = injector.get(UnRecursiveFileSystemWatcher);
-    fse.mkdirpSync(FileUri.fsPath(root.resolve('for_rename_folder')));
-    fse.writeFileSync(FileUri.fsPath(root.resolve('for_rename')), 'rename');
-    await watcherServer.watchFileChanges(root.toString());
-    return { root, watcherServer };
-  }
-  const watcherServerList: UnRecursiveFileSystemWatcher[] = [];
-  afterAll(async () => {
+  const rootPathCb = (root: URI) => root.toString();
+
+  afterAll(() => {
     track.cleanupSync();
-    watcherServerList.forEach((watcherServer) => {
-      watcherServer.dispose();
-    });
   });
   it('Rename the files under the folder', async () => {
     const addUris = new Set<string>();
@@ -43,8 +58,8 @@ describe('unRecursively watch for folder additions, deletions, rename,and update
         });
       },
     };
-    const { root, watcherServer } = await generateWatcher();
-    watcherServer.setClient(watcherClient);
+    const { root, watcherServer, setClient } = await generateWatcher(track, rootPathCb);
+    setClient(watcherClient);
 
     const expectedAddUris = [root.resolve('for_rename_renamed').toString()];
 
@@ -54,7 +69,7 @@ describe('unRecursively watch for folder additions, deletions, rename,and update
     await sleep(sleepTime);
     expect([...addUris]).toEqual(expectedAddUris);
     expect([...deleteUris]).toEqual(expectedDeleteUris);
-    watcherServerList.push(watcherServer);
+    watcherServer.dispose();
   });
   it('Add the files under the folder', async () => {
     const addUris = new Set<string>();
@@ -72,8 +87,8 @@ describe('unRecursively watch for folder additions, deletions, rename,and update
         });
       },
     };
-    const { root, watcherServer } = await generateWatcher();
-    watcherServer.setClient(watcherClient);
+    const { root, watcherServer, setClient } = await generateWatcher(track, rootPathCb);
+    setClient(watcherClient);
 
     const expectedAddUris = [root.resolve('README.md').toString()];
 
@@ -84,7 +99,7 @@ describe('unRecursively watch for folder additions, deletions, rename,and update
 
     expect(Array.from(addUris)).toEqual(expectedAddUris);
     expect(Array.from(deleteUris)).toEqual(expectedDeleteUris);
-    watcherServerList.push(watcherServer);
+    watcherServer.dispose();
   });
   it('Update the files under the folder', async () => {
     const updatedUris = new Set<string>();
@@ -101,15 +116,15 @@ describe('unRecursively watch for folder additions, deletions, rename,and update
         });
       },
     };
-    const { root, watcherServer } = await generateWatcher();
-    watcherServer.setClient(watcherClient);
+    const { root, watcherServer, setClient } = await generateWatcher(track, rootPathCb);
+    setClient(watcherClient);
     const expectedDeleteUris = [];
     const expectedUpdatedUris = [root.resolve('for_rename').toString()];
     fse.writeFileSync(root.resolve('for_rename').codeUri.fsPath.toString(), '');
     await sleep(sleepTime);
     expect(Array.from(updatedUris)).toEqual(expectedUpdatedUris);
     expect(Array.from(deleteUris)).toEqual(expectedDeleteUris);
-    watcherServerList.push(watcherServer);
+    watcherServer.dispose();
   });
   it('Delete the files under the folder', async () => {
     const addUris = new Set<string>();
@@ -127,16 +142,17 @@ describe('unRecursively watch for folder additions, deletions, rename,and update
         });
       },
     };
-    const { root, watcherServer } = await generateWatcher();
-    watcherServer.setClient(watcherClient);
+    const { root, watcherServer, setClient } = await generateWatcher(track, rootPathCb);
+    setClient(watcherClient);
+
     const expectedDeleteUris = [root.resolve('for_rename').toString()];
     const expectedAddUris = [];
     await fse.unlink(root.resolve('for_rename').codeUri.fsPath.toString());
     await sleep(sleepTime);
 
     expect(Array.from(addUris)).toEqual(expectedAddUris);
     expect(Array.from(deleteUris)).toEqual(expectedDeleteUris);
-    watcherServerList.push(watcherServer);
+    watcherServer.dispose();
   });
   it('Rename the watched folder', async () => {
     const addUris = new Set<string>();
@@ -154,8 +170,8 @@ describe('unRecursively watch for folder additions, deletions, rename,and update
         });
       },
     };
-    const { root, watcherServer } = await generateWatcher();
-    watcherServer.setClient(watcherClient);
+    const { root, watcherServer, setClient } = await generateWatcher(track, rootPathCb);
+    setClient(watcherClient);
 
     const expectedAddUris = [];
     const expectedDeleteUris = [];
@@ -168,7 +184,7 @@ describe('unRecursively watch for folder additions, deletions, rename,and update
 
     expect([...addUris]).toEqual(expectedAddUris);
     expect([...deleteUris]).toEqual(expectedDeleteUris);
-    watcherServerList.push(watcherServer);
+    watcherServer.dispose();
   });
   it('Add the watched folder', async () => {
     const addUris = new Set<string>();
@@ -185,8 +201,8 @@ describe('unRecursively watch for folder additions, deletions, rename,and update
         });
       },
     };
-    const { root, watcherServer } = await generateWatcher();
-    watcherServer.setClient(watcherClient);
+    const { root, watcherServer, setClient } = await generateWatcher(track, rootPathCb);
+    setClient(watcherClient);
 
     const expectedAddUris = [];
 
@@ -197,7 +213,7 @@ describe('unRecursively watch for folder additions, deletions, rename,and update
 
     expect(Array.from(addUris)).toEqual(expectedAddUris);
     expect(Array.from(deleteUris)).toEqual(expectedDeleteUris);
-    watcherServerList.push(watcherServer);
+    watcherServer.dispose();
   });
 
   it('Delete the watched folder', async () => {
@@ -216,35 +232,26 @@ describe('unRecursively watch for folder additions, deletions, rename,and update
         });
       },
     };
-    const { root, watcherServer } = await generateWatcher();
-    watcherServer.setClient(watcherClient);
+    const { root, watcherServer, setClient } = await generateWatcher(track, rootPathCb);
+    setClient(watcherClient);
+
     const expectedDeleteUris = [];
     const expectedAddUris = [];
     await fse.remove(root.resolve('for_rename_folder').codeUri.fsPath.toString());
     await sleep(sleepTime);
 
     expect(Array.from(addUris)).toEqual(expectedAddUris);
     expect(Array.from(deleteUris)).toEqual(expectedDeleteUris);
-    watcherServerList.push(watcherServer);
+    watcherServer.dispose();
   });
 });
 
 describe('Delete and update monitored files', () => {
   const track = temp.track();
-  async function generateWatcher() {
-    const injector = createNodeInjector([]);
-    const root = FileUri.create(fse.realpathSync(await temp.mkdir('unRecursive-test')));
-    const watcherServer = injector.get(UnRecursiveFileSystemWatcher);
-    fse.writeFileSync(FileUri.fsPath(root.resolve('for_rename')), 'rename');
-    await watcherServer.watchFileChanges(root.toString() + '/for_rename');
-    return { root, watcherServer };
-  }
-  const watcherServerList: UnRecursiveFileSystemWatcher[] = [];
-  afterAll(async () => {
+  const rootPathCb = (root: URI) => root.toString() + '/for_rename';
+
+  afterAll(() => {
     track.cleanupSync();
-    watcherServerList.forEach((watcherServer) => {
-      watcherServer.dispose();
-    });
   });
 
   it('Delete watched files', async () => {
@@ -263,8 +270,8 @@ describe('Delete and update monitored files', () => {
         });
       },
     };
-    const { root, watcherServer } = await generateWatcher();
-    watcherServer.setClient(watcherClient);
+    const { root, watcherServer, setClient } = await generateWatcher(track, rootPathCb);
+    setClient(watcherClient);
 
     const expectedDeleteUris = [root.resolve('for_rename').toString()];
 
@@ -273,7 +280,7 @@ describe('Delete and update monitored files', () => {
     await sleep(sleepTime);
     expect(Array.from(addUris)).toEqual(expectedAddUris);
     expect(Array.from(deleteUris)).toEqual(expectedDeleteUris);
-    watcherServerList.push(watcherServer);
+    watcherServer.dispose();
   });
 
   it('Update watched files', async () => {
@@ -292,14 +299,14 @@ describe('Delete and update monitored files', () => {
         });
       },
     };
-    const { root, watcherServer } = await generateWatcher();
-    watcherServer.setClient(watcherClient);
+    const { root, watcherServer, setClient } = await generateWatcher(track, rootPathCb);
+    setClient(watcherClient);
     const expectedDeleteUris = [];
     const expectedUpdatedUris = [root.resolve('for_rename').toString()];
     await fse.writeFile(root.resolve('for_rename').codeUri.fsPath.toString(), 'for');
     await sleep(sleepTime);
     expect(Array.from(updatedUris)).toEqual(expectedUpdatedUris);
     expect(Array.from(deleteUris)).toEqual(expectedDeleteUris);
-    watcherServerList.push(watcherServer);
+    watcherServer.dispose();
   });
 });