Fix stuck changes-since-review progress

src/test/view/progress.test.ts

@@ -0,0 +1,27 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { default as assert } from 'assert';
+import { ProgressHelper } from '../../view/progress';
+
+describe('ProgressHelper', function () {
+	it('ends progress when the task fails', async function () {
+		const helper = new ProgressHelper();
+		const error = new Error('Failed to update');
+		let progressEnded = false;
+
+		const task = helper.run(async () => {
+			throw error;
+		});
+		helper.progress.then(() => {
+			progressEnded = true;
+		});
+
+		await assert.rejects(task, candidate => candidate === error);
+		await Promise.resolve();
+
+		assert.strictEqual(progressEnded, true);
+	});
+});

src/view/progress.ts

@@ -7,12 +7,13 @@ import * as vscode from 'vscode';
 
 export class ProgressHelper {
 	private _progress: Promise<void> = Promise.resolve();
-	private _endProgress: vscode.EventEmitter<void> = new vscode.EventEmitter();
+	private readonly _endProgress = new vscode.EventEmitter<void>();
 
 	get progress(): Promise<void> {
 		return this._progress;
 	}
-	startProgress() {
+
+	private startProgress(): void {
 		this.endProgress();
 		this._progress = new Promise(resolve => {
 			const disposable = this._endProgress.event(() => {
@@ -22,7 +23,16 @@ export class ProgressHelper {
 		});
 	}
 
-	endProgress() {
+	private endProgress(): void {
 		this._endProgress.fire();
 	}
+
+	async run(task: () => Promise<void>): Promise<void> {
+		this.startProgress();
+		try {
+			await task();
+		} finally {
+			this.endProgress();
+		}
+	}
 }

src/view/reviewManager.ts

@@ -806,16 +806,12 @@ export class ReviewManager extends Disposable {
 
 		this._activePrViewCoordinator.setPullRequest(pr, this._folderRepoManager, this, previousActive);
 		this._localToDispose.push(
-			pr.onDidChangeChangesSinceReview(async _ => {
-				this._changesSinceLastReviewProgress.startProgress();
+			pr.onDidChangeChangesSinceReview(() => this._changesSinceLastReviewProgress.run(async () => {
 				this.changesInPrDataProvider.refresh();
 				await this.updateComments();
 				await this.reopenNewReviewDiffs();
-				if (pr) {
-					PullRequestModel.openChanges(this._folderRepoManager, pr);
-				}
-				this._changesSinceLastReviewProgress.endProgress();
-			})
+				PullRequestModel.openChanges(this._folderRepoManager, pr);
+			}))
 		);
 		Logger.appendLine(`Register in memory content provider`, this.id);
 		if (previousPrNumber !== pr.number) {