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/renderer/components/+apps-helm-charts/helm-charts.tsx

@@ -96,7 +96,7 @@ export class HelmCharts extends Component<Props> {
             searchProps: {
               ...searchProps,
               placeholder: "Search Helm Charts...",
-            },
+            }
           })}
           renderTableHeader={[
             { className: "icon", showWithColumn: columnId.name },

src/renderer/components/+extensions/extensions.tsx

@@ -21,7 +21,7 @@
 
 import "./extensions.scss";
 
-import { remote, shell } from "electron";
+import { shell } from "electron";
 import fse from "fs-extra";
 import _ from "lodash";
 import { makeObservable, observable, reaction, when } from "mobx";
@@ -46,6 +46,8 @@ import { InstalledExtensions } from "./installed-extensions";
 import { Notice } from "./notice";
 import { SettingLayout } from "../layout/setting-layout";
 import { docsUrl } from "../../../common/vars";
+import { dialog } from "../../remote-helpers";
+import { getPath } from "../../../common/utils/getPath";
 
 function getMessageFromError(error: any): string {
   if (!error || typeof error !== "object") {
@@ -466,9 +468,8 @@ async function installFromInput(input: string) {
 const supportedFormats = ["tar", "tgz"];
 
 async function installFromSelectFileDialog() {
-  const { dialog, BrowserWindow, app } = remote;
-  const { canceled, filePaths } = await dialog.showOpenDialog(BrowserWindow.getFocusedWindow(), {
-    defaultPath: app.getPath("downloads"),
+  const { canceled, filePaths } = await dialog.showOpenDialog({
+    defaultPath: getPath("downloads"),
     properties: ["openFile", "multiSelections"],
     message: `Select extensions to install (formats: ${supportedFormats.join(", ")}), `,
     buttonLabel: "Use configuration",

src/renderer/components/+preferences/add-helm-repo-dialog.tsx

@@ -22,7 +22,7 @@
 import "./add-helm-repo-dialog.scss";
 
 import React from "react";
-import { remote, FileFilter } from "electron";
+import type { FileFilter } from "electron";
 import { observable, makeObservable } from "mobx";
 import { observer } from "mobx-react";
 import { Dialog, DialogProps } from "../dialog";
@@ -35,6 +35,7 @@ import { SubTitle } from "../layout/sub-title";
 import { Icon } from "../icon";
 import { Notifications } from "../notifications";
 import { HelmRepo, HelmRepoManager } from "../../../main/helm/helm-repo-manager";
+import { dialog } from "../../remote-helpers";
 
 interface Props extends Partial<DialogProps> {
   onAddRepo: Function
@@ -88,8 +89,7 @@ export class AddHelmRepoDialog extends React.Component<Props> {
   }
 
   async selectFileDialog(type: FileType, fileFilter: FileFilter) {
-    const { dialog, BrowserWindow } = remote;
-    const { canceled, filePaths } = await dialog.showOpenDialog(BrowserWindow.getFocusedWindow(), {
+    const { canceled, filePaths } = await dialog.showOpenDialog({
       defaultPath: this.getFilePath(type),
       properties: ["openFile", "showHiddenFiles"],
       message: `Select file`,

src/renderer/components/cluster-manager/lens-views.ts

@@ -50,6 +50,7 @@ export async function initView(clusterId: ClusterId) {
   const parentElem = document.getElementById("lens-views");
   const iframe = document.createElement("iframe");
 
+  iframe.id = `cluster-frame-${cluster.id}`;
   iframe.name = cluster.contextName;
   iframe.setAttribute("src", getClusterFrameUrl(clusterId));
   iframe.addEventListener("load", () => {

src/renderer/components/path-picker/index.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) 2021 OpenLens Authors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+export * from "./path-picker";

src/renderer/initializers/catalog-category-registry.tsx

@@ -27,7 +27,7 @@ import { UserStore } from "../../common/user-store";
 import { getAllEntries } from "../components/+preferences/kubeconfig-syncs";
 import { runInAction } from "mobx";
 import { isWindows } from "../../common/vars";
-import { PathPicker } from "../components/path-picker/path-picker";
+import { PathPicker } from "../components/path-picker";
 import { Notifications } from "../components/notifications";
 import { Link } from "react-router-dom";
 

src/renderer/ipc/index.tsx

@@ -117,7 +117,7 @@ function HotbarTooManyItemsHandler(): void {
   Notifications.error(`Cannot have more than ${defaultHotbarCells} items pinned to a hotbar`);
 }
 
-export function registerIpcHandlers() {
+export function registerIpcListeners() {
   onCorrect({
     source: ipcRenderer,
     channel: UpdateAvailableChannel,

src/renderer/keyboard-shortcuts/index.ts

@@ -0,0 +1,88 @@
+/**
+ * Copyright (c) 2021 OpenLens Authors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import { ipcRenderer } from "electron";
+import { navigate } from "../navigation";
+
+/**
+ * The definition of a keyboard shortcut
+ */
+interface Shortcut {
+  code?: string;
+  key?: string;
+  metaKey?: boolean;
+  altKey?: boolean;
+  shiftKey?: boolean;
+  ctrlKey?: boolean;
+  action: () => void;
+}
+
+const shortcuts: Shortcut[] = [
+  {
+    key: "p",
+    metaKey: true,
+    shiftKey: true,
+    action: () => ipcRenderer.emit("command-palette:open"),
+  },
+  {
+    code: "Comma",
+    metaKey: true,
+    action: () => navigate("/preferences"),
+  },
+];
+
+function shortcutMatches(shortcut: Shortcut, event: KeyboardEvent): boolean {
+  if (typeof shortcut.metaKey === "boolean" && shortcut.metaKey !== event.metaKey) {
+    return false;
+  }
+
+  if (typeof shortcut.altKey === "boolean" && shortcut.altKey !== event.altKey) {
+    return false;
+  }
+
+  if (typeof shortcut.shiftKey === "boolean" && shortcut.shiftKey !== event.shiftKey) {
+    return false;
+  }
+
+  if (typeof shortcut.ctrlKey === "boolean" && shortcut.ctrlKey !== event.ctrlKey) {
+    return false;
+  }
+
+  if (typeof shortcut.code === "string" && shortcut.code !== event.code) {
+    return false;
+  }
+
+  if (typeof shortcut.key === "string" && shortcut.key !== event.key) {
+    return false;
+  }
+
+  return true;
+}
+
+export function registerKeyboardShortcuts() {
+  window.addEventListener("keydown", event => {
+    for (const shortcut of shortcuts) {
+      if (shortcutMatches(shortcut, event)) {
+        shortcut.action();
+      }
+    }
+  });
+}

src/renderer/lens-app.tsx

@@ -32,10 +32,11 @@ import { ExtensionLoader } from "../extensions/extension-loader";
 import { broadcastMessage } from "../common/ipc";
 import { CommandContainer } from "./components/command-palette/command-container";
 import { bindProtocolAddRouteHandlers, LensProtocolRouterRenderer } from "./protocol-handler";
-import { registerIpcHandlers } from "./ipc";
+import { registerIpcListeners } from "./ipc";
 import { ipcRenderer } from "electron";
 import { IpcRendererNavigationEvents } from "./navigation/events";
 import { catalogEntityRegistry } from "./api/catalog-entity-registry";
+import { registerKeyboardShortcuts } from "./keyboard-shortcuts";
 
 @observer
 export class LensApp extends React.Component {
@@ -48,7 +49,8 @@ export class LensApp extends React.Component {
     window.addEventListener("offline", () => broadcastMessage("network:offline"));
     window.addEventListener("online", () => broadcastMessage("network:online"));
 
-    registerIpcHandlers();
+    registerKeyboardShortcuts();
+    registerIpcListeners();
   }
 
   componentDidMount() {

src/renderer/remote-helpers/dialog.ts

@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) 2021 OpenLens Authors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import { dialogShowOpenDialogHandler, requestMain } from "../../common/ipc";
+
+export async function showOpenDialog(options: Electron.OpenDialogOptions): Promise<Electron.OpenDialogReturnValue> {
+  return requestMain(dialogShowOpenDialogHandler, options);
+}

src/renderer/remote-helpers/index.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) 2021 OpenLens Authors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+import * as dialog from "./dialog";
+
+export { dialog };

src/renderer/utils/createStorage.ts

@@ -22,13 +22,12 @@
 // Keeps window.localStorage state in external JSON-files.
 // Because app creates random port between restarts => storage session wiped out each time.
 import path from "path";
-import { app, remote } from "electron";
 import { comparer, observable, reaction, toJS, when } from "mobx";
 import fse from "fs-extra";
 import { StorageHelper } from "./storageHelper";
 import { ClusterStore } from "../../common/cluster-store";
 import logger from "../../main/logger";
-import { getHostedClusterId } from "../../common/utils";
+import { getHostedClusterId, getPath } from "../../common/utils";
 
 const storage = observable({
   initialized: false,
@@ -47,7 +46,7 @@ export function createStorage<T>(key: string, defaultValue: T) {
 
 export function createAppStorage<T>(key: string, defaultValue: T, clusterId?: string | undefined) {
   const { logPrefix } = StorageHelper;
-  const folder = path.resolve((app || remote.app).getPath("userData"), "lens-local-storage");
+  const folder = path.resolve(getPath("userData"), "lens-local-storage");
   const fileName = `${clusterId ?? "app"}.json`;
   const filePath = path.resolve(folder, fileName);