#462 Add "CI/CD Status" column

package.json

@@ -484,12 +484,17 @@
 						"Commit": {
 							"type": "boolean",
 							"title": "Visibility of the Commit column"
+						},
+						"CICD": {
+							"type": "boolean",
+							"title": "Visibility of the CI/CD Status column"
 						}
 					},
 					"default": {
 						"Date": true,
 						"Author": true,
-						"Commit": true
+						"Commit": true,
+						"CICD": true
 					},
 					"description": "An object specifying the default visibility of the Date, Author & Commit columns. Example: {\"Date\": true, \"Author\": true, \"Commit\": true}"
 				},
@@ -1471,11 +1476,14 @@
 		"test-and-report-coverage": "jest --verbose --coverage"
 	},
 	"dependencies": {
-		"iconv-lite": "0.5.0"
+		"iconv-lite": "0.5.0",
+		"request": "2.88.2",
+		"request-promise": "4.2.6"
 	},
 	"devDependencies": {
 		"@types/jest": "26.0.19",
 		"@types/node": "8.10.62",
+		"@types/request-promise": "4.1.46",
 		"@types/vscode": "1.38.0",
 		"@typescript-eslint/eslint-plugin": "4.10.0",
 		"@typescript-eslint/parser": "4.10.0",

src/config.ts

@@ -160,10 +160,10 @@ class Config {
 	 */
 	get defaultColumnVisibility(): DefaultColumnVisibility {
 		let obj: any = this.config.get('defaultColumnVisibility', {});
-		if (typeof obj === 'object' && obj !== null && typeof obj['Date'] === 'boolean' && typeof obj['Author'] === 'boolean' && typeof obj['Commit'] === 'boolean') {
-			return { author: obj['Author'], commit: obj['Commit'], date: obj['Date'] };
+		if (typeof obj === 'object' && obj !== null && typeof obj['Date'] === 'boolean' && typeof obj['Author'] === 'boolean' && typeof obj['Commit'] === 'boolean' && typeof obj['CICD'] === 'boolean') {
+			return { author: obj['Author'], commit: obj['Commit'], date: obj['Date'], cicd: obj['CICD']};
 		} else {
-			return { author: true, commit: true, date: true };
+			return { author: true, commit: true, date: true, cicd: true };
 		}
 	}
 

src/dataSource.ts

@@ -6,10 +6,11 @@ import * as vscode from 'vscode';
 import { AskpassEnvironment, AskpassManager } from './askpass/askpassManager';
 import { getConfig } from './config';
 import { Logger } from './logger';
-import { CommitOrdering, DateType, DeepWriteable, ErrorInfo, GitCommit, GitCommitDetails, GitCommitStash, GitConfigLocation, GitFileChange, GitFileStatus, GitPushBranchMode, GitRepoConfig, GitRepoConfigBranches, GitResetMode, GitSignatureStatus, GitStash, MergeActionOn, RebaseActionOn, SquashMessageFormat, TagType, Writeable } from './types';
+import { CICDConfig, CICDProvider, CommitOrdering, DateType, DeepWriteable, ErrorInfo, GitCICDData, GitCommit, GitCommitDetails, GitCommitStash, GitConfigLocation, GitFileChange, GitFileStatus, GitPushBranchMode, GitRepoConfig, GitRepoConfigBranches, GitResetMode, GitSignatureStatus, GitStash, MergeActionOn, RebaseActionOn, SquashMessageFormat, TagType, Writeable } from './types';
 import { GitExecutable, UNABLE_TO_FIND_GIT_MSG, UNCOMMITTED, abbrevCommit, constructIncompatibleGitVersionMessage, doesVersionMeetRequirement, getPathFromStr, getPathFromUri, openGitTerminal, pathWithTrailingSlash, realpath, resolveSpawnOutput, showErrorMessage } from './utils';
 import { Disposable } from './utils/disposable';
 import { Event } from './utils/event';
+import * as request from 'request-promise';
 
 const DRIVE_LETTER_PATH_REGEX = /^[a-z]:\//;
 const EOL_REGEX = /\r\n|\r|\n/g;
@@ -158,13 +159,15 @@ export class DataSource extends Disposable {
 	 * @param stashes An array of all stashes in the repository.
 	 * @returns The commits in the repository.
 	 */
-	public getCommits(repo: string, branches: ReadonlyArray<string> | null, maxCommits: number, showTags: boolean, showRemoteBranches: boolean, includeCommitsMentionedByReflogs: boolean, onlyFollowFirstParent: boolean, commitOrdering: CommitOrdering, remotes: ReadonlyArray<string>, hideRemotes: ReadonlyArray<string>, stashes: ReadonlyArray<GitStash>): Promise<GitCommitData> {
+	public getCommits(repo: string, branches: ReadonlyArray<string> | null, maxCommits: number, showTags: boolean, showRemoteBranches: boolean, includeCommitsMentionedByReflogs: boolean, onlyFollowFirstParent: boolean, commitOrdering: CommitOrdering, remotes: ReadonlyArray<string>, hideRemotes: ReadonlyArray<string>, stashes: ReadonlyArray<GitStash>, cicdConfigs: CICDConfig[] | null): Promise<GitCommitData> {
 		const config = getConfig();
 		return Promise.all([
 			this.getLog(repo, branches, maxCommits + 1, showTags && config.showCommitsOnlyReferencedByTags, showRemoteBranches, includeCommitsMentionedByReflogs, onlyFollowFirstParent, commitOrdering, remotes, hideRemotes, stashes),
-			this.getRefs(repo, showRemoteBranches, config.showRemoteHeads, hideRemotes).then((refData: GitRefData) => refData, (errorMessage: string) => errorMessage)
+			this.getRefs(repo, showRemoteBranches, config.showRemoteHeads, hideRemotes).then((refData: GitRefData) => refData, (errorMessage: string) => errorMessage),
+			this.getCICDs(cicdConfigs).then((refData: GitCICDData[] | string | undefined) => refData, (errorMessage: string) => errorMessage)
 		]).then(async (results) => {
 			let commits: GitCommitRecord[] = results[0], refData: GitRefData | string = results[1], i;
+			let cicds: GitCICDData[] | string | undefined = results[2];
 			let moreCommitsAvailable = commits.length === maxCommits + 1;
 			if (moreCommitsAvailable) commits.pop();
 
@@ -197,7 +200,7 @@ export class DataSource extends Disposable {
 
 			for (i = 0; i < commits.length; i++) {
 				commitLookup[commits[i].hash] = i;
-				commitNodes.push({ ...commits[i], heads: [], tags: [], remotes: [], stash: null });
+				commitNodes.push({ ...commits[i], heads: [], tags: [], remotes: [], stash: null, cicd: null });
 			}
 
 			/* Insert Stashes */
@@ -217,6 +220,7 @@ export class DataSource extends Disposable {
 			for (i = toAdd.length - 1; i >= 0; i--) {
 				let stash = toAdd[i].data;
 				commitNodes.splice(toAdd[i].index, 0, {
+					cicd: null,
 					hash: stash.hash,
 					parents: [stash.baseHash],
 					author: stash.author,
@@ -257,6 +261,16 @@ export class DataSource extends Disposable {
 				}
 			}
 
+			if (typeof cicds === 'string' || typeof cicds === 'undefined') {
+				cicds = [];
+			}
+			/* Annotate CI/CDs */
+			for (i = 0; i < cicds.length; i++) {
+				if (typeof commitLookup[cicds[i].sha] === 'number') {
+					commitNodes[commitLookup[cicds[i].sha]].cicd = cicds[i];
+				}
+			}
+
 			return {
 				commits: commitNodes,
 				head: refData.head,
@@ -1496,6 +1510,182 @@ export class DataSource extends Disposable {
 		});
 	}
 
+	/**
+	 * Get the result in a CI/CDs.
+	 * @param cicdConfigs CI/CD configuration.
+	 * @returns The references data.
+	 */
+	private async getCICDs(cicdConfigs: CICDConfig[] | null) {
+		if (cicdConfigs === null) {
+			return '';
+		}
+
+		return await Promise.all(
+			cicdConfigs.map(async cicdConfig => {
+				if (cicdConfig.provider === CICDProvider.GitHubV3) {
+
+					const match1 = cicdConfig.gitUrl.match(/^(https?:\/\/|git@)((?=[^/]+@)[^@]+@|(?![^/]+@))([^/:]+)/);
+					let hostRootUrl = match1 !== null ? 'https://api.' + match1[3] : '';
+
+					const match2 = cicdConfig.gitUrl.match(/^(https?:\/\/|git@)[^/:]+[/:]([^/]+)\/([^/]*?)(.git|)$/);
+					let sourceOwner = match2 !== null ? match2[2] : '';
+					let sourceRepo = match2 !== null ? match2[3] : '';
+
+					const apiRoot = `${hostRootUrl}`;
+					const cicdRootPath = `/repos/${sourceOwner}/${sourceRepo.replace(/\//g, '%2F')}/actions/runs?per_page=100`;
+
+					let config: request.RequestPromiseOptions = {
+						method: 'GET',
+						headers: {
+							'Authorization': `token ${cicdConfig.glToken}`,
+							'Accept': 'application/vnd.github.v3+json',
+							'User-Agent': 'vscode-git-graph'
+						}
+					};
+					if (cicdConfig.glToken === '' && config.headers) {
+						delete config.headers['Authorization'];
+					}
+
+					config.transform = (body, response) => {
+						try {
+							let res: any = JSON.parse(body);
+							let last = 1;
+							let next = 2;
+							if (typeof response.headers['link'] === 'string') {
+								next = 3;
+								const DELIM_LINKS = ',';
+								const DELIM_LINK_PARAM = ';';
+								let links = response.headers['link'].split(DELIM_LINKS);
+								links.forEach(link => {
+									let segments = link.split(DELIM_LINK_PARAM);
+
+									let linkPart = segments[0].trim();
+									if (!linkPart.startsWith('<') || !linkPart.endsWith('>')) {
+										return true;
+									}
+									linkPart = linkPart.substring(1, linkPart.length - 1);
+									let match3 = linkPart.match(/&page=(\d+).*$/);
+									let linkPage = match3 !== null ? match3[1] : '0';
+
+									for (let i = 1; i < segments.length; i++) {
+										let rel = segments[i].trim().split('=');
+										if (rel.length < 2) {
+											continue;
+										}
+
+										let relValue = rel[1];
+										if (relValue.startsWith('"') && relValue.endsWith('"')) {
+											relValue = relValue.substring(1, relValue.length - 1);
+										}
+
+										if (relValue === 'last') {
+											last = parseInt(linkPage);
+										} else if (relValue === 'next') {
+											next = parseInt(linkPage);
+										}
+									}
+								});
+							}
+							if (typeof res['workflow_runs'] !== 'undefined' && res['workflow_runs'].length >= 1) { // url found
+								let ret: GitCICDData[] = res['workflow_runs'].map( (elm: { [x: string]: any; }) => {
+									return {
+										id: elm['id'],
+										status: elm['conclusion'],
+										ref: elm['name'],
+										sha: elm['head_sha'],
+										web_url: elm['html_url'],
+										created_at: elm['created_at'],
+										updated_at: elm['updated_at']
+									};
+								});
+								if (next === 2) {
+									return { x_total_pages: last, ret: ret };
+								}
+								return ret;
+							}
+							return { x_total_pages: 0, ret: 'error' };
+						} catch (e) {
+							return { x_total_pages: 0, ret: e };
+						}
+					};
+					return request(`${apiRoot}${cicdRootPath}`, config).then(async (result1st) => {
+						let promises = [];
+						promises.push(result1st.ret);
+						for (let i = 1; i < result1st.x_total_pages; i++) {
+							promises.push(request(`${apiRoot}${cicdRootPath}&page=${i + 1}`, config));
+						}
+						return await Promise.all(promises);
+					}).then((resultAll) => {
+						let retAll: GitCICDData[] = [];
+						for (let i = 0; i < resultAll.length; i++) {
+							retAll = retAll.concat(resultAll[i]);
+						}
+						return retAll;
+					});
+				}
+				if (cicdConfig.provider === CICDProvider.GitLabV4) {
+
+					const match1 = cicdConfig.gitUrl.match(/^(https?:\/\/|git@)((?=[^/]+@)[^@]+@|(?![^/]+@))([^/:]+)/);
+					let hostRootUrl = match1 !== null ? 'https://' + match1[3] : '';
+
+					const match2 = cicdConfig.gitUrl.match(/^(https?:\/\/|git@)[^/:]+[/:]([^/]+)\/([^/]*?)(.git|)$/);
+					let sourceOwner = match2 !== null ? match2[2] : '';
+					let sourceRepo = match2 !== null ? match2[3] : '';
+
+					const apiRoot = `${hostRootUrl}/api/v4`;
+					const cicdRootPath = `/projects/${sourceOwner}%2F${sourceRepo.replace(/\//g, '%2F')}/pipelines?per_page=100`;
+
+					const config: request.RequestPromiseOptions = {
+						method: 'GET',
+						headers: {
+							'PRIVATE-TOKEN': cicdConfig.glToken,
+							'User-Agent': 'vscode-git-graph'
+						}
+					};
+
+					config.transform = (body, response) => {
+						try {
+							if (typeof response.headers['x-page'] === 'string' && typeof response.headers['x-total-pages'] === 'string' && typeof response.headers['x-total'] === 'string') {
+								let res: any = JSON.parse(body);
+								if (parseInt(response.headers['x-total']) !== 0 && res.length && res[0].id) { // url found
+									let ret: GitCICDData[] = res;
+									if (parseInt(response.headers['x-page']) === 1) {
+										return { x_total_pages: parseInt(response.headers['x-total-pages']), ret: ret };
+									}
+									return ret;
+								}
+							}
+							return { x_total_pages: 0, ret: 'error' };
+						} catch (e) {
+							return { x_total_pages: 0, ret: e };
+						}
+					};
+					return request(`${apiRoot}${cicdRootPath}`, config).then(async (result1st) => {
+						let promises = [];
+						promises.push(result1st.ret);
+						for (let i = 1; i < result1st.x_total_pages; i++) {
+							promises.push(request(`${apiRoot}${cicdRootPath}&page=${i + 1}`, config));
+						}
+						return await Promise.all(promises);
+					}).then((resultAll) => {
+						let retAll: GitCICDData[] = [];
+						for (let i = 0; i < resultAll.length; i++) {
+							retAll = retAll.concat(resultAll[i]);
+						}
+						return retAll;
+					});
+				}
+			})
+		).then((resultAll2) => {
+			let retAll: GitCICDData[] = [];
+			resultAll2.forEach(resultList => {
+				resultList?.forEach(result => {
+					retAll = retAll.concat(result);
+				});
+			});
+			return retAll;
+		});
+	}
 	/**
 	 * Get the references in a repository.
 	 * @param repo The path of the repository.

src/extensionState.ts

@@ -32,6 +32,7 @@ export const DEFAULT_REPO_STATE: GitRepoState = {
 	onRepoLoadShowCheckedOutBranch: BooleanOverride.Default,
 	onRepoLoadShowSpecificBranches: null,
 	pullRequestConfig: null,
+	cicdConfigs: null,
 	showRemoteBranches: true,
 	showRemoteBranchesV2: BooleanOverride.Default,
 	showStashes: BooleanOverride.Default,

src/gitGraphView.ts

@@ -404,7 +404,7 @@ export class GitGraphView extends Disposable {
 					command: 'loadCommits',
 					refreshId: msg.refreshId,
 					onlyFollowFirstParent: msg.onlyFollowFirstParent,
-					...await this.dataSource.getCommits(msg.repo, msg.branches, msg.maxCommits, msg.showTags, msg.showRemoteBranches, msg.includeCommitsMentionedByReflogs, msg.onlyFollowFirstParent, msg.commitOrdering, msg.remotes, msg.hideRemotes, msg.stashes)
+					...await this.dataSource.getCommits(msg.repo, msg.branches, msg.maxCommits, msg.showTags, msg.showRemoteBranches, msg.includeCommitsMentionedByReflogs, msg.onlyFollowFirstParent, msg.commitOrdering, msg.remotes, msg.hideRemotes, msg.stashes, msg.cicdConfigs)
 				});
 				break;
 			case 'loadConfig':

src/types.ts

@@ -11,6 +11,17 @@ export interface GitCommit {
 	readonly tags: ReadonlyArray<GitCommitTag>;
 	readonly remotes: ReadonlyArray<GitCommitRemote>;
 	readonly stash: GitCommitStash | null; // null => not a stash, otherwise => stash info
+	readonly cicd: GitCICDData | null;
+}
+
+export interface GitCICDData {
+	id: string;
+	status: string;
+	ref: string;
+	sha: string;
+	web_url: string;
+	created_at: string;
+	updated_at: string;
 }
 
 export interface GitCommitTag {
@@ -188,6 +199,36 @@ interface PullRequestConfigCustom extends PullRequestConfigBase {
 
 export type PullRequestConfig = PullRequestConfigBuiltIn | PullRequestConfigCustom;
 
+
+
+export interface CICDConfigBase {
+	readonly gitUrl: string;
+	readonly glToken: string;
+}
+
+export const enum CICDProvider {
+	Bitbucket,
+	Custom,
+	GitHubV3,
+	GitLabV4,
+	Jenkins
+}
+
+interface CICDConfigBuiltIn extends CICDConfigBase {
+	readonly provider: CICDProvider;
+	readonly custom: null;
+}
+
+interface CICDConfigCustom extends CICDConfigBase {
+	readonly provider: CICDProvider.Custom;
+	readonly custom: {
+		readonly name: string,
+		readonly templateUrl: string
+	};
+}
+
+export type CICDConfig = CICDConfigBuiltIn | CICDConfigCustom;
+
 export interface GitRepoState {
 	cdvDivider: number;
 	cdvHeight: number;
@@ -203,6 +244,7 @@ export interface GitRepoState {
 	onRepoLoadShowCheckedOutBranch: BooleanOverride;
 	onRepoLoadShowSpecificBranches: string[] | null;
 	pullRequestConfig: PullRequestConfig | null;
+	cicdConfigs: CICDConfig[] | null;
 	showRemoteBranches: boolean;
 	showRemoteBranchesV2: BooleanOverride;
 	showStashes: BooleanOverride;
@@ -427,6 +469,7 @@ export interface DefaultColumnVisibility {
 	readonly date: boolean;
 	readonly author: boolean;
 	readonly commit: boolean;
+	readonly cicd: boolean;
 }
 
 export interface DialogDefaults {
@@ -884,6 +927,7 @@ export interface RequestLoadCommits extends RepoRequest {
 	readonly remotes: ReadonlyArray<string>;
 	readonly hideRemotes: ReadonlyArray<string>;
 	readonly stashes: ReadonlyArray<GitStash>;
+	readonly cicdConfigs: CICDConfig[] | null;
 }
 export interface ResponseLoadCommits extends ResponseWithErrorInfo {
 	readonly command: 'loadCommits';