{{ message }}
Repository navigation
Expand file tree
/
Copy pathreviewManager.ts
More file actions
1675 lines (1500 loc) · 62.8 KB
/
Copy pathreviewManager.ts
File metadata and controls
1675 lines (1500 loc) · 62.8 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
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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as nodePath from 'path';
import * as vscode from 'vscode';
import type { Branch, Change, Repository } from '../api/api';
import { GitApiImpl, GitErrorCodes, Status } from '../api/api1';
import { openDescription } from '../commands';
import { CreatePullRequestHelper } from './createPullRequestHelper';
import { GitFileChangeModel, InMemFileChangeModel, RemoteFileChangeModel } from './fileChangeModel';
import { getInMemPRFileSystemProvider, provideDocumentContentForChangeModel } from './inMemPRContentProvider';
import { PullRequestChangesTreeDataProvider } from './prChangesTreeDataProvider';
import { ProgressHelper } from './progress';
import { PullRequestsTreeDataProvider } from './prsTreeDataProvider';
import { ReviewCommentController, SuggestionInformation } from './reviewCommentController';
import { ReviewModel } from './reviewModel';
import { DiffChangeType, DiffHunk, parsePatch, splitIntoSmallerHunks } from '../common/diffHunk';
import { commands } from '../common/executeCommands';
import { GitChangeType, InMemFileChange, SlimFileChange } from '../common/file';
import { Disposable, disposeAll, toDisposable } from '../common/lifecycle';
import Logger from '../common/logger';
import { parseRepositoryRemotes, Remote } from '../common/remote';
import {
COMMENTS,
FOCUSED_MODE,
IGNORE_PR_BRANCHES,
NEVER_IGNORE_DEFAULT_BRANCH,
OPEN_VIEW,
POST_CREATE,
PR_SETTINGS_NAMESPACE,
PULL_PR_BRANCH_BEFORE_CHECKOUT,
PullPRBranchVariants,
QUICK_DIFF,
} from '../common/settingKeys';
import { getReviewMode } from '../common/settingsUtils';
import { ITelemetry } from '../common/telemetry';
import { fromPRUri, fromReviewUri, KnownMediaExtensions, PRUriParams, Schemes, toReviewUri } from '../common/uri';
import { formatError, groupBy, onceEvent } from '../common/utils';
import { FOCUS_REVIEW_MODE } from '../constants';
import { GitHubCreatePullRequestLinkProvider } from '../github/createPRLinkProvider';
import { FolderRepositoryManager } from '../github/folderRepositoryManager';
import { GitHubRepository } from '../github/githubRepository';
import { GithubItemStateEnum } from '../github/interface';
import { PullRequestGitHelper, PullRequestMetadata } from '../github/pullRequestGitHelper';
import { IResolvedPullRequestModel, PullRequestModel } from '../github/pullRequestModel';
import { GitFileChangeNode, gitFileChangeNodeFilter, RemoteFileChangeNode } from './treeNodes/fileChangeNode';
import { WebviewViewCoordinator } from './webviewViewCoordinator';
export class ReviewManager extends Disposable {
public static ID = 'Review';
private static readonly MIN_POLL_INTERVAL_MS = 1000 * 60 * 5;
private static readonly MAX_POLL_INTERVAL_MS = 1000 * 60 * 30;
private static readonly POLL_BACKOFF_MULTIPLIER = 2;
private readonly _localToDispose: vscode.Disposable[] = [];
private readonly _reviewModel: ReviewModel = new ReviewModel();
private _lastCommitSha?: string;
private _validateStatusInProgress?: Promise<void>;
private _reviewCommentController: ReviewCommentController | undefined;
private _quickDiffProvider: vscode.Disposable | undefined;
private _inMemGitHubContentProvider: vscode.Disposable | undefined;
private _statusBarItem: vscode.StatusBarItem;
private _prNumber?: number;
private _isShowingLastReviewChanges: boolean = false;
private _previousRepositoryState: {
HEAD: Branch | undefined;
remotes: Remote[];
};
private _switchingToReviewMode: boolean;
private _stateValidated: boolean = false;
private _changesSinceLastReviewProgress: ProgressHelper = new ProgressHelper();
/**
* Cached max PR numbers per repo, keyed by `owner/repo`.
* Used to skip expensive `checkGitHubForPrBranch` calls when no new PRs
* have been created since the last check for the current branch.
*/
private _cachedMaxPRNumbers: Map<string, number> | undefined;
private _cachedBranchName: string | undefined;
/**
* Tracks branches for which we've already performed the one-shot GitHub
* re-check after detecting existing local PR metadata. This allows stale
* `branch.<name>.github-pr-owner-number` entries (e.g. pointing at a
* closed PR) to self-heal once, without bypassing the
* branch-change/new-PR cache on every subsequent `validateState` call.
*/
private readonly _staleMetadataCheckedBranches = new Set<string>();
private _pollHandle: NodeJS.Timeout | undefined;
private _pollIntervalMs = ReviewManager.MIN_POLL_INTERVAL_MS;
/**
* Flag set when the "Checkout" action is used and cleared on the next git
* state update, once review mode has been entered. Used to disambiguate
* explicit user action from something like reloading on an existing PR branch.
*/
private justSwitchedToReviewMode: boolean = false;
/**
* The last pull request the user explicitly switched to via the switch method.
* Used to enter review mode for this PR regardless of its state (open/closed/merged).
*/
private _switchedToPullRequest?: PullRequestModel;
private _switchedToPullRequestBranch?: string;
/**
* Track whether this repository is currently selected in the UI.
* Used to show/hide the status bar item based on repository selection.
*/
private _isRepositorySelected!: boolean;
public get switchingToReviewMode(): boolean {
return this._switchingToReviewMode;
}
public set switchingToReviewMode(newState: boolean) {
this._switchingToReviewMode = newState;
if (!newState) {
this.updateState(true);
}
}
private _isFirstLoad = true;
constructor(
private _id: number,
private _context: vscode.ExtensionContext,
private readonly _repository: Repository,
private _folderRepoManager: FolderRepositoryManager,
private _telemetry: ITelemetry,
public changesInPrDataProvider: PullRequestChangesTreeDataProvider,
private _pullRequestsTree: PullRequestsTreeDataProvider,
private _showPullRequest: ShowPullRequest,
private readonly _activePrViewCoordinator: WebviewViewCoordinator,
private _createPullRequestHelper: CreatePullRequestHelper,
private _gitApi: GitApiImpl
) {
super();
this._switchingToReviewMode = false;
this._isRepositorySelected = _repository.ui.selected;
this._previousRepositoryState = {
HEAD: _repository.state.HEAD,
remotes: parseRepositoryRemotes(this._repository),
};
this._register(toDisposable(() => disposeAll(this._localToDispose)));
this.registerListeners();
if (_gitApi.state === 'initialized') {
this.updateState(true);
}
this.pollForStateChange();
this._register(vscode.window.onDidChangeWindowState(state => {
if (state.focused && !this._pollHandle) {
// Polling was skipped because the window was not focused. Schedule a
// poll with a randomized delay (jitter) so that in multi-repo setups
// all ReviewManagers don't poll at the same time. Reuse _pollHandle so
// subsequent focus events don't trigger overlapping polls; doPoll
// applies the normal backoff rules.
const jitter = 15_000 + Math.floor(Math.random() * 45_000); // 15-60s
this._pollHandle = setTimeout(() => this.doPoll(), jitter);
}
}));
this._register(toDisposable(() => {
if (this._pollHandle) {
clearTimeout(this._pollHandle);
this._pollHandle = undefined;
}
}));
}
private registerListeners(): void {
this._register(this._repository.state.onDidChange(_ => {
const oldHead = this._previousRepositoryState.HEAD;
const newHead = this._repository.state.HEAD;
if (!oldHead && !newHead) {
// both oldHead and newHead are undefined
return;
}
let sameUpstream: boolean | undefined;
if (!oldHead || !newHead) {
sameUpstream = false;
} else {
sameUpstream = !!oldHead.upstream
? newHead.upstream &&
oldHead.upstream.name === newHead.upstream.name &&
oldHead.upstream.remote === newHead.upstream.remote
: !newHead.upstream;
}
const sameHead =
sameUpstream && // falsy if oldHead or newHead is undefined.
oldHead!.ahead === newHead!.ahead &&
oldHead!.behind === newHead!.behind &&
oldHead!.commit === newHead!.commit &&
oldHead!.name === newHead!.name &&
oldHead!.remote === newHead!.remote &&
oldHead!.type === newHead!.type;
const remotes = parseRepositoryRemotes(this._repository);
const sameRemotes =
this._previousRepositoryState.remotes.length === remotes.length &&
this._previousRepositoryState.remotes.every(remote => remotes.some(r => remote.equals(r)));
if (!sameHead || !sameRemotes) {
this._previousRepositoryState = {
HEAD: this._repository.state.HEAD,
remotes: remotes,
};
// The first time this event occurs we do want to do visible updates.
// The first time, oldHead will be undefined.
// For subsequent changes, we don't want to make visible updates.
// This occurs on branch changes.
// Note that the visible changes will occur when checking out a PR.
this.updateState(true);
}
if (oldHead && newHead) {
this.updateBaseBranchMetadata(oldHead, newHead);
}
}));
this._register(vscode.workspace.onDidChangeConfiguration(e => {
this.updateFocusedViewMode();
if (e.affectsConfiguration(`${PR_SETTINGS_NAMESPACE}.${IGNORE_PR_BRANCHES}`)) {
this.validateStateAndResetPromise(true, false);
}
}));
this._register(this._folderRepoManager.onDidChangeActivePullRequest(_ => {
this.updateFocusedViewMode();
this.registerQuickDiff();
}));
this._register(this._repository.ui.onDidChange(() => {
this._isRepositorySelected = this._repository.ui.selected;
this.updateStatusBarVisibility();
}));
this._register(GitHubCreatePullRequestLinkProvider.registerProvider(this, this._folderRepoManager));
}
private pollForStateChange() {
if (this._pollHandle) {
clearTimeout(this._pollHandle);
}
this._pollHandle = setTimeout(() => this.doPoll(), this._pollIntervalMs);
}
private async doPoll() {
if (this.isDisposed) {
return;
}
this._pollHandle = undefined;
if (!vscode.window.state.focused) {
// Skip polling while the window is not focused. Polling will resume
// immediately when the window regains focus (see onDidChangeWindowState).
Logger.appendLine('Skipping poll: window is not focused', this.id);
return;
}
Logger.appendLine('Polling for state change...', this.id);
let hasDetectedChange = false;
try {
if (!this._validateStatusInProgress) {
const shouldRefreshForActivePr = !!this._folderRepoManager.activePullRequest && await this.hasNewPullRequests();
if (shouldRefreshForActivePr) {
Logger.appendLine('Polling detected potential new PR activity while a PR is active. Refreshing state.', this.id);
}
if (!this._folderRepoManager.activePullRequest || shouldRefreshForActivePr) {
const previousPrNumber = this._prNumber;
const previousLastCommitSha = this._lastCommitSha;
await this.updateState(true, false);
hasDetectedChange =
previousPrNumber !== this._prNumber ||
previousLastCommitSha !== this._lastCommitSha;
}
}
if (hasDetectedChange) {
this._pollIntervalMs = ReviewManager.MIN_POLL_INTERVAL_MS;
Logger.appendLine(`Polling detected change. Next poll in ${Math.round(this._pollIntervalMs / 1000)}s.`, this.id);
} else {
this._pollIntervalMs = Math.min(
ReviewManager.MAX_POLL_INTERVAL_MS,
this._pollIntervalMs * ReviewManager.POLL_BACKOFF_MULTIPLIER,
);
Logger.appendLine(`Polling found no change. Backing off to ${Math.round(this._pollIntervalMs / 1000)}s.`, this.id);
}
} catch (e) {
Logger.warn(`Polling for state change failed: ${formatError(e)}`, this.id);
} finally {
if (!this.isDisposed) {
this.pollForStateChange();
}
}
}
private async updateBaseBranchMetadata(oldHead: Branch, newHead: Branch) {
if (!oldHead.commit || (oldHead.commit !== newHead.commit) || !newHead.name || !oldHead.name || (oldHead.name === newHead.name)) {
return;
}
let githubRepository = this._folderRepoManager.gitHubRepositories.find(repo => repo.remote.remoteName === oldHead.upstream?.remote);
if (githubRepository) {
const metadata = await githubRepository.getMetadata();
if (metadata.fork && oldHead.name === metadata.default_branch) {
// For forks, we use the upstream repo if it's available. Otherwise, fallback to the fork.
githubRepository = this._folderRepoManager.gitHubRepositories.find(repo => repo.remote.owner === metadata.parent?.owner?.login && repo.remote.repositoryName === metadata.parent?.name) ?? githubRepository;
}
return PullRequestGitHelper.associateBaseBranchWithBranch(this.repository, newHead.name, { owner: githubRepository.remote.owner, repo: githubRepository.remote.repositoryName, branch: oldHead.name });
}
}
private registerQuickDiff() {
if (vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<boolean>(QUICK_DIFF)) {
if (this._quickDiffProvider) {
this._quickDiffProvider.dispose();
this._quickDiffProvider = undefined;
}
const label = this._folderRepoManager.activePullRequest ? vscode.l10n.t('GitHub pull request #{0}', this._folderRepoManager.activePullRequest.number) : vscode.l10n.t('GitHub pull request');
this._register(this._quickDiffProvider = vscode.window.registerQuickDiffProvider({ scheme: 'file' }, {
provideOriginalResource: (uri: vscode.Uri) => {
const changeNode = this.reviewModel.localFileChanges.find(changeNode => changeNode.changeModel.filePath.toString() === uri.toString());
if (changeNode) {
return changeNode.changeModel.parentFilePath;
}
}
}, 'github-pr', label, this.repository.rootUri));
}
}
get statusBarItem() {
if (!this._statusBarItem) {
this._statusBarItem = vscode.window.createStatusBarItem('github.pullrequest.status', vscode.StatusBarAlignment.Left);
this._statusBarItem.name = vscode.l10n.t('GitHub Active Pull Request');
}
return this._statusBarItem;
}
/**
* Updates the status bar visibility based on whether this repository is selected.
* If there's an active PR (or switching to review mode) and the repository is selected, show the status bar.
* Otherwise, hide it.
*/
private updateStatusBarVisibility() {
if (this._statusBarItem) {
if (this._isRepositorySelected && (this._folderRepoManager.activePullRequest || this._switchingToReviewMode)) {
this._statusBarItem.show();
} else {
this._statusBarItem.hide();
}
}
}
/**
* Shows the status bar item only if this repository is currently selected.
*/
private showStatusBarIfSelected() {
if (this._isRepositorySelected) {
this.statusBarItem.show();
}
}
get repository(): Repository {
return this._repository;
}
get reviewModel() {
return this._reviewModel;
}
private get id(): string {
return `${ReviewManager.ID}+${this._id}`;
}
public async updateState(silent: boolean = false, updateLayout: boolean = true) {
if (this.switchingToReviewMode) {
return;
}
if (!this._validateStatusInProgress) {
Logger.appendLine('Validate state in progress', this.id);
this._validateStatusInProgress = this.validateStatusAndSetContext(silent, updateLayout);
return this._validateStatusInProgress;
} else {
Logger.appendLine('Queuing additional validate state', this.id);
this._validateStatusInProgress = this._validateStatusInProgress.then(async _ => {
return await this.validateStatusAndSetContext(silent, updateLayout);
});
return this._validateStatusInProgress;
}
}
private async validateStatusAndSetContext(silent: boolean, updateLayout: boolean) {
// Network errors can cause one of the GitHub API calls in validateState to never return.
let timeout: NodeJS.Timeout | undefined;
const timeoutPromise = new Promise<void>(resolve => {
timeout = setTimeout(() => {
if (timeout) {
clearTimeout(timeout);
timeout = undefined;
Logger.error('Timeout occurred while validating state.', this.id);
/* __GDPR__
"pr.checkout" : {
"version" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }
}
*/
this._telemetry.sendTelemetryErrorEvent('pr.validateStateTimeout', { version: this._context.extension.packageJSON.version });
}
resolve();
}, 1000 * 60 * 2);
});
const validatePromise = new Promise<void>(resolve => {
this.validateStateAndResetPromise(silent, updateLayout).then(() => {
const done = () => {
if (timeout) {
clearTimeout(timeout);
timeout = undefined;
}
resolve();
};
if (!this._stateValidated) {
this._stateValidated = true;
commands.setContext('github:stateValidated', true).then(done);
} else {
done();
}
});
});
return Promise.race([validatePromise, timeoutPromise]);
}
private async offerIgnoreBranch(currentBranchName): Promise<boolean> {
const ignoreBranchStateKey = 'githubPullRequest.showOfferIgnoreBranch';
const showOffer = this._context.workspaceState.get(ignoreBranchStateKey, true);
if (!showOffer) {
return false;
}
// Only show once per day.
const lastOfferTimeKey = 'githubPullRequest.offerIgnoreBranchTime';
const lastOfferTime = this._context.workspaceState.get<number>(lastOfferTimeKey, 0);
const currentTime = new Date().getTime();
if ((currentTime - lastOfferTime) < (1000 * 60 * 60 * 24)) { // 1 day
return false;
}
const { base } = await this._folderRepoManager.getPullRequestDefaults(currentBranchName);
if (base !== currentBranchName) {
return false;
}
await this._context.workspaceState.update(lastOfferTimeKey, currentTime);
const ignore = vscode.l10n.t('Ignore Pull Request');
const dontShow = vscode.l10n.t('Don\'t Show Again');
const offerResult = await vscode.window.showInformationMessage(
vscode.l10n.t(`There\'s a pull request associated with the default branch '{0}'. Do you want to ignore this Pull Request?`, currentBranchName),
ignore,
dontShow);
if (offerResult === ignore) {
Logger.appendLine(`Branch ${currentBranchName} will now be ignored in ${IGNORE_PR_BRANCHES}.`, this.id);
const settingNamespace = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE);
const setting = settingNamespace.get<string[]>(IGNORE_PR_BRANCHES, []);
setting.push(currentBranchName);
await settingNamespace.update(IGNORE_PR_BRANCHES, setting);
return true;
} else if (offerResult === dontShow) {
await this._context.workspaceState.update(ignoreBranchStateKey, false);
return false;
}
return false;
}
private async getUpstreamUrlAndName(branch: Branch): Promise<{ remoteUrl: string | undefined, upstreamBranchName: string | undefined, remoteName: string | undefined }> {
if (branch.upstream) {
Logger.debug(`Upstream for branch ${branch.name} is ${branch.upstream.remote}/${branch.upstream.name}`, this.id);
return { remoteName: branch.upstream.remote, upstreamBranchName: branch.upstream.name, remoteUrl: undefined };
} else {
try {
const remoteUrl = await this.repository.getConfig(`branch.${branch.name}.remote`);
const upstreamBranch = await this.repository.getConfig(`branch.${branch.name}.merge`);
let upstreamBranchName: string | undefined;
if (upstreamBranch) {
upstreamBranchName = upstreamBranch.substring('refs/heads/'.length);
}
Logger.debug(`Upstream for branch ${branch.name} is ${upstreamBranchName} at ${remoteUrl}`, this.id);
return { remoteUrl: remoteUrl, upstreamBranchName, remoteName: undefined };
} catch (e) {
Logger.appendLine(`Failed to get upstream for branch ${branch.name} from git config.`, this.id);
return { remoteUrl: undefined, upstreamBranchName: undefined, remoteName: undefined };
}
}
}
/**
* Returns the GitHub repos relevant to the current branch: the head repo
* (matching the branch's remote) and its parent repos (for forks, the upstream).
*/
private async getRelevantGitHubRepos(): Promise<GitHubRepository[]> {
const remoteName = this._repository.state.HEAD?.remote ?? this._repository.state.HEAD?.upstream?.remote;
if (!remoteName) {
return [];
}
const headRepo = this._folderRepoManager.gitHubRepositories.find(
repo => repo.remote.remoteName === remoteName,
);
if (!headRepo) {
return [];
}
try {
const metadata = await headRepo.getMetadata();
if (!metadata?.owner) {
return [headRepo];
}
const parentRepos = this._folderRepoManager.gitHubRepositories.filter(repo => {
if (metadata.fork) {
return repo.remote.owner === metadata.parent?.owner?.login && repo.remote.repositoryName === metadata.parent?.name;
} else {
return repo.remote.owner === metadata.owner?.login && repo.remote.repositoryName === metadata.name;
}
});
// Include both head and parent repos, deduplicated
const result = new Set<GitHubRepository>(parentRepos);
result.add(headRepo);
return [...result];
} catch (e) {
Logger.warn(`Failed to get metadata for relevant repos: ${formatError(e)}`, this.id);
return [headRepo];
}
}
private async getMaxPullRequestNumbers(): Promise<Map<string, number>> {
const result = new Map<string, number>();
const repos = await this.getRelevantGitHubRepos();
await Promise.all(repos.map(async repo => {
const max = await repo.getMaxPullRequest();
if (max !== undefined) {
result.set(`${repo.remote.owner}/${repo.remote.repositoryName}`, max);
}
}));
return result;
}
private async hasNewPullRequests(): Promise<boolean> {
if (!this._cachedMaxPRNumbers) {
this._cachedMaxPRNumbers = await this.getMaxPullRequestNumbers();
return true;
}
const current = await this.getMaxPullRequestNumbers();
// If we couldn't determine max PR for any repo, assume there may be new PRs,
// but keep the last known good cache so transient failures do not discard it.
if (current.size === 0) {
return true;
}
let result = false;
for (const [key, value] of current) {
const cached = this._cachedMaxPRNumbers.get(key);
if (cached === undefined || value > cached) {
result = true;
break;
}
}
this._cachedMaxPRNumbers = current;
return result;
}
private async checkGitHubForPrBranch(branch: Branch): Promise<(PullRequestMetadata & { model: PullRequestModel }) | undefined> {
try {
let branchToCheck: Branch;
if (this._repository.state.HEAD && (branch.name === this._repository.state.HEAD.name)) {
branchToCheck = this._repository.state.HEAD;
} else {
branchToCheck = branch;
}
const { remoteUrl: url, upstreamBranchName, remoteName } = await this.getUpstreamUrlAndName(branchToCheck);
const metadataFromGithub = await this._folderRepoManager.getMatchingPullRequestMetadataFromGitHub(branchToCheck, remoteName, url, upstreamBranchName);
if (metadataFromGithub) {
Logger.appendLine(`Found matching pull request metadata on GitHub for current branch ${branch.name}. Repo: ${metadataFromGithub.owner}/${metadataFromGithub.repositoryName} PR: ${metadataFromGithub.prNumber}`, this.id);
await PullRequestGitHelper.associateBranchWithPullRequest(
this._repository,
metadataFromGithub.model,
branch.name!,
);
return metadataFromGithub;
}
} catch (e) {
Logger.warn(`Failed to check GitHub for PR branch: ${e.message}`, this.id);
return undefined;
}
}
private async resolvePullRequest(metadata: PullRequestMetadata, useCache: boolean): Promise<(PullRequestModel & IResolvedPullRequestModel) | undefined> {
try {
this._prNumber = metadata.prNumber;
const { owner, repositoryName } = metadata;
Logger.appendLine('Resolving pull request', this.id);
let pr = await this._folderRepoManager.resolvePullRequest(owner, repositoryName, metadata.prNumber, useCache);
if (!pr || !pr.isResolved() || !(await pr.githubRepository.hasBranch(pr.base.ref))) {
await this.clear(true);
this._prNumber = undefined;
Logger.appendLine('This PR is no longer valid', this.id);
return;
}
return pr;
} catch (e) {
Logger.appendLine(`Pull request cannot be resolved: ${e.message}`, this.id);
}
}
private async validateStateAndResetPromise(silent: boolean, updateLayout: boolean): Promise<void> {
return this.validateState(silent, updateLayout).then(() => {
this._validateStatusInProgress = undefined;
});
}
private async validateState(silent: boolean, updateLayout: boolean) {
Logger.appendLine('Validating state...', this.id);
const oldLastCommitSha = this._lastCommitSha;
this._lastCommitSha = undefined;
if (!(await this._folderRepoManager.updateRepositories(false))) {
return;
}
if (!this._repository.state.HEAD) {
await this.clear(true);
return;
}
const branch = this._repository.state.HEAD;
const ignoreBranches = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<string[]>(IGNORE_PR_BRANCHES);
const remoteName = branch.remote ?? branch.upstream?.remote;
if (ignoreBranches?.find(value => value === branch.name) && ((remoteName === 'origin') || !(await this._folderRepoManager.gitHubRepositories.find(repo => repo.remote.remoteName === remoteName)?.getMetadata())?.fork)) {
Logger.appendLine(`Branch ${branch.name} is ignored in ${IGNORE_PR_BRANCHES}.`, this.id);
await this.clear(true);
return;
}
// An explicit PR checkout is still in progress, so its destination branch is not known yet.
if (this._switchedToPullRequest && !this._switchedToPullRequestBranch && this.switchingToReviewMode) {
this._lastCommitSha = oldLastCommitSha;
return;
}
let switchedToPullRequest: PullRequestModel | undefined;
if (this._switchedToPullRequest && this._switchedToPullRequestBranch && this._switchedToPullRequestBranch === branch.name) {
switchedToPullRequest = this._switchedToPullRequest;
} else {
this._switchedToPullRequest = undefined;
this._switchedToPullRequestBranch = undefined;
}
let matchingPullRequestMetadata = switchedToPullRequest ? {
owner: switchedToPullRequest.remote.owner,
repositoryName: switchedToPullRequest.remote.repositoryName,
prNumber: switchedToPullRequest.number,
} : await this._folderRepoManager.getMatchingPullRequestMetadataForBranch();
if (!matchingPullRequestMetadata) {
Logger.appendLine(`No matching pull request metadata found locally for current branch ${branch.name}`, this.id);
}
const activePullRequest = this._folderRepoManager.activePullRequest;
const branchChanged = this._cachedBranchName !== branch.name;
// Verify local metadata once per branch so stale associations can self-heal.
const shouldVerifyLocalMetadata = !switchedToPullRequest
&& !!matchingPullRequestMetadata
&& !!branch.name
&& !this._staleMetadataCheckedBranches.has(branch.name);
// If an active PR loses its local metadata, retry GitHub before clearing the view.
const shouldRecoverMissingMetadata = !matchingPullRequestMetadata
&& !!activePullRequest
&& !branchChanged;
let shouldCheckGitHub = false;
if (!switchedToPullRequest) {
shouldCheckGitHub = branchChanged || shouldRecoverMissingMetadata || shouldVerifyLocalMetadata;
if (!shouldCheckGitHub) {
shouldCheckGitHub = await this.hasNewPullRequests();
}
}
if (shouldCheckGitHub) {
const metadataFromGithub = await this.checkGitHubForPrBranch(branch);
if (metadataFromGithub) {
matchingPullRequestMetadata = metadataFromGithub;
}
if (shouldVerifyLocalMetadata && branch.name) {
this._staleMetadataCheckedBranches.add(branch.name);
}
} else if (switchedToPullRequest) {
Logger.appendLine(`Skipping GitHub check for branch ${branch.name}: using explicitly selected pull request #${switchedToPullRequest.number}`, this.id);
} else {
Logger.appendLine(`Skipping GitHub check for branch ${branch.name}: no new PRs since last check`, this.id);
}
this._cachedBranchName = branch.name;
if (!matchingPullRequestMetadata) {
if (shouldRecoverMissingMetadata && activePullRequest) {
Logger.appendLine(`Keeping active pull request #${activePullRequest.number} after its branch metadata could not be refreshed`, this.id);
this._lastCommitSha = oldLastCommitSha;
return;
}
Logger.appendLine(
`No matching pull request metadata found on GitHub for current branch ${branch.name}`, this.id
);
await this.clear(true);
return;
}
Logger.appendLine(`Found matching pull request metadata for current branch ${branch.name}. Repo: ${matchingPullRequestMetadata.owner}/${matchingPullRequestMetadata.repositoryName} PR: ${matchingPullRequestMetadata.prNumber}`, this.id);
// we switch to another PR, let's clean up first.
Logger.appendLine(
`current branch ${this._repository.state.HEAD.name} is associated with pull request #${matchingPullRequestMetadata.prNumber}`, this.id
);
const previousPrNumber = this._prNumber;
// Use the cache if we just checked out the same PR as a small performance optimization.
const justCheckedOutSamePr = this.justSwitchedToReviewMode && (previousPrNumber === matchingPullRequestMetadata.prNumber);
let pr = await this.resolvePullRequest(matchingPullRequestMetadata, justCheckedOutSamePr);
if (!pr) {
Logger.appendLine(`Unable to resolve PR #${matchingPullRequestMetadata.prNumber}`, this.id);
return;
}
Logger.appendLine(`Resolved PR #${matchingPullRequestMetadata.prNumber}, state is ${pr.state}`, this.id);
// Check if the PR is open, if not, check if there's another PR from the same branch on GitHub
if (!switchedToPullRequest && pr.state !== GithubItemStateEnum.Open) {
const metadataFromGithub = await this.checkGitHubForPrBranch(branch);
if (metadataFromGithub && metadataFromGithub?.prNumber !== pr.number) {
const prFromGitHub = await this.resolvePullRequest(metadataFromGithub, false);
if (prFromGitHub) {
pr = prFromGitHub;
}
}
}
const hasPushedChanges = branch.commit !== oldLastCommitSha && branch.ahead === 0 && branch.behind === 0;
if (!this.justSwitchedToReviewMode && (previousPrNumber === pr.number) && !hasPushedChanges && (this._isShowingLastReviewChanges === pr.showChangesSinceReview)) {
// No meaningful state change; keep the previous commit SHA so polling
// doesn't treat this as a change on the next cycle.
this._lastCommitSha = oldLastCommitSha;
return;
}
this._isShowingLastReviewChanges = pr.showChangesSinceReview;
if (previousPrNumber !== pr.number) {
this.clear(false);
}
const useReviewConfiguration = getReviewMode();
// If this is the PR the user explicitly switched to, always use review mode regardless of state
const isSwitchedToPullRequest = this._switchedToPullRequest?.number === pr.number;
if (pr.isClosed && !useReviewConfiguration.closed && !isSwitchedToPullRequest) {
Logger.appendLine('This PR is closed', this.id);
await this.clear(true);
return;
}
if (pr.isMerged && !useReviewConfiguration.merged && !isSwitchedToPullRequest) {
Logger.appendLine('This PR is merged', this.id);
await this.clear(true);
return;
}
const neverIgnoreDefaultBranch = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<boolean>(NEVER_IGNORE_DEFAULT_BRANCH, false);
if (!neverIgnoreDefaultBranch) {
// Do not await the result of offering to ignore the branch.
this.offerIgnoreBranch(branch.name);
}
const previousActive = this._folderRepoManager.activePullRequest;
this._folderRepoManager.activePullRequest = pr;
this._lastCommitSha = pr.head.sha;
if (this._isFirstLoad) {
this._isFirstLoad = false;
this._folderRepoManager.checkBranchUpToDate(pr, true);
}
Logger.appendLine('Fetching pull request data', this.id);
if (!silent) {
onceEvent(this._reviewModel.onDidChangeLocalFileChanges)(() => {
if (pr) {
this._upgradePullRequestEditors(pr);
}
});
}
// Don't await. Events will be fired as part of the initialization.
this.initializePullRequestData(pr);
await this.changesInPrDataProvider.addPrToView(
this._folderRepoManager,
pr,
this._reviewModel,
this.justSwitchedToReviewMode,
this._changesSinceLastReviewProgress
);
Logger.appendLine(`Register comments provider`, this.id);
await this.registerCommentController();
this._activePrViewCoordinator.setPullRequest(pr, this._folderRepoManager, this, previousActive);
this._localToDispose.push(
pr.onDidChangeChangesSinceReview(() => this._changesSinceLastReviewProgress.run(async () => {
this.changesInPrDataProvider.refresh();
await this.updateComments();
await this.reopenNewReviewDiffs();
PullRequestModel.openChanges(this._folderRepoManager, pr);
}))
);
Logger.appendLine(`Register in memory content provider`, this.id);
if (previousPrNumber !== pr.number) {
await this.registerGitHubInMemContentProvider();
}
this.statusBarItem.text = '$(git-pull-request) ' + vscode.l10n.t('Pull Request #{0}', pr.number);
this.statusBarItem.command = {
command: 'pr.openDescription',
title: vscode.l10n.t('View Pull Request Description'),
arguments: [pr],
};
Logger.appendLine(`Display pull request status bar indicator.`, this.id);
this.showStatusBarIfSelected();
this.layout(pr, updateLayout, this.justSwitchedToReviewMode ? false : silent);
this.justSwitchedToReviewMode = false;
}
private layout(pr: PullRequestModel, updateLayout: boolean, silent: boolean) {
const isFocusMode = this._context.workspaceState.get<boolean>(FOCUS_REVIEW_MODE);
const shouldShow = isFocusMode ? this._showPullRequest.takeShouldShow() : false;
Logger.appendLine(`Using focus mode = ${isFocusMode}.`, this.id);
Logger.appendLine(`State validation silent = ${silent}.`, this.id);
Logger.appendLine(`PR show should show = ${shouldShow}.`, this.id);
if ((!silent || shouldShow) && isFocusMode) {
this._doFocusShow(pr, updateLayout);
} else if (isFocusMode) {
const showPRChangedDisposable = this._showPullRequest.onChangedShowValue(shouldShow => {
Logger.appendLine(`PR show value changed = ${shouldShow}.`, this.id);
if (shouldShow && this._showPullRequest.takeShouldShow()) {
this._doFocusShow(pr, updateLayout);
}
showPRChangedDisposable.dispose();
});
this._localToDispose.push(showPRChangedDisposable);
}
}
private async reopenNewReviewDiffs() {
let hasOpenDiff = false;
await Promise.all(vscode.window.tabGroups.all.map(tabGroup => {
return tabGroup.tabs.map(tab => {
if (tab.input instanceof vscode.TabInputTextDiff) {
if ((tab.input.original.scheme === Schemes.Review)) {
for (const localChange of this._reviewModel.localFileChanges) {
const fileName = fromReviewUri(tab.input.original.query);
if (localChange.fileName === fileName.path) {
hasOpenDiff = true;
vscode.window.tabGroups.close(tab).then(_ => localChange.openDiff(this._folderRepoManager, { preview: tab.isPreview }));
break;
}
}
}
}
return Promise.resolve(undefined);
});
}).flat());
if (!hasOpenDiff && this._reviewModel.localFileChanges.length) {
this._reviewModel.localFileChanges[0].openDiff(this._folderRepoManager, { preview: true });
}
}
private openDiff() {
if (this._reviewModel.localFileChanges.length) {
let fileChangeToShow: GitFileChangeNode[] = [];
for (const fileChange of this._reviewModel.localFileChanges) {
if (fileChange.status === GitChangeType.MODIFY) {
if (KnownMediaExtensions.includes(nodePath.extname(fileChange.fileName))) {
fileChangeToShow.push(fileChange);
} else {
fileChangeToShow.unshift(fileChange);
break;
}
}
}
const change = fileChangeToShow.length ? fileChangeToShow[0] : this._reviewModel.localFileChanges[0];
change.openDiff(this._folderRepoManager);
}
}
private _openFirstDiff() {
if (this._reviewModel.localFileChanges.length) {
this.openDiff();
} else {
const localFileChangesDisposable = this._reviewModel.onDidChangeLocalFileChanges(() => {
localFileChangesDisposable.dispose();
this.openDiff();
});
}
}
private _doFocusShow(pr: PullRequestModel, updateLayout: boolean) {
// Respect the setting 'comments.openView' when it's 'never'.
const shouldShowCommentsView = vscode.workspace.getConfiguration(COMMENTS).get<'never' | string>(OPEN_VIEW);
if ((shouldShowCommentsView !== 'never') && (pr.hasComments)) {
commands.executeCommand('workbench.action.focusCommentsPanel');
}
this._activePrViewCoordinator.show(pr);
if (updateLayout) {
const focusedMode = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<'firstDiff' | 'overview' | 'multiDiff' | false>(FOCUSED_MODE);
if (focusedMode && pr.fileChanges.size === 0) {
// If there are no file changes, the only useful thing to show is the overview
return this.openDescription();
}
if (focusedMode === 'firstDiff') {
return this._openFirstDiff();
} else if (focusedMode === 'overview') {
return this.openDescription();
} else if (focusedMode === 'multiDiff') {
if (pr.fileChanges.size < 400) {
return PullRequestModel.openChanges(this._folderRepoManager, pr);
} else {
return this._openFirstDiff();
}
}
}
}
private async _closeOutdatedMultiDiffEditors(pullRequest: PullRequestModel): Promise<void> {
// Close any multidiff editors for this PR that may be outdated
const multiDiffLabel = vscode.l10n.t('Changes in Pull Request #{0}', pullRequest.number);
const closePromises: Promise<boolean>[] = [];
for (const tabGroup of vscode.window.tabGroups.all) {
for (const tab of tabGroup.tabs) {
// Check if this is a TabInputTextMultiDiff with matching label
if (tab.input instanceof vscode.TabInputTextMultiDiff && tab.label.startsWith(multiDiffLabel)) {
Logger.appendLine(`Closing outdated multidiff editor for PR #${pullRequest.number}`, this.id);
closePromises.push(Promise.resolve(vscode.window.tabGroups.close(tab)));
}
}
}
await Promise.all(closePromises);
}
public async _upgradePullRequestEditors(pullRequest: PullRequestModel) {
// Close any outdated multidiff editors first
await this._closeOutdatedMultiDiffEditors(pullRequest);
// Go through all open editors and find pr scheme editors that belong to the active pull request.
// Close the editors, and reopen them from the pull request.
const reopenFilenames: Set<[PRUriParams, PRUriParams]> = new Set();
await Promise.all(vscode.window.tabGroups.all.map(tabGroup => {
return tabGroup.tabs.map(tab => {
if (tab.input instanceof vscode.TabInputTextDiff) {
if ((tab.input.original.scheme === Schemes.Pr) && (tab.input.modified.scheme === Schemes.Pr)) {
const originalParams = fromPRUri(tab.input.original);
const modifiedParams = fromPRUri(tab.input.modified);
if ((originalParams?.prNumber === pullRequest.number) && (modifiedParams?.prNumber === pullRequest.number)) {
reopenFilenames.add([originalParams, modifiedParams]);
return vscode.window.tabGroups.close(tab);
}
}
}
return Promise.resolve(undefined);
});
}).flat());
const reopenPromises: Promise<void>[] = [];
if (reopenFilenames.size) {
for (const localChange of this.reviewModel.localFileChanges) {
for (const prFileChange of reopenFilenames) {
if (Array.isArray(prFileChange)) {
const modifiedPrChange = prFileChange[1];
if (localChange.fileName === modifiedPrChange.fileName) {
reopenPromises.push(localChange.openDiff(this._folderRepoManager, { preview: false }));
reopenFilenames.delete(prFileChange);
break;
}
}
}
}
}
return Promise.all(reopenPromises);
}
async createSuggestionFromChange(editor: vscode.TextDocument, diffLines: vscode.LineChange[]) {
const change = this._reviewModel.localFileChanges.find(change => change.changeModel.filePath.toString() === editor.uri.toString());
You can’t perform that action at this time.