Re-enable branch protection in overview feature (#3445)

Author: alexr00

src/github/credentials.ts

@@ -284,7 +284,7 @@ export class CredentialStore implements vscode.Disposable {
 			request: { agent, fetch: fetchCore },
 			userAgent: 'GitHub VSCode Pull Requests',
 			// `shadow-cat-preview` is required for Draft PR API access -- https://developer.github.com/v3/previews/#draft-pull-requests
-			previews: ['shadow-cat-preview'],
+			previews: ['shadow-cat-preview', 'merge-info-preview'],
 			auth: `${token || ''}`,
 			baseUrl: baseUrl,
 		});
@@ -321,7 +321,7 @@ const link = (url: string, token: string) =>
 		headers: {
 			...headers,
 			authorization: token ? `Bearer ${token}` : '',
-			Accept: 'application/vnd.github.shadow-cat-preview+json, application/vnd.github.antiope-preview+json',
+			Accept: 'application/vnd.github.merge-info-preview'
 		},
 	})).concat(
 		createHttpLink({

src/github/githubRepository.ts

@@ -701,7 +701,6 @@ export class GitHubRepository implements vscode.Disposable {
 				},
 			});
 			Logger.debug(`Fetch pull request ${id} - done`, GitHubRepository.ID);
-
 			return this.createOrUpdatePullRequestModel(parseGraphQLPullRequest(data, this));
 		} catch (e) {
 			Logger.appendLine(`GithubRepository> Unable to fetch PR: ${e}`);
@@ -724,7 +723,7 @@ export class GitHubRepository implements vscode.Disposable {
 			});
 			Logger.debug(`Fetch issue ${id} - done`, GitHubRepository.ID);
 
