{{ message }}
forked from microsoft/vscode-pull-request-github
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpullRequestOverview.ts
More file actions
377 lines (329 loc) · 13.2 KB
/
Copy pathpullRequestOverview.ts
File metadata and controls
377 lines (329 loc) · 13.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
'use strict';
import * as path from 'path';
import * as vscode from 'vscode';
import { IPullRequest, IPullRequestManager, IPullRequestModel, Commit } from './interface';
import { onDidClosePR } from '../commands';
import { exec } from '../common/git';
import { TimelineEvent, EventType, ReviewEvent, CommitEvent } from '../common/timelineEvent';
import { Comment } from '../common/comment';
import { groupBy, formatError } from '../common/utils';
import { GitErrorCodes } from '../common/gitError';
export class PullRequestOverviewPanel {
/**
* Track the currently panel. Only allow a single panel to exist at a time.
*/
public static currentPanel: PullRequestOverviewPanel | undefined;
private static readonly _viewType = 'PullRequestOverview';
private readonly _panel: vscode.WebviewPanel;
private readonly _extensionPath: string;
private _disposables: vscode.Disposable[] = [];
private _pullRequest: IPullRequestModel;
private _pullRequestManager: IPullRequestManager;
private _initialized: boolean;
public static createOrShow(extensionPath: string, pullRequestManager: IPullRequestManager, pullRequestModel: IPullRequestModel) {
const column = vscode.window.activeTextEditor ? vscode.window.activeTextEditor.viewColumn : undefined;
// If we already have a panel, show it.
// Otherwise, create a new panel.
if (PullRequestOverviewPanel.currentPanel) {
PullRequestOverviewPanel.currentPanel._panel.reveal(column, true);
} else {
const title = `Pull Request #${pullRequestModel.prNumber.toString()}`;
PullRequestOverviewPanel.currentPanel = new PullRequestOverviewPanel(extensionPath, column || vscode.ViewColumn.One, title, pullRequestManager);
}
PullRequestOverviewPanel.currentPanel.update(pullRequestModel);
}
public static refresh():void {
if (this.currentPanel) {
this.currentPanel.refreshPanel();
}
}
private constructor(extensionPath: string, column: vscode.ViewColumn, title: string, pullRequestManager: IPullRequestManager) {
this._extensionPath = extensionPath;
this._pullRequestManager = pullRequestManager;
// Create and show a new webview panel
this._panel = vscode.window.createWebviewPanel(PullRequestOverviewPanel._viewType, title, column, {
// Enable javascript in the webview
enableScripts: true,
// And restric the webview to only loading content from our extension's `media` directory.
localResourceRoots: [
vscode.Uri.file(path.join(this._extensionPath, 'media'))
]
});
// Listen for when the panel is disposed
// This happens when the user closes the panel or when the panel is closed programatically
this._panel.onDidDispose(() => this.dispose(), null, this._disposables);
// Listen for changes to panel visibility, if the webview comes into view resubmit data
this._panel.onDidChangeViewState(e => {
if (e.webviewPanel.visible) {
this.update(this._pullRequest);
}
}, this, this._disposables);
// Handle messages from the webview
this._panel.webview.onDidReceiveMessage(async message => {
await this._onDidReceiveMessage(message);
}, null, this._disposables);
this._pullRequestManager.onDidChangeActivePullRequest(_ => {
if (this._pullRequestManager && this._pullRequest) {
const isCurrentlyCheckedOut = this._pullRequest.equals(this._pullRequestManager.activePullRequest);
this._panel.webview.postMessage({
command: 'pr.update-checkout-status',
isCurrentlyCheckedOut: isCurrentlyCheckedOut
});
}
}, null, this._disposables);
onDidClosePR(pr => {
if (pr) {
this._pullRequest.update(pr);
}
this._panel.webview.postMessage({
command: 'update-state',
state: this._pullRequest.state,
});
}, null, this._disposables);
}
public async refreshPanel(): Promise<void> {
this._initialized = false;
if (this._panel && this._panel.visible) {
this.update(this._pullRequest);
}
}
public async update(pullRequestModel: IPullRequestModel): Promise<void> {
this._panel.webview.html = this.getHtmlForWebview(pullRequestModel.prNumber.toString());
if (!pullRequestModel.equals(this._pullRequest) || !this._initialized) {
this._pullRequest = pullRequestModel;
this._initialized = true;
this._panel.title = `Pull Request #${pullRequestModel.prNumber.toString()}`;
const isCurrentlyCheckedOut = pullRequestModel.equals(this._pullRequestManager.activePullRequest);
Promise.all(
[
this._pullRequestManager.getPullRequestCommits(pullRequestModel),
this._pullRequestManager.getTimelineEvents(pullRequestModel),
this._pullRequestManager.getPullRequestComments(pullRequestModel),
this._pullRequestManager.getPullRequestRepositoryDefaultBranch(pullRequestModel)
]
).then(result => {
const [reviewCommits, timelineEvents, reviewComments, defaultBranch] = result;
this.fixCommentThreads(timelineEvents, reviewComments);
this.fixCommitAttribution(timelineEvents, reviewCommits);
this._panel.webview.postMessage({
command: 'pr.initialize',
pullrequest: {
number: pullRequestModel.prNumber,
title: pullRequestModel.title,
url: pullRequestModel.html_url,
createdAt: pullRequestModel.createdAt,
body: pullRequestModel.body,
author: pullRequestModel.author,
state: pullRequestModel.state,
events: timelineEvents,
isCurrentlyCheckedOut: isCurrentlyCheckedOut,
base: pullRequestModel.base && pullRequestModel.base.label || 'UNKNOWN',
head: pullRequestModel.head && pullRequestModel.head.label || 'UNKNOWN',
commitsCount: pullRequestModel.commitCount,
repositoryDefaultBranch: defaultBranch
}
});
});
}
}
/**
* For review timeline events, the comments on the event are only those in that review. Any reponses to those comments
* belong to separate reviews. This modifies review timeline event comments to contain both their comments and responses to them.
* @param timelineEvents The timeline events
* @param reviewComments All review comments
*/
private fixCommentThreads(timelineEvents: TimelineEvent[], reviewComments: Comment[]): void {
const reviewEvents: ReviewEvent[] = (<ReviewEvent[]>timelineEvents.filter(event => event.event === EventType.Reviewed));
reviewEvents.forEach(review => review.comments = []);
// Group comments by file and position
const commentsByFile = groupBy(reviewComments, comment => comment.path);
for (let file in commentsByFile) {
const fileComments = commentsByFile[file];
const commentThreads = groupBy(fileComments, comment => String(comment.position === null ? comment.original_position : comment.position));
// Loop through threads, for each thread, see if there is a matching review, push all comments to it
for (let i in commentThreads) {
const comments = commentThreads[i];
const reviewId = comments[0].pull_request_review_id;
if (reviewId) {
const matchingEvent = reviewEvents.find(review => review.id === reviewId);
if (matchingEvent) {
matchingEvent.comments = matchingEvent.comments.concat(comments);
}
}
}
}
}
/**
* Commit timeline events only list the bare user commit information, not the details of the associated GitHub user account. Add these details.
* @param timelineEvents The timeline events
* @param commits All review commits
*/
private fixCommitAttribution(timelineEvents: TimelineEvent[], commits: Commit[]): void {
const commitEvents: CommitEvent[] = (<CommitEvent[]>timelineEvents.filter(event => event.event === EventType.Committed));
for (let commitEvent of commitEvents) {
const matchingCommits = commits.filter(commit => commit.sha === commitEvent.sha);
if (matchingCommits.length === 1) {
const author = matchingCommits[0].author;
// There is not necessarily a GitHub account associated with the commit.
if (author !== null) {
commitEvent.author.avatar_url = author.avatar_url;
commitEvent.author.login = author.login;
commitEvent.author.html_url = author.html_url;
}
}
}
}
private async _onDidReceiveMessage(message) {
switch (message.command) {
case 'alert':
vscode.window.showErrorMessage(message.text);
return;
case 'pr.checkout':
return this.checkoutPullRequest();
case 'pr.close':
return this.closePullRequest(message.text);
case 'pr.approve':
return this.approvePullRequest(message.text);
case 'pr.request-changes':
return this.requestChanges(message.text);
case 'pr.checkout-default-branch':
return this.checkoutDefaultBranch(message.branch);
case 'pr.comment':
return this.createComment(message.text);
}
}
private checkoutPullRequest(): void {
vscode.commands.executeCommand('pr.pick', this._pullRequest).then(() => {}, () => {
const isCurrentlyCheckedOut = this._pullRequest.equals(this._pullRequestManager.activePullRequest);
this._panel.webview.postMessage({
command: 'pr.update-checkout-status',
isCurrentlyCheckedOut: isCurrentlyCheckedOut
});
});
}
private closePullRequest(message?: string): void {
vscode.commands.executeCommand<IPullRequest>('pr.close', this._pullRequest, message).then(comment => {
if (comment) {
this._panel.webview.postMessage({
command: 'pr.append-comment',
value: comment
});
}
});
}
private async checkoutDefaultBranch(branch: string): Promise<void> {
try {
// This should be updated for multi-root support and consume the git extension API if possible
const result = await exec(['rev-parse', '--symbolic-full-name', '@{-1}'], {
cwd: vscode.workspace.rootPath
});
if (result) {
const branchFullName = result.stdout.trim();
if (`refs/heads/${branch}` === branchFullName) {
await this._pullRequestManager.checkout(branch);
} else {
await vscode.commands.executeCommand('git.checkout');
}
}
} catch (e) {
if (e.gitErrorCode) {
// for known git errors, we should provide actions for users to continue.
if (e.gitErrorCode === GitErrorCodes.LocalChangesOverwritten) {
vscode.window.showErrorMessage('Your local changes would be overwritten by checkout, please commit your changes or stash them before you switch branches');
this._panel.webview.postMessage({
command: 'pr.enable-exit'
});
return;
}
}
vscode.window.showErrorMessage(`Exiting failed: ${e}`);
this._panel.webview.postMessage({
command: 'pr.enable-exit'
});
}
}
private createComment(text: string) {
this._pullRequestManager.createIssueComment(this._pullRequest, text).then(comment => {
this._panel.webview.postMessage({
command: 'pr.append-comment',
value: comment
});
});
}
private approvePullRequest(message?: string): void {
vscode.commands.executeCommand<IPullRequest>('pr.approve', this._pullRequest, message).then(review => {
if (review) {
this._panel.webview.postMessage({
command: 'pr.append-review',
value: review
});
}
this._panel.webview.postMessage({
command: 'pr.enable-approve'
});
}, (e) => {
vscode.window.showErrorMessage(`Approving pull request failed. ${formatError(e)}`);
this._panel.webview.postMessage({
command: 'pr.enable-approve'
});
});
}
private requestChanges(message?: string): void {
vscode.commands.executeCommand<IPullRequest>('pr.requestChanges', this._pullRequest, message).then(review => {
if (review) {
this._panel.webview.postMessage({
command: 'pr.append-review',
value: review
});
}
}, (e) => {
vscode.window.showErrorMessage(`Requesting changes failed. ${formatError(e)}`);
this._panel.webview.postMessage({
command: 'pr.enable-request-changes'
});
});
}
public dispose() {
PullRequestOverviewPanel.currentPanel = undefined;
// Clean up our resources
this._panel.dispose();
while (this._disposables.length) {
const x = this._disposables.pop();
if (x) {
x.dispose();
}
}
}
private getHtmlForWebview(number: string) {
const scriptPathOnDisk = vscode.Uri.file(path.join(this._extensionPath, 'media', 'index.js'));
const scriptUri = scriptPathOnDisk.with({ scheme: 'vscode-resource' });
const nonce = getNonce();
return `<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="Content-Security-Policy" content="default-src 'none'; img-src vscode-resource: https:; script-src 'nonce-${nonce}'; style-src vscode-resource: 'unsafe-inline' http: https: data:;">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Pull Request #${number}</title>
</head>
<body>
<script nonce="${nonce}" src="${scriptUri}"></script>
<div id="title" class="title"></div>
<div id="timeline-events" class="discussion" aria-live="polite"></div>
<div id="comment-form" class="comment-form"></div>
</body>
</html>`;
}
}
function getNonce() {
let text = '';
const possible = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
for (let i = 0; i < 32; i++) {
text += possible.charAt(Math.floor(Math.random() * possible.length));
}
return text;
}
You can’t perform that action at this time.