Add option to disable release notes completely

filiptronicek · jeanp413 · commit 97373ca43693 · 2023-01-18T23:04:57.000Z
diff --git a/extensions/gitpod-web/package.json b/extensions/gitpod-web/package.json
@@ -507,6 +507,12 @@
           "type": "boolean",
           "description": "Control whether to prompt to open in VS Code Desktop on page load.",
           "default": false
+        },
+        "gitpod.showReleaseNotes": {
+          "type": "boolean",
+          "description": "Show the Gitpod Changelog whenever a new one comes out.",
+          "default": true,
+          "scope": "application"
         }
       }
     },
diff --git a/extensions/gitpod-web/src/releaseNotes.ts b/extensions/gitpod-web/src/releaseNotes.ts
@@ -71,6 +71,9 @@ export class ReleaseNotes extends Disposable {
 				ttl: this.getResponseCacheTime(resp),
 			};
 		});
+		if (!md) {
+			return;
+		}
 
 		const parseInfo = (md: string) => {
 			if (!md.startsWith('---')) {
@@ -113,7 +116,15 @@ export class ReleaseNotes extends Disposable {
 		}
 
 		const releaseId = await this.getLastPublish();
+		if (!releaseId) {
+			return;
+		}
+
 		const mdContent = await this.loadChangelog(releaseId);
+		if (!mdContent) {
+			return;
+		}
+
 		const html = await vscode.commands.executeCommand<string>('markdown.api.render', mdContent);
 		this.panel.webview.html = `<!DOCTYPE html>
 <html lang="en">
@@ -143,10 +154,13 @@ export class ReleaseNotes extends Disposable {
 	}
 
 	private async showIfNewRelease(lastReadId: string | undefined) {
-		const releaseId = await this.getLastPublish();
-		console.log(`gitpod release notes lastReadId: ${lastReadId}, latestReleaseId: ${releaseId}`);
-		if (releaseId !== lastReadId) {
-			this.createOrShow();
+		const showReleaseNotes = vscode.workspace.getConfiguration('gitpod').get<boolean>('showReleaseNotes');
+		if (showReleaseNotes) {
+			const releaseId = await this.getLastPublish();
+			if (releaseId && releaseId !== lastReadId) {
+				console.log(`gitpod release notes lastReadId: ${lastReadId}, latestReleaseId: ${releaseId}`);
+				this.createOrShow();
+			}
 		}
 	}
 
diff --git a/extensions/gitpod-web/src/util/cache.ts b/extensions/gitpod-web/src/util/cache.ts
@@ -40,12 +40,15 @@ export class CacheHelper {
 		return now > data.expiration ? undefined : data.value;
 	}
 
-	async getOrRefresh<T>(key: string, refreshCallback: () => Thenable<{ value: T; ttl?: number }>): Promise<T> {
+	async getOrRefresh<T>(key: string, refreshCallback: () => Thenable<{ value: T; ttl?: number }>): Promise<T | undefined> {
 		let value = this.get<T>(key);
 		if (value === undefined) {
-			const result = await refreshCallback();
-			await this.set(key, result.value, result.ttl);
-			value = result.value;
+			try {
+				const result = await refreshCallback();
+				await this.set(key, result.value, result.ttl);
+				value = result.value;
+			} catch {
+			}
 		}
 		return value;
 	}

Original file line number	Diff line number	Diff line change
`@@ -507,6 +507,12 @@`
`507`	`507`	`"type": "boolean",`
`508`	`508`	`"description": "Control whether to prompt to open in VS Code Desktop on page load.",`
`509`	`509`	`"default": false`
	`510`	`+ },`
	`511`	`+ "gitpod.showReleaseNotes": {`
	`512`	`+ "type": "boolean",`
	`513`	`+ "description": "Show the Gitpod Changelog whenever a new one comes out.",`
	`514`	`+ "default": true,`
	`515`	`+ "scope": "application"`
`510`	`516`	`}`
`511`	`517`	`}`
`512`	`518`	`},`
Original file line number	Diff line number	Diff line change
`@@ -40,12 +40,15 @@ export class CacheHelper {`
`40`	`40`	`return now > data.expiration ? undefined : data.value;`
`41`	`41`	`}`
`42`	`42`
`43`		`- async getOrRefresh<T>(key: string, refreshCallback: () => Thenable<{ value: T; ttl?: number }>): Promise<T> {`
	`43`	`+ async getOrRefresh<T>(key: string, refreshCallback: () => Thenable<{ value: T; ttl?: number }>): Promise<T \| undefined> {`
`44`	`44`	`let value = this.get<T>(key);`
`45`	`45`	`if (value === undefined) {`
`46`		`- const result = await refreshCallback();`
`47`		`- await this.set(key, result.value, result.ttl);`
`48`		`- value = result.value;`
	`46`	`+ try {`
	`47`	`+ const result = await refreshCallback();`
	`48`	`+ await this.set(key, result.value, result.ttl);`
	`49`	`+ value = result.value;`
	`50`	`+ } catch {`
	`51`	`+ }`
`49`	`52`	`}`
`50`	`53`	`return value;`
`51`	`54`	`}`