-			return new IssueModel(this, remote, parseGraphQLPullRequest(data, this));
+			return new IssueModel(this, remote, parseGraphQLIssue(data.repository.pullRequest, this));
 		} catch (e) {
 			Logger.appendLine(`GithubRepository> Unable to fetch PR: ${e}`);
 			return;

src/github/graphql.ts

@@ -417,6 +417,7 @@ export interface PullRequest {
 	};
 	merged: boolean;
 	mergeable: 'MERGEABLE' | 'CONFLICTING' | 'UNKNOWN';
+	mergeStateStatus: 'BEHIND' | 'BLOCKED' | 'CLEAN' | 'DIRTY' | 'HAS_HOOKS' | 'UNKNOWN' | 'UNSTABLE';
 	isDraft?: boolean;
 	suggestedReviewers: SuggestedReviewerResponse[];
 	milestone?: {
@@ -441,6 +442,16 @@ export interface PullRequestResponse {
 	rateLimit: RateLimit;
 }
 
+export interface PullRequestMergabilityResponse {
+	repository: {
+		pullRequest: {
+			mergeable: 'MERGEABLE' | 'CONFLICTING' | 'UNKNOWN';
+			mergeStateStatus: 'BEHIND' | 'BLOCKED' | 'CLEAN' | 'DIRTY' | 'HAS_HOOKS' | 'UNKNOWN' | 'UNSTABLE';
+		};
+	};
+	rateLimit: RateLimit;
+}
+
 export interface IssuesSearchResponse {
 	search: {
 		issueCount: number;

src/github/interface.ts

@@ -24,6 +24,7 @@ export enum GithubItemStateEnum {
 export enum PullRequestMergeability {
 	Mergeable,
 	NotMergeable,
+	Conflict,
 	Unknown,
 }
 

src/github/pullRequestModel.ts

@@ -34,7 +34,7 @@ import {
 	PendingReviewIdResponse,
 	PullRequestCommentsResponse,
 	PullRequestFilesResponse,
-	PullRequestResponse,
+	PullRequestMergabilityResponse,
 	ReactionGroup,
 	ResolveReviewThreadResponse,
 	StartReviewResponse,
@@ -959,7 +959,7 @@ export class PullRequestModel extends IssueModel<PullRequest> implements IPullRe
 	 * Get the status checks of the pull request, those for the last commit.
 	 */
 	async getStatusChecks(): Promise<PullRequestChecks> {
-		const { query, remote, schema } = await this.githubRepository.ensure();
+		const { query, remote, schema, octokit } = await this.githubRepository.ensure();
 		let result;
 		try {
 			result = await query<GetChecksResponse>({
@@ -991,7 +991,7 @@ export class PullRequestModel extends IssueModel<PullRequest> implements IPullRe
 			};
 		}
 
-		return {
+		const checks: PullRequestChecks = {
 			state: statusCheckRollup.state.toLowerCase(),
 			statuses: statusCheckRollup.contexts.nodes.map(context => {
 				if (isCheckRun(context)) {
@@ -1017,6 +1017,25 @@ export class PullRequestModel extends IssueModel<PullRequest> implements IPullRe
 				}
 			}),
 		};
+
+		// Fun info: The checks don't include whether a review is required.
+		// Also, unless you're an admin on the repo, you can't just do octokit.repos.getBranchProtection
+		if (this.item.mergeable === PullRequestMergeability.NotMergeable) {
+			const branch = await octokit.repos.getBranch({ branch: this.base.ref, owner: remote.owner, repo: remote.repositoryName });
+			if (branch.data.protected && branch.data.protection.required_status_checks.enforcement_level !== 'off') {
+				// We need to add the "review required" check manually.
+				checks.statuses.unshift({
+					id: 'unknown',
+					context: 'Branch Protection',
+					description: 'Requirements have not been met.',
+					state: 'failure',
+					target_url: this.html_url
+				});
+				checks.state = 'failure';
+			}
+		}
+
+		return checks;
 	}
 
 	static async openDiffFromComment(
@@ -1186,7 +1205,7 @@ export class PullRequestModel extends IssueModel<PullRequest> implements IPullRe
 			Logger.debug(`Fetch pull request mergeability ${this.number} - enter`, PullRequestModel.ID);
 			const { query, remote, schema } = await this.githubRepository.ensure();
 
-			const { data } = await query<PullRequestResponse>({
+			const { data } = await query<PullRequestMergabilityResponse>({
 				query: schema.PullRequestMergeability,
 				variables: {
 					owner: remote.owner,
@@ -1195,7 +1214,7 @@ export class PullRequestModel extends IssueModel<PullRequest> implements IPullRe
 				},
 			});
 			Logger.debug(`Fetch pull request mergeability ${this.number} - done`, PullRequestModel.ID);
-			return parseMergeability(data.repository.pullRequest.mergeable);
+			return parseMergeability(data.repository.pullRequest.mergeable, data.repository.pullRequest.mergeStateStatus);
 		} catch (e) {
 			Logger.appendLine(`PullRequestModel> Unable to fetch PR Mergeability: ${e}`);
 			return PullRequestMergeability.Unknown;

src/github/queries.gql

@@ -334,6 +334,7 @@ query PullRequest($owner: String!, $name: String!, $number: Int!) {
 			}
 			merged
 			mergeable
+			mergeStateStatus
 			id
 			databaseId
 			isDraft
@@ -502,6 +503,7 @@ query PullRequestMergeability($owner: String!, $name: String!, $number: Int!) {
 	repository(owner: $owner, name: $name) {
 		pullRequest(number: $number) {
 			mergeable
+			mergeStateStatus
 		}
 	}
 	rateLimit {

src/github/utils.ts

@@ -479,15 +479,24 @@ export function parseMilestone(
 	};
 }
 
-export function parseMergeability(mergeability: 'UNKNOWN' | 'MERGEABLE' | 'CONFLICTING'): PullRequestMergeability {
+export function parseMergeability(mergeability: 'UNKNOWN' | 'MERGEABLE' | 'CONFLICTING',
+	mergeStateStatus: 'BEHIND' | 'BLOCKED' | 'CLEAN' | 'DIRTY' | 'HAS_HOOKS' | 'UNKNOWN' | 'UNSTABLE'): PullRequestMergeability {
+	let parsed: PullRequestMergeability;
 	switch (mergeability) {
 		case 'UNKNOWN':
-			return PullRequestMergeability.Unknown;
+			parsed = PullRequestMergeability.Unknown;
+			break;
 		case 'MERGEABLE':
-			return PullRequestMergeability.Mergeable;
+			parsed = PullRequestMergeability.Mergeable;
+			break;
 		case 'CONFLICTING':
-			return PullRequestMergeability.NotMergeable;
+			parsed = PullRequestMergeability.Conflict;
+			break;
 	}
+	if ((parsed !== PullRequestMergeability.Conflict) && (mergeStateStatus === 'BLOCKED')) {
+		parsed = PullRequestMergeability.NotMergeable;
+	}
+	return parsed;
 }
 
 export function parseGraphQLPullRequest(
@@ -513,7 +522,7 @@ export function parseGraphQLPullRequest(
 		base: parseRef(graphQLPullRequest.baseRef?.name ?? graphQLPullRequest.baseRefName, graphQLPullRequest.baseRefOid, graphQLPullRequest.baseRepository),
 		user: parseAuthor(graphQLPullRequest.author, githubRepository),
 		merged: graphQLPullRequest.merged,
-		mergeable: parseMergeability(graphQLPullRequest.mergeable),
+		mergeable: parseMergeability(graphQLPullRequest.mergeable, graphQLPullRequest.mergeStateStatus),
 		labels: graphQLPullRequest.labels.nodes,
 		isDraft: graphQLPullRequest.isDraft,
 		suggestedReviewers: parseSuggestedReviewers(graphQLPullRequest.suggestedReviewers),
@@ -587,7 +596,7 @@ export function parseGraphQLIssuesRequest(
 		base: parseRef(graphQLPullRequest.baseRef?.name ?? graphQLPullRequest.baseRefName, graphQLPullRequest.baseRefOid, graphQLPullRequest.baseRepository),
 		user: parseAuthor(graphQLPullRequest.author, githubRepository),
 		merged: graphQLPullRequest.merged,
-		mergeable: parseMergeability(graphQLPullRequest.mergeable),
+		mergeable: parseMergeability(graphQLPullRequest.mergeable, pullRequest.mergeStateStatus),
 		labels: graphQLPullRequest.labels.nodes,
 		isDraft: graphQLPullRequest.isDraft,
 		suggestedReviewers: parseSuggestedReviewers(graphQLPullRequest.suggestedReviewers),

src/test/builders/graphql/pullRequestBuilder.ts

@@ -67,6 +67,7 @@ export const PullRequestBuilder = createBuilderClass<PullRequestResponse>()({
 			}),
 			merged: { default: false },
 			mergeable: { default: 'MERGEABLE' },
+			mergeStateStatus: { default: 'CLEAN' },
 			isDraft: { default: false },
 			suggestedReviewers: { default: [] },
 		}),

webviews/components/merge.tsx

@@ -145,15 +145,17 @@ export const MergeStatus = ({ mergeable, isSimple }: { mergeable: PullRequestMer
 				? null
 				: mergeable === PullRequestMergeability.Mergeable
 					? checkIcon
-					: mergeable === PullRequestMergeability.NotMergeable
+					: (mergeable === PullRequestMergeability.NotMergeable || mergeable === PullRequestMergeability.Conflict)
 						? deleteIcon
 						: pendingIcon}
 			<div>
-				{mergeable === PullRequestMergeability.Mergeable
+				{(mergeable) === PullRequestMergeability.Mergeable
 					? 'This branch has no conflicts with the base branch.'
-					: mergeable === PullRequestMergeability.NotMergeable
+					: mergeable === PullRequestMergeability.Conflict
 						? 'This branch has conflicts that must be resolved.'
-						: 'Checking if this branch can be merged...'}
+						: mergeable === PullRequestMergeability.NotMergeable
+							? 'Branch protection policy must be fulfilled before merging.'
+							: 'Checking if this branch can be merged...'}
 			</div>
 		</div>
 	);

webviews/editorWebview/index.css

@@ -235,6 +235,16 @@ body .comment-container .review-comment-header {
 	width: 16px;
 }
 
+#status-checks .avatar-link svg {
+	width: 24px;
+	margin-right: 0px;
+    vertical-align: middle;
+}
+
+.status-check .avatar-link .avatar-icon {
+	margin-right: 0px;
+}
+
 #status-checks .merge-select-container {
 	display: flex;
 	align-items: center;