refactor(main): move window-all-closed listener to main class (podman-desktop#11468)

Signed-off-by: axel7083 <42176370+axel7083@users.noreply.github.com>

Author: axel7083

packages/main/src/index.ts

@@ -56,15 +56,6 @@ app.on('second-instance', (_event, _args, _workingDirectory, additionalData: unk
   });
 });
 
-/**
- * Shout down background process if all windows was closed
- */
-app.on('window-all-closed', () => {
-  if (!isMac()) {
-    app.quit();
-  }
-});
-
 app.once('before-quit', event => {
   if (!extensionLoader) {
     stoppedExtensions.val = true;

packages/main/src/main.spec.ts

@@ -16,10 +16,10 @@
  * SPDX-License-Identifier: Apache-2.0
  ***********************************************************************/
 import type { App as ElectronApp } from 'electron';
-import { afterEach, beforeEach, expect, test, vi } from 'vitest';
+import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
 
 import { SecurityRestrictions } from '/@/security-restrictions.js';
-import { isWindows } from '/@/util.js';
+import { isLinux, isMac, isWindows } from '/@/util.js';
 
 import { Main } from './main.js';
 
@@ -34,6 +34,7 @@ const ELECTRON_APP_MOCK: ElectronApp = {
   requestSingleInstanceLock: vi.fn(),
   setAppUserModelId: vi.fn(),
   quit: vi.fn(),
+  on: vi.fn(),
 } as unknown as ElectronApp;
 
 let PROCESS_EXIT_ORIGINAL: typeof process.exit;
@@ -87,3 +88,64 @@ test('on windows setAppUserModelId should be called', async () => {
 
   expect(ELECTRON_APP_MOCK.setAppUserModelId).toHaveBeenCalledWith(ELECTRON_APP_MOCK.name);
 });
+
+// Utility type definition for {@link ElectronApp.on} and {@link WebContents.on}
+type Listener = (...args: unknown[]) => void;
+
+/**
+ * Utility function to get listener register in {@link ELECTRON_APP_MOCK.on}
+ * @remarks cannot found any way to properly infer type based on event value (see https://github.com/microsoft/TypeScript/issues/53439)
+ * @param event
+ */
+function findElectronAppListener(event: string): Listener | undefined {
+  expect(ELECTRON_APP_MOCK.on).toHaveBeenCalledWith(event, expect.any(Function));
+  return vi.mocked(ELECTRON_APP_MOCK.on).mock.calls.find(([mEvent]) => mEvent === event)?.[1];
+}
+
+/**
+ * Based on {@link findElectronAppListener}, throw an error if the result is undefined
+ * @param event
+ */
+function getElectronAppListener(event: string): Listener {
+  const listener = findElectronAppListener(event);
+  if (!listener) throw new Error(`cannot found listener for event ${event}`);
+  return listener;
+}
+
+describe('ElectronApp#on window-all-closed', () => {
+  let code: Main;
+  beforeEach(() => {
+    code = new Main(ELECTRON_APP_MOCK);
+    code.main([]);
+  });
+
+  test('listener should be registered on init', () => {
+    expect(ELECTRON_APP_MOCK.on).toHaveBeenCalledWith('window-all-closed', expect.any(Function));
+  });
+
+  test('listener should be a valid function', () => {
+    const listener = findElectronAppListener('window-all-closed');
+    expect(listener).toBeDefined();
+    expect(listener).toBeInstanceOf(Function);
+  });
+
+  test('listener should not call ElectronApp#quit on mac', () => {
+    vi.mocked(isMac).mockReturnValue(true);
+
+    const listener = getElectronAppListener('window-all-closed');
+    listener();
+
+    expect(ELECTRON_APP_MOCK.quit).not.toHaveBeenCalled();
+  });
+
+  test.each(['windows', 'linux'])('listener should not call ElectronApp#quit on %s', platform => {
+    vi.mocked(isMac).mockReturnValue(false);
+    vi.mocked(isWindows).mockReturnValue(platform === 'windows');
+    vi.mocked(isLinux).mockReturnValue(platform === 'linux');
+
+    const listener = getElectronAppListener('window-all-closed');
+    listener();
+
+    expect(ELECTRON_APP_MOCK.quit).toHaveBeenCalledOnce();
+  });
+});

packages/main/src/main.ts

@@ -18,7 +18,7 @@
 import type { App as ElectronApp, BrowserWindow } from 'electron';
 
 import { SecurityRestrictions } from '/@/security-restrictions.js';
-import { isWindows } from '/@/util.js';
+import { isMac, isWindows } from '/@/util.js';
 
 import { Deferred } from './plugin/util/deferred.js';
 import { ProtocolLauncher } from './protocol-launcher.js';
@@ -86,5 +86,20 @@ export class Main {
     if (isWindows()) {
       this.app.setAppUserModelId(this.app.name);
     }
+
+    /**
+     * Setup {@link ElectronApp.on} listeners
+     */
+    this.app.on('window-all-closed', this.onWindowAllClosed.bind(this));
+  }
+
+  /**
+   * Listener for {@link ElectronApp.on('window-all-closed')} event
+   * Shout down background process if all windows was closed
+   */
+  protected onWindowAllClosed(): void {
+    if (!isMac()) {
+      this.app.quit();
+    }
   }
 }