[MM-50485] Migrate app to ServerManager, remove view names and replace with IDs (#2672)

* Migrate app to ServerManager, remove view names and replace with IDs

* Fixed a test

* Fixed a bug when adding the initial server

* Merge'd

* Bug fixes and PR feedback

src/main/menus/app.test.js

@@ -6,7 +6,7 @@
 import {getDoNotDisturb as getDarwinDoNotDisturb} from 'macos-notification-state';
 
 import {localizeMessage} from 'main/i18nManager';
-import WindowManager from 'main/windows/windowManager';
+import ServerManager from 'common/servers/serverManager';
 
 import {createTemplate} from './app';
 
@@ -49,13 +49,18 @@ jest.mock('macos-notification-state', () => ({
 jest.mock('main/i18nManager', () => ({
     localizeMessage: jest.fn(),
 }));
+jest.mock('common/servers/serverManager', () => ({
+    hasServers: jest.fn(),
+    getCurrentServer: jest.fn(),
+    getOrderedServers: jest.fn(),
+    getOrderedTabsForServer: jest.fn(),
+}));
 jest.mock('main/diagnostics', () => ({}));
 jest.mock('main/downloadsManager', () => ({
     hasDownloads: jest.fn(),
 }));
 jest.mock('main/views/viewManager', () => ({}));
 jest.mock('main/windows/windowManager', () => ({
-    getCurrentTeamName: jest.fn(),
     sendToRenderer: jest.fn(),
 }));
 jest.mock('main/windows/settingsWindow', () => ({}));
@@ -66,54 +71,42 @@ jest.mock('common/tabs/TabView', () => ({
 describe('main/menus/app', () => {
     const config = {
         enableServerManagement: true,
-        teams: [{
-            name: 'example',
-            url: 'http://example.com',
-            order: 0,
-            tabs: [
-                {
-                    name: 'TAB_MESSAGING',
-                    order: 0,
-                    isOpen: true,
-                },
-                {
-                    name: 'TAB_FOCALBOARD',
-                    order: 1,
-                    isOpen: true,
-                },
-                {
-                    name: 'TAB_PLAYBOOKS',
-                    order: 2,
-                    isOpen: true,
-                },
-            ],
-            lastActiveTab: 0,
-        }, {
-            name: 'github',
-            url: 'https://github.com/',
-            order: 1,
-            tabs: [
-                {
-                    name: 'TAB_MESSAGING',
-                    order: 0,
-                    isOpen: true,
-                },
-                {
-                    name: 'TAB_FOCALBOARD',
-                    order: 1,
-                    isOpen: true,
-                },
-                {
-                    name: 'TAB_PLAYBOOKS',
-                    order: 2,
-                    isOpen: true,
-                },
-            ],
-            lastActiveTab: 0,
-        }],
         helpLink: 'http://link-to-help.site.com',
     };
+    const servers = [
+        {
+            id: 'server-1',
+            name: 'example',
+            url: 'http://example.com',
+        },
+        {
+            id: 'server-2',
+            name: 'github',
+            url: 'https:/ /github.com/',
+        },
+    ];
+    const tabs = [
+        {
+            id: 'tab-1',
+            name: 'TAB_MESSAGING',
+            isOpen: true,
+        },
+        {
+            id: 'tab-2',
+            name: 'TAB_FOCALBOARD',
+            isOpen: true,
+        },
+        {
+            id: 'tab-3',
+            name: 'TAB_PLAYBOOKS',
+            isOpen: true,
+        },
+    ];
+
     beforeEach(() => {
+        ServerManager.getCurrentServer.mockReturnValue(servers[0]);
+        ServerManager.getOrderedServers.mockReturnValue(servers);
+        ServerManager.getOrderedTabsForServer.mockReturnValue(tabs);
         getDarwinDoNotDisturb.mockReturnValue(false);
     });
 
@@ -192,6 +185,7 @@ describe('main/menus/app', () => {
                 return id;
             }
         });
+        ServerManager.hasServers.mockReturnValue(true);
         const menu = createTemplate(config);
         const fileMenu = menu.find((item) => item.label === '&AppName' || item.label === '&File');
         const signInOption = fileMenu.submenu.find((item) => item.label === 'Sign in to Another Server');
@@ -209,6 +203,7 @@ describe('main/menus/app', () => {
                 return '';
             }
         });
+        ServerManager.hasServers.mockReturnValue(true);
         const modifiedConfig = {
             ...config,
             enableServerManagement: false,
@@ -230,11 +225,8 @@ describe('main/menus/app', () => {
                 return '';
             }
         });
-        const modifiedConfig = {
-            ...config,
-            teams: [],
-        };
-        const menu = createTemplate(modifiedConfig);
+        ServerManager.hasServers.mockReturnValue(false);
+        const menu = createTemplate(config);
         const fileMenu = menu.find((item) => item.label === '&AppName' || item.label === '&File');
         const signInOption = fileMenu.submenu.find((item) => item.label === 'Sign in to Another Server');
         expect(signInOption).toBe(undefined);
@@ -247,31 +239,27 @@ describe('main/menus/app', () => {
             }
             return id;
         });
-        const modifiedConfig = {
-            teams: [...Array(15).keys()].map((key) => ({
-                name: `server-${key}`,
-                url: `http://server-${key}.com`,
-                order: (key + 5) % 15,
-                lastActiveTab: 0,
-                tab: [
-                    {
-                        name: 'TAB_MESSAGING',
-                        isOpen: true,
-                    },
-                ],
-            })),
-        };
-        const menu = createTemplate(modifiedConfig);
+        const modifiedServers = [...Array(15).keys()].map((key) => ({
+            id: `server-${key}`,
+            name: `server-${key}`,
+            url: `http://server-${key}.com`,
+        }));
+        const modifiedTabs = [
+            {
+                id: 'tab-1',
+                type: 'TAB_MESSAGING',
+                isOpen: true,
+            },
+        ];
+        ServerManager.getOrderedServers.mockReturnValue(modifiedServers);
+        ServerManager.getOrderedTabsForServer.mockReturnValue(modifiedTabs);
+        const menu = createTemplate(config);
         const windowMenu = menu.find((item) => item.label === '&Window');
-        for (let i = 10; i < 15; i++) {
+        for (let i = 0; i < 9; i++) {
             const menuItem = windowMenu.submenu.find((item) => item.label === `server-${i}`);
             expect(menuItem).not.toBe(undefined);
         }
-        for (let i = 0; i < 4; i++) {
-            const menuItem = windowMenu.submenu.find((item) => item.label === `server-${i}`);
-            expect(menuItem).not.toBe(undefined);
-        }
-        for (let i = 4; i < 10; i++) {
+        for (let i = 9; i < 15; i++) {
             const menuItem = windowMenu.submenu.find((item) => item.label === `server-${i}`);
             expect(menuItem).toBe(undefined);
         }
@@ -287,31 +275,21 @@ describe('main/menus/app', () => {
             }
             return id;
         });
-        WindowManager.getCurrentTeamName.mockImplementation(() => config.teams[0].name);
+        ServerManager.getCurrentServer.mockImplementation(() => ({id: servers[0].id}));
 
-        const modifiedConfig = {
-            teams: [
-                {
-                    ...config.teams[0],
-                    tabs: [...Array(15).keys()].map((key) => ({
-                        name: `tab-${key}`,
-                        isOpen: true,
-                        order: (key + 5) % 15,
-                    })),
-                },
-            ],
-        };
-        const menu = createTemplate(modifiedConfig);
+        const modifiedTabs = [...Array(15).keys()].map((key) => ({
+            id: `tab-${key}`,
+            type: `tab-${key}`,
+            isOpen: true,
+        }));
+        ServerManager.getOrderedTabsForServer.mockReturnValue(modifiedTabs);
+        const menu = createTemplate(config);
         const windowMenu = menu.find((item) => item.label === '&Window');
-        for (let i = 10; i < 15; i++) {
+        for (let i = 0; i < 9; i++) {
             const menuItem = windowMenu.submenu.find((item) => item.label === `    tab-${i}`);
             expect(menuItem).not.toBe(undefined);
         }
-        for (let i = 0; i < 4; i++) {
-            const menuItem = windowMenu.submenu.find((item) => item.label === `    tab-${i}`);
-            expect(menuItem).not.toBe(undefined);
-        }
-        for (let i = 4; i < 10; i++) {
+        for (let i = 9; i < 15; i++) {
             const menuItem = windowMenu.submenu.find((item) => item.label === `    tab-${i}`);
             expect(menuItem).toBe(undefined);
         }

src/main/menus/app.ts

@@ -12,6 +12,7 @@ import {getTabDisplayName, TabType} from 'common/tabs/TabView';
 import {Config} from 'common/config';
 
 import {localizeMessage} from 'main/i18nManager';
+import ServerManager from 'common/servers/serverManager';
 import WindowManager from 'main/windows/windowManager';
 import {UpdateManager} from 'main/autoUpdater';
 import downloadsManager from 'main/downloadsManager';
@@ -49,7 +50,7 @@ export function createTemplate(config: Config, updateManager: UpdateManager) {
         },
     });
 
-    if (config.enableServerManagement === true && config.teams.length > 0) {
+    if (config.enableServerManagement === true && ServerManager.hasServers()) {
         platformAppMenu.push({
             label: localizeMessage('main.menus.app.file.signInToAnotherServer', 'Sign in to Another Server'),
             click() {
@@ -231,7 +232,7 @@ export function createTemplate(config: Config, updateManager: UpdateManager) {
         }],
     });
 
-    const teams = config.teams || [];
+    const teams = ServerManager.getOrderedServers();
     const windowMenu = {
         id: 'window',
         label: localizeMessage('main.menus.app.window', '&Window'),
@@ -251,29 +252,29 @@ export function createTemplate(config: Config, updateManager: UpdateManager) {
             label: isMac ? localizeMessage('main.menus.app.window.closeWindow', 'Close Window') : localizeMessage('main.menus.app.window.close', 'Close'),
             accelerator: 'CmdOrCtrl+W',
         }, separatorItem,
-        ...(config.teams.length ? [{
+        ...(ServerManager.hasServers() ? [{
             label: localizeMessage('main.menus.app.window.showServers', 'Show Servers'),
             accelerator: `${process.platform === 'darwin' ? 'Cmd+Ctrl' : 'Ctrl+Shift'}+S`,
             click() {
                 ipcMain.emit(OPEN_TEAMS_DROPDOWN);
             },
         }] : []),
-        ...teams.sort((teamA, teamB) => teamA.order - teamB.order).slice(0, 9).map((team, i) => {
+        ...teams.slice(0, 9).map((team, i) => {
             const items = [];
             items.push({
                 label: team.name,
                 accelerator: `${process.platform === 'darwin' ? 'Cmd+Ctrl' : 'Ctrl+Shift'}+${i + 1}`,
                 click() {
-                    WindowManager.switchServer(team.name);
+                    WindowManager.switchServer(team.id);
                 },
             });
-            if (WindowManager.getCurrentTeamName() === team.name) {
-                team.tabs.filter((tab) => tab.isOpen).sort((teamA, teamB) => teamA.order - teamB.order).slice(0, 9).forEach((tab, i) => {
+            if (ServerManager.getCurrentServer().id === team.id) {
+                ServerManager.getOrderedTabsForServer(team.id).slice(0, 9).forEach((tab, i) => {
                     items.push({
-                        label: `    ${localizeMessage(`common.tabs.${tab.name}`, getTabDisplayName(tab.name as TabType))}`,
+                        label: `    ${localizeMessage(`common.tabs.${tab.type}`, getTabDisplayName(tab.type as TabType))}`,
                         accelerator: `CmdOrCtrl+${i + 1}`,
                         click() {
-                            WindowManager.switchTab(team.name, tab.name);
+                            WindowManager.switchTab(tab.id);
                         },
                     });
                 });

src/main/menus/tray.test.js

@@ -3,41 +3,35 @@
 
 'use strict';
 
+import ServerManager from 'common/servers/serverManager';
+
 import {createTemplate} from './tray';
 
 jest.mock('main/i18nManager', () => ({
     localizeMessage: jest.fn(),
 }));
 
+jest.mock('common/servers/serverManager', () => ({
+    getOrderedServers: jest.fn(),
+}));
+
 jest.mock('main/windows/settingsWindow', () => ({}));
 jest.mock('main/windows/windowManager', () => ({}));
 
 describe('main/menus/tray', () => {
     it('should show the first 9 servers (using order)', () => {
-        const config = {
-            teams: [...Array(15).keys()].map((key) => ({
-                name: `server-${key}`,
-                url: `http://server-${key}.com`,
-                order: (key + 5) % 15,
-                lastActiveTab: 0,
-                tab: [
-                    {
-                        name: 'TAB_MESSAGING',
-                        isOpen: true,
-                    },
-                ],
-            })),
-        };
-        const menu = createTemplate(config);
-        for (let i = 10; i < 15; i++) {
+        const servers = [...Array(15).keys()].map((key) => ({
+            id: `server-${key}`,
+            name: `server-${key}`,
+            url: `http://server-${key}.com`,
+        }));
+        ServerManager.getOrderedServers.mockReturnValue(servers);
+        const menu = createTemplate();
+        for (let i = 0; i < 9; i++) {
             const menuItem = menu.find((item) => item.label === `server-${i}`);
             expect(menuItem).not.toBe(undefined);
         }
-        for (let i = 0; i < 4; i++) {
-            const menuItem = menu.find((item) => item.label === `server-${i}`);
-            expect(menuItem).not.toBe(undefined);
-        }
-        for (let i = 4; i < 10; i++) {
+        for (let i = 9; i < 15; i++) {
             const menuItem = menu.find((item) => item.label === `server-${i}`);
             expect(menuItem).toBe(undefined);
         }

src/main/menus/tray.ts

@@ -4,20 +4,20 @@
 'use strict';
 
 import {Menu, MenuItem, MenuItemConstructorOptions} from 'electron';
-import {CombinedConfig} from 'types/config';
 
 import WindowManager from 'main/windows/windowManager';
 import {localizeMessage} from 'main/i18nManager';
+import ServerManager from 'common/servers/serverManager';
 import SettingsWindow from 'main/windows/settingsWindow';
 
-export function createTemplate(config: CombinedConfig) {
-    const teams = config.teams;
+export function createTemplate() {
+    const teams = ServerManager.getOrderedServers();
     const template = [
-        ...teams.sort((teamA, teamB) => teamA.order - teamB.order).slice(0, 9).map((team) => {
+        ...teams.slice(0, 9).map((team) => {
             return {
                 label: team.name.length > 50 ? `${team.name.slice(0, 50)}...` : team.name,
                 click: () => {
-                    WindowManager.switchServer(team.name);
+                    WindowManager.switchServer(team.id);
                 },
             };
         }), {
@@ -36,7 +36,7 @@ export function createTemplate(config: CombinedConfig) {
     return template;
 }
 
-export function createMenu(config: CombinedConfig) {
+export function createMenu() {
     // Electron is enforcing certain variables that it doesn't need
-    return Menu.buildFromTemplate(createTemplate(config) as Array<MenuItemConstructorOptions | MenuItem>);
+    return Menu.buildFromTemplate(createTemplate() as Array<MenuItemConstructorOptions | MenuItem>);
 }