feat(code-service): 增加内置 blame 和 link 命令

Author: winjo

packages/code-api/src/antcode/antcode.service.ts

@@ -210,4 +210,17 @@ export class AntCodeAPIService implements ICodeAPIService {
     );
     return reqRes;
   }
+
+  async getFileBlame(repo: IRepositoryModel, path: string) {
+    return new Uint8Array(
+      await this.request(
+        `/api/v3/projects/${this.getProjectId(repo)}/repository/blame?sha=${
+          repo.commit
+        }&file_path=${path}`,
+        {
+          responseType: 'arrayBuffer',
+        }
+      )
+    );
+  }
 }

packages/code-api/src/common/types.ts

@@ -133,6 +133,10 @@ export interface ICodeAPIService {
     searchString: string,
     options: { limit: number }
   ): Promise<string[]>;
+  /**
+   * file blame
+   */
+  getFileBlame(repo: IRepositoryModel, filepath: string): Promise<Uint8Array | void>;
 }
 
 export interface ICodeAPIServiceProvider extends ICodeAPIService {

packages/code-api/src/github/github.service.ts

@@ -540,4 +540,7 @@ export class GitHubAPIService implements ICodeAPIService {
     }
     return this.recursiveTreeMap.get(key)!;
   }
+
+  // TODO: graphql 下才支持
+  async getFileBlame() {}
 }

packages/code-api/src/gitlab/gitlab.service.ts

@@ -236,4 +236,7 @@ export class GitLabAPIService implements ICodeAPIService {
   async searchFile() {
     return [];
   }
+
+  // 不支持
+  async getFileBlame() {}
 }

packages/code-service/src/commands.contribution.ts

@@ -0,0 +1,99 @@
+import { Autowired } from '@ali/common-di';
+import {
+  CommandContribution,
+  Domain,
+  CommandRegistry,
+  Command,
+  Disposable,
+} from '@ali/ide-core-common';
+import { IOpenerService } from '@ali/ide-core-browser';
+import { CODE_PLATFORM_CONFIG, CodePlatform } from '@alipay/alex-code-api';
+import { CodeModelService } from './code-model.service';
+
+// 对外暴露的服务命令
+namespace CODE_SERVICE_COMMANDS {
+  const CATEGORY = 'CodeService';
+
+  export const BLAME: Command = {
+    id: 'codeService.getFileBlame',
+    category: CATEGORY,
+  };
+
+  export type BLAME = (filepath: string) => Promise<Uint8Array | void>;
+
+  export const OPEN_IN_REMOTE: Command = {
+    id: 'codeService.openInRemote',
+    category: CATEGORY,
+  };
+
+  export type OPEN_IN_REMOTE = (filepath: string, res: RemoteResource) => void;
+}
+
+export enum RemoteResourceType {
+  Branch = 'branch',
+  Branches = 'branches',
+  Commit = 'commit',
+  File = 'file',
+  Repo = 'repo',
+  Revision = 'revision',
+}
+
+export type RemoteResource =
+  | {
+      type: RemoteResourceType.Branch;
+      branch: string;
+    }
+  | {
+      type: RemoteResourceType.Branches;
+    }
+  | {
+      type: RemoteResourceType.Commit;
+      sha: string;
+    }
+  | {
+      type: RemoteResourceType.File;
+      branch?: string;
+      fileName: string;
+      range?: Range;
+    }
+  | {
+      type: RemoteResourceType.Repo;
+    };
+
+@Domain(CommandContribution)
+export class CommandsContribution extends Disposable implements CommandContribution {
+  @Autowired(CodeModelService)
+  private readonly codeModel: CodeModelService;
+
+  @Autowired(IOpenerService)
+  private readonly openerService: IOpenerService;
+
+  registerCommands(registry: CommandRegistry) {
+    this.addDispose([
+      // TODO: 这里直接返回 Uint8Array，减少序列化耗时，但考虑到多平台又需转换成统一格式数据
+      registry.registerCommand<CODE_SERVICE_COMMANDS.BLAME>(CODE_SERVICE_COMMANDS.BLAME, {
+        execute: async (filepath) => {
+          const repo = this.codeModel.getRepository(filepath);
+          if (repo && repo.platform === CodePlatform.antcode) {
+            return repo.request.getFileBlame(repo.asRelativePath(filepath));
+          }
+        },
+      }),
+
+      registry.registerCommand<CODE_SERVICE_COMMANDS.OPEN_IN_REMOTE>(
+        CODE_SERVICE_COMMANDS.OPEN_IN_REMOTE,
+        {
+          execute: (filepath, res) => {
+            const repo = this.codeModel.getRepository(filepath);
+            if (repo) {
+              if (res.type === RemoteResourceType.Commit) {
+                const { origin } = CODE_PLATFORM_CONFIG[repo.platform];
+                this.openerService.open(`${origin}/${repo.owner}/${repo.name}/commit/${res.sha}`);
+              }
+            }
+          },
+        }
+      ),
+    ]);
+  }
+}

packages/code-service/src/index.ts

@@ -14,6 +14,7 @@ import { ICodeServiceConfig } from './types';
 import { StatusbarContribution } from './statusbar';
 import { DecorationProvider } from './decoration.provider';
 import { LineDecorationContribution } from './line-decoration.contribution';
+import { CommandsContribution } from './commands.contribution';
 
 export { CodeModelService };
 
@@ -43,6 +44,7 @@ export class CodeServiceModule extends BrowserModule {
     DecorationProvider,
     SearchContribution,
     LineDecorationContribution,
+    CommandsContribution,
     {
       token: ContentSearchServerPath,
       useClass: ContentSearchService,

packages/code-service/src/repository.ts

@@ -122,6 +122,10 @@ export class Repository implements IRepositoryModel {
       return [];
     }
   }
+
+  asRelativePath(absolutePath: string) {
+    return path.relative(this.root, absolutePath);
+  }
 }
 
 @Injectable({ multiple: true })