Stop using @electron/remote to obtain app.getPath() (#4078)

* Stop using remote to obtain app.getPath()

- Initialize entire map in bootstrap()

- Updated unit tests

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

* Resolve PR comments

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

* Fix test

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

* Fix build

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

* Ensure that init can only be called once and catch errors

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

* Replace basically all uses of app.getPath() with AppPaths.get()

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

* Fix unit tests

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

src/renderer/components/+catalog/catalog.test.tsx

@@ -31,26 +31,30 @@ import { CatalogEntityRegistry } from "../../../renderer/api/catalog-entity-regi
 import { CatalogEntityDetailRegistry } from "../../../extensions/registries";
 import { CatalogEntityItem } from "./catalog-entity-item";
 import { CatalogEntityStore } from "./catalog-entity.store";
+import { AppPaths } from "../../../common/app-paths";
 
 mockWindow();
+jest.mock("electron", () => ({
+  app: {
+    getVersion: () => "99.99.99",
+    getName: () => "lens",
+    setName: jest.fn(),
+    setPath: jest.fn(),
+    getPath: () => "tmp",
+    getLocale: () => "en",
+    setLoginItemSettings: jest.fn(),
+  },
+  ipcMain: {
+    on: jest.fn(),
+    handle: jest.fn(),
+  },
+}));
 
-// avoid TypeError: Cannot read property 'getPath' of undefined
-jest.mock("@electron/remote", () => {
-  return {
-    app: {
-      getPath: () => {
-        // avoid TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received undefined
-        return "";
-      },
-    },
-  };
-});
+AppPaths.init();
 
-jest.mock("./hotbar-toggle-menu-item", () => {
-  return {
-    HotbarToggleMenuItem: () => <div>menu item</div>
-  };
-});
+jest.mock("./hotbar-toggle-menu-item", () => ({
+  HotbarToggleMenuItem: () => <div>menu item</div>
+}));
 
 class MockCatalogEntity extends CatalogEntity {
   public apiVersion = "api";

src/renderer/components/+catalog/catalog.tsx

@@ -37,7 +37,7 @@ import { CatalogAddButton } from "./catalog-add-button";
 import type { RouteComponentProps } from "react-router";
 import { Notifications } from "../notifications";
 import { MainLayout } from "../layout/main-layout";
-import { createAppStorage, cssNames, prevDefault } from "../../utils";
+import { createStorage, cssNames, prevDefault } from "../../utils";
 import { makeCss } from "../../../common/utils/makeCss";
 import { CatalogEntityDetails } from "./catalog-entity-details";
 import { browseCatalogTab, catalogURL, CatalogViewRouteParam } from "../../../common/routes";
@@ -47,7 +47,7 @@ import { RenderDelay } from "../render-delay/render-delay";
 import { Icon } from "../icon";
 import { HotbarToggleMenuItem } from "./hotbar-toggle-menu-item";
 
-export const previousActiveTab = createAppStorage("catalog-previous-active-tab", browseCatalogTab);
+export const previousActiveTab = createStorage("catalog-previous-active-tab", browseCatalogTab);
 
 enum sortBy {
   name = "name",
@@ -74,7 +74,7 @@ export class Catalog extends React.Component<Props> {
     this.catalogEntityStore = props.catalogEntityStore;
   }
   static defaultProps = {
-    catalogEntityStore: new CatalogEntityStore(),       
+    catalogEntityStore: new CatalogEntityStore(),
   };
 
   get routeActiveTab(): string {

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

@@ -31,6 +31,7 @@ import { ExtensionInstallationStateStore } from "../extension-install.store";
 import { Extensions } from "../extensions";
 import mockFs from "mock-fs";
 import { mockWindow } from "../../../../../__mocks__/windowMock";
+import { AppPaths } from "../../../../common/app-paths";
 
 mockWindow();
 
@@ -38,23 +39,39 @@ jest.setTimeout(30000);
 jest.mock("fs-extra");
 jest.mock("../../notifications");
 
-jest.mock("../../../../common/utils", () => ({
-  ...jest.requireActual<any>("../../../../common/utils"),
-  downloadFile: jest.fn(() => ({
-    promise: Promise.resolve()
+jest.mock("../../../../common/utils/downloadFile", () => ({
+  downloadFile: jest.fn(({ url }) => ({
+    promise: Promise.resolve(),
+    url,
+    cancel: () => {},
+  })),
+  downloadJson: jest.fn(({ url }) => ({
+    promise: Promise.resolve({}),
+    url,
+    cancel: () => { },
   })),
-  extractTar: jest.fn(() => Promise.resolve())
 }));
 
+jest.mock("../../../../common/utils/tar");
+
 jest.mock("electron", () => ({
   app: {
     getVersion: () => "99.99.99",
+    getName: () => "lens",
+    setName: jest.fn(),
+    setPath: jest.fn(),
     getPath: () => "tmp",
     getLocale: () => "en",
-    setLoginItemSettings: (): void => void 0,
-  }
+    setLoginItemSettings: jest.fn(),
+  },
+  ipcMain: {
+    on: jest.fn(),
+    handle: jest.fn(),
+  },
 }));
 
+AppPaths.init();
+
 describe("Extensions", () => {
   beforeEach(async () => {
     mockFs({

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

@@ -47,7 +47,7 @@ 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";
+import { AppPaths } from "../../../common/app-paths";
 
 function getMessageFromError(error: any): string {
   if (!error || typeof error !== "object") {
@@ -469,7 +469,7 @@ const supportedFormats = ["tar", "tgz"];
 
 async function installFromSelectFileDialog() {
   const { canceled, filePaths } = await dialog.showOpenDialog({
-    defaultPath: getPath("downloads"),
+    defaultPath: AppPaths.get("downloads"),
     properties: ["openFile", "multiSelections"],
     message: `Select extensions to install (formats: ${supportedFormats.join(", ")}), `,
     buttonLabel: "Use configuration",

src/renderer/components/delete-cluster-dialog/__tests__/delete-cluster-dialog.test.tsx

@@ -27,13 +27,26 @@ import selectEvent from "react-select-event";
 
 import { Cluster } from "../../../../main/cluster";
 import { DeleteClusterDialog } from "../delete-cluster-dialog";
+import { AppPaths } from "../../../../common/app-paths";
 
 jest.mock("electron", () => ({
   app: {
+    getVersion: () => "99.99.99",
+    getName: () => "lens",
+    setName: jest.fn(),
+    setPath: jest.fn(),
     getPath: () => "tmp",
+    getLocale: () => "en",
+    setLoginItemSettings: jest.fn(),
+  },
+  ipcMain: {
+    on: jest.fn(),
+    handle: jest.fn(),
   },
 }));
 
+AppPaths.init();
+
 const kubeconfig = `
 apiVersion: v1
 clusters:

src/renderer/components/dock/__test__/dock-tabs.test.tsx

@@ -30,6 +30,7 @@ import { noop } from "../../../utils";
 import { ThemeStore } from "../../../theme.store";
 import { TerminalStore } from "../terminal.store";
 import { UserStore } from "../../../../common/user-store";
+import { AppPaths } from "../../../../common/app-paths";
 
 jest.mock("react-monaco-editor", () => ({
   monaco: {
@@ -41,9 +42,20 @@ jest.mock("react-monaco-editor", () => ({
 
 jest.mock("electron", () => ({
   app: {
+    getVersion: () => "99.99.99",
+    getName: () => "lens",
+    setName: jest.fn(),
+    setPath: jest.fn(),
     getPath: () => "tmp",
+    getLocale: () => "en",
+    setLoginItemSettings: jest.fn(),
+  },
+  ipcMain: {
+    on: jest.fn(),
+    handle: jest.fn(),
   },
 }));
+AppPaths.init();
 
 const initialTabs: DockTab[] = [
   { id: "terminal", kind: TabKind.TERMINAL, title: "Terminal", pinned: false, },

src/renderer/components/dock/__test__/log-resource-selector.test.tsx

@@ -31,15 +31,28 @@ import { dockerPod, deploymentPod1 } from "./pod.mock";
 import { ThemeStore } from "../../../theme.store";
 import { UserStore } from "../../../../common/user-store";
 import mockFs from "mock-fs";
+import { AppPaths } from "../../../../common/app-paths";
 
 jest.mock("react-monaco-editor", () => null);
 
 jest.mock("electron", () => ({
   app: {
+    getVersion: () => "99.99.99",
+    getName: () => "lens",
+    setName: jest.fn(),
+    setPath: jest.fn(),
     getPath: () => "tmp",
+    getLocale: () => "en",
+    setLoginItemSettings: jest.fn(),
+  },
+  ipcMain: {
+    on: jest.fn(),
+    handle: jest.fn(),
   },
 }));
 
+AppPaths.init();
+
 const getComponent = (tabData: LogTabData) => {
   return (
     <LogResourceSelector

src/renderer/components/dock/__test__/log-tab.store.test.ts

@@ -28,6 +28,7 @@ import { logTabStore } from "../log-tab.store";
 import { deploymentPod1, deploymentPod2, deploymentPod3, dockerPod } from "./pod.mock";
 import fse from "fs-extra";
 import { mockWindow } from "../../../../../__mocks__/windowMock";
+import { AppPaths } from "../../../../common/app-paths";
 
 mockWindow();
 
@@ -35,10 +36,22 @@ jest.mock("react-monaco-editor", () => null);
 
 jest.mock("electron", () => ({
   app: {
+    getVersion: () => "99.99.99",
+    getName: () => "lens",
+    setName: jest.fn(),
+    setPath: jest.fn(),
     getPath: () => "tmp",
+    getLocale: () => "en",
+    setLoginItemSettings: jest.fn(),
+  },
+  ipcMain: {
+    on: jest.fn(),
+    handle: jest.fn(),
   },
 }));
 
+AppPaths.init();
+
 podsStore.items.push(new Pod(dockerPod));
 podsStore.items.push(new Pod(deploymentPod1));
 podsStore.items.push(new Pod(deploymentPod2));

src/renderer/components/hotbar/__tests__/hotbar-remove-command.test.tsx

@@ -27,14 +27,26 @@ import { ThemeStore } from "../../../theme.store";
 import { UserStore } from "../../../../common/user-store";
 import { Notifications } from "../../notifications";
 import mockFs from "mock-fs";
+import { AppPaths } from "../../../../common/app-paths";
 
 jest.mock("electron", () => ({
   app: {
+    getVersion: () => "99.99.99",
+    getName: () => "lens",
+    setName: jest.fn(),
+    setPath: jest.fn(),
     getPath: () => "tmp",
+    getLocale: () => "en",
     setLoginItemSettings: jest.fn(),
   },
+  ipcMain: {
+    on: jest.fn(),
+    handle: jest.fn(),
+  },
 }));
 
+AppPaths.init();
+
 const mockHotbars: {[id: string]: any} = {
   "1": {
     id: "1",