feat: 优化 git 文件写系统

Author: winjo

packages/alex/src/api/createApp.tsx

@@ -7,7 +7,7 @@ import {
   IAppOpts,
   STORAGE_NAME,
 } from '@alipay/alex-core';
-import { SlotRenderer, SlotLocation, IAppRenderer } from '@ali/ide-core-browser';
+import { SlotRenderer, SlotLocation, IAppRenderer, FILES_DEFAULTS } from '@ali/ide-core-browser';
 import { BoxPanel, SplitPanel } from '@ali/ide-core-browser/lib/components';
 import { IThemeService } from '@ali/ide-theme/lib/common';
 import '@ali/ide-core-browser/lib/style/index.less';
@@ -40,6 +40,11 @@ const getDefaultAppConfig = (): IAppOpts => ({
     'editor.quickSuggestionsDelay': 10,
     'editor.quickSuggestionsMaxCount': 50,
     'settings.userBeforeWorkspace': true,
+    'files.exclude': {
+      ...FILES_DEFAULTS.filesExclude,
+      // browserfs OverlayFS 用来记录删除的文件
+      '**/.deletedFiles.log': true,
+    },
   },
   layoutConfig,
   layoutComponent: LayoutComponent,

packages/alex/src/integration/startup/index.tsx

@@ -1,7 +1,8 @@
 import React from 'react';
 import ReactDOM from 'react-dom';
-import { AppRenderer, renderApp, IAppInstance } from '../..';
 import { GitFileSchemeModule } from '@alipay/alex-git';
+import { IAppInstance, AppRenderer } from '../..';
+import * as Alex from '../..';
 import { StartupModule } from './startup.module';
 import './languages';
 import SarifViewer from '../../../extensions/cloud-ide-ext.sarif-viewer';
@@ -11,6 +12,8 @@ import json from '../../../extensions/alex.json-language-features-worker';
 import markdown from '../../../extensions/alex.markdown-language-features-worker';
 import typescript from '../../../extensions/alex.typescript-language-features-worker';
 
+(window as any).alex = Alex;
+
 const query = location.search
   .slice(1)
   .split('&')
@@ -34,6 +37,7 @@ ReactDOM.render(
     }}
     runtimeConfig={{
       git: {
+        platform: 'antcode',
         baseURL: '/code-service',
         project,
         branch: query.branch,

packages/core/src/common/constant.ts

@@ -12,6 +12,8 @@ export const WORKSPACE_ROOT = '/workspace';
 
 export const GIT_ROOT = '/git';
 
+export const IDB_ROOT = '/idb';
+
 // 全局数据存储目录
 export const STORAGE_NAME = '.cloudide';
 

packages/core/src/common/types.ts

@@ -1,5 +1,3 @@
-import type * as vscode from 'vscode';
-import { Event } from '@ali/ide-core-common';
 import { BrowserFS, FileSystemConfiguration } from '../server/node';
 
 export { AppConfig } from '@ali/ide-core-browser';
@@ -20,9 +18,12 @@ export interface FileIndex {
 }
 
 interface GitConfig {
+  // 平台
+  platform: string;
+  // host
   baseURL: string;
   // 项目 IDE
-  projectId?: number;
+  projectId?: number | string;
   // 项目名称 group/repository
   project: string;
   // 分支

packages/core/src/server/core/util.ts

@@ -6,8 +6,7 @@ const { createFileSystem, FileSystem, initialize } = BrowserFS;
 
 export const initializeRootFileSystem = async () => {
   // TODO: /home 采用 localStorage 作为文件系统是不是更好点，理论数据量不大的话没必要用 IndexedDB
-  const [tmp, workspace, home] = await Promise.all([
-    createFileSystem(FileSystem.InMemory, {}),
+  const [tmp, home] = await Promise.all([
     createFileSystem(FileSystem.InMemory, {}),
     createFileSystem(FileSystem.IndexedDB, {
       storeName: HOME_IDB_NAME,
@@ -16,7 +15,6 @@ export const initializeRootFileSystem = async () => {
   const mountfs = await createFileSystem(FileSystem.MountableFileSystem, {
     [TMP_ROOT]: tmp,
     [HOME_ROOT]: home,
-    [WORKSPACE_ROOT]: workspace,
   });
   initialize(mountfs);
   return mountfs as RootFS;

packages/core/src/server/node/bfs/index.ts

@@ -1,3 +1,4 @@
+import './patch';
 import fs from 'browserfs/dist/node/core/node_fs';
 import { checkOptions } from 'browserfs/dist/node/core/util';
 import {

packages/core/src/server/node/bfs/patch.ts

@@ -0,0 +1,35 @@
+// @ts-nocheck
+// patch
+// 修复 stat 错误
+
+import { BFSCallback } from 'browserfs/dist/node/core/file_system';
+import { ApiError, ErrorCode } from 'browserfs/dist/node/core/api_error';
+import Stats from 'browserfs/dist/node/core/node_fs_stats';
+import { UnlockedOverlayFS } from 'browserfs/dist/node/backend/OverlayFS';
+
+function makeModeWritable(mode: number): number {
+  return 0o222 | mode;
+}
+
+UnlockedOverlayFS.prototype.stat = function (p: string, isLstat: boolean, cb: BFSCallback<Stats>) {
+  if (!this.checkInitAsync(cb)) {
+    return;
+  }
+  this._writable.stat(p, isLstat, (err: ApiError, stat?: Stats) => {
+    if (err && err.errno === ErrorCode.ENOENT) {
+      if (this._deletedFiles[p]) {
+        cb(ApiError.ENOENT(p));
+        return;
+      }
+      this._readable.stat(p, isLstat, (err: ApiError, stat?: Stats) => {
+        if (stat) {
+          stat = stat.clone();
+          stat.mode = makeModeWritable(stat.mode);
+        }
+        cb(err, stat);
+      });
+    } else {
+      cb(err, stat);
+    }
+  });
+};

packages/git/src/filesystem/configure.ts

@@ -1,5 +1,6 @@
 import { BrowserFS, WORKSPACE_IDB_NAME } from '@alipay/alex-core';
 import { IGitAPIService } from '../types';
+import { GitModelService } from '../git-model.service';
 
 const stripSlash = (p: string) => {
   if (p[0] === '/') {
@@ -10,29 +11,50 @@ const stripSlash = (p: string) => {
 
 type Callback<T = any> = (err: Error | null, rv?: T) => void;
 
-const configureFileSystem = async (apiService: IGitAPIService) => {
+const configureFileSystem = async (model: GitModelService, api: IGitAPIService) => {
   const requestByMethod = (name: 'getTreeEntry' | 'getTree' | 'getBlob' | 'getBlobSize') => (
     p: string,
     cb: Callback<any>
   ) => {
     p = stripSlash(p);
-    (apiService[name](p) as Promise<any>).then((res) => cb(null, res)).catch((err) => cb(err));
+    (api[name](p) as Promise<any>).then((res) => cb(null, res)).catch((err) => cb(err));
   };
 
-  const gitFileSystem = await BrowserFS.createFileSystem(BrowserFS.FileSystem.CodeHost, {
-    requestStat: requestByMethod('getTreeEntry'),
-    requestDir: requestByMethod('getTree'),
-    requestFile: requestByMethod('getBlob'),
-    requestFileSize: requestByMethod('getBlobSize'),
+  const {
+    createFileSystem,
+    FileSystem: { CodeHost, OverlayFS, FolderAdapter, IndexedDB },
+  } = BrowserFS;
+
+  const [gitFileSystem, idbFileSystem] = await Promise.all([
+    createFileSystem(CodeHost, {
+      requestStat: requestByMethod('getTreeEntry'),
+      requestDir: requestByMethod('getTree'),
+      requestFile: requestByMethod('getBlob'),
+      requestFileSize: requestByMethod('getBlobSize'),
+    }),
+    createFileSystem(IndexedDB, { storeName: WORKSPACE_IDB_NAME }),
+  ]);
+  const folderSystem = await createFileSystem(FolderAdapter, {
+    wrapped: idbFileSystem,
+    folder: `/${model.platform}-${model.projectId}-${model.commit}`,
   });
-  const overlayFileSystem = await BrowserFS.createFileSystem(BrowserFS.FileSystem.OverlayFS, {
+  await new Promise<void>((resolve, reject) => {
+    (folderSystem as InstanceType<typeof FolderAdapter>).initialize((err) => {
+      if (err) {
+        reject(err);
+      } else {
+        resolve();
+      }
+    });
+  });
+  const overlayFileSystem = await createFileSystem(OverlayFS, {
     readable: gitFileSystem,
-    writable: await BrowserFS.createFileSystem(BrowserFS.FileSystem.IndexedDB, {
-      storeName: WORKSPACE_IDB_NAME,
-    }),
+    writable: folderSystem,
   });
   return {
     gitFileSystem,
+    idbFileSystem,
+    folderSystem,
     overlayFileSystem,
   };
 };

packages/git/src/git-api.service.ts

@@ -1,99 +1,58 @@
-import { Injectable } from '@ali/common-di';
-import { Deferred } from '@ali/ide-core-common';
+import { Injectable, Autowired } from '@ali/common-di';
+import { GitModelService } from './git-model.service';
 import { request, API } from './request';
 import { IGitAPIService } from './types';
 
-// TODO: 适配 gitlab 接口
-// TODO: 放到集成侧去做？AntCode 上如果也用 IDE，那么也会造成重复
 @Injectable()
 export class GitAPIService implements IGitAPIService {
-  public platform = 'antcode';
-  private initialized = new Deferred();
-  public project: string;
-  public projectId: number;
-  public commit: string;
-  public branch: string;
-
-  async initProject(config: {
-    project: string;
-    projectId?: number;
-    commit?: string;
-    branch?: string;
-  }) {
-    this.project = config.project;
-    if (config.projectId) {
-      this.projectId = config.projectId;
-    }
-    if (config.commit) {
-      this.commit = config.commit;
-    }
-    if (config.branch) {
-      this.branch = config.branch;
-    }
-    // 唯一确定一个项目
-    if (this.projectId && this.commit) {
-      return;
-    }
-    if (!this.projectId || !this.branch) {
-      const projectInfo = await this.getProjectInfo();
-      this.projectId = projectInfo.id;
-      if (!this.branch) {
-        this.branch = projectInfo.default_branch;
-      }
-    }
-    if (!this.commit) {
-      const commitInfo = await this.getCommit(this.branch);
-      this.commit = commitInfo.id;
-    }
-    this.initialized.resolve();
-  }
-
-  get ready() {
-    return this.initialized.promise;
-  }
+  @Autowired()
+  gitModel: GitModelService;
 
   getProjectInfo() {
     return request<API.ResponseGetProjectById>(
-      `/api/v3/projects/${encodeURIComponent(this.project)}`
+      `/api/v3/projects/${encodeURIComponent(this.gitModel.project)}`
     );
   }
 
-  // 根据分支获取最新的 commit
   async getCommit(ref: string) {
     return request<API.ResponseGetCommit>(
-      `/api/v3/projects/${this.projectId}/repository/commits/${ref}`
+      `/api/v3/projects/${this.gitModel.projectId}/repository/commits/${ref}`
     );
   }
 
-  // 获取文件节点
   async getTreeEntry(path: string) {
-    await this.ready;
+    await this.gitModel.ready;
     return request<API.ResponseGetTreeEntry>(
-      `/api/v3/projects/${this.projectId}/repository/tree_entry`,
+      `/api/v3/projects/${this.gitModel.projectId}/repository/tree_entry`,
       {
         params: {
-          ref_name: this.commit,
+          ref_name: this.gitModel.commit,
           path,
         },
       }
     );
   }
 
-  // 根据 commit 和 path 获取 tree
+  /**
+   * 根据 commit 和 path 获取 tree
+   */
   async getTree(path: string = '') {
-    await this.ready;
-    return request<API.ResponseGetTree>(`/api/v3/projects/${this.projectId}/repository/tree`, {
-      params: {
-        ref_name: this.commit,
-        path,
-      },
-    });
+    await this.gitModel.ready;
+    return request<API.ResponseGetTree>(
+      `/api/v3/projects/${this.gitModel.projectId}/repository/tree`,
+      {
+        params: {
+          ref_name: this.gitModel.commit,
+          path,
+        },
+      }
+    );
   }
 
   async getBlobSize(path: string) {
-    await this.ready;
+    await this.gitModel.ready;
     const res: Response = await request(
-      `/api/v3/projects/${this.projectId}/repository/blobs/${this.commit}`,
+      `/api/v3/projects/${this.gitModel.projectId}/repository/blobs/${this.gitModel.commit}`,
       {
         params: {
           filepath: path,
@@ -105,11 +64,10 @@ export class GitAPIService implements IGitAPIService {
     return parseInt(res.headers.get('Content-Length') || '-1', 10);
   }
 
-  // 根据 commit 和 path 获取 blob
   async getBlob(path: string = '') {
-    await this.ready;
+    await this.gitModel.ready;
     const buf = await request<ArrayBuffer>(
-      `/api/v3/projects/${this.projectId}/repository/blobs/${this.commit}`,
+      `/api/v3/projects/${this.gitModel.projectId}/repository/blobs/${this.gitModel.commit}`,
       {
         params: {
           filepath: path,