[MM-55152] Add new Desktop API endpoints, improve preload script, some clean-up

.eslintrc.json

@@ -103,7 +103,7 @@
                 "src/main/downloadURL.ts",
                 "src/main/SpellChecker.ts",
                 "src/main/menus/app.ts",
-                "src/main/preload/mattermost.js",
+                "src/main/preload/externalAPI.js",
                 "src/renderer/components/RemoveServerModal.tsx",
                 "src/renderer/components/MainPage.tsx",
                 "src/renderer/components/HoveringURL.tsx",

.gitignore

@@ -24,3 +24,5 @@ fastlane/README.md
 fastlane/report.xml
 
 *.provisionprofile
+
+src/types/api/lib/*

src/app/serverViewState.ts

@@ -68,7 +68,7 @@ export class ServerViewState {
     }
 
     getCurrentServer = () => {
-        log.debug('getCurrentServer');
+        log.silly('getCurrentServer');
 
         if (!this.currentServerId) {
             throw new Error('No server set as current');

src/common/appState.ts

@@ -25,7 +25,7 @@ export class AppState extends EventEmitter {
     updateExpired = (viewId: string, expired: boolean) => {
         ServerManager.getViewLog(viewId, 'AppState').silly('updateExpired', expired);
 
-        this.unreads.set(viewId, expired);
+        this.expired.set(viewId, expired);
         this.emitStatusForView(viewId);
     }
 

src/common/communication.ts

@@ -1,6 +1,8 @@
 // Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved.
 // See LICENSE.txt for license information.
 
+export const GET_APP_INFO = 'get-app-info';
+
 export const SWITCH_SERVER = 'switch-server';
 export const SWITCH_TAB = 'switch-tab';
 export const CLOSE_VIEW = 'close-view';
@@ -58,9 +60,9 @@ export const GET_DOWNLOAD_LOCATION = 'get_download_location';
 export const UPDATE_MENTIONS = 'update_mentions';
 export const IS_UNREAD = 'is_unread';
 export const UNREAD_RESULT = 'unread_result';
+export const MENTIONS_RESULT = 'mentions-changed';
 export const SESSION_EXPIRED = 'session_expired';
 
-export const SET_VIEW_OPTIONS = 'set-view-name';
 export const REACT_APP_INITIALIZED = 'react-app-initialized';
 
 export const TOGGLE_BACK_BUTTON = 'toggle-back-button';
@@ -93,7 +95,6 @@ export const START_UPGRADE = 'start-upgrade';
 export const CHECK_FOR_UPDATES = 'check-for-updates';
 export const NO_UPDATE_AVAILABLE = 'no-update-available';
 
-export const BROWSER_HISTORY_BUTTON = 'browser-history-button';
 export const BROWSER_HISTORY_PUSH = 'browser-history-push';
 export const APP_LOGGED_IN = 'app-logged-in';
 export const APP_LOGGED_OUT = 'app-logged-out';
@@ -118,7 +119,7 @@ export const GET_AVAILABLE_LANGUAGES = 'get-available-languages';
 export const VIEW_FINISHED_RESIZING = 'view-finished-resizing';
 
 // Calls
-export const DISPATCH_GET_DESKTOP_SOURCES = 'dispatch-get-desktop-sources';
+export const GET_DESKTOP_SOURCES = 'get-desktop-sources';
 export const DESKTOP_SOURCES_RESULT = 'desktop-sources-result';
 export const DESKTOP_SOURCES_MODAL_REQUEST = 'desktop-sources-modal-request';
 export const CALLS_JOIN_CALL = 'calls-join-call';
@@ -177,3 +178,11 @@ export const VALIDATE_SERVER_URL = 'validate-server-url';
 export const GET_IS_DEV_MODE = 'get-is-dev-mode';
 
 export const TOGGLE_SECURE_INPUT = 'toggle-secure-input';
+
+export const REQUEST_BROWSER_HISTORY_STATUS = 'request-browser-history-status';
+export const BROWSER_HISTORY_STATUS_UPDATED = 'browser-history-status-updated';
+
+export const NOTIFICATION_CLICKED = 'notification-clicked';
+
+// Legacy code remove signal
+export const LEGACY_OFF = 'legacy-off';

src/common/utils/url.ts

@@ -57,6 +57,7 @@ export const isUrlType = (urlType: string, serverURL: URL, inputURL: URL) => {
     getFormattedPathName(inputURL.pathname).startsWith(`/${urlType}/`));
 };
 
+export const isLoginUrl = (serverURL: URL, inputURL: URL) => isUrlType('login', serverURL, inputURL);
 export const isHelpUrl = (serverURL: URL, inputURL: URL) => isUrlType('help', serverURL, inputURL);
 export const isImageProxyUrl = (serverURL: URL, inputURL: URL) => isUrlType('api/v4/image', serverURL, inputURL);
 export const isPublicFilesUrl = (serverURL: URL, inputURL: URL) => isUrlType('files', serverURL, inputURL);

src/main/app/initialize.ts

@@ -30,6 +30,7 @@ import {
     WINDOW_RESTORE,
     DOUBLE_CLICK_ON_WINDOW,
     TOGGLE_SECURE_INPUT,
+    GET_APP_INFO,
 } from 'common/communication';
 import Config from 'common/config';
 import {Logger} from 'common/log';
@@ -249,7 +250,7 @@ function initializeBeforeAppReady() {
 
 function initializeInterCommunicationEventListeners() {
     ipcMain.on(NOTIFY_MENTION, handleMentionNotification);
-    ipcMain.handle('get-app-version', handleAppVersion);
+    ipcMain.handle(GET_APP_INFO, handleAppVersion);
     ipcMain.on(UPDATE_SHORTCUT_MENU, handleUpdateMenuEvent);
     ipcMain.on(FOCUS_BROWSERVIEW, ViewManager.focusCurrentView);
 
@@ -366,7 +367,7 @@ async function initializeAfterAppReady() {
     // listen for status updates and pass on to renderer
     UserActivityMonitor.on('status', (status) => {
         log.debug('UserActivityMonitor.on(status)', status);
-        ViewManager.sendToAllViews(USER_ACTIVITY_UPDATE, status);
+        ViewManager.sendToAllViews(USER_ACTIVITY_UPDATE, status.userIsActive, status.idleTime, status.isSystemEvent);
     });
 
     // start monitoring user activity (needs to be started after the app is ready)

src/main/app/intercom.ts

@@ -4,7 +4,6 @@
 import {app, IpcMainEvent, IpcMainInvokeEvent, Menu} from 'electron';
 
 import {UniqueServer} from 'types/config';
-import {MentionData} from 'types/notification';
 
 import ServerViewState from 'app/serverViewState';
 
@@ -114,9 +113,9 @@ export function handleWelcomeScreenModal() {
     }
 }
 
-export function handleMentionNotification(event: IpcMainEvent, title: string, body: string, channel: {id: string}, teamId: string, url: string, silent: boolean, data: MentionData) {
-    log.debug('handleMentionNotification', {title, body, channel, teamId, url, silent, data});
-    NotificationManager.displayMention(title, body, channel, teamId, url, silent, event.sender, data);
+export function handleMentionNotification(event: IpcMainEvent, title: string, body: string, channelId: string, teamId: string, url: string, silent: boolean, soundName: string) {
+    log.debug('handleMentionNotification', {title, body, channelId, teamId, url, silent, soundName});
+    NotificationManager.displayMention(title, body, channelId, teamId, url, silent, event.sender, soundName);
 }
 
 export function handleOpenAppMenu() {

src/main/notifications/Mention.ts

@@ -27,25 +27,25 @@ const DEFAULT_WIN7 = 'Ding';
 
 export class Mention extends Notification {
     customSound: string;
-    channel: {id: string}; // TODO: Channel from mattermost-redux
+    channelId: string;
     teamId: string;
     uId: string;
 
-    constructor(customOptions: MentionOptions, channel: {id: string}, teamId: string) {
+    constructor(customOptions: MentionOptions, channelId: string, teamId: string) {
         const options = {...defaultOptions, ...customOptions};
         if (process.platform === 'darwin' || (process.platform === 'win32' && Utils.isVersionGreaterThanOrEqualTo(os.release(), '10.0'))) {
             // Notification Center shows app's icon, so there were two icons on the notification.
             Reflect.deleteProperty(options, 'icon');
         }
         const isWin7 = (process.platform === 'win32' && !Utils.isVersionGreaterThanOrEqualTo(os.release(), '6.3') && DEFAULT_WIN7);
-        const customSound = String(!options.silent && ((options.data && options.data.soundName !== 'None' && options.data.soundName) || isWin7));
+        const customSound = String(!options.silent && ((options.soundName !== 'None' && options.soundName) || isWin7));
         if (customSound) {
             options.silent = true;
         }
         super(options);
 
         this.customSound = customSound;
-        this.channel = channel;
+        this.channelId = channelId;
         this.teamId = teamId;
         this.uId = uuid();
     }

src/main/notifications/index.test.ts

@@ -92,6 +92,7 @@ jest.mock('../views/viewManager', () => ({
                 name: 'server_name',
                 url: new URL('http://someurl.com'),
             },
+            shouldNotify: true,
         },
     }),
     showById: jest.fn(),
@@ -144,12 +145,12 @@ describe('main/notifications', () => {
             await NotificationManager.displayMention(
                 'test',
                 'test body',
-                {id: 'channel_id'},
+                'channel_id',
                 'team_id',
                 'http://server-1.com/team_id/channel_id',
                 false,
                 {id: 1} as WebContents,
-                {soundName: ''},
+                '',
             );
             expect(MainWindow.show).not.toBeCalled();
         });
@@ -164,12 +165,12 @@ describe('main/notifications', () => {
             await NotificationManager.displayMention(
                 'test',
                 'test body',
-                {id: 'channel_id'},
+                'channel_id',
                 'team_id',
                 'http://server-1.com/team_id/channel_id',
                 false,
                 {id: 1} as WebContents,
-                {soundName: ''},
+                '',
             );
             expect(MainWindow.show).not.toBeCalled();
 
@@ -188,12 +189,12 @@ describe('main/notifications', () => {
             await NotificationManager.displayMention(
                 'test',
                 'test body',
-                {id: 'channel_id'},
+                'channel_id',
                 'team_id',
                 'http://server-1.com/team_id/channel_id',
                 false,
                 {id: 1} as WebContents,
-                {soundName: ''},
+                '',
             );
             expect(MainWindow.show).not.toBeCalled();
 
@@ -207,12 +208,12 @@ describe('main/notifications', () => {
             await NotificationManager.displayMention(
                 'test',
                 'test body',
-                {id: 'channel_id'},
+                'channel_id',
                 'team_id',
                 'http://server-1.com/team_id/channel_id',
                 false,
                 {id: 1} as WebContents,
-                {soundName: ''},
+                '',
             );
             expect(MainWindow.show).not.toBeCalled();
         });
@@ -221,12 +222,12 @@ describe('main/notifications', () => {
             await NotificationManager.displayMention(
                 'test',
                 'test body',
-                {id: 'channel_id'},
+                'channel_id',
                 'team_id',
                 'http://server-1.com/team_id/channel_id',
                 false,
                 {id: 1} as WebContents,
-                {soundName: 'test_sound'},
+                'test_sound',
             );
             expect(MainWindow.sendToRenderer).toHaveBeenCalledWith(PLAY_SOUND, 'test_sound');
         });
@@ -240,12 +241,12 @@ describe('main/notifications', () => {
             await NotificationManager.displayMention(
                 'test',
                 'test body',
-                {id: 'channel_id'},
+                'channel_id',
                 'team_id',
                 'http://server-1.com/team_id/channel_id',
                 false,
                 {id: 1} as WebContents,
-                {soundName: ''},
+                '',
             );
 
             // convert to any to access private field
@@ -257,12 +258,12 @@ describe('main/notifications', () => {
             await NotificationManager.displayMention(
                 'test',
                 'test body 2',
-                {id: 'channel_id'},
+                'channel_id',
                 'team_id',
                 'http://server-1.com/team_id/channel_id',
                 false,
                 {id: 1} as WebContents,
-                {soundName: ''},
+                '',
             );
 
             expect(mentionsPerChannel.delete).toHaveBeenCalled();
@@ -277,12 +278,12 @@ describe('main/notifications', () => {
             await NotificationManager.displayMention(
                 'click_test',
                 'mention_click_body',
-                {id: 'channel_id'},
+                'channel_id',
                 'team_id',
                 'http://server-1.com/team_id/channel_id',
                 false,
                 {id: 1, send: jest.fn()} as unknown as WebContents,
-                {soundName: ''},
+                '',
             );
             const mention = mentions.find((m) => m.body === 'mention_click_body');
             mention?.value.click();
@@ -298,12 +299,12 @@ describe('main/notifications', () => {
             await NotificationManager.displayMention(
                 'click_test',
                 'mention_click_body',
-                {id: 'channel_id'},
+                'channel_id',
                 'team_id',
                 'http://server-1.com/team_id/channel_id',
                 false,
                 {id: 1, send: jest.fn()} as unknown as WebContents,
-                {soundName: ''},
+                '',
             );
             Object.defineProperty(process, 'platform', {
                 value: originalPlatform,
@@ -324,12 +325,12 @@ describe('main/notifications', () => {
             await NotificationManager.displayMention(
                 'click_test',
                 'mention_click_body',
-                {id: 'channel_id'},
+                'channel_id',
                 'team_id',
                 'http://server-1.com/team_id/channel_id',
                 false,
                 {id: 1, send: jest.fn()} as unknown as WebContents,
-                {soundName: ''},
+                '',
             );
             Object.defineProperty(process, 'platform', {
                 value: originalPlatform,
@@ -345,12 +346,12 @@ describe('main/notifications', () => {
             await NotificationManager.displayMention(
                 'click_test',
                 'mention_click_body',
-                {id: 'channel_id'},
+                'channel_id',
                 'team_id',
                 'http://server-1.com/team_id/channel_id',
                 false,
                 {id: 1, send: jest.fn()} as unknown as WebContents,
-                {soundName: ''},
+                '',
             );
             Object.defineProperty(process, 'platform', {
                 value: originalPlatform,
@@ -371,12 +372,12 @@ describe('main/notifications', () => {
             await NotificationManager.displayMention(
                 'click_test',
                 'mention_click_body',
-                {id: 'channel_id'},
+                'channel_id',
                 'team_id',
                 'http://server-1.com/team_id/channel_id',
                 false,
                 {id: 1, send: jest.fn()} as unknown as WebContents,
-                {soundName: ''},
+                '',
             );
             Object.defineProperty(process, 'platform', {
                 value: originalPlatform,