Remove storing of User-Agent on disk.

Fixes: #921. Co-authored-by: Anders Kaseorg <[email protected]>
zulip · Apr 26, 2020 · 16f0af8 · 16f0af8
1 parent bb6d906
commit 16f0af8
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 24 deletions.
diff --git a/app/main/index.ts b/app/main/index.ts
@@ -158,6 +158,9 @@ app.on('activate', () => {
 });
 
 app.on('ready', () => {
+	const ses = session.fromPartition('persist:webviewsession');
+	ses.setUserAgent(`ZulipElectron/${app.getVersion()} ${ses.getUserAgent()}`);
+
 	AppMenu.setMenu({
 		tabs: []
 	});
@@ -190,10 +193,10 @@ app.on('ready', () => {
 		} else {
 			mainWindow.show();
 		}
-		if (!ConfigUtil.isConfigItemExists('userAgent')) {
-			const userAgent = session.fromPartition('webview:persistsession').getUserAgent();
-			ConfigUtil.setConfigItem('userAgent', userAgent);
-		}
+	});
+
+	ipcMain.on('fetch-user-agent', event => {
+		event.returnValue = session.fromPartition('persist:webviewsession').getUserAgent();
 	});
 
 	page.once('did-frame-finish-load', () => {

diff --git a/app/renderer/js/components/webview.ts b/app/renderer/js/components/webview.ts
@@ -149,12 +149,6 @@ export default class WebView extends BaseComponent {
 			if (!isSettingPage) {
 				this.props.switchLoading(true, this.props.url);
 			}
-			let userAgent = SystemUtil.getUserAgent();
-			if (!userAgent) {
-				SystemUtil.setUserAgent(this.$el.getUserAgent());
-				userAgent = SystemUtil.getUserAgent();
-			}
-			this.$el.setUserAgent(userAgent);
 		});
 
 		this.$el.addEventListener('did-stop-loading', () => {

diff --git a/app/renderer/js/main.ts b/app/renderer/js/main.ts
@@ -140,6 +140,7 @@ class ServerManagerView {
 		await this.loadProxy();
 		this.initDefaultSettings();
 		this.initSidebar();
+		this.removeUAfromDisk();
 		if (EnterpriseUtil.configFile) {
 			this.initPresetOrgs();
 		}
@@ -239,6 +240,12 @@ class ServerManagerView {
 		this.toggleSidebar(showSidebar);
 	}
 
+	// Remove the stale UA string from the disk if the app is not freshly
+	// installed.  This should be removed in a further release.
+	removeUAfromDisk(): void {
+		ConfigUtil.removeConfigItem('userAgent');
+	}
+
 	async queueDomain(domain: any): Promise<boolean> {
 		// allows us to start adding multiple domains to the app simultaneously
 		// promise of addition resolves in both cases, but we consider it rejected

diff --git a/app/renderer/js/utils/system-util.ts b/app/renderer/js/utils/system-util.ts
@@ -1,9 +1,6 @@
-import { remote } from 'electron';
+import { ipcRenderer } from 'electron';
 
 import os from 'os';
-import * as ConfigUtil from './config-util';
-
-const { app } = remote;
 
 export const connectivityERR: string[] = [
 	'ERR_INTERNET_DISCONNECTED',
@@ -14,7 +11,7 @@ export const connectivityERR: string[] = [
 	'ERR_NETWORK_CHANGED'
 ];
 
-let userAgent: string | null = null;
+const userAgent = ipcRenderer.sendSync('fetch-user-agent');
 
 export function getOS(): string {
 	const platform = os.platform();
@@ -32,14 +29,6 @@ export function getOS(): string {
 		return '';
 	}
 }
-
-export function setUserAgent(webViewUserAgent: string): void {
-	userAgent = `ZulipElectron/${app.getVersion()} ${webViewUserAgent}`;
-}
-
-export function getUserAgent(): string | null {
-	if (!userAgent) {
-		setUserAgent(ConfigUtil.getConfigItem('userAgent', null));
-	}
+export function getUserAgent(): string {
 	return userAgent;
 }