Support closing an issue (#6884)

Fixes #6864

Author: alexr00

common/views.ts

@@ -3,7 +3,8 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { IAccount, ILabel, IMilestone, IProject, ITeam, MergeMethod, MergeMethodsAvailability } from '../src/github/interface';
+import { ClosedEvent, CommentEvent } from '../src/common/timelineEvent';
+import { GithubItemStateEnum, IAccount, ILabel, IMilestone, IProject, ITeam, MergeMethod, MergeMethodsAvailability } from '../src/github/interface';
 import { PreReviewState } from '../src/github/views';
 
 export interface RemoteInfo {
@@ -168,4 +169,10 @@ export interface TitleAndDescriptionResult {
 	description: string | undefined;
 }
 
+export interface CloseResult {
+	state: GithubItemStateEnum;
+	commentEvent?: CommentEvent;
+	closeEvent: ClosedEvent;
+}
+
 // #endregion

package.json

@@ -828,11 +828,6 @@
 				"title": "%command.pr.readyForReview.title%",
 				"category": "%command.pull.request.category%"
 			},
-			{
-				"command": "pr.close",
-				"title": "%command.pr.close.title%",
-				"category": "%command.pull.request.category%"
-			},
 			{
 				"command": "pr.openPullRequestOnGitHub",
 				"title": "%command.pr.openPullRequestOnGitHub.title%",
@@ -1776,10 +1771,6 @@
 					"command": "review.openLocalFile",
 					"when": "false"
 				},
-				{
-					"command": "pr.close",
-					"when": "gitHubOpenRepositoryCount != 0 && github:inReviewMode"
-				},
 				{
 					"command": "pr.create",
 					"when": "gitHubOpenRepositoryCount != 0 && github:authenticated"

package.nls.json

@@ -173,7 +173,6 @@
 	"command.pr.dismissNotification.title": "Dismiss Notification",
 	"command.pr.merge.title": "Merge Pull Request",
 	"command.pr.readyForReview.title": "Mark Pull Request Ready For Review",
-	"command.pr.close.title": "Close Pull Request",
 	"command.pr.openPullRequestOnGitHub.title": "Open Pull Request on GitHub",
 	"command.pr.openAllDiffs.title": "Open All Diffs",
 	"command.pr.refreshPullRequest.title": "Refresh Pull Request",

src/commands.ts

@@ -9,7 +9,6 @@ import * as vscode from 'vscode';
 import { Repository } from './api/api';
 import { GitErrorCodes } from './api/api1';
 import { CommentReply, findActiveHandler, resolveCommentHandler } from './commentHandlerResolver';
-import { IComment } from './common/comment';
 import { commands } from './common/executeCommands';
 import Logger from './common/logger';
 import { FILE_LIST_LAYOUT, PR_SETTINGS_NAMESPACE } from './common/settingKeys';
@@ -20,7 +19,7 @@ import { formatError } from './common/utils';
 import { EXTENSION_ID } from './constants';
 import { FolderRepositoryManager } from './github/folderRepositoryManager';
 import { GitHubRepository } from './github/githubRepository';
-import { Issue, PullRequest } from './github/interface';
+import { Issue } from './github/interface';
 import { IssueModel } from './github/issueModel';
 import { IssueOverviewPanel } from './github/issueOverview';
 import { NotificationProvider } from './github/notifications';
@@ -46,9 +45,6 @@ import {
 import { PRNode } from './view/treeNodes/pullRequestNode';
 import { RepositoryChangesNode } from './view/treeNodes/repositoryChangesNode';
 
-const _onDidUpdatePR = new vscode.EventEmitter<PullRequest | void>();
-export const onDidUpdatePR: vscode.Event<PullRequest | void> = _onDidUpdatePR.event;
-
 function ensurePR(folderRepoManager: FolderRepositoryManager, pr?: PRNode): PullRequestModel;
 function ensurePR<TIssue extends Issue, TIssueModel extends IssueModel<TIssue>>(folderRepoManager: FolderRepositoryManager, pr?: TIssueModel): TIssueModel;
 function ensurePR<TIssue extends Issue, TIssueModel extends IssueModel<TIssue>>(folderRepoManager: FolderRepositoryManager, pr?: PRNode | TIssueModel): TIssueModel {
@@ -749,56 +745,6 @@ export function registerCommands(
 		}),
 	);
 
-	context.subscriptions.push(
-		vscode.commands.registerCommand('pr.close', async (pr?: PRNode | PullRequestModel, message?: string) => {
-			let pullRequestModel: PullRequestModel | undefined;
-			if (pr) {
-				pullRequestModel = pr instanceof PullRequestModel ? pr : pr.pullRequestModel;
-			} else {
-				const activePullRequests: PullRequestModel[] = reposManager.folderManagers
-					.map(folderManager => folderManager.activePullRequest!)
-					.filter(activePR => !!activePR);
-				pullRequestModel = await chooseItem<PullRequestModel>(
-					activePullRequests,
-					itemValue => `${itemValue.number}: ${itemValue.title}`,
-					{ placeHolder: vscode.l10n.t('Pull request to close') },
-				);
-			}
-			if (!pullRequestModel) {
-				return;
-			}
-			const pullRequest: PullRequestModel = pullRequestModel;
-			const yes = vscode.l10n.t('Yes');
-			return vscode.window
-				.showWarningMessage(
-					vscode.l10n.t('Are you sure you want to close this pull request on GitHub? This will close the pull request without merging.'),
-					{ modal: true },
-					yes,
-					vscode.l10n.t('No'),
-				)
-				.then(async value => {
-					if (value === yes) {
-						try {
-							let newComment: IComment | undefined = undefined;
-							if (message) {
-								newComment = await pullRequest.createIssueComment(message);
-							}
-
-							const newPR = await pullRequest.close();
-							vscode.commands.executeCommand('pr.refreshList');
-							_onDidUpdatePR.fire(newPR);
-							return newComment;
-						} catch (e) {
-							vscode.window.showErrorMessage(`Unable to close pull request. ${formatError(e)}`);
-							_onDidUpdatePR.fire();
-						}
-					}
-
-					_onDidUpdatePR.fire();
-				});
-		}),
-	);
-
 	context.subscriptions.push(
 		vscode.commands.registerCommand('pr.dismissNotification', node => {
 			if (node instanceof PRNode) {

src/common/timelineEvent.ts

@@ -19,6 +19,8 @@ export enum EventType {
 	HeadRefDeleted,
 	Merged,
 	CrossReferenced,
+	Closed,
+	Reopened,
 	Other,
 }
 
@@ -121,4 +123,18 @@ export interface CrossReferencedEvent {
 	willCloseTarget: boolean;
 }
 
-export type TimelineEvent = CommitEvent | ReviewEvent | CommentEvent | NewCommitsSinceReviewEvent | MergedEvent | AssignEvent | HeadRefDeleteEvent | CrossReferencedEvent;
+export interface ClosedEvent {
+	id: string
+	event: EventType.Closed;
+	actor: IActor;
+	createdAt: string;
+}
+
+export interface ReopenedEvent {
+	id: string;
+	event: EventType.Reopened;
+	actor: IActor;
+	createdAt: string;
+}
+
+export type TimelineEvent = CommitEvent | ReviewEvent | CommentEvent | NewCommitsSinceReviewEvent | MergedEvent | AssignEvent | HeadRefDeleteEvent | CrossReferencedEvent | ClosedEvent | ReopenedEvent;

src/github/activityBarViewProvider.ts

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
-import { onDidUpdatePR, openPullRequestOnGitHub } from '../commands';
+import { openPullRequestOnGitHub } from '../commands';
 import { IComment } from '../common/comment';
 import { disposeAll } from '../common/lifecycle';
 import { ReviewEvent as CommonReviewEvent } from '../common/timelineEvent';
@@ -31,18 +31,6 @@ export class PullRequestViewProvider extends WebviewViewBase implements vscode.W
 	) {
 		super(extensionUri);
 
-		this._register(onDidUpdatePR(
-			pr => {
-				if (pr) {
-					this._item.update(pr);
-				}
-
-				this._postMessage({
-					command: 'update-state',
-					state: this._item.state,
-				});
-			}));
-
 		this._register(this._folderRepositoryManager.onDidMergePullRequest(_ => {
 			this._postMessage({
 				command: 'update-state',

src/github/common.ts

@@ -39,6 +39,7 @@ export namespace OctokitCommon {
 	export type PullsCreateReviewResponseData = Endpoints['POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews']['response']['data'];
 	export type PullsCreateReviewCommentResponseData = Endpoints['POST /repos/{owner}/{repo}/pulls/{pull_number}/comments']['response']['data'];
 	export type PullsGetResponseData = OctokitRest.RestEndpointMethodTypes['pulls']['get']['response']['data'];
+	export type IssuesGetResponseData = OctokitRest.RestEndpointMethodTypes['issues']['get']['response']['data'];
 	export type PullsGetResponseUser = Exclude<PullsGetResponseData['user'], null>;
 	export type PullsListCommitsResponseData = Endpoints['GET /repos/{owner}/{repo}/pulls/{pull_number}/commits']['response']['data'];
 	export type PullsListRequestedReviewersResponseData = Endpoints['GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers']['response']['data'];

src/github/folderRepositoryManager.ts

@@ -1154,7 +1154,7 @@ export class FolderRepositoryManager extends Disposable {
 			Logger.debug(`Fetch pull request category ${categoryQuery} - enter`, this.id);
 			const { octokit, query, schema } = await githubRepository.ensure();
 
-			const user = await githubRepository.getAuthenticatedUser();
+			const user = (await githubRepository.getAuthenticatedUser()).login;
 			// Search api will not try to resolve repo that redirects, so get full name first
 			repo = await githubRepository.getMetadata();
 			const { data, headers } = await octokit.call(octokit.api.search.issuesAndPullRequests, {

src/github/githubRepository.ts

@@ -886,8 +886,8 @@ export class GitHubRepository extends Disposable {
 		}
 	}
 
-	async getAuthenticatedUser(): Promise<string> {
-		return (await this._credentialStore.getCurrentUser(this.remote.authProviderId)).login;
+	async getAuthenticatedUser(): Promise<IAccount> {
+		return await this._credentialStore.getCurrentUser(this.remote.authProviderId);
 	}
 
 	async getAuthenticatedUserEmails(): Promise<string[]> {

src/github/graphql.ts

@@ -47,6 +47,20 @@ export interface CrossReferencedEvent {
 	willCloseTarget: boolean;
 }
 
+export interface ClosedEvent {
+	__typename: string;
+	id: string;
+	actor: Actor;
+	createdAt: string;
+}
+
+export interface ReopenedEvent {
+	__typename: string;
+	id: string;
+	actor: Actor;
+	createdAt: string;
+}
+
 export interface AbbreviatedIssueComment {
 	author: Account;
 	body: string;