[MM-36058][MM-40572] Tray fixes (#1933)

* [MM-36058] Added config migration function, update default tray icon theme to system, allow Windows users to override icon theme

* [MM-40572] Restore minimize to tray option for Windows

* Lint fix

* Test fix

* Oops

src/common/config/defaultPreferences.ts

@@ -20,7 +20,7 @@ const defaultPreferences: ConfigV3 = {
     version: 3,
     teams: [],
     showTrayIcon: true,
-    trayIconTheme: 'light',
+    trayIconTheme: 'use_system',
     minimizeToTray: true,
     notifications: {
         flashWindow: 2,

src/common/config/index.test.js

@@ -89,6 +89,8 @@ jest.mock('common/config/upgradePreferences', () => {
     });
 });
 
+jest.mock('common/config/migrationPreferences', () => jest.fn());
+
 jest.mock('common/config/buildConfig', () => {
     return {
         defaultTeams: [buildTeam],

src/common/config/index.ts

@@ -31,6 +31,7 @@ import defaultPreferences, {getDefaultDownloadLocation} from './defaultPreferenc
 import upgradeConfigData from './upgradePreferences';
 import buildConfig from './buildConfig';
 import RegistryConfig, {REGISTRY_READ_EVENT} from './RegistryConfig';
+import migrateConfigItems from './migrationPreferences';
 
 /**
  * Handles loading and merging all sources of configuration as well as saving user provided config
@@ -339,6 +340,11 @@ export class Config extends EventEmitter {
                     this.writeFileSync(this.configFilePath, configData);
                     log.info(`Configuration updated to version ${this.defaultConfigData.version} successfully.`);
                 }
+                const didMigrate = migrateConfigItems(configData);
+                if (didMigrate) {
+                    this.writeFileSync(this.configFilePath, configData);
+                    log.info('Migrating config items successfully.');
+                }
             } catch (error) {
                 log.error(`Failed to update configuration to version ${this.defaultConfigData.version}.`);
             }

src/common/config/migrationPreferences.test.js

@@ -0,0 +1,38 @@
+// Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+import JsonFileManager from 'common/JsonFileManager';
+
+import migrateConfigItems from './migrationPreferences';
+
+jest.mock('common/JsonFileManager', () => jest.fn());
+
+describe('common/config/migrationPreferences', () => {
+    describe('migrateConfigItems', () => {
+        afterEach(() => {
+            jest.resetAllMocks();
+        });
+
+        it('should not migrate if all items migrated', () => {
+            JsonFileManager.mockImplementation(() => ({
+                getValue: () => true,
+            }));
+            expect(migrateConfigItems({})).toBe(false);
+        });
+
+        it('should migrate if items are not migrated', () => {
+            const originalPlatform = process.platform;
+            Object.defineProperty(process, 'platform', {
+                value: 'win32',
+            });
+            JsonFileManager.mockImplementation(() => ({
+                getValue: () => false,
+                setValue: jest.fn(),
+            }));
+            expect(migrateConfigItems({})).toBe(true);
+            Object.defineProperty(process, 'platform', {
+                value: originalPlatform,
+            });
+        });
+    });
+});

src/common/config/migrationPreferences.ts

@@ -0,0 +1,21 @@
+// Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+import {Config, MigrationInfo} from 'types/config';
+
+import JsonFileManager from 'common/JsonFileManager';
+
+import {migrationInfoPath} from 'main/constants';
+
+export default function migrateConfigItems(config: Config) {
+    const migrationPrefs = new JsonFileManager<MigrationInfo>(migrationInfoPath);
+    let didMigrate = false;
+
+    if (!migrationPrefs.getValue('updateTrayIconWin32') && process.platform === 'win32') {
+        config.trayIconTheme = 'use_system';
+        migrationPrefs.setValue('updateTrayIconWin32', true);
+        didMigrate = true;
+    }
+
+    return didMigrate;
+}

src/main/Validator.test.js

@@ -149,7 +149,7 @@ describe('main/Validator', () => {
                     ],
                 },
             ],
-            trayIconTheme: 'light',
+            trayIconTheme: 'use_system',
             useSpellChecker: true,
             version: 3,
         };

src/main/Validator.ts

@@ -108,7 +108,7 @@ const configDataSchemaV3 = Joi.object<ConfigV3>({
         })).default([]),
     })).default([]),
     showTrayIcon: Joi.boolean().default(false),
-    trayIconTheme: Joi.any().allow('').valid('light', 'dark').default('light'),
+    trayIconTheme: Joi.any().allow('').valid('light', 'dark', 'use_system').default('use_system'),
     minimizeToTray: Joi.boolean().default(false),
     notifications: Joi.object({
         flashWindow: Joi.any().valid(0, 2).default(0),

src/main/constants.ts

@@ -17,6 +17,7 @@ export let appVersionJson = '';
 export let certificateStorePath = '';
 export let trustedOriginsStoreFile = '';
 export let boundsInfoPath = '';
+export let migrationInfoPath = '';
 
 export function updatePaths(emit = false) {
     userDataPath = app.getPath('userData');
@@ -27,6 +28,7 @@ export function updatePaths(emit = false) {
     certificateStorePath = path.resolve(userDataPath, 'certificate.json');
     trustedOriginsStoreFile = path.resolve(userDataPath, 'trustedOrigins.json');
     boundsInfoPath = path.join(userDataPath, 'bounds-info.json');
+    migrationInfoPath = path.resolve(userDataPath, 'migration-info.json');
 
     if (emit) {
         ipcMain.emit(UPDATE_PATHS);

src/main/tray/tray.ts

@@ -18,7 +18,8 @@ let lastMessage = app.name;
 
 /* istanbul ignore next */
 export function refreshTrayImages(trayIconTheme: string) {
-    const winTheme = nativeTheme.shouldUseDarkColors ? 'dark' : 'light';
+    const systemTheme = nativeTheme.shouldUseDarkColors ? 'dark' : 'light';
+    const winTheme = trayIconTheme === 'use_system' ? systemTheme : trayIconTheme;
 
     switch (process.platform) {
     case 'win32':

src/renderer/components/SettingsPage.tsx

@@ -637,7 +637,7 @@ export default class SettingsPage extends React.PureComponent<Record<string, nev
                 </FormCheck>);
         }
 
-        if (window.process.platform === 'linux') {
+        if (window.process.platform === 'linux' || window.process.platform === 'win32') {
             options.push(
                 <FormGroup
                     key='trayIconTheme'
@@ -645,6 +645,20 @@ export default class SettingsPage extends React.PureComponent<Record<string, nev
                     style={{marginLeft: '20px'}}
                 >
                     {'Icon theme: '}
+                    {window.process.platform === 'win32' &&
+                        <>
+                            <FormCheck
+                                type='radio'
+                                inline={true}
+                                name='trayIconTheme'
+                                value='use_system'
+                                defaultChecked={this.state.trayIconTheme === 'use_system' || !this.state.trayIconTheme}
+                                onChange={() => this.handleChangeTrayIconTheme('use_system')}
+                                label={'Use system default'}
+                            />
+                            {' '}
+                        </>
+                    }
                     <FormCheck
                         type='radio'
                         inline={true}
@@ -668,7 +682,7 @@ export default class SettingsPage extends React.PureComponent<Record<string, nev
             );
         }
 
-        if (window.process.platform === 'linux') {
+        if (window.process.platform === 'linux' || window.process.platform === 'win32') {
             options.push(
                 <FormCheck
                     key='inputMinimizeToTray'

src/types/config.ts

@@ -118,3 +118,7 @@ export type LocalConfiguration = Config & {
     appName: string;
     enableServerManagement: boolean;
 }
+
+export type MigrationInfo = {
+    updateTrayIconWin32: boolean;
+}