Expose Desktop API in Calls popout window (#3258)

mattermost · Jan 20, 2025 · 34932df · 34932df
1 parent a0ac399
commit 34932df
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 1 deletion.
diff --git a/i18n/en.json b/i18n/en.json
@@ -97,6 +97,7 @@
   "main.menus.app.view.developerModeDisableUserActivityMonitor": "Disable User Activity Monitor",
   "main.menus.app.view.devToolsAppWrapper": "Developer Tools for Application Wrapper",
   "main.menus.app.view.devToolsCurrentCallWidget": "Developer Tools for Call Widget",
+  "main.menus.app.view.devToolsCurrentCallWidgetPopout": "Developer Tools for Call Widget Popout",
   "main.menus.app.view.devToolsCurrentServer": "Developer Tools for Current Server",
   "main.menus.app.view.devToolsSubMenu": "Developer Tools",
   "main.menus.app.view.downloads": "Downloads",

diff --git a/src/main/menus/app.test.js b/src/main/menus/app.test.js
@@ -360,6 +360,7 @@ describe('main/menus/app', () => {
 
     it('should show menu item if widget window is open', () => {
         CallsWidgetWindow.isOpen = jest.fn(() => true);
+        CallsWidgetWindow.isPopoutOpen = jest.fn(() => false);
         const menu = createTemplate(config);
 
         const appMenu = menu.find((item) => item.label === 'main.menus.app.view');
@@ -371,4 +372,19 @@ describe('main/menus/app', () => {
         const menuItem = devToolsSubMenu.submenu.find((item) => item.label === 'main.menus.app.view.devToolsCurrentCallWidget');
         expect(menuItem).not.toBe(undefined);
     });
+
+    it('should show additional menu item if widget popout is open', () => {
+        CallsWidgetWindow.isOpen = jest.fn(() => true);
+        CallsWidgetWindow.isPopoutOpen = jest.fn(() => true);
+        const menu = createTemplate(config);
+
+        const appMenu = menu.find((item) => item.label === 'main.menus.app.view');
+        expect(appMenu).not.toBe(undefined);
+
+        const devToolsSubMenu = appMenu.submenu.find((item) => item.label === 'main.menus.app.view.devToolsSubMenu');
+        expect(devToolsSubMenu).not.toBe(undefined);
+
+        const menuItem = devToolsSubMenu.submenu.find((item) => item.label === 'main.menus.app.view.devToolsCurrentCallWidgetPopout');
+        expect(menuItem).not.toBe(undefined);
+    });
 });
diff --git a/src/main/menus/app.ts b/src/main/menus/app.ts
@@ -179,6 +179,15 @@ export function createTemplate(config: Config, updateManager: UpdateManager) {
                 CallsWidgetWindow.openDevTools();
             },
         });
+
+        if (CallsWidgetWindow.isPopoutOpen()) {
+            devToolsSubMenu.push({
+                label: localizeMessage('main.menus.app.view.devToolsCurrentCallWidgetPopout', 'Developer Tools for Call Widget Popout'),
+                click() {
+                    CallsWidgetWindow.openPopoutDevTools();
+                },
+            });
+        }
     }
 
     if (DeveloperMode.enabled()) {

diff --git a/src/main/windows/callsWidgetWindow.test.js b/src/main/windows/callsWidgetWindow.test.js
@@ -79,7 +79,7 @@ jest.mock('main/views/viewManager', () => ({
 jest.mock('../utils', () => ({
     openScreensharePermissionsSettingsMacOS: jest.fn(),
     resetScreensharePermissionsMacOS: jest.fn(),
-    getLocalPreload: jest.fn(),
+    getLocalPreload: jest.fn((file) => file),
     composeUserAgent: jest.fn(),
 }));
 
@@ -369,6 +369,12 @@ describe('main/windows/callsWidgetWindow', () => {
             urlUtils.isCallsPopOutURL.mockReturnValue(false);
             expect(callsWidgetWindow.onPopOutOpen({url: 'http://localhost:8065/notpopouturl'})).toHaveProperty('action', 'deny');
         });
+
+        it('should pop out and make sure preload is set', () => {
+            urlUtils.isCallsPopOutURL.mockReturnValue(true);
+            expect(callsWidgetWindow.onPopOutOpen({url: 'http://localhost:8065/popouturl'})).toHaveProperty('action', 'allow');
+            expect(callsWidgetWindow.onPopOutOpen({url: 'http://localhost:8065/popouturl'})).toHaveProperty('overrideBrowserWindowOptions.webPreferences.preload', 'externalAPI.js');
+        });
     });
 
     describe('handlePopOutFocus', () => {

diff --git a/src/main/windows/callsWidgetWindow.ts b/src/main/windows/callsWidgetWindow.ts
@@ -97,6 +97,10 @@ export class CallsWidgetWindow {
         return Boolean(this.win && !this.win.isDestroyed());
     }
 
+    public isPopoutOpen() {
+        return Boolean(this.popOut && !this.popOut.isDestroyed());
+    }
+
     /**
      * Helper functions
      */
@@ -105,6 +109,10 @@ export class CallsWidgetWindow {
         this.win?.webContents.openDevTools({mode: 'detach'});
     };
 
+    public openPopoutDevTools = () => {
+        this.popOut?.webContents.openDevTools({mode: 'detach'});
+    };
+
     getViewURL = () => {
         return this.mainView?.view.server.url;
     };
@@ -292,6 +300,9 @@ export class CallsWidgetWindow {
                 action: 'allow' as const,
                 overrideBrowserWindowOptions: {
                     autoHideMenuBar: true,
+                    webPreferences: {
+                        preload: getLocalPreload('externalAPI.js'),
+                    },
                 },
             };
         }
@@ -318,7 +329,11 @@ export class CallsWidgetWindow {
         const contextMenu = new ContextMenu({}, this.popOut);
         contextMenu.reload();
 
+        // Update menu to show the developer tools option for this window.
+        ipcMain.emit(UPDATE_SHORTCUT_MENU);
+
         this.popOut.on('closed', () => {
+            ipcMain.emit(UPDATE_SHORTCUT_MENU);
             delete this.popOut;
             contextMenu.dispose();
             this.setWidgetWindowStacking({onTop: true});