Option for disabling release notes (#29)

filiptronicek · jeanp413 · web-flow · commit 6d2fcc8b46a6 · 2022-12-21T03:09:02.000-05:00
Co-authored-by: Jean Pierre &lt;jeanp413@hotmail.com&gt;
diff --git a/package.json b/package.json
@@ -59,6 +59,12 @@
 						"default": "https://gitpod.io/",
 						"scope": "application"
 					},
+					"gitpod.showReleaseNotes": {
+						"type": "boolean",
+						"description": "Show the Gitpod Changelog whenever a new one comes out.",
+						"default": true,
+						"scope": "application"
+					},
 					"gitpod.remote.useLocalApp": {
 						"type": "boolean",
 						"description": "Use the local companion app to connect to a remote workspace.\nWarning: Connecting to a remote workspace using local companion app will be removed in the near future.",
diff --git a/src/common/cache.ts b/src/common/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;
 	}
diff --git a/src/extension.ts b/src/extension.ts
@@ -79,7 +79,13 @@ export async function activate(context: vscode.ExtensionContext) {
 		}
 	}));
 
-	context.subscriptions.push(new ReleaseNotes(context));
+	if (vscode.workspace.getConfiguration('gitpod').get<boolean>('enableReleaseNotes')) {
+		const lastRead = context.globalState.get<string>(ReleaseNotes.RELEASE_NOTES_LAST_READ_KEY);
+		logger.info(`Last read release notes: ${lastRead}`);
+		context.subscriptions.push(new ReleaseNotes(context));
+	} else {
+		logger.info('Release notes are disabled');
+	}
 
 	if (!context.globalState.get<boolean>(FIRST_INSTALL_KEY, false)) {
 		await context.globalState.update(FIRST_INSTALL_KEY, true);
diff --git a/src/releaseNotes.ts b/src/releaseNotes.ts
@@ -70,6 +70,9 @@ export class ReleaseNotes extends Disposable {
 				ttl: this.getResponseCacheTime(resp),
 			};
 		});
+		if (!md) {
+			return;
+		}
 
 		const parseInfo = (md: string) => {
 			if (!md.startsWith('---')) {
@@ -112,7 +115,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">
@@ -142,10 +153,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();
+			}
 		}
 	}
 

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`	`}`