Retry fetching release notes on failure, and display failures (microsoft#101158)

SnirBroshi · web-flow · commit d0c1d2ed944c · 2020-06-26T15:25:57.000-07:00
* Retry getting release notes on failure, and show xhr failures

* improved release notes errors

* improve async code in loadReleaseNotes
diff --git a/src/vs/base/parts/request/browser/request.ts b/src/vs/base/parts/request/browser/request.ts
@@ -21,7 +21,7 @@ export function request(options: IRequestOptions, token: CancellationToken): Pro
 		setRequestHeaders(xhr, options);
 
 		xhr.responseType = 'arraybuffer';
-		xhr.onerror = e => reject(new Error(xhr.statusText && ('XHR failed: ' + xhr.statusText)));
+		xhr.onerror = e => reject(new Error(xhr.statusText && ('XHR failed: ' + xhr.statusText) || 'XHR failed'));
 		xhr.onload = (e) => {
 			resolve({
 				res: {
diff --git a/src/vs/workbench/contrib/update/browser/releaseNotesEditor.ts b/src/vs/workbench/contrib/update/browser/releaseNotesEditor.ts
@@ -95,10 +95,10 @@ export class ReleaseNotesManager {
 		return true;
 	}
 
-	private loadReleaseNotes(version: string): Promise<string> {
+	private async loadReleaseNotes(version: string): Promise<string> {
 		const match = /^(\d+\.\d+)\./.exec(version);
 		if (!match) {
-			return Promise.reject(new Error('not found'));
+			throw new Error('not found');
 		}
 
 		const versionLabel = match[1].replace(/\./g, '_');
@@ -138,17 +138,30 @@ export class ReleaseNotesManager {
 				.replace(/kbstyle\(([^\)]+)\)/gi, kbstyle);
 		};
 
-		if (!this._releaseNotesCache.has(version)) {
-			this._releaseNotesCache.set(version, this._requestService.request({ url }, CancellationToken.None)
-				.then(asText)
-				.then(text => {
-					if (!text || !/^#\s/.test(text)) { // release notes always starts with `#` followed by whitespace
-						return Promise.reject(new Error('Invalid release notes'));
-					}
+		const fetchReleaseNotes = async () => {
+			let text;
+			try {
+				text = await asText(await this._requestService.request({ url }, CancellationToken.None));
+			} catch {
+				throw new Error('Failed to fetch release notes');
+			}
+
+			if (!text || !/^#\s/.test(text)) { // release notes always starts with `#` followed by whitespace
+				throw new Error('Invalid release notes');
+			}
 
-					return Promise.resolve(text);
-				})
-				.then(text => patchKeybindings(text)));
+			return patchKeybindings(text);
+		};
+
+		if (!this._releaseNotesCache.has(version)) {
+			this._releaseNotesCache.set(version, (async () => {
+				try {
+					return await fetchReleaseNotes();
+				} catch (err) {
+					this._releaseNotesCache.delete(version);
+					throw err;
+				}
+			})());
 		}
 
 		return this._releaseNotesCache.get(version)!;
diff --git a/src/vs/workbench/contrib/update/browser/update.ts b/src/vs/workbench/contrib/update/browser/update.ts
@@ -51,12 +51,12 @@ export class OpenLatestReleaseNotesInBrowserAction extends Action {
 		super('update.openLatestReleaseNotes', nls.localize('releaseNotes', "Release Notes"), undefined, true);
 	}
 
-	run(): Promise<any> {
+	async run(): Promise<void> {
 		if (this.productService.releaseNotesUrl) {
 			const uri = URI.parse(this.productService.releaseNotesUrl);
-			return this.openerService.open(uri);
+			await this.openerService.open(uri);
 		}
-		return Promise.resolve(false);
+		throw new Error('This version of Visual Studio Code does not have release notes online');
 	}
 }
 
@@ -71,18 +71,22 @@ export abstract class AbstractShowReleaseNotesAction extends Action {
 		super(id, label, undefined, true);
 	}
 
-	run(): Promise<boolean> {
+	async run(): Promise<void> {
 		if (!this.enabled) {
-			return Promise.resolve(false);
+			return;
 		}
-
 		this.enabled = false;
 
-		return showReleaseNotes(this.instantiationService, this.version)
-			.then(undefined, () => {
-				const action = this.instantiationService.createInstance(OpenLatestReleaseNotesInBrowserAction);
-				return action.run().then(() => false);
-			});
+		try {
+			await showReleaseNotes(this.instantiationService, this.version);
+		} catch (err) {
+			const action = this.instantiationService.createInstance(OpenLatestReleaseNotesInBrowserAction);
+			try {
+				await action.run();
+			} catch (err2) {
+				throw new Error(`${err.message} and ${err2.message}`);
+			}
+		}
 	}
 }
 

Original file line number	Diff line number	Diff line change
`@@ -51,12 +51,12 @@ export class OpenLatestReleaseNotesInBrowserAction extends Action {`
`51`	`51`	`super('update.openLatestReleaseNotes', nls.localize('releaseNotes', "Release Notes"), undefined, true);`
`52`	`52`	`}`
`53`	`53`
`54`		`- run(): Promise<any> {`
	`54`	`+ async run(): Promise<void> {`
`55`	`55`	`if (this.productService.releaseNotesUrl) {`
`56`	`56`	`const uri = URI.parse(this.productService.releaseNotesUrl);`
`57`		`- return this.openerService.open(uri);`
	`57`	`+ await this.openerService.open(uri);`
`58`	`58`	`}`
`59`		`- return Promise.resolve(false);`
	`59`	`+ throw new Error('This version of Visual Studio Code does not have release notes online');`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`
`@@ -71,18 +71,22 @@ export abstract class AbstractShowReleaseNotesAction extends Action {`
`71`	`71`	`super(id, label, undefined, true);`
`72`	`72`	`}`
`73`	`73`
`74`		`- run(): Promise<boolean> {`
	`74`	`+ async run(): Promise<void> {`
`75`	`75`	`if (!this.enabled) {`
`76`		`- return Promise.resolve(false);`
	`76`	`+ return;`
`77`	`77`	`}`
`78`		`-`
`79`	`78`	`this.enabled = false;`
`80`	`79`
`81`		`- return showReleaseNotes(this.instantiationService, this.version)`
`82`		`- .then(undefined, () => {`
`83`		`- const action = this.instantiationService.createInstance(OpenLatestReleaseNotesInBrowserAction);`
`84`		`- return action.run().then(() => false);`
`85`		`- });`
	`80`	`+ try {`
	`81`	`+ await showReleaseNotes(this.instantiationService, this.version);`
	`82`	`+ } catch (err) {`
	`83`	`+ const action = this.instantiationService.createInstance(OpenLatestReleaseNotesInBrowserAction);`
	`84`	`+ try {`
	`85`	`+ await action.run();`
	`86`	`+ } catch (err2) {`
	`87`	+ throw new Error(`${err.message} and ${err2.message}`);
	`88`	`+ }`
	`89`	`+ }`
`86`	`90`	`}`
`87`	`91`	`}`
`88`	`92`