Upgrade to Electron 14.2.4 (#4625)

Co-authored-by: Sebastian Malton <sebastian@malton.name>
Co-authored-by: Jim Ehrismann <jehrismann@mirantis.com>

src/common/ipc/catalog.ts

@@ -3,14 +3,17 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 
-export enum CatalogIpcEvents {
-  /**
-   * This is broadcast on whenever there is an update to any catalog item
-   */
-  ITEMS = "catalog:items",
+/**
+ * This is used to activate a specific entity in the renderer main frame
+ */
+export const catalogEntityRunListener = "catalog-entity:run";
 
-  /**
-   * This can be sent from renderer to main to initialize a broadcast of ITEMS
-   */
-  INIT = "catalog:init",
-}
+/**
+ * This is broadcast on whenever there is an update to any catalog item
+ */
+export const catalogItemsChannel = "catalog:items";
+
+/**
+ * This can be sent from renderer to main to initialize a broadcast of ITEMS
+ */
+export const catalogInitChannel = "catalog:init";

src/common/ipc/cluster.ipc.ts

@@ -1,16 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-
-/**
- * This channel is broadcast on whenever the cluster fails to list namespaces
- * during a refresh and no `accessibleNamespaces` have been set.
- */
-export const ClusterListNamespaceForbiddenChannel = "cluster:list-namespace-forbidden";
-
-export type ListNamespaceForbiddenArgs = [clusterId: string];
-
-export function isListNamespaceForbiddenArgs(args: unknown[]): args is ListNamespaceForbiddenArgs {
-  return args.length === 1 && typeof args[0] === "string";
-}

src/common/ipc/cluster.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+export const clusterActivateHandler = "cluster:activate";
+export const clusterSetFrameIdHandler = "cluster:set-frame-id";
+export const clusterVisibilityHandler = "cluster:visibility";
+export const clusterRefreshHandler = "cluster:refresh";
+export const clusterDisconnectHandler = "cluster:disconnect";
+export const clusterDeleteHandler = "cluster:delete";
+export const clusterSetDeletingHandler = "cluster:deleting:set";
+export const clusterClearDeletingHandler = "cluster:deleting:clear";
+export const clusterKubectlApplyAllHandler = "cluster:kubectl-apply-all";
+export const clusterKubectlDeleteAllHandler = "cluster:kubectl-delete-all";
+export const clusterStates = "cluster:states";
+
+/**
+ * This channel is broadcast on whenever the cluster fails to list namespaces
+ * during a refresh and no `accessibleNamespaces` have been set.
+ */
+export const clusterListNamespaceForbiddenChannel = "cluster:list-namespace-forbidden";
+
+export type ListNamespaceForbiddenArgs = [clusterId: string];
+
+export function isListNamespaceForbiddenArgs(args: unknown[]): args is ListNamespaceForbiddenArgs {
+  return args.length === 1 && typeof args[0] === "string";
+}

src/common/ipc/dialog.ts

@@ -2,4 +2,5 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
-export const BundledExtensionsLoaded = "extension-loader:bundled-extensions-loaded";
+
+export const openFilePickingDialogChannel = "dialog:open:file-picking";

src/common/ipc/extension-handling.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+export const extensionDiscoveryStateChannel = "extension-discovery:state";
+export const bundledExtensionsLoaded = "extension-loader:bundled-extensions-loaded";
+export const extensionLoaderFromMainChannel = "extension-loader:main:state";
+export const extensionLoaderFromRendererChannel = "extension-loader:renderer:state";

src/common/ipc/hotbar.ts

@@ -3,4 +3,4 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 
-export const HotbarTooManyItems = "hotbar:too-many-items";
+export const hotbarTooManyItemsChannel = "hotbar:too-many-items";

src/common/ipc/index.ts

@@ -3,13 +3,7 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 
-export const dialogShowOpenDialogHandler = "dialog:show-open-dialog";
-export const catalogEntityRunListener = "catalog-entity:run";
-
 export * from "./ipc";
 export * from "./invalid-kubeconfig";
-export * from "./update-available.ipc";
-export * from "./cluster.ipc";
+export * from "./update-available";
 export * from "./type-enforced-ipc";
-export * from "./hotbar";
-export * from "./extension-loader.ipc";

src/common/ipc/ipc.ts

@@ -12,25 +12,8 @@ import { toJS } from "../utils/toJS";
 import logger from "../../main/logger";
 import { ClusterFrameInfo, clusterFrameMap } from "../cluster-frames";
 import type { Disposer } from "../utils";
-import type remote from "@electron/remote";
 
-const electronRemote = (() => {
-  if (ipcRenderer) {
-    try {
-      return require("@electron/remote");
-    } catch {
-      // ignore temp
-    }
-  }
-
-  return null;
-})();
-
-const subFramesChannel = "ipc:get-sub-frames";
-
-export async function requestMain(channel: string, ...args: any[]) {
-  return ipcRenderer.invoke(channel, ...args.map(sanitizePayload));
-}
+export const broadcastMainChannel = "ipc:broadcast-main";
 
 export function ipcMainHandle(channel: string, listener: (event: Electron.IpcMainInvokeEvent, ...args: any[]) => any) {
   ipcMain.handle(channel, async (event, ...args) => {
@@ -42,51 +25,55 @@ function getSubFrames(): ClusterFrameInfo[] {
   return Array.from(clusterFrameMap.values());
 }
 
-export function broadcastMessage(channel: string, ...args: any[]) {
-  const subFramesP = ipcRenderer
-    ? requestMain(subFramesChannel)
-    : Promise.resolve(getSubFrames());
+export async function broadcastMessage(channel: string, ...args: any[]): Promise<void> {
+  if (ipcRenderer) {
+    return ipcRenderer.invoke(broadcastMainChannel, channel, ...args.map(sanitizePayload));
+  }
 
-  subFramesP
-    .then(subFrames => {
-      const views: undefined | ReturnType<typeof webContents.getAllWebContents> | ReturnType<typeof remote.webContents.getAllWebContents> = (webContents || electronRemote?.webContents)?.getAllWebContents();
+  if (!webContents) {
+    return;
+  }
 
-      if (!views || !Array.isArray(views) || views.length === 0) return;
-      args = args.map(sanitizePayload);
+  ipcMain.listeners(channel).forEach((func) => func({
+    processId: undefined, frameId: undefined, sender: undefined, senderFrame: undefined,
+  }, ...args));
 
-      ipcRenderer?.send(channel, ...args);
-      ipcMain?.emit(channel, ...args);
+  const subFrames = getSubFrames();
+  const views = webContents.getAllWebContents();
 
-      for (const view of views) {
-        let viewType = "unknown";
+  if (!views || !Array.isArray(views) || views.length === 0) return;
 
-        // There will be a uncaught exception if the view is destroyed.
-        try {
-          viewType = view.getType();
-        } catch {
-          // We can ignore the view destroyed exception as viewType is only used for logging.
-        }
+  args = args.map(sanitizePayload);
 
-        // Send message to views.
-        try {
-          logger.silly(`[IPC]: broadcasting "${channel}" to ${viewType}=${view.id}`, { args });
-          view.send(channel, ...args);
-        } catch (error) {
-          logger.error(`[IPC]: failed to send IPC message "${channel}" to view "${viewType}=${view.id}"`, { error: String(error) });
-        }
+  for (const view of views) {
+    let viewType = "unknown";
 
-        // Send message to subFrames of views.
-        for (const frameInfo of subFrames) {
-          logger.silly(`[IPC]: broadcasting "${channel}" to subframe "frameInfo.processId"=${frameInfo.processId} "frameInfo.frameId"=${frameInfo.frameId}`, { args });
+    // There will be a uncaught exception if the view is destroyed.
+    try {
+      viewType = view.getType();
+    } catch {
+      // We can ignore the view destroyed exception as viewType is only used for logging.
+    }
 
-          try {
-            view.sendToFrame([frameInfo.processId, frameInfo.frameId], channel, ...args);
-          } catch (error) {
-            logger.error(`[IPC]: failed to send IPC message "${channel}" to view "${viewType}=${view.id}"'s subframe "frameInfo.processId"=${frameInfo.processId} "frameInfo.frameId"=${frameInfo.frameId}`, { error: String(error) });
-          }
-        }
+    // Send message to views.
+    try {
+      logger.silly(`[IPC]: broadcasting "${channel}" to ${viewType}=${view.id}`, { args });
+      view.send(channel, ...args);
+    } catch (error) {
+      logger.error(`[IPC]: failed to send IPC message "${channel}" to view "${viewType}=${view.id}"`, { error });
+    }
+
+    // Send message to subFrames of views.
+    for (const frameInfo of subFrames) {
+      logger.silly(`[IPC]: broadcasting "${channel}" to subframe "frameInfo.processId"=${frameInfo.processId} "frameInfo.frameId"=${frameInfo.frameId}`, { args });
+
+      try {
+        view.sendToFrame([frameInfo.processId, frameInfo.frameId], channel, ...args);
+      } catch (error) {
+        logger.error(`[IPC]: failed to send IPC message "${channel}" to view "${viewType}=${view.id}"'s subframe "frameInfo.processId"=${frameInfo.processId} "frameInfo.frameId"=${frameInfo.frameId}`, { error: String(error) });
       }
-    });
+    }
+  }
 }
 
 export function ipcMainOn(channel: string, listener: (event: Electron.IpcMainEvent, ...args: any[]) => any): Disposer {
@@ -101,10 +88,6 @@ export function ipcRendererOn(channel: string, listener: (event: Electron.IpcRen
   return () => ipcRenderer.off(channel, listener);
 }
 
-export function bindBroadcastHandlers() {
-  ipcMainHandle(subFramesChannel, () => getSubFrames());
-}
-
 /**
  * Sanitizing data for IPC-messaging before send.
  * Removes possible observable values to avoid exceptions like "can't clone object".

src/common/ipc/window.ts

@@ -0,0 +1,39 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+export const windowActionHandleChannel = "window:window-action";
+export const windowOpenAppMenuAsContextMenuChannel = "window:open-app-context-menu";
+export const windowLocationChangedChannel = "window:location-changed";
+
+/**
+ * The supported actions on the current window. The argument for `windowActionHandleChannel`
+ */
+export enum WindowAction {
+  /**
+   * Request that the current window goes back one step of browser history
+   */
+  GO_BACK = "back",
+
+  /**
+   * Request that the current window goes forward one step of browser history
+   */
+  GO_FORWARD = "forward",
+
+  /**
+   * Request that the current window is minimized
+   */
+  MINIMIZE = "minimize",
+
+  /**
+   * Request that the current window is maximized if it isn't, or unmaximized
+   * if it is
+   */
+  TOGGLE_MAXIMIZE = "toggle-maximize",
+
+  /**
+   * Request that the current window is closed
+   */
+  CLOSE = "close",
+}