feat: add gitlab support

conwnet · conwnet · May 13, 2022 · Aug 3, 2021 · Aug 5, 2021 · Aug 12, 2021
commit e339a26e179c10305bc3528dc9b8b053a3f2bd53
diff --git a/extensions/github1s/package.json b/extensions/github1s/package.json
@@ -12,7 +12,9 @@
     "lib": "lib"
   },
   "activationEvents": [
-    "onFileSystem:github1s"
+    "onFileSystem:github1s",
+    "onFileSystem:gitlab1s",
+    "onFileSystem:bitbucket1s"
   ],
   "browser": "./dist/extension",
   "engines": {
@@ -214,7 +216,7 @@
         "command": "github1s.commands.toggleEditorGutterBlame",
         "title": "Toggle File Blame",
         "category": "GitHub1s",
-        "enablement": "!isInDiffEditor && resourceScheme =~ /^github1s$/"
+        "enablement": "!isInDiffEditor"
       },
       {
         "command": "github1s.commands.openEditorGutterBlame",
@@ -224,7 +226,7 @@
           "dark": "assets/icons/dark/open-blame.svg",
           "light": "assets/icons/light/open-blame.svg"
         },
-        "enablement": "!isInDiffEditor && resourceScheme =~ /^github1s$/"
+        "enablement": "!isInDiffEditor"
       },
       {
         "command": "github1s.commands.closeEditorGutterBlame",
@@ -234,7 +236,7 @@
           "dark": "assets/icons/dark/close-blame.svg",
           "light": "assets/icons/light/close-blame.svg"
         },
-        "enablement": "!isInDiffEditor && resourceScheme =~ /^github1s$/"
+        "enablement": "!isInDiffEditor"
       },
       {
         "command": "github1s.commands.openOnGitHub",
@@ -526,12 +528,12 @@
         },
         {
           "command": "github1s.commands.openEditorGutterBlame",
-          "when": "!isInDiffEditor && resourceScheme =~ /^github1s$/ && !github1s:blames:gutterBlameOpen",
+          "when": "!isInDiffEditor && !github1s:blames:gutterBlameOpen",
           "group": "navigation@4"
         },
         {
           "command": "github1s.commands.closeEditorGutterBlame",
-          "when": "!isInDiffEditor && resourceScheme =~ /^github1s$/ && github1s:blames:gutterBlameOpen",
+          "when": "!isInDiffEditor && github1s:blames:gutterBlameOpen",
           "group": "navigation@4"
         }
       ]

diff --git a/extensions/github1s/src/adapters/github1s/data-source.ts b/extensions/github1s/src/adapters/github1s/data-source.ts
@@ -131,7 +131,7 @@ export class GitHub1sDataSource extends DataSource {
 	);
 
 	@trySourcegraphApiFirst
