Upgrade to electron 12 and Node 14 (#3572)

Upgrade to electron 12 and Node 14

- Compute cluster ID for tests
- Switch to temporary appData path while testing

Signed-off-by: Sebastian Malton <sebastian@malton.name>

Co-authored-by: Sebastian Malton <smalton@mirantis.com>
Co-authored-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

src/main/cluster.ts

@@ -33,7 +33,8 @@ import { VersionDetector } from "./cluster-detectors/version-detector";
 import { DetectorRegistry } from "./cluster-detectors/detector-registry";
 import plimit from "p-limit";
 import { toJS } from "../common/utils";
-import { initialNodeShellImage, ClusterState, ClusterMetadataKey, ClusterRefreshOptions, ClusterStatus, ClusterMetricsResourceType, ClusterId, ClusterMetadata, ClusterModel, ClusterPreferences, ClusterPrometheusPreferences, UpdateClusterModel } from "../common/cluster-types";
+import type { ClusterState, ClusterRefreshOptions, ClusterMetricsResourceType, ClusterId, ClusterMetadata, ClusterModel, ClusterPreferences, ClusterPrometheusPreferences, UpdateClusterModel } from "../common/cluster-types";
+import { ClusterMetadataKey, initialNodeShellImage, ClusterStatus } from "../common/cluster-types";
 
 /**
  * Cluster

src/main/exit-app.ts

@@ -26,14 +26,9 @@ import { ClusterManager } from "./cluster-manager";
 import logger from "./logger";
 
 export function exitApp() {
-  console.log("before windowManager");
   const windowManager = WindowManager.getInstance(false);
-
-  console.log("before clusterManager");
   const clusterManager = ClusterManager.getInstance(false);
 
-  console.log("after clusterManager");
-
   appEventBus.emit({ name: "service", action: "close" });
   windowManager?.hide();
   clusterManager?.stop();

src/main/extension-filesystem.ts

@@ -21,13 +21,13 @@
 
 import { randomBytes } from "crypto";
 import { SHA256 } from "crypto-js";
-import { app, remote } from "electron";
 import fse from "fs-extra";
 import { action, makeObservable, observable } from "mobx";
 import path from "path";
 import { BaseStore } from "../common/base-store";
 import type { LensExtensionId } from "../extensions/lens-extension";
 import { toJS } from "../common/utils";
+import { getPath } from "../common/utils/getPath";
 
 interface FSProvisionModel {
   extensions: Record<string, string>; // extension names to paths
@@ -55,7 +55,7 @@ export class FilesystemProvisionerStore extends BaseStore<FSProvisionModel> {
     if (!this.registeredExtensions.has(extensionName)) {
       const salt = randomBytes(32).toString("hex");
       const hashedName = SHA256(`${extensionName}/${salt}`).toString();
-      const dirPath = path.resolve((app || remote.app).getPath("userData"), "extension_data", hashedName);
+      const dirPath = path.resolve(getPath("userData"), "extension_data", hashedName);
 
       this.registeredExtensions.set(extensionName, dirPath);
     }

src/main/index.ts

@@ -22,12 +22,12 @@
 // Main process
 
 import "../common/system-ca";
+import { initialize as initializeRemote } from "@electron/remote/main";
 import * as Mobx from "mobx";
 import * as LensExtensionsCommonApi from "../extensions/common-api";
 import * as LensExtensionsMainApi from "../extensions/main-api";
 import { app, autoUpdater, dialog, powerMonitor } from "electron";
-import { appName, isMac, productName } from "../common/vars";
-import path from "path";
+import { appName, isIntegrationTesting, isMac, productName } from "../common/vars";
 import { LensProxy } from "./lens-proxy";
 import { WindowManager } from "./window-manager";
 import { ClusterManager } from "./cluster-manager";
@@ -63,13 +63,13 @@ import { ensureDir } from "fs-extra";
 import { Router } from "./router";
 import { initMenu } from "./menu";
 import { initTray } from "./tray";
+import * as path from "path";
 import { kubeApiRequest, shellApiRequest } from "./proxy-functions";
 
+const onCloseCleanup = disposer();
+const onQuitCleanup = disposer();
+
 SentryInit();
-
-const workingDir = path.join(app.getPath("appData"), appName);
-const cleanup = disposer();
-
 app.setName(appName);
 
 logger.info(`📟 Setting ${productName} as protocol client for lens://`);
@@ -80,14 +80,16 @@ if (app.setAsDefaultProtocolClient("lens")) {
   logger.info("📟 Protocol client register failed ❗");
 }
 
-if (!process.env.CICD) {
-  app.setPath("userData", workingDir);
+if (process.env.CICD) {
+  app.setPath("appData", process.env.CICD);
+  app.setPath("userData", path.join(process.env.CICD, appName));
 }
 
 if (process.env.LENS_DISABLE_GPU) {
   app.disableHardwareAcceleration();
 }
 
+initializeRemote();
 configurePackages();
 mangleProxyEnv();
 initializers.initIpcMainHandlers();
@@ -121,7 +123,7 @@ app.on("second-instance", (event, argv) => {
 });
 
 app.on("ready", async () => {
-  logger.info(`🚀 Starting ${productName} from "${workingDir}"`);
+  logger.info(`🚀 Starting ${productName} from "${app.getPath("exe")}"`);
   logger.info("🐚 Syncing shell environment");
   await shellSync();
 
@@ -209,7 +211,7 @@ app.on("ready", async () => {
   logger.info("🖥️  Starting WindowManager");
   const windowManager = WindowManager.createInstance();
 
-  cleanup.push(
+  onQuitCleanup.push(
     initMenu(windowManager),
     initTray(windowManager),
   );
@@ -221,7 +223,7 @@ app.on("ready", async () => {
   }
 
   ipcMainOn(IpcRendererNavigationEvents.LOADED, async () => {
-    cleanup.push(pushCatalogToRenderer(catalogEntityRegistry));
+    onCloseCleanup.push(pushCatalogToRenderer(catalogEntityRegistry));
     await ensureDir(storedKubeConfigFolder());
     KubeconfigSyncManager.getInstance().startSync();
     startUpdateChecking();
@@ -269,7 +271,7 @@ app.on("activate", (event, hasVisibleWindows) => {
 /**
  * This variable should is used so that `autoUpdater.installAndQuit()` works
  */
-let blockQuit = true;
+let blockQuit = !isIntegrationTesting;
 
 autoUpdater.on("before-quit-for-update", () => blockQuit = false);
 
@@ -282,7 +284,7 @@ app.on("will-quit", (event) => {
   appEventBus.emit({ name: "app", action: "close" });
   ClusterManager.getInstance(false)?.stop(); // close cluster connections
   KubeconfigSyncManager.getInstance(false)?.stopSync();
-  cleanup();
+  onCloseCleanup();
 
   if (lprm) {
     // This is set to false here so that LPRM can wait to send future lens://
@@ -298,7 +300,8 @@ app.on("will-quit", (event) => {
     return; // skip exit to make tray work, to quit go to app's global menu or tray's menu
   }
 
-  LensProtocolRouterMain.getInstance(false)?.cleanup();
+  lprm?.cleanup();
+  onQuitCleanup();
 });
 
 app.on("open-url", (event, rawUrl) => {

src/main/initializers/ipc.ts

@@ -19,20 +19,21 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-import type { IpcMainInvokeEvent } from "electron";
+import { BrowserWindow, dialog, IpcMainInvokeEvent } from "electron";
 import { KubernetesCluster } from "../../common/catalog-entities";
 import { clusterFrameMap } from "../../common/cluster-frames";
 import { clusterActivateHandler, clusterSetFrameIdHandler, clusterVisibilityHandler, clusterRefreshHandler, clusterDisconnectHandler, clusterKubectlApplyAllHandler, clusterKubectlDeleteAllHandler, clusterDeleteHandler } from "../../common/cluster-ipc";
 import { ClusterStore } from "../../common/cluster-store";
 import type { ClusterId } from "../../common/cluster-types";
 import { appEventBus } from "../../common/event-bus";
-import { ipcMainHandle } from "../../common/ipc";
+import { dialogShowOpenDialogHandler, ipcMainHandle } from "../../common/ipc";
 import { catalogEntityRegistry } from "../catalog";
 import { ClusterManager } from "../cluster-manager";
 import { bundledKubectlPath } from "../kubectl";
 import logger from "../logger";
 import { promiseExecFile } from "../promise-exec";
 import { ResourceApplier } from "../resource-applier";
+import { WindowManager } from "../window-manager";
 
 export function initIpcMainHandlers() {
   ipcMainHandle(clusterActivateHandler, (event, clusterId: ClusterId, force = false) => {
@@ -138,4 +139,10 @@ export function initIpcMainHandlers() {
       throw `${clusterId} is not a valid cluster id`;
     }
   });
+
+  ipcMainHandle(dialogShowOpenDialogHandler, async (event, dialogOpts: Electron.OpenDialogOptions) => {
+    await WindowManager.getInstance().ensureMainWindow();
+
+    return dialog.showOpenDialog(BrowserWindow.getFocusedWindow(), dialogOpts);
+  });
 }

src/main/kubectl.ts

@@ -19,7 +19,6 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-import { app, remote } from "electron";
 import path from "path";
 import fs from "fs";
 import { promiseExec } from "./promise-exec";
@@ -32,6 +31,7 @@ import { customRequest } from "../common/request";
 import { getBundledKubectlVersion } from "../common/utils/app-version";
 import { isDevelopment, isWindows, isTestEnv } from "../common/vars";
 import { SemVer } from "semver";
+import { getPath } from "../common/utils/getPath";
 
 const bundledVersion = getBundledKubectlVersion();
 const kubectlMap: Map<string, string> = new Map([
@@ -84,7 +84,7 @@ export class Kubectl {
   protected dirname: string;
 
   static get kubectlDir() {
-    return path.join((app || remote.app).getPath("userData"), "binaries", "kubectl");
+    return path.join(getPath("userData"), "binaries", "kubectl");
   }
 
   public static readonly bundledKubectlVersion: string = bundledVersion;

src/main/menu.ts

@@ -83,7 +83,7 @@ export function buildMenu(windowManager: WindowManager) {
         accelerator: "CmdOrCtrl+,",
         click() {
           navigate(preferencesURL());
-        }
+        },
       },
       {
         label: "Extensions",
@@ -106,7 +106,7 @@ export function buildMenu(windowManager: WindowManager) {
           exitApp();
         }
       }
-    ]
+    ],
   };
   const fileMenu: MenuItemConstructorOptions = {
     label: "File",
@@ -150,7 +150,7 @@ export function buildMenu(windowManager: WindowManager) {
           }
         }
       ])
-    ]
+    ],
   };
   const editMenu: MenuItemConstructorOptions = {
     label: "Edit",

src/main/window-manager.ts

@@ -89,7 +89,8 @@ export class WindowManager extends Singleton {
           nodeIntegration: true,
           nodeIntegrationInSubFrames: true,
           enableRemoteModule: true,
-          webviewTag: true
+          webviewTag: true,
+          contextIsolation: false,
         },
       });
       this.windowState.manage(this.mainWindow);
@@ -257,7 +258,10 @@ export class WindowManager extends Singleton {
         resizable: false,
         show: false,
         webPreferences: {
-          nodeIntegration: true
+          nodeIntegration: true,
+          enableRemoteModule: true,
+          contextIsolation: false,
+          nodeIntegrationInSubFrames: true,
         }
       });
       await this.splashWindow.loadURL("static://splash.html");