Merge pull request #324 from Concordium/fix-macos-window-closed-issue

Cleanup handlers and listeners on all windows closed

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 1.4.2
+
+### Fixed
+
+-   Fixed an issue on macOS where an error popup would show after closing the main application window and opening it again.
+-   Fixed an issue on macOS where identity creation was not possible after closing the main application window and opening it again.
+
 ## 1.4.1
 
 ### Added

app/main.ts

@@ -13,8 +13,14 @@ import path from 'path';
 import { app, BrowserView, BrowserWindow, shell } from 'electron';
 import ipcRendererCommands from './constants/ipcRendererCommands.json';
 import { createMenu, addContextMenu } from './main/menu';
-import initializeIpcHandlers from './main/ipcHandlers';
-import initAutoUpdate from './main/autoUpdate';
+import {
+    initializeIpcHandlers,
+    removeAllIpcHandlers,
+} from './main/ipcHandlers';
+import {
+    initAutoUpdate,
+    removeAutoUpdateHandlersAndListeners,
+} from './main/autoUpdate';
 
 let mainWindow: BrowserWindow | null = null;
 let printWindow: BrowserWindow | null = null;
@@ -170,16 +176,22 @@ const createWindow = async () => {
     initializeIpcHandlers(mainWindow, printWindow, browserView);
 };
 
+const isMac = process.platform === 'darwin';
+
 app.on('window-all-closed', () => {
-    // Respect the OSX convention of having the application in memory even
-    // after all windows have been closed
-    if (process.platform !== 'darwin') {
+    // Respect the macOS convention of having the application in memory even
+    // after all windows have been closed.
+    if (!isMac) {
         app.quit();
+    } else {
+        // On macOS we have to clear all ipc handlers when all windows are closed,
+        // as we need to spawn new handlers that are connected to the newly created
+        // windows to avoid referencing destroyed objects.
+        removeAllIpcHandlers();
+        removeAutoUpdateHandlersAndListeners();
     }
 });
 
-const isMac = process.platform === 'darwin';
-
 if (process.env.E2E_BUILD === 'true') {
     // eslint-disable-next-line promise/catch-or-return
     app.whenReady().then(createWindow);

app/main/autoUpdate/index.ts

@@ -1 +1 @@
-export { default } from './init';
+export { initAutoUpdate, removeAutoUpdateHandlersAndListeners } from './init';

app/main/autoUpdate/init.ts

@@ -45,7 +45,26 @@ const handleUpdateDownloaded = (mainWindow: BrowserWindow) => async (
     }
 };
 
-export default function initAutoUpdate(mainWindow: BrowserWindow) {
+/**
+ * Removes all ipcMain handlers and auto update listeners added by
+ * 'initAutoUpdate'.
+ */
+export function removeAutoUpdateHandlersAndListeners() {
+    autoUpdater.removeAllListeners('update-available');
+    autoUpdater.removeAllListeners('error');
+    autoUpdater.removeAllListeners('update-downloaded');
+    ipcMain.removeHandler(triggerAppUpdate);
+    ipcMain.removeHandler(quitAndInstallUpdate);
+}
+
+/**
+ * Initializes the auto update functionality by setting up handlers
+ * and auto update listeners.
+ *
+ * If adding a new handler to this method, then ensure that 'removeAutoUpdateHandlersAndListeners'
+ * above is updated to keep in sync with this method.
+ */
+export function initAutoUpdate(mainWindow: BrowserWindow) {
     const canAutoUpdate =
         process.platform === 'win32' ||
         process.platform === 'darwin' ||

app/main/ipcHandlers.ts

@@ -141,7 +141,29 @@ export function saveFileDialog(opts: SaveDialogOptions) {
     return dialog.showSaveDialog(opts);
 }
 
-export default function initializeIpcHandlers(
+/**
+ * Removes all ipcMain handlers registered by 'initializeIpcHandler'.
+ */
+export function removeAllIpcHandlers() {
+    ipcMain.removeHandler(ipcCommands.getUserDataPath);
+    ipcMain.removeHandler(ipcCommands.print);
+    ipcMain.removeHandler(ipcCommands.openUrl);
+    ipcMain.removeHandler(ipcCommands.httpsGet);
+    ipcMain.removeHandler(ipcCommands.createView);
+    ipcMain.removeHandler(ipcCommands.removeView);
+    ipcMain.removeHandler(ipcCommands.resizeView);
+    ipcMain.removeHandler(ipcCommands.saveFileDialog);
+    ipcMain.removeHandler(ipcCommands.openFileDialog);
+    ipcMain.removeHandler(ipcCommands.messageBox);
+}
+
+/**
+ * Initializes ipcMain handlers.
+ *
+ * If adding a new handler to this method, then ensure that 'removeAllIpcHandlers'
+ * above is updated to keep in sync with this method.
+ */
+export function initializeIpcHandlers(
     mainWindow: BrowserWindow,
     printWindow: BrowserWindow,
     browserView: BrowserView

app/package.json

@@ -2,7 +2,7 @@
     "name": "concordium-desktop-wallet",
     "productName": "concordium-desktop-wallet",
     "description": "concordium-desktop-wallet",
-    "version": "1.4.1",
+    "version": "1.4.2",
     "main": "./main.prod.js",
     "author": {
         "name": "Concordium Software",