-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
github.ts
499 lines (427 loc) · 15.2 KB
/
github.ts
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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
import type { AuthenticationSession, Disposable, QuickInputButton, Range } from 'vscode';
import { env, ThemeIcon, Uri, window } from 'vscode';
import type { Autolink, DynamicAutolinkReference } from '../../annotations/autolinks';
import type { AutolinkReference } from '../../config';
import type { Container } from '../../container';
import type {
IntegrationAuthenticationProvider,
IntegrationAuthenticationSessionDescriptor,
} from '../../plus/integrationAuthentication';
import { isSubscriptionPaidPlan, isSubscriptionPreviewTrialExpired } from '../../subscription';
import { log } from '../../system/decorators/log';
import { memoize } from '../../system/decorators/memoize';
import { encodeUrl } from '../../system/encoding';
import { equalsIgnoreCase } from '../../system/string';
import type { Account } from '../models/author';
import type { DefaultBranch } from '../models/defaultBranch';
import type { IssueOrPullRequest } from '../models/issue';
import type { PullRequest, PullRequestState } from '../models/pullRequest';
import { GitRevision } from '../models/reference';
import type { Repository } from '../models/repository';
import { RichRemoteProvider } from './richRemoteProvider';
const autolinkFullIssuesRegex = /\b(?<repo>[^/\s]+\/[^/\s]+)#(?<num>[0-9]+)\b(?!]\()/g;
const fileRegex = /^\/([^/]+)\/([^/]+?)\/blob(.+)$/i;
const rangeRegex = /^L(\d+)(?:-L(\d+))?$/;
const authProvider = Object.freeze({ id: 'github', scopes: ['repo', 'read:user', 'user:email'] });
const enterpriseAuthProvider = Object.freeze({ id: 'github-enterprise', scopes: ['repo', 'read:user', 'user:email'] });
function isGitHubDotCom(domain: string): boolean {
return equalsIgnoreCase(domain, 'github.com');
}
export class GitHubRemote extends RichRemoteProvider {
@memoize()
protected get authProvider() {
return isGitHubDotCom(this.domain) ? authProvider : enterpriseAuthProvider;
}
constructor(
container: Container,
domain: string,
path: string,
protocol?: string,
name?: string,
custom: boolean = false,
) {
super(container, domain, path, protocol, name, custom);
}
get apiBaseUrl() {
return this.custom ? `${this.protocol}://${this.domain}/api/v3` : `https://api.${this.domain}`;
}
private _autolinks: (AutolinkReference | DynamicAutolinkReference)[] | undefined;
override get autolinks(): (AutolinkReference | DynamicAutolinkReference)[] {
if (this._autolinks === undefined) {
this._autolinks = [
{
prefix: '#',
url: `${this.baseUrl}/issues/<num>`,
title: `Open Issue or Pull Request #<num> on ${this.name}`,
description: `Issue or Pull Request #<num> on ${this.name}`,
},
{
prefix: 'gh-',
url: `${this.baseUrl}/issues/<num>`,
title: `Open Issue or Pull Request #<num> on ${this.name}`,
ignoreCase: true,
description: `Issue or Pull Request #<num> on ${this.name}`,
},
{
tokenize: (
text: string,
outputFormat: 'html' | 'markdown' | 'plaintext',
tokenMapping: Map<string, string>,
) => {
return outputFormat === 'plaintext'
? text
: text.replace(autolinkFullIssuesRegex, (linkText: string, repo: string, num: string) => {
const url = encodeUrl(`${this.protocol}://${this.domain}/${repo}/issues/${num}`);
const title = ` "Open Issue or Pull Request #${num} from ${repo} on ${this.name}"`;
const token = `\x00${tokenMapping.size}\x00`;
if (outputFormat === 'markdown') {
tokenMapping.set(token, `[${linkText}](${url}${title})`);
} else if (outputFormat === 'html') {
tokenMapping.set(token, `<a href="${url}" title=${title}>${linkText}</a>`);
}
return token;
});
},
parse: (text: string, autolinks: Map<string, Autolink>) => {
let repo: string;
let num: string;
let match;
do {
match = autolinkFullIssuesRegex.exec(text);
if (match?.groups == null) break;
({ repo, num } = match.groups);
autolinks.set(num, {
provider: this,
id: num,
prefix: `${repo}#`,
url: `${this.protocol}://${this.domain}/${repo}/issues/${num}`,
title: `Open Issue or Pull Request #<num> from ${repo} on ${this.name}`,
description: `Issue or Pull Request #${num} from ${repo} on ${this.name}`,
});
} while (true);
},
},
];
}
return this._autolinks;
}
override get avatarUri() {
const [owner] = this.splitPath();
return Uri.parse(`https://avatars.githubusercontent.com/${owner}`);
}
override get icon() {
return 'github';
}
get id() {
return 'github';
}
get name() {
return this.formatName('GitHub');
}
@log()
override async connect(): Promise<boolean> {
if (!isGitHubDotCom(this.domain)) {
const title =
'Connecting to a GitHub Enterprise instance for rich integration features requires a paid GitLens+ account.';
while (true) {
const subscription = await this.container.subscription.getSubscription();
if (subscription.account?.verified === false) {
const resend = { title: 'Resend Verification' };
const cancel = { title: 'Cancel', isCloseAffordance: true };
const result = await window.showWarningMessage(
`${title}\n\nYou must verify your GitLens+ account email address before you can continue.`,
{ modal: true },
resend,
cancel,
);
if (result === resend) {
if (await this.container.subscription.resendVerification()) {
continue;
}
}
return false;
}
const plan = subscription.plan.effective.id;
if (isSubscriptionPaidPlan(plan)) break;
if (subscription.account == null && !isSubscriptionPreviewTrialExpired(subscription)) {
const startTrial = { title: 'Try GitLens+' };
const cancel = { title: 'Cancel', isCloseAffordance: true };
const result = await window.showWarningMessage(
`${title}\n\nDo you want to try GitLens+ for free for 3 days?`,
{ modal: true },
startTrial,
cancel,
);
if (result !== startTrial) return false;
void this.container.subscription.startPreviewTrial();
break;
} else if (subscription.account == null) {
const signIn = { title: 'Sign In to GitLens+' };
const cancel = { title: 'Cancel', isCloseAffordance: true };
const result = await window.showWarningMessage(
`${title}\n\nDo you want to sign in to GitLens+?`,
{ modal: true },
signIn,
cancel,
);
if (result === signIn) {
if (await this.container.subscription.loginOrSignUp()) {
continue;
}
}
} else {
const upgrade = { title: 'Upgrade Account' };
const cancel = { title: 'Cancel', isCloseAffordance: true };
const result = await window.showWarningMessage(
`${title}\n\nDo you want to upgrade your account?`,
{ modal: true },
upgrade,
cancel,
);
if (result === upgrade) {
void this.container.subscription.purchase();
}
}
return false;
}
}
return super.connect();
}
async getLocalInfoFromRemoteUri(
repository: Repository,
uri: Uri,
options?: { validate?: boolean },
): Promise<{ uri: Uri; startLine?: number; endLine?: number } | undefined> {
if (uri.authority !== this.domain) return undefined;
if ((options?.validate ?? true) && !uri.path.startsWith(`/${this.path}/`)) return undefined;
let startLine;
let endLine;
if (uri.fragment) {
const match = rangeRegex.exec(uri.fragment);
if (match != null) {
const [, start, end] = match;
if (start) {
startLine = parseInt(start, 10);
if (end) {
endLine = parseInt(end, 10);
}
}
}
}
const match = fileRegex.exec(uri.path);
if (match == null) return undefined;
const [, , , path] = match;
// Check for a permalink
let index = path.indexOf('/', 1);
if (index !== -1) {
const sha = path.substring(1, index);
if (GitRevision.isSha(sha)) {
const uri = repository.toAbsoluteUri(path.substr(index), { validate: options?.validate });
if (uri != null) return { uri: uri, startLine: startLine, endLine: endLine };
}
}
// Check for a link with branch (and deal with branch names with /)
let branch;
const possibleBranches = new Map<string, string>();
index = path.length;
do {
index = path.lastIndexOf('/', index - 1);
branch = path.substring(1, index);
possibleBranches.set(branch, path.substr(index));
} while (index > 0);
if (possibleBranches.size !== 0) {
const { values: branches } = await repository.getBranches({
filter: b => b.remote && possibleBranches.has(b.getNameWithoutRemote()),
});
for (const branch of branches) {
const path = possibleBranches.get(branch.getNameWithoutRemote());
if (path == null) continue;
const uri = repository.toAbsoluteUri(path, { validate: options?.validate });
if (uri != null) return { uri: uri, startLine: startLine, endLine: endLine };
}
}
return undefined;
}
protected getUrlForBranches(): string {
return this.encodeUrl(`${this.baseUrl}/branches`);
}
protected getUrlForBranch(branch: string): string {
return this.encodeUrl(`${this.baseUrl}/tree/${branch}`);
}
protected getUrlForCommit(sha: string): string {
return this.encodeUrl(`${this.baseUrl}/commit/${sha}`);
}
protected override getUrlForComparison(base: string, compare: string, notation: '..' | '...'): string {
return this.encodeUrl(`${this.baseUrl}/compare/${base}${notation}${compare}`);
}
protected override getUrlForCreatePullRequest(
base: { branch?: string; remote: { path: string; url: string } },
compare: { branch: string; remote: { path: string; url: string } },
): string | undefined {
if (base.remote.url === compare.remote.url) {
return this.encodeUrl(`${this.baseUrl}/pull/new/${base.branch ?? 'HEAD'}...${compare.branch}`);
}
const [owner] = compare.remote.path.split('/', 1);
return this.encodeUrl(`${this.baseUrl}/pull/new/${base.branch ?? 'HEAD'}...${owner}:${compare.branch}`);
}
protected getUrlForFile(fileName: string, branch?: string, sha?: string, range?: Range): string {
let line;
if (range != null) {
if (range.start.line === range.end.line) {
line = `#L${range.start.line}`;
} else {
line = `#L${range.start.line}-L${range.end.line}`;
}
} else {
line = '';
}
if (sha) return `${this.encodeUrl(`${this.baseUrl}/blob/${sha}/${fileName}`)}${line}`;
if (branch) return `${this.encodeUrl(`${this.baseUrl}/blob/${branch}/${fileName}`)}${line}`;
return `${this.encodeUrl(`${this.baseUrl}?path=${fileName}`)}${line}`;
}
protected async getProviderAccountForCommit(
{ accessToken }: AuthenticationSession,
ref: string,
options?: {
avatarSize?: number;
},
): Promise<Account | undefined> {
const [owner, repo] = this.splitPath();
return (await this.container.github)?.getAccountForCommit(this, accessToken, owner, repo, ref, {
...options,
baseUrl: this.apiBaseUrl,
});
}
protected async getProviderAccountForEmail(
{ accessToken }: AuthenticationSession,
email: string,
options?: {
avatarSize?: number;
},
): Promise<Account | undefined> {
const [owner, repo] = this.splitPath();
return (await this.container.github)?.getAccountForEmail(this, accessToken, owner, repo, email, {
...options,
baseUrl: this.apiBaseUrl,
});
}
protected async getProviderDefaultBranch({
accessToken,
}: AuthenticationSession): Promise<DefaultBranch | undefined> {
const [owner, repo] = this.splitPath();
return (await this.container.github)?.getDefaultBranch(this, accessToken, owner, repo, {
baseUrl: this.apiBaseUrl,
});
}
protected async getProviderIssueOrPullRequest(
{ accessToken }: AuthenticationSession,
id: string,
): Promise<IssueOrPullRequest | undefined> {
const [owner, repo] = this.splitPath();
return (await this.container.github)?.getIssueOrPullRequest(this, accessToken, owner, repo, Number(id), {
baseUrl: this.apiBaseUrl,
});
}
protected async getProviderPullRequestForBranch(
{ accessToken }: AuthenticationSession,
branch: string,
options?: {
avatarSize?: number;
include?: PullRequestState[];
},
): Promise<PullRequest | undefined> {
const [owner, repo] = this.splitPath();
const { include, ...opts } = options ?? {};
const GitHubPullRequest = (await import(/* webpackChunkName: "github" */ '../../plus/github/models'))
.GitHubPullRequest;
return (await this.container.github)?.getPullRequestForBranch(this, accessToken, owner, repo, branch, {
...opts,
include: include?.map(s => GitHubPullRequest.toState(s)),
baseUrl: this.apiBaseUrl,
});
}
protected async getProviderPullRequestForCommit(
{ accessToken }: AuthenticationSession,
ref: string,
): Promise<PullRequest | undefined> {
const [owner, repo] = this.splitPath();
return (await this.container.github)?.getPullRequestForCommit(this, accessToken, owner, repo, ref, {
baseUrl: this.apiBaseUrl,
});
}
}
const gitHubNoReplyAddressRegex = /^(?:(\d+)\+)?([a-zA-Z\d-]{1,39})@users\.noreply\.(.*)$/i;
export function getGitHubNoReplyAddressParts(
email: string,
): { userId: string; login: string; authority: string } | undefined {
const match = gitHubNoReplyAddressRegex.exec(email);
if (match == null) return undefined;
const [, userId, login, authority] = match;
return { userId: userId, login: login, authority: authority };
}
export class GitHubAuthenticationProvider implements Disposable, IntegrationAuthenticationProvider {
private readonly _disposable: Disposable;
constructor(container: Container) {
this._disposable = container.integrationAuthentication.registerProvider('github-enterprise', this);
}
dispose() {
this._disposable.dispose();
}
getSessionId(descriptor?: IntegrationAuthenticationSessionDescriptor): string {
return descriptor?.domain ?? '';
}
async createSession(
descriptor?: IntegrationAuthenticationSessionDescriptor,
): Promise<AuthenticationSession | undefined> {
const input = window.createInputBox();
input.ignoreFocusOut = true;
const disposables: Disposable[] = [];
let token;
try {
const infoButton: QuickInputButton = {
iconPath: new ThemeIcon(`link-external`),
tooltip: 'Open Access Tokens page on GitHub',
};
token = await new Promise<string | undefined>(resolve => {
disposables.push(
input.onDidHide(() => resolve(undefined)),
input.onDidChangeValue(() => (input.validationMessage = undefined)),
input.onDidAccept(() => {
const value = input.value.trim();
if (!value) {
input.validationMessage = 'A personal access token is required';
return;
}
resolve(value);
}),
input.onDidTriggerButton(e => {
if (e === infoButton) {
void env.openExternal(
Uri.parse(`https://${descriptor?.domain ?? 'github.com'}/settings/tokens`),
);
}
}),
);
input.password = true;
input.title = `GitHub Authentication${descriptor?.domain ? ` \u2022 ${descriptor.domain}` : ''}`;
input.placeholder = `Requires ${descriptor?.scopes.join(', ') ?? 'all'} scopes`;
input.prompt = 'Paste your GitHub Personal Access Token';
input.buttons = [infoButton];
input.show();
});
} finally {
input.dispose();
disposables.forEach(d => void d.dispose());
}
if (!token) return undefined;
return {
id: this.getSessionId(descriptor),
accessToken: token,
scopes: [],
account: {
id: '',
label: '',
},
};
}
}