-	async extractGitHubRef(repoFullName: string, refAndPath: string): Promise<{ ref: string; path: string }> {
+	async extractRefPath(repoFullName: string, refAndPath: string): Promise<{ ref: string; path: string }> {
 		const fetcher = GitHubFetcher.getInstance();
 		const { owner, repo } = parseRepoFullName(repoFullName);
 		const requestParams = { owner, repo, refAndPath };

diff --git a/extensions/github1s/src/adapters/github1s/parser/commit.ts b/extensions/github1s/src/adapters/github1s/parser/commit.ts
@@ -8,7 +8,8 @@ import { RouterState, PageType } from '../../types';
 
 export const parseCommitUrl = async (path: string): Promise<RouterState> => {
 	const pathParts = parsePath(path).pathname!.split('/').filter(Boolean);
-	const [owner, repo, _pageType, commitSha] = pathParts;
+	const [owner, repo, _pageType, ...refParts] = pathParts;
+	const commitSha = refParts.join('/');
 
 	return { repo: `${owner}/${repo}`, pageType: PageType.Commit, ref: commitSha, commitSha };
 };
diff --git a/extensions/github1s/src/adapters/github1s/parser/index.ts b/extensions/github1s/src/adapters/github1s/parser/index.ts
@@ -12,22 +12,19 @@ import { parsePullUrl } from './pull';
 import { parseCommitsUrl } from './commits';
 import { parseCommitUrl } from './commit';
 
-// detect concrete PageType the *third part* in url.path
-const detectPageTypeFromPathParts = (pathParts: string[]): PageType => {
-	const PAGE_TYPE_MAP = {
-		tree: PageType.Tree,
-		blob: PageType.Blob,
-		pulls: PageType.CodeReviewList,
-		pull: PageType.CodeReview,
-		commit: PageType.Commit,
-		commits: PageType.CommitList,
-	};
-	return pathParts[2] ? PAGE_TYPE_MAP[pathParts[2]] : PageType.Unknown;
+const PAGE_TYPE_MAP = {
+	tree: PageType.Tree,
+	blob: PageType.Blob,
+	pulls: PageType.CodeReviewList,
+	pull: PageType.CodeReview,
+	commit: PageType.Commit,
+	commits: PageType.CommitList,
 };
 
 export const parseGitHubPath = async (path: string): Promise<RouterState> => {
 	const pathParts = parsePath(path).pathname?.split('/').filter(Boolean) || [];
-	const pageType = detectPageTypeFromPathParts(pathParts);
+	// detect concrete PageType the *third part* in url.path
+	const pageType = pathParts[2] ? PAGE_TYPE_MAP[pathParts[2]] || PageType.Unknown : PageType.Tree;
 
 	if (pathParts.length >= 2) {
 		switch (pageType) {

diff --git a/extensions/github1s/src/adapters/github1s/parser/tree.ts b/extensions/github1s/src/adapters/github1s/parser/tree.ts
@@ -7,7 +7,7 @@ import { parsePath } from 'history';
 import { GitHub1sDataSource } from '../data-source';
 import { PageType, RouterState } from '../../types';
 
-export const extractGitHubRef = async (
+export const extractRefPath = async (
 	repoFullName: string,
 	refAndFilePath: string
 ): Promise<{ ref: string; path: string }> => {
@@ -18,14 +18,14 @@ export const extractGitHubRef = async (
 		return { ref: 'HEAD', path: refAndFilePath.slice(5) };
 	}
 
-	return GitHub1sDataSource.getInstance().extractGitHubRef(repoFullName, refAndFilePath);
+	return GitHub1sDataSource.getInstance().extractRefPath(repoFullName, refAndFilePath);
 };
 
 export const parseTreeUrl = async (path: string): Promise<RouterState> => {
 	const pathParts = parsePath(path).pathname!.split('/').filter(Boolean);
 	const [owner, repo, _pageType, ...restParts] = pathParts;
 	const repoFullName = `${owner}/${repo}`;
-	const { ref, path: filePath } = await extractGitHubRef(repoFullName, restParts.join('/'));
+	const { ref, path: filePath } = await extractRefPath(repoFullName, restParts.join('/'));
 
 	return { pageType: PageType.Tree, repo: repoFullName, ref, filePath };
 };
diff --git a/extensions/github1s/src/adapters/github1s/router-parser.ts b/extensions/github1s/src/adapters/github1s/router-parser.ts
@@ -3,10 +3,10 @@
  * @author netcon
  */
 
-import * as github1s from '../types';
+import * as adapterTypes from '../types';
 import { parseGitHubPath } from './parser';
 
-export class GitHub1sRouterParser extends github1s.RouterParser {
+export class GitHub1sRouterParser extends adapterTypes.RouterParser {
 	private static instance: GitHub1sRouterParser | null = null;
 
 	public static getInstance(): GitHub1sRouterParser {
@@ -16,7 +16,7 @@ export class GitHub1sRouterParser extends github1s.RouterParser {
 		return (GitHub1sRouterParser.instance = new GitHub1sRouterParser());
 	}
 
-	parsePath(path: string): Promise<github1s.RouterState> {
+	parsePath(path: string): Promise<adapterTypes.RouterState> {
 		return parseGitHubPath(path);
 	}
 
@@ -41,7 +41,7 @@ export class GitHub1sRouterParser extends github1s.RouterParser {
 		return `/${repo}/pulls`;
 	}
 
-	buildCodeReviewPath(repo: string, codeReviewId: string): github1s.Promisable<string> {
+	buildCodeReviewPath(repo: string, codeReviewId: string): adapterTypes.Promisable<string> {
 		return `/${repo}/pull/${codeReviewId}`;
 	}
 

diff --git a/extensions/github1s/src/adapters/gitlab1s/index.ts b/extensions/github1s/src/adapters/gitlab1s/index.ts
@@ -0,0 +1,31 @@
+/**
+ * @file GitLab1s adapter
+ * @author netcon
+ */
+
+import { GitLab1sRouterParser } from './router-parser';
+import { SourcegraphDataSource } from '../sourcegraph/data-source';
+import { Adapter, CodeReviewType, PlatformName } from '../types';
+import { setVSCodeContext } from '@/helpers/vscode';
+
+export class GitLab1sAdapter implements Adapter {
+	public scheme: string = 'gitlab1s';
+	public platformName = PlatformName.GitLab;
+	public codeReviewType = CodeReviewType.MergeRequest;
+
+	resolveDataSource() {
+		return Promise.resolve(SourcegraphDataSource.getInstance('gitlab'));
+	}
+
+	resolveRouterParser() {
+		return Promise.resolve(GitLab1sRouterParser.getInstance());
+	}
+
+	activateAsDefault() {
+		setVSCodeContext('github1s:views:commitList:visible', true);
+	}
+
+	deactivateAsDefault() {
+		setVSCodeContext('github1s:views:commitList:visible', false);
+	}
+}
diff --git a/extensions/github1s/src/adapters/gitlab1s/parser/blob.ts b/extensions/github1s/src/adapters/gitlab1s/parser/blob.ts
@@ -0,0 +1,29 @@
+/**
+ * @file GitLab Blob Url Parser
+ * @author netcon
+ */
+
+import { parsePath } from 'history';
+import { PageType, RouterState } from '../../types';
+import { parseTreeUrl } from './tree';
+
+export const parseBlobUrl = async (path: string): Promise<RouterState> => {
+	const routerState = (await parseTreeUrl(path)) as any;
+	const { hash: routerHash } = parsePath(path);
+
+	if (!routerHash) {
+		return { ...routerState, pageType: PageType.Blob };
+	}
+
+	// get selected line number range from path which looks like:
+	// `/gitlab-org/gitlab/-/blob/HEAD/package.json#L10-L20`
+	const matches = routerHash.match(/^#L(\d+)(?:-L(\d+))?/);
+	const [_, startLineNumber = '0', endLineNumber] = matches ? matches : [];
+
+	return {
+		...routerState,
+		pageType: PageType.Blob,
+		startLine: parseInt(startLineNumber, 10),
+		endLine: parseInt(endLineNumber || startLineNumber, 10),
+	};
+};
diff --git a/extensions/github1s/src/adapters/gitlab1s/parser/commit.ts b/extensions/github1s/src/adapters/gitlab1s/parser/commit.ts
@@ -0,0 +1,16 @@
+/**
+ * @file GitLab Commit Url Parser
+ * @author netcon
+ */
+
+import { parsePath } from 'history';
+import { RouterState, PageType } from '../../types';
+
+export const parseCommitUrl = async (path: string): Promise<RouterState> => {
+	const pathParts = parsePath(path).pathname!.split('/').filter(Boolean);
+	const dashIndex = pathParts.indexOf('-');
+	const repo = pathParts.slice(0, dashIndex).join('/');
+	const commitSha = pathParts.slice(dashIndex + 2).join('/');
+
+	return { repo, pageType: PageType.Commit, ref: commitSha, commitSha };
+};
diff --git a/extensions/github1s/src/adapters/gitlab1s/parser/commits.ts b/extensions/github1s/src/adapters/gitlab1s/parser/commits.ts
@@ -0,0 +1,16 @@
+/**
+ * @file GitLab Commit List Url Parser
+ * @author netcon
+ */
+
+import { parsePath } from 'history';
+import { RouterState, PageType } from '../../types';
+
+export const parseCommitsUrl = async (path: string): Promise<RouterState> => {
+	const pathParts = parsePath(path).pathname!.split('/').filter(Boolean);
+	const dashIndex = pathParts.indexOf('-');
+	const repo = pathParts.slice(0, dashIndex).join('/');
+	const ref = pathParts.slice(dashIndex + 2).join('/') || 'HEAD';
+
+	return { repo, pageType: PageType.CommitList, ref };
+};
diff --git a/extensions/github1s/src/adapters/gitlab1s/parser/index.ts b/extensions/github1s/src/adapters/gitlab1s/parser/index.ts
@@ -0,0 +1,47 @@
+/**
+ * @file GitLab Url Parser
+ * @author netcon
+ */
+
+import { PageType, RouterState } from '@/adapters/types';
+import { parsePath } from 'history';
+import { parseTreeUrl } from './tree';
+import { parseBlobUrl } from './blob';
+import { parseCommitsUrl } from './commits';
+import { parseCommitUrl } from './commit';
+
+const PAGE_TYPE_MAP = {
+	tree: PageType.Tree,
+	blob: PageType.Blob,
+	commit: PageType.Commit,
+	commits: PageType.CommitList,
+};
+
+export const parseGitLabPath = async (path: string): Promise<RouterState> => {
+	const pathParts = parsePath(path).pathname?.split('/').filter(Boolean) || [];
+	const dashIndex = pathParts.indexOf('-');
+	const typeSegment = dashIndex > 0 && pathParts[dashIndex + 1];
+	const pageType = typeSegment ? PAGE_TYPE_MAP[typeSegment] || PageType.Unknown : PageType.Tree;
+
+	if (dashIndex > 0) {
+		switch (pageType) {
+			case PageType.Tree:
+			case PageType.Unknown:
+				return parseTreeUrl(path);
+			case PageType.Blob:
+				return parseBlobUrl(path);
+			case PageType.Commit:
+				return parseCommitUrl(path);
+			case PageType.CommitList:
+				return parseCommitsUrl(path);
+		}
+	}
+
+	// fallback to default
+	return {
+		repo: 'gitlab-org/gitlab-docs',
+		ref: 'HEAD',
+		pageType: PageType.Tree,
+		filePath: '',
+	};
+};
diff --git a/extensions/github1s/src/adapters/gitlab1s/parser/tree.ts b/extensions/github1s/src/adapters/gitlab1s/parser/tree.ts
@@ -0,0 +1,32 @@
+/**
+ * @file GitLab Tree Url Parser
+ * @author netcon
+ */
+
+import { parsePath } from 'history';
+import { PageType, RouterState } from '../../types';
+import { SourcegraphDataSource } from '@/adapters/sourcegraph/data-source';
+
+export const extractRefPath = async (
+	repoFullName: string,
+	refAndFilePath: string
+): Promise<{ ref: string; path: string }> => {
+	if (!refAndFilePath) {
+		return { ref: 'HEAD', path: '' };
+	}
+	if (refAndFilePath.match(/^HEAD(\/.*)?$/i)) {
+		return { ref: 'HEAD', path: refAndFilePath.slice(5) };
+	}
+
+	return SourcegraphDataSource.getInstance('gitlab').extractRefPath(repoFullName, refAndFilePath);
+};
+
+export const parseTreeUrl = async (path: string): Promise<RouterState> => {
+	const pathParts = parsePath(path).pathname!.split('/').filter(Boolean);
+	const dashIndex = pathParts.indexOf('-');
+	const repo = pathParts.slice(0, dashIndex).join('/');
+	const restParts = pathParts.slice(dashIndex + 2);
+	const { ref, path: filePath } = await extractRefPath(repo, restParts.join('/'));
+
+	return { pageType: PageType.Tree, repo, ref, filePath };
+};
diff --git a/extensions/github1s/src/adapters/gitlab1s/router-parser.ts b/extensions/github1s/src/adapters/gitlab1s/router-parser.ts
@@ -0,0 +1,51 @@
+/**
+ * @file router parser
+ * @author netcon
+ */
+
+import * as adapterTypes from '../types';
+import { parseGitLabPath } from './parser/index';
+
+export class GitLab1sRouterParser extends adapterTypes.RouterParser {
+	private static instance: GitLab1sRouterParser | null = null;
+
+	public static getInstance(): GitLab1sRouterParser {
+		if (GitLab1sRouterParser.instance) {
+			return GitLab1sRouterParser.instance;
+		}
+		return (GitLab1sRouterParser.instance = new GitLab1sRouterParser());
+	}
+
+	parsePath(path: string): Promise<adapterTypes.RouterState> {
+		return parseGitLabPath(path);
+	}
+
+	buildTreePath(repo: string, ref?: string, filePath?: string): string {
+		return ref ? (filePath ? `/${repo}/-/tree/${ref}/${filePath}` : `/${repo}/-/tree/${ref}`) : `/${repo}`;
+	}
+
+	buildBlobPath(repo: string, ref: string, filePath: string, startLine?: number, endLine?: number): string {
+		const hash = startLine ? (endLine ? `#L${startLine}-L${endLine}` : `#L${startLine}`) : '';
+		return `/${repo}/-/blob/${ref}/${filePath}${hash}`;
+	}
+
+	buildCommitListPath(repo: string): string {
+		return `/${repo}/-/commits`;
+	}
+
+	buildCommitPath(repo: string, commitSha: string): string {
+		return `/${repo}/-/commit/${commitSha}`;
+	}
+
+	buildCodeReviewListPath(repo: string): string {
+		return `/${repo}/-/merge_requests`;
+	}
+
+	buildCodeReviewPath(repo: string, codeReviewId: string): adapterTypes.Promisable<string> {
+		return `/${repo}/-/merge_requests/${codeReviewId}`;
+	}
+
+	buildExternalLink(path: string): string {
+		return 'https://gitlab.com' + (path.startsWith('/') ? path : `/${path}`);
+	}
+}