{{ message }}
forked from microsoft/vscode-pull-request-github
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcreatePRViewProvider.ts
More file actions
297 lines (248 loc) · 10.1 KB
/
Copy pathcreatePRViewProvider.ts
File metadata and controls
297 lines (248 loc) · 10.1 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
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as vscode from 'vscode';
import { byRemoteName, DetachedHeadError, FolderRepositoryManager, PullRequestDefaults, titleAndBodyFrom } from './folderRepositoryManager';
import webviewContent from '../../media/createPR-webviewIndex.js';
import { getNonce, IRequestMessage, WebviewViewBase } from '../common/webview';
import { OctokitCommon } from './common';
import { PullRequestModel } from './pullRequestModel';
import Logger from '../common/logger';
import { PullRequestGitHelper } from './pullRequestGitHelper';
import { Branch, RefType } from '../api/api';
interface RemoteInfo {
owner: string;
repositoryName: string;
}
export class CreatePullRequestViewProvider extends WebviewViewBase implements vscode.WebviewViewProvider {
public readonly viewType = 'github:createPullRequest';
private _onDone = new vscode.EventEmitter<PullRequestModel | undefined>();
readonly onDone: vscode.Event<PullRequestModel | undefined> = this._onDone.event;
private _onDidChangeBaseRemote = new vscode.EventEmitter<RemoteInfo>();
readonly onDidChangeBaseRemote: vscode.Event<RemoteInfo> = this._onDidChangeBaseRemote.event;
private _onDidChangeBaseBranch = new vscode.EventEmitter<string>();
readonly onDidChangeBaseBranch: vscode.Event<string> = this._onDidChangeBaseBranch.event;
private _onDidChangeCompareBranch = new vscode.EventEmitter<string>();
readonly onDidChangeCompareBranch: vscode.Event<string> = this._onDidChangeCompareBranch.event;
private _firstLoad: boolean = true;
constructor(
private readonly _extensionUri: vscode.Uri,
private readonly _folderRepositoryManager: FolderRepositoryManager,
private readonly _pullRequestDefaults: PullRequestDefaults,
compareBranch: Branch,
) {
super();
this._compareBranch = compareBranch;
}
public resolveWebviewView(
webviewView: vscode.WebviewView,
context: vscode.WebviewViewResolveContext,
_token: vscode.CancellationToken,
) {
this._view = webviewView;
this._webview = webviewView.webview;
super.initialize();
webviewView.webview.options = {
// Allow scripts in the webview
enableScripts: true,
localResourceRoots: [
this._extensionUri
]
};
webviewView.webview.html = this._getHtmlForWebview();
if (this._firstLoad) {
this._firstLoad = false;
// Reset any stored state.
// TODO @RMacfarlane Clear stored state on extension deactivation instead.
this.initializeParams(true);
} else {
this.initializeParams();
}
}
private _compareBranch: Branch;
get compareBranch() {
return this._compareBranch;
}
set compareBranch(compareBranch: Branch) {
this._compareBranch = compareBranch;
if (compareBranch && compareBranch.name !== this._compareBranch.name) {
void this.initializeParams(true);
this._onDidChangeCompareBranch.fire(this._compareBranch.name!);
}
}
public show(compareBranch?: Branch): void {
if (compareBranch) {
this.compareBranch = compareBranch;
}
super.show();
}
private async getTitle(): Promise<string> {
// Use same default as GitHub, if there is only one commit, use the commit, otherwise use the branch name.
// By default, the base branch we use for comparison is the base branch of origin. Compare this to the
// compare branch if it has a GitHub remote.
const origin = await this._folderRepositoryManager.getOrigin(this._compareBranch);
let hasMultipleCommits = false;
if (this.compareBranch.upstream) {
const headRepo = this._folderRepositoryManager.findRepo(byRemoteName(this.compareBranch.upstream.remote));
if (headRepo) {
const headBranch = `${headRepo.remote.owner}:${this.compareBranch.name ?? ''}`;
const commits = await origin.compareCommits(this._pullRequestDefaults.base, headBranch);
hasMultipleCommits = commits.total_commits > 1;
}
}
if (hasMultipleCommits) {
return this.compareBranch.name!;
} else {
return titleAndBodyFrom(await this._folderRepositoryManager.getTipCommitMessage(this.compareBranch.name!)).title;
}
}
private async getPullRequestTemplate(): Promise<string | undefined> {
const templateUris = await this._folderRepositoryManager.getPullRequestTemplates();
if (templateUris[0]) {
try {
const templateContent = await vscode.workspace.fs.readFile(templateUris[0]);
return templateContent.toString();
} catch (e) {
Logger.appendLine(`Reading pull request template failed: ${e}`);
return undefined;
}
}
return undefined;
}
private async getDescription(): Promise<string> {
// Try to match github's default, first look for template, then use commit body if available.
const pullRequestTemplate = this.getPullRequestTemplate();
return (await pullRequestTemplate) ?? titleAndBodyFrom(await this._folderRepositoryManager.getTipCommitMessage(this.compareBranch.name!)).body ?? '';
}
public async initializeParams(reset: boolean = false): Promise<void> {
if (!this.compareBranch) {
throw new DetachedHeadError(this._folderRepositoryManager.repository);
}
const defaultRemote: RemoteInfo = {
owner: this._pullRequestDefaults.owner,
repositoryName: this._pullRequestDefaults.repo
};
const [githubRemotes, branchesForRemote, defaultTitle, defaultDescription] = await Promise.all([
this._folderRepositoryManager.getGitHubRemotes(),
this._folderRepositoryManager.listBranches(this._pullRequestDefaults.owner, this._pullRequestDefaults.repo),
this.getTitle(),
this.getDescription()
]);
const remotes: RemoteInfo[] = githubRemotes.map(remote => {
return {
owner: remote.owner,
repositoryName: remote.repositoryName
};
});
this._postMessage({
command: reset ? 'reset' : 'pr.initialize',
params: {
availableRemotes: remotes,
defaultRemote,
defaultBranch: this._pullRequestDefaults.base,
branchesForRemote,
defaultTitle,
defaultDescription,
compareBranch: this.compareBranch.name!,
isDraft: false
}
});
}
private async changeBaseRemote(message: IRequestMessage<{ owner: string, repositoryName: string }>): Promise<void> {
const { owner, repositoryName } = message.args;
const githubRepository = this._folderRepositoryManager.findRepo(repo => owner === repo.remote.owner && repositoryName === repo.remote.repositoryName);
if (!githubRepository) {
throw new Error('No matching GitHub repository found.');
}
const defaultBranch = await githubRepository.getDefaultBranch();
const newBranches = await this._folderRepositoryManager.listBranches(owner, repositoryName);
this._onDidChangeBaseRemote.fire({ owner, repositoryName });
return this._replyMessage(message, { branches: newBranches, defaultBranch });
}
private async create(message: IRequestMessage<OctokitCommon.PullsCreateParams>): Promise<void> {
try {
let branchName;
let remote;
if (this.compareBranch.type === RefType.RemoteHead) {
const index = this.compareBranch.name!.indexOf('/');
branchName = this.compareBranch.name!.substring(index + 1);
remote = this.compareBranch.name!.substring(0, index);
} else {
branchName = this.compareBranch.name!;
remote = this.compareBranch.upstream?.remote;
}
if (!remote) {
// We assume this happens only when the compare branch is based on the current branch.
const shouldPushUpstream = await vscode.window.showInformationMessage(`There is currently no upstream branch for '${branchName}'. Do you want to publish it and try again?`, { modal: true }, 'Yes');
if (shouldPushUpstream === 'Yes') {
await vscode.commands.executeCommand('git.publish');
if (this._folderRepositoryManager.repository.state.HEAD) {
this.compareBranch = this._folderRepositoryManager.repository.state.HEAD;
remote = this.compareBranch.upstream?.remote;
}
} else {
this._throwError(message, 'No upstream for the compare branch.');
return;
}
}
const headRepo = this._folderRepositoryManager.findRepo(byRemoteName(remote!));
if (!headRepo) {
throw new Error(`Unable to find GitHub repository matching '${remote}'.`);
}
const head = `${headRepo.remote.owner}:${branchName}`;
const createdPR = await this._folderRepositoryManager.createPullRequest({ ...message.args, head });
// Create was cancelled
if (!createdPR) {
this._throwError(message, 'There must be a difference in commits to create a pull request.');
} else {
await this._replyMessage(message, {});
await PullRequestGitHelper.associateBranchWithPullRequest(this._folderRepositoryManager.repository, createdPR, branchName);
this._onDone.fire(createdPR);
}
} catch (e) {
this._throwError(message, e.message);
}
}
protected async _onDidReceiveMessage(message: IRequestMessage<any>) {
const result = await super._onDidReceiveMessage(message);
if (result !== this.MESSAGE_UNHANDLED) {
return;
}
switch (message.command) {
case 'pr.cancelCreate':
vscode.commands.executeCommand('setContext', 'github:createPullRequest', false);
this._onDone.fire(undefined);
return;
case 'pr.create':
return this.create(message);
case 'pr.changeBaseRemote':
return this.changeBaseRemote(message);
case 'pr.changeBaseBranch':
this._onDidChangeBaseBranch.fire(message.args);
return;
case 'pr.changeCompareBranch':
this._onDidChangeCompareBranch.fire(message.args);
return;
default:
// Log error
vscode.window.showErrorMessage('Unsupported webview message');
}
}
private _getHtmlForWebview() {
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>Create Pull Request</title>
</head>
<body>
<div id="app"></div>
<script nonce="${nonce}">${webviewContent}</script>
</body>
</html>`;
}
}
You can’t perform that action at this time.