From f297407156ad11e92ccfe08129b3601229797424 Mon Sep 17 00:00:00 2001 From: Sebastian Malton Date: Wed, 27 Oct 2021 21:07:41 -0400 Subject: [PATCH] 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 * Resolve PR comments Signed-off-by: Sebastian Malton * Fix test Signed-off-by: Sebastian Malton * Fix build Signed-off-by: Sebastian Malton * Ensure that init can only be called once and catch errors Signed-off-by: Sebastian Malton * Replace basically all uses of app.getPath() with AppPaths.get() Signed-off-by: Sebastian Malton * Fix unit tests Signed-off-by: Sebastian Malton --- __mocks__/electron.ts | 5 - integration/helpers/utils.ts | 4 +- src/common/__tests__/cluster-store.test.ts | 38 +++--- src/common/__tests__/hotbar-store.test.ts | 28 +++-- src/common/__tests__/user-store.test.ts | 27 ++-- src/common/app-paths.ts | 117 ++++++++++++++++++ src/common/base-store.ts | 4 +- src/common/logger.ts | 9 +- src/common/user-store/user-store.ts | 4 +- src/common/utils/cluster-id-url-parsing.ts | 5 + src/common/utils/index.ts | 8 +- src/common/utils/local-kubeconfig.ts | 4 +- src/common/utils/{getPath.ts => objects.ts} | 17 +-- .../__tests__/extension-discovery.test.ts | 12 ++ src/extensions/extension-loader.ts | 5 +- .../__tests__/page-registry.test.ts | 13 ++ src/main/__test__/context-handler.test.ts | 12 ++ src/main/__test__/kube-auth-proxy.test.ts | 48 ++++--- src/main/__test__/kubeconfig-manager.test.ts | 31 +++-- src/main/__test__/router.test.ts | 19 +++ .../__test__/kubeconfig-sync.test.ts | 15 ++- src/main/extension-filesystem.ts | 4 +- src/main/index.ts | 12 +- src/main/initializers/ipc.ts | 5 +- src/main/kubeconfig-manager.ts | 4 +- src/main/kubectl.ts | 4 +- .../protocol-handler/__test__/router.test.ts | 12 ++ src/migrations/cluster-store/3.6.0-beta.1.ts | 4 +- src/migrations/cluster-store/5.0.0-beta.10.ts | 4 +- src/migrations/cluster-store/5.0.0-beta.13.ts | 4 +- src/migrations/hotbar-store/5.0.0-beta.10.ts | 4 +- src/migrations/user-store/5.0.3-beta.1.ts | 7 +- .../user-store/file-name-migration.ts | 4 +- src/renderer/bootstrap.tsx | 19 +-- .../components/+catalog/catalog.test.tsx | 36 +++--- src/renderer/components/+catalog/catalog.tsx | 6 +- .../+extensions/__tests__/extensions.test.tsx | 31 +++-- .../components/+extensions/extensions.tsx | 4 +- .../__tests__/delete-cluster-dialog.test.tsx | 13 ++ .../dock/__test__/dock-tabs.test.tsx | 12 ++ .../__test__/log-resource-selector.test.tsx | 13 ++ .../dock/__test__/log-tab.store.test.ts | 13 ++ .../__tests__/hotbar-remove-command.test.tsx | 12 ++ src/renderer/utils/createStorage.ts | 62 ++++------ src/renderer/utils/storageHelper.ts | 7 ++ 45 files changed, 521 insertions(+), 200 deletions(-) create mode 100644 src/common/app-paths.ts rename src/common/utils/{getPath.ts => objects.ts} (74%) diff --git a/__mocks__/electron.ts b/__mocks__/electron.ts index 0a369eea4e..4c69a9bca0 100644 --- a/__mocks__/electron.ts +++ b/__mocks__/electron.ts @@ -26,11 +26,6 @@ export default { getLocale: jest.fn().mockRejectedValue("en"), getPath: jest.fn(() => "tmp"), }, - remote: { - app: { - getPath: jest.fn() - } - }, dialog: jest.fn(), ipcRenderer: { on: jest.fn() diff --git a/integration/helpers/utils.ts b/integration/helpers/utils.ts index 359332f0d4..a33b93a8f4 100644 --- a/integration/helpers/utils.ts +++ b/integration/helpers/utils.ts @@ -26,7 +26,7 @@ import * as uuid from "uuid"; import { ElectronApplication, Frame, Page, _electron as electron } from "playwright"; import { noop } from "lodash"; -export const AppPaths: Partial> = { +export const appPaths: Partial> = { "win32": "./dist/win-unpacked/OpenLens.exe", "linux": "./dist/linux-unpacked/open-lens", "darwin": "./dist/mac/OpenLens.app/Contents/MacOS/OpenLens", @@ -65,7 +65,7 @@ export async function start() { const app = await electron.launch({ args: ["--integration-testing"], // this argument turns off the blocking of quit - executablePath: AppPaths[process.platform], + executablePath: appPaths[process.platform], bypassCSP: true, env: { CICD, diff --git a/src/common/__tests__/cluster-store.test.ts b/src/common/__tests__/cluster-store.test.ts index 8bb920de73..33dd577635 100644 --- a/src/common/__tests__/cluster-store.test.ts +++ b/src/common/__tests__/cluster-store.test.ts @@ -30,6 +30,7 @@ import { Console } from "console"; import { stdout, stderr } from "process"; import type { ClusterId } from "../cluster-types"; import { getCustomKubeConfigPath } from "../utils"; +import { AppPaths } from "../app-paths"; console = new Console(stdout, stderr); @@ -67,23 +68,26 @@ function embed(clusterId: ClusterId, contents: any): string { return absPath; } -jest.mock("electron", () => { - return { - app: { - getVersion: () => "99.99.99", - getPath: () => "tmp", - getLocale: () => "en", - setLoginItemSettings: jest.fn(), - }, - ipcMain: { - handle: jest.fn(), - on: jest.fn(), - removeAllListeners: jest.fn(), - off: jest.fn(), - send: jest.fn(), - } - }; -}); +jest.mock("electron", () => ({ + app: { + getVersion: () => "99.99.99", + getName: () => "lens", + setName: jest.fn(), + setPath: jest.fn(), + getPath: () => "tmp", + getLocale: () => "en", + setLoginItemSettings: jest.fn(), + }, + ipcMain: { + handle: jest.fn(), + on: jest.fn(), + removeAllListeners: jest.fn(), + off: jest.fn(), + send: jest.fn(), + } +})); + +AppPaths.init(); describe("empty config", () => { beforeEach(async () => { diff --git a/src/common/__tests__/hotbar-store.test.ts b/src/common/__tests__/hotbar-store.test.ts index e029835006..a5632e06a0 100644 --- a/src/common/__tests__/hotbar-store.test.ts +++ b/src/common/__tests__/hotbar-store.test.ts @@ -22,6 +22,7 @@ import { anyObject } from "jest-mock-extended"; import mockFs from "mock-fs"; import logger from "../../main/logger"; +import { AppPaths } from "../app-paths"; import { ClusterStore } from "../cluster-store"; import { HotbarStore } from "../hotbar-store"; @@ -116,16 +117,23 @@ const awsCluster = { } }; -jest.mock("electron", () => { - return { - app: { - getVersion: () => "99.99.99", - getPath: () => "tmp", - getLocale: () => "en", - setLoginItemSettings: (): void => void 0, - } - }; -}); +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(); describe("HotbarStore", () => { beforeEach(() => { diff --git a/src/common/__tests__/user-store.test.ts b/src/common/__tests__/user-store.test.ts index ba31f06db6..adfe5ecf4b 100644 --- a/src/common/__tests__/user-store.test.ts +++ b/src/common/__tests__/user-store.test.ts @@ -21,16 +21,21 @@ import mockFs from "mock-fs"; -jest.mock("electron", () => { - return { - app: { - getVersion: () => "99.99.99", - getPath: () => "tmp", - getLocale: () => "en", - setLoginItemSettings: (): void => void 0, - } - }; -}); +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(), + }, +})); import { UserStore } from "../user-store"; import { Console } from "console"; @@ -39,8 +44,10 @@ import electron from "electron"; import { stdout, stderr } from "process"; import { ThemeStore } from "../../renderer/theme.store"; import type { ClusterStoreModel } from "../cluster-store"; +import { AppPaths } from "../app-paths"; console = new Console(stdout, stderr); +AppPaths.init(); describe("user store tests", () => { describe("for an empty config", () => { diff --git a/src/common/app-paths.ts b/src/common/app-paths.ts new file mode 100644 index 0000000000..883b7053a4 --- /dev/null +++ b/src/common/app-paths.ts @@ -0,0 +1,117 @@ +/** + * 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 { app, ipcMain, ipcRenderer } from "electron"; +import { observable, when } from "mobx"; +import path from "path"; +import logger from "./logger"; +import { fromEntries, toJS } from "./utils"; +import { isWindows } from "./vars"; + +export type PathName = Parameters[0]; + +const pathNames: PathName[] = [ + "home", + "appData", + "userData", + "cache", + "temp", + "exe", + "module", + "desktop", + "documents", + "downloads", + "music", + "pictures", + "videos", + "logs", + "crashDumps", +]; + +if (isWindows) { + pathNames.push("recent"); +} + +export class AppPaths { + private static paths = observable.box | undefined>(); + private static readonly ipcChannel = "get-app-paths"; + + /** + * Initializes the local copy of the paths from electron. + */ + static async init(): Promise { + logger.info(`[APP-PATHS]: initializing`); + + if (AppPaths.paths.get()) { + return void logger.error("[APP-PATHS]: init called more than once"); + } + + if (ipcMain) { + AppPaths.initMain(); + } else { + await AppPaths.initRenderer(); + } + } + + private static initMain(): void { + if (process.env.CICD) { + app.setPath("appData", process.env.CICD); + } + + app.setPath("userData", path.join(app.getPath("appData"), app.getName())); + + AppPaths.paths.set(fromEntries(pathNames.map(pathName => [pathName, app.getPath(pathName)]))); + ipcMain.handle(AppPaths.ipcChannel, () => toJS(AppPaths.paths.get())); + } + + private static async initRenderer(): Promise { + const paths = await ipcRenderer.invoke(AppPaths.ipcChannel); + + if (!paths || typeof paths !== "object") { + throw Object.assign(new Error("[APP-PATHS]: ipc handler returned unexpected data"), { data: paths }); + } + + AppPaths.paths.set(paths); + } + + /** + * An alternative to `app.getPath()` for use in renderer and common. + * This function throws if called before initialization. + * @param name The name of the path field + */ + static get(name: PathName): string { + if (!AppPaths.paths.get()) { + throw new Error("AppPaths.init() has not been called"); + } + + return AppPaths.paths.get()[name]; + } + + /** + * An async version of `AppPaths.get()` which waits for `AppPaths.init()` to + * be called before returning + */ + static async getAsync(name: PathName): Promise { + await when(() => Boolean(AppPaths.paths.get())); + + return AppPaths.paths.get()[name]; + } +} diff --git a/src/common/base-store.ts b/src/common/base-store.ts index c5fc7383b1..43911aff4d 100644 --- a/src/common/base-store.ts +++ b/src/common/base-store.ts @@ -30,7 +30,7 @@ import { broadcastMessage, ipcMainOn, ipcRendererOn } from "./ipc"; import isEqual from "lodash/isEqual"; import { isTestEnv } from "./vars"; import { kebabCase } from "lodash"; -import { getPath } from "./utils/getPath"; +import { AppPaths } from "./app-paths"; export interface BaseStoreParams extends ConfOptions { syncOptions?: IReactionOptions; @@ -93,7 +93,7 @@ export abstract class BaseStore extends Singleton { } protected cwd() { - return getPath("userData"); + return AppPaths.get("userData"); } protected async saveToFile(model: T) { diff --git a/src/common/logger.ts b/src/common/logger.ts index ca975871b8..3f71c095df 100644 --- a/src/common/logger.ts +++ b/src/common/logger.ts @@ -19,13 +19,12 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -import { ipcMain } from "electron"; +import { app, ipcMain } from "electron"; import winston, { format } from "winston"; import type Transport from "winston-transport"; import { consoleFormat } from "winston-console-format"; import { isDebugging, isTestEnv } from "./vars"; import BrowserConsole from "winston-transport-browserconsole"; -import { getPath } from "./utils/getPath"; const logLevel = process.env.LOG_LEVEL ? process.env.LOG_LEVEL @@ -66,7 +65,11 @@ if (ipcMain) { handleExceptions: false, level: logLevel, filename: "lens.log", - dirname: getPath("logs"), + /** + * SAFTEY: the `ipcMain` check above should mean that this is only + * called in the main process + */ + dirname: app.getPath("logs"), maxsize: 16 * 1024, maxFiles: 16, tailable: true, diff --git a/src/common/user-store/user-store.ts b/src/common/user-store/user-store.ts index f17ac9c5c6..40f230ccbd 100644 --- a/src/common/user-store/user-store.ts +++ b/src/common/user-store/user-store.ts @@ -33,7 +33,7 @@ import { ObservableToggleSet, toJS } from "../../renderer/utils"; import { DESCRIPTORS, KubeconfigSyncValue, UserPreferencesModel, EditorConfiguration } from "./preferences-helpers"; import logger from "../../main/logger"; import type { monaco } from "react-monaco-editor"; -import { getPath } from "../utils/getPath"; +import { AppPaths } from "../app-paths"; export interface UserStoreModel { lastSeenAppVersion: string; @@ -257,5 +257,5 @@ export class UserStore extends BaseStore /* implements UserStore * @returns string */ export function getDefaultKubectlDownloadPath(): string { - return path.join(getPath("userData"), "binaries"); + return path.join(AppPaths.get("userData"), "binaries"); } diff --git a/src/common/utils/cluster-id-url-parsing.ts b/src/common/utils/cluster-id-url-parsing.ts index e692bc4595..9a25dcaa9b 100644 --- a/src/common/utils/cluster-id-url-parsing.ts +++ b/src/common/utils/cluster-id-url-parsing.ts @@ -46,6 +46,11 @@ export function getClusterFrameUrl(clusterId: ClusterId) { * Get the result of `getClusterIdFromHost` from the current `location.host` */ export function getHostedClusterId(): ClusterId | undefined { + // catch being called in main + if (typeof location === "undefined") { + return undefined; + } + return getClusterIdFromHost(location.host); } diff --git a/src/common/utils/index.ts b/src/common/utils/index.ts index b39dcd0fae..2875877a16 100644 --- a/src/common/utils/index.ts +++ b/src/common/utils/index.ts @@ -32,19 +32,21 @@ export * from "./base64"; export * from "./camelCase"; export * from "./cloneJson"; export * from "./cluster-id-url-parsing"; +export * from "./convertCpu"; +export * from "./convertMemory"; export * from "./debouncePromise"; export * from "./defineGlobal"; export * from "./delay"; export * from "./disposer"; export * from "./downloadFile"; -export * from "./formatDuration"; export * from "./escapeRegExp"; export * from "./extended-map"; -export * from "./getPath"; +export * from "./formatDuration"; export * from "./getRandId"; export * from "./hash-set"; export * from "./local-kubeconfig"; export * from "./n-fircate"; +export * from "./objects"; export * from "./openExternal"; export * from "./paths"; export * from "./reject-promise"; @@ -56,8 +58,6 @@ export * from "./toggle-set"; export * from "./toJS"; export * from "./type-narrowing"; export * from "./types"; -export * from "./convertMemory"; -export * from "./convertCpu"; import * as iter from "./iter"; import * as array from "./array"; diff --git a/src/common/utils/local-kubeconfig.ts b/src/common/utils/local-kubeconfig.ts index 8af595e5ec..2b2d6e6241 100644 --- a/src/common/utils/local-kubeconfig.ts +++ b/src/common/utils/local-kubeconfig.ts @@ -21,11 +21,11 @@ import path from "path"; import * as uuid from "uuid"; +import { AppPaths } from "../app-paths"; import type { ClusterId } from "../cluster-types"; -import { getPath } from "./getPath"; export function storedKubeConfigFolder(): string { - return path.resolve(getPath("userData"), "kubeconfigs"); + return path.resolve(AppPaths.get("userData"), "kubeconfigs"); } export function getCustomKubeConfigPath(clusterId: ClusterId = uuid.v4()): string { diff --git a/src/common/utils/getPath.ts b/src/common/utils/objects.ts similarity index 74% rename from src/common/utils/getPath.ts rename to src/common/utils/objects.ts index 01df73975b..2c9ed80b67 100644 --- a/src/common/utils/getPath.ts +++ b/src/common/utils/objects.ts @@ -19,19 +19,10 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -import { app, ipcMain } from "electron"; - -const remote = ipcMain ? null : require("@electron/remote"); - /** - * calls getPath either on app or on the remote's app - * - * @deprecated Use a different method for accessing the getPath function + * A better typed version of `Object.fromEntries` where the keys are known to + * be a specific subset */ -export function getPath(name: Parameters[0]): string { - if (app) { - return app.getPath(name); - } - - return remote.app.getPath(name); +export function fromEntries(entries: Iterable): { [k in Key]: T } { + return Object.fromEntries(entries) as { [k in Key]: T }; } diff --git a/src/extensions/__tests__/extension-discovery.test.ts b/src/extensions/__tests__/extension-discovery.test.ts index 6db33acf19..6975d8a7f2 100644 --- a/src/extensions/__tests__/extension-discovery.test.ts +++ b/src/extensions/__tests__/extension-discovery.test.ts @@ -26,6 +26,7 @@ import path from "path"; import { ExtensionDiscovery } from "../extension-discovery"; import os from "os"; import { Console } from "console"; +import { AppPaths } from "../../common/app-paths"; jest.setTimeout(60_000); @@ -41,11 +42,22 @@ jest.mock("../extension-installer", () => ({ })); 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(); + console = new Console(process.stdout, process.stderr); // fix mockFS const mockedWatch = watch as jest.MockedFunction; diff --git a/src/extensions/extension-loader.ts b/src/extensions/extension-loader.ts index 2074de1183..b6ed1a5a47 100644 --- a/src/extensions/extension-loader.ts +++ b/src/extensions/extension-loader.ts @@ -24,9 +24,10 @@ import { EventEmitter } from "events"; import { isEqual } from "lodash"; import { action, computed, makeObservable, observable, observe, reaction, when } from "mobx"; import path from "path"; +import { AppPaths } from "../common/app-paths"; import { ClusterStore } from "../common/cluster-store"; import { broadcastMessage, ipcMainOn, ipcRendererOn, requestMain, ipcMainHandle } from "../common/ipc"; -import { Disposer, getHostedClusterId, Singleton, toJS, getPath } from "../common/utils"; +import { Disposer, getHostedClusterId, Singleton, toJS } from "../common/utils"; import logger from "../main/logger"; import type { InstalledExtension } from "./extension-discovery"; import { ExtensionsStore } from "./extensions-store"; @@ -36,7 +37,7 @@ import type { LensRendererExtension } from "./lens-renderer-extension"; import * as registries from "./registries"; export function extensionPackagesRoot() { - return path.join(getPath("userData")); + return path.join(AppPaths.get("userData")); } const logModule = "[EXTENSIONS-LOADER]"; diff --git a/src/extensions/registries/__tests__/page-registry.test.ts b/src/extensions/registries/__tests__/page-registry.test.ts index 5aa1b53a36..7be2fb851c 100644 --- a/src/extensions/registries/__tests__/page-registry.test.ts +++ b/src/extensions/registries/__tests__/page-registry.test.ts @@ -28,15 +28,28 @@ import { stdout, stderr } from "process"; import { ThemeStore } from "../../../renderer/theme.store"; import { TerminalStore } from "../../renderer-api/components"; import { UserStore } from "../../../common/user-store"; +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(); + console = new Console(stdout, stderr); let ext: LensExtension = null; diff --git a/src/main/__test__/context-handler.test.ts b/src/main/__test__/context-handler.test.ts index 0652ed5733..8c2c49ef44 100644 --- a/src/main/__test__/context-handler.test.ts +++ b/src/main/__test__/context-handler.test.ts @@ -23,12 +23,22 @@ import { UserStore } from "../../common/user-store"; import { ContextHandler } from "../context-handler"; import { PrometheusProvider, PrometheusProviderRegistry, PrometheusService } from "../prometheus"; 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(), + }, })); enum ServiceResult { @@ -76,6 +86,8 @@ function getHandler() { }) as any); } +AppPaths.init(); + describe("ContextHandler", () => { beforeEach(() => { mockFs({ diff --git a/src/main/__test__/kube-auth-proxy.test.ts b/src/main/__test__/kube-auth-proxy.test.ts index e0dd7f73c6..faeaba0668 100644 --- a/src/main/__test__/kube-auth-proxy.test.ts +++ b/src/main/__test__/kube-auth-proxy.test.ts @@ -19,15 +19,6 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -const logger = { - silly: jest.fn(), - debug: jest.fn(), - log: jest.fn(), - info: jest.fn(), - error: jest.fn(), - crit: jest.fn(), -}; - jest.mock("winston", () => ({ format: { colorize: jest.fn(), @@ -35,26 +26,27 @@ jest.mock("winston", () => ({ simple: jest.fn(), label: jest.fn(), timestamp: jest.fn(), - printf: jest.fn() + printf: jest.fn(), + padLevels: jest.fn(), + ms: jest.fn(), }, - createLogger: jest.fn().mockReturnValue(logger), + createLogger: jest.fn().mockReturnValue({ + silly: jest.fn(), + debug: jest.fn(), + log: jest.fn(), + info: jest.fn(), + error: jest.fn(), + crit: jest.fn(), + }), transports: { Console: jest.fn(), File: jest.fn(), } })); -jest.mock("electron", () => ({ - app: { - getPath: () => "tmp", - setLoginItemSettings: jest.fn(), - }, -})); - jest.mock("../../common/ipc"); jest.mock("child_process"); jest.mock("tcp-port-used"); -//jest.mock("../utils/get-port"); import { Cluster } from "../cluster"; import { KubeAuthProxy } from "../kube-auth-proxy"; @@ -68,6 +60,7 @@ import { UserStore } from "../../common/user-store"; import { Console } from "console"; import { stdout, stderr } from "process"; import mockFs from "mock-fs"; +import { AppPaths } from "../../common/app-paths"; console = new Console(stdout, stderr); @@ -75,6 +68,23 @@ const mockBroadcastIpc = broadcastMessage as jest.MockedFunction; const mockWaitUntilUsed = waitUntilUsed as jest.MockedFunction; +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(); + describe("kube auth proxy tests", () => { beforeEach(() => { jest.clearAllMocks(); diff --git a/src/main/__test__/kubeconfig-manager.test.ts b/src/main/__test__/kubeconfig-manager.test.ts index 0d0bab04ad..cfa0deeb51 100644 --- a/src/main/__test__/kubeconfig-manager.test.ts +++ b/src/main/__test__/kubeconfig-manager.test.ts @@ -28,12 +28,6 @@ const logger = { crit: jest.fn(), }; -jest.mock("electron", () => ({ - app: { - getPath: () => `/tmp`, - }, -})); - jest.mock("winston", () => ({ format: { colorize: jest.fn(), @@ -41,7 +35,9 @@ jest.mock("winston", () => ({ simple: jest.fn(), label: jest.fn(), timestamp: jest.fn(), - printf: jest.fn() + padLevels: jest.fn(), + ms: jest.fn(), + printf: jest.fn(), }, createLogger: jest.fn().mockReturnValue(logger), transports: { @@ -58,6 +54,25 @@ import fse from "fs-extra"; import { loadYaml } from "@kubernetes/client-node"; import { Console } from "console"; import * as path from "path"; +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(); console = new Console(process.stdout, process.stderr); // fix mockFS @@ -111,7 +126,7 @@ describe("kubeconfig manager tests", () => { const kubeConfManager = new KubeconfigManager(cluster, contextHandler); expect(logger.error).not.toBeCalled(); - expect(await kubeConfManager.getPath()).toBe(`${path.sep}tmp${path.sep}kubeconfig-foo`); + expect(await kubeConfManager.getPath()).toBe(`tmp${path.sep}kubeconfig-foo`); // this causes an intermittent "ENXIO: no such device or address, read" error // const file = await fse.readFile(await kubeConfManager.getPath()); const file = fse.readFileSync(await kubeConfManager.getPath()); diff --git a/src/main/__test__/router.test.ts b/src/main/__test__/router.test.ts index 61e23e0b04..102be317eb 100644 --- a/src/main/__test__/router.test.ts +++ b/src/main/__test__/router.test.ts @@ -19,8 +19,27 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +import { AppPaths } from "../../common/app-paths"; import { Router } from "../router"; +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(); + describe("Router", () => { it("blocks path traversal attacks", async () => { const response: any = { diff --git a/src/main/catalog-sources/__test__/kubeconfig-sync.test.ts b/src/main/catalog-sources/__test__/kubeconfig-sync.test.ts index ac0eb3b33b..2e49b09c16 100644 --- a/src/main/catalog-sources/__test__/kubeconfig-sync.test.ts +++ b/src/main/catalog-sources/__test__/kubeconfig-sync.test.ts @@ -28,13 +28,26 @@ import mockFs from "mock-fs"; import fs from "fs"; import { ClusterStore } from "../../../common/cluster-store"; import { ClusterManager } from "../../cluster-manager"; +import { AppPaths } from "../../../common/app-paths"; jest.mock("electron", () => ({ app: { - getPath: () => "/foo", + 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(); + describe("kubeconfig-sync.source tests", () => { beforeEach(() => { mockFs(); diff --git a/src/main/extension-filesystem.ts b/src/main/extension-filesystem.ts index d7c213e483..849165afa4 100644 --- a/src/main/extension-filesystem.ts +++ b/src/main/extension-filesystem.ts @@ -27,7 +27,7 @@ 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"; +import { AppPaths } from "../common/app-paths"; interface FSProvisionModel { extensions: Record; // extension names to paths @@ -55,7 +55,7 @@ export class FilesystemProvisionerStore extends BaseStore { if (!this.registeredExtensions.has(extensionName)) { const salt = randomBytes(32).toString("hex"); const hashedName = SHA256(`${extensionName}/${salt}`).toString(); - const dirPath = path.resolve(getPath("userData"), "extension_data", hashedName); + const dirPath = path.resolve(AppPaths.get("userData"), "extension_data", hashedName); this.registeredExtensions.set(extensionName, dirPath); } diff --git a/src/main/index.ts b/src/main/index.ts index 18bfa0980e..786a79a7b7 100644 --- a/src/main/index.ts +++ b/src/main/index.ts @@ -63,13 +63,12 @@ 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"; +import { AppPaths } from "../common/app-paths"; const onCloseCleanup = disposer(); const onQuitCleanup = disposer(); -const workingDir = path.join(app.getPath("appData"), appName); SentryInit(); app.setName(appName); @@ -82,12 +81,7 @@ if (app.setAsDefaultProtocolClient("lens")) { logger.info("📟 Protocol client register failed ❗"); } -if (process.env.CICD) { - app.setPath("appData", process.env.CICD); - app.setPath("userData", path.join(process.env.CICD, appName)); -} else { - app.setPath("userData", workingDir); -} +AppPaths.init(); if (process.env.LENS_DISABLE_GPU) { app.disableHardwareAcceleration(); @@ -127,7 +121,7 @@ app.on("second-instance", (event, argv) => { }); app.on("ready", async () => { - logger.info(`🚀 Starting ${productName} from "${app.getPath("exe")}"`); + logger.info(`🚀 Starting ${productName} from "${AppPaths.get("exe")}"`); logger.info("🐚 Syncing shell environment"); await shellSync(); diff --git a/src/main/initializers/ipc.ts b/src/main/initializers/ipc.ts index c16c3e1fe1..ff79bd091b 100644 --- a/src/main/initializers/ipc.ts +++ b/src/main/initializers/ipc.ts @@ -19,7 +19,7 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -import { app, BrowserWindow, dialog, 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, clusterSetDeletingHandler, clusterClearDeletingHandler } from "../../common/cluster-ipc"; @@ -34,6 +34,7 @@ import { ResourceApplier } from "../resource-applier"; import { WindowManager } from "../window-manager"; import path from "path"; import { remove } from "fs-extra"; +import { AppPaths } from "../../common/app-paths"; export function initIpcMainHandlers() { ipcMainHandle(clusterActivateHandler, (event, clusterId: ClusterId, force = false) => { @@ -99,7 +100,7 @@ export function initIpcMainHandlers() { try { // remove the local storage file - const localStorageFilePath = path.resolve(app.getPath("userData"), "lens-local-storage", `${cluster.id}.json`); + const localStorageFilePath = path.resolve(AppPaths.get("userData"), "lens-local-storage", `${cluster.id}.json`); await remove(localStorageFilePath); } catch {} diff --git a/src/main/kubeconfig-manager.ts b/src/main/kubeconfig-manager.ts index c9b101d59f..bd9b4a5ab0 100644 --- a/src/main/kubeconfig-manager.ts +++ b/src/main/kubeconfig-manager.ts @@ -22,15 +22,15 @@ import type { KubeConfig } from "@kubernetes/client-node"; import type { Cluster } from "./cluster"; import type { ContextHandler } from "./context-handler"; -import { app } from "electron"; import path from "path"; import fs from "fs-extra"; import { dumpConfigYaml } from "../common/kube-helpers"; import logger from "./logger"; import { LensProxy } from "./lens-proxy"; +import { AppPaths } from "../common/app-paths"; export class KubeconfigManager { - protected configDir = app.getPath("temp"); + protected configDir = AppPaths.get("temp"); protected tempFile: string = null; constructor(protected cluster: Cluster, protected contextHandler: ContextHandler) { } diff --git a/src/main/kubectl.ts b/src/main/kubectl.ts index 846133d828..c68e00b2dd 100644 --- a/src/main/kubectl.ts +++ b/src/main/kubectl.ts @@ -31,8 +31,8 @@ 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"; import { defaultPackageMirror, packageMirrors } from "../common/user-store/preferences-helpers"; +import { AppPaths } from "../common/app-paths"; const bundledVersion = getBundledKubectlVersion(); const kubectlMap: Map = new Map([ @@ -81,7 +81,7 @@ export class Kubectl { protected dirname: string; static get kubectlDir() { - return path.join(getPath("userData"), "binaries", "kubectl"); + return path.join(AppPaths.get("userData"), "binaries", "kubectl"); } public static readonly bundledKubectlVersion: string = bundledVersion; diff --git a/src/main/protocol-handler/__test__/router.test.ts b/src/main/protocol-handler/__test__/router.test.ts index 2045266ba3..d46036dbf9 100644 --- a/src/main/protocol-handler/__test__/router.test.ts +++ b/src/main/protocol-handler/__test__/router.test.ts @@ -29,16 +29,28 @@ import { ExtensionLoader } from "../../../extensions/extension-loader"; import { ExtensionsStore } from "../../../extensions/extensions-store"; import { LensProtocolRouterMain } from "../router"; import mockFs from "mock-fs"; +import { AppPaths } from "../../../common/app-paths"; jest.mock("../../../common/ipc"); 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(); + function throwIfDefined(val: any): void { if (val != null) { throw val; diff --git a/src/migrations/cluster-store/3.6.0-beta.1.ts b/src/migrations/cluster-store/3.6.0-beta.1.ts index 7ef4b042ec..00b2842983 100644 --- a/src/migrations/cluster-store/3.6.0-beta.1.ts +++ b/src/migrations/cluster-store/3.6.0-beta.1.ts @@ -23,12 +23,12 @@ // convert file path cluster icons to their base64 encoded versions import path from "path"; -import { app } from "electron"; import fse from "fs-extra"; import { loadConfigFromFileSync } from "../../common/kube-helpers"; import { MigrationDeclaration, migrationLog } from "../helpers"; import type { ClusterModel } from "../../common/cluster-types"; import { getCustomKubeConfigPath, storedKubeConfigFolder } from "../../common/utils"; +import { AppPaths } from "../../common/app-paths"; interface Pre360ClusterModel extends ClusterModel { kubeConfig: string; @@ -37,7 +37,7 @@ interface Pre360ClusterModel extends ClusterModel { export default { version: "3.6.0-beta.1", run(store) { - const userDataPath = app.getPath("userData"); + const userDataPath = AppPaths.get("userData"); const storedClusters: Pre360ClusterModel[] = store.get("clusters") ?? []; const migratedClusters: ClusterModel[] = []; diff --git a/src/migrations/cluster-store/5.0.0-beta.10.ts b/src/migrations/cluster-store/5.0.0-beta.10.ts index a26f0ed662..287f2ecd79 100644 --- a/src/migrations/cluster-store/5.0.0-beta.10.ts +++ b/src/migrations/cluster-store/5.0.0-beta.10.ts @@ -20,10 +20,10 @@ */ import path from "path"; -import { app } from "electron"; import fse from "fs-extra"; import type { ClusterModel } from "../../common/cluster-types"; import type { MigrationDeclaration } from "../helpers"; +import { AppPaths } from "../../common/app-paths"; interface Pre500WorkspaceStoreModel { workspaces: { @@ -35,7 +35,7 @@ interface Pre500WorkspaceStoreModel { export default { version: "5.0.0-beta.10", run(store) { - const userDataPath = app.getPath("userData"); + const userDataPath = AppPaths.get("userData"); try { const workspaceData: Pre500WorkspaceStoreModel = fse.readJsonSync(path.join(userDataPath, "lens-workspace-store.json")); diff --git a/src/migrations/cluster-store/5.0.0-beta.13.ts b/src/migrations/cluster-store/5.0.0-beta.13.ts index 6c8f37e366..b75b938a14 100644 --- a/src/migrations/cluster-store/5.0.0-beta.13.ts +++ b/src/migrations/cluster-store/5.0.0-beta.13.ts @@ -23,8 +23,8 @@ import type { ClusterModel, ClusterPreferences, ClusterPrometheusPreferences } f import { MigrationDeclaration, migrationLog } from "../helpers"; import { generateNewIdFor } from "../utils"; import path from "path"; -import { app } from "electron"; import { moveSync, removeSync } from "fs-extra"; +import { AppPaths } from "../../common/app-paths"; function mergePrometheusPreferences(left: ClusterPrometheusPreferences, right: ClusterPrometheusPreferences): ClusterPrometheusPreferences { if (left.prometheus && left.prometheusProvider) { @@ -106,7 +106,7 @@ function moveStorageFolder({ folder, newId, oldId }: { folder: string, newId: st export default { version: "5.0.0-beta.13", run(store) { - const folder = path.resolve(app.getPath("userData"), "lens-local-storage"); + const folder = path.resolve(AppPaths.get("userData"), "lens-local-storage"); const oldClusters: ClusterModel[] = store.get("clusters") ?? []; const clusters = new Map(); diff --git a/src/migrations/hotbar-store/5.0.0-beta.10.ts b/src/migrations/hotbar-store/5.0.0-beta.10.ts index a9a0de11b2..e5691d3622 100644 --- a/src/migrations/hotbar-store/5.0.0-beta.10.ts +++ b/src/migrations/hotbar-store/5.0.0-beta.10.ts @@ -19,11 +19,11 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -import { app } from "electron"; import fse from "fs-extra"; import { isNull } from "lodash"; import path from "path"; import * as uuid from "uuid"; +import { AppPaths } from "../../common/app-paths"; import type { ClusterStoreModel } from "../../common/cluster-store"; import { defaultHotbarCells, getEmptyHotbar, Hotbar, HotbarItem } from "../../common/hotbar-types"; import { catalogEntity } from "../../main/catalog-sources/general"; @@ -48,7 +48,7 @@ export default { run(store) { const rawHotbars = store.get("hotbars"); const hotbars: Hotbar[] = Array.isArray(rawHotbars) ? rawHotbars.filter(h => h && typeof h === "object") : []; - const userDataPath = app.getPath("userData"); + const userDataPath = AppPaths.get("userData"); // Hotbars might be empty, if some of the previous migrations weren't run if (hotbars.length === 0) { diff --git a/src/migrations/user-store/5.0.3-beta.1.ts b/src/migrations/user-store/5.0.3-beta.1.ts index 05a1767f08..ec5de34d66 100644 --- a/src/migrations/user-store/5.0.3-beta.1.ts +++ b/src/migrations/user-store/5.0.3-beta.1.ts @@ -19,7 +19,6 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -import { app } from "electron"; import { existsSync, readFileSync } from "fs"; import path from "path"; import os from "os"; @@ -27,14 +26,16 @@ import type { ClusterStoreModel } from "../../common/cluster-store"; import type { KubeconfigSyncEntry, UserPreferencesModel } from "../../common/user-store"; import { MigrationDeclaration, migrationLog } from "../helpers"; import { isLogicalChildPath, storedKubeConfigFolder } from "../../common/utils"; +import { AppPaths } from "../../common/app-paths"; export default { version: "5.0.3-beta.1", run(store) { try { const { syncKubeconfigEntries = [], ...preferences }: UserPreferencesModel = store.get("preferences") ?? {}; - const { clusters = [] }: ClusterStoreModel = JSON.parse(readFileSync(path.resolve(app.getPath("userData"), "lens-cluster-store.json"), "utf-8")) ?? {}; - const extensionDataDir = path.resolve(app.getPath("userData"), "extension_data"); + const userData = AppPaths.get("userData"); + const { clusters = [] }: ClusterStoreModel = JSON.parse(readFileSync(path.resolve(userData, "lens-cluster-store.json"), "utf-8")) ?? {}; + const extensionDataDir = path.resolve(userData, "extension_data"); const syncPaths = new Set(syncKubeconfigEntries.map(s => s.filePath)); syncPaths.add(path.join(os.homedir(), ".kube")); diff --git a/src/migrations/user-store/file-name-migration.ts b/src/migrations/user-store/file-name-migration.ts index 932e542642..80bff67302 100644 --- a/src/migrations/user-store/file-name-migration.ts +++ b/src/migrations/user-store/file-name-migration.ts @@ -19,12 +19,12 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -import { app } from "electron"; import fse from "fs-extra"; import path from "path"; +import { AppPaths } from "../../common/app-paths"; export function fileNameMigration() { - const userDataPath = app.getPath("userData"); + const userDataPath = AppPaths.get("userData"); const configJsonPath = path.join(userDataPath, "config.json"); const lensUserStoreJsonPath = path.join(userDataPath, "lens-user-store.json"); diff --git a/src/renderer/bootstrap.tsx b/src/renderer/bootstrap.tsx index d381f560e9..d80512561a 100644 --- a/src/renderer/bootstrap.tsx +++ b/src/renderer/bootstrap.tsx @@ -36,8 +36,6 @@ import { ClusterStore } from "../common/cluster-store"; import { UserStore } from "../common/user-store"; import { ExtensionDiscovery } from "../extensions/extension-discovery"; import { ExtensionLoader } from "../extensions/extension-loader"; -import { App } from "./components/app"; -import { LensApp } from "./lens-app"; import { HelmRepoManager } from "../main/helm/helm-repo-manager"; import { ExtensionInstallationStateStore } from "./components/+extensions/extension-install.store"; import { DefaultProps } from "./mui-base-theme"; @@ -51,6 +49,7 @@ import { ThemeStore } from "./theme.store"; import { SentryInit } from "../common/sentry"; import { TerminalStore } from "./components/dock/terminal.store"; import cloudsMidnight from "./monaco-themes/Clouds Midnight.json"; +import { AppPaths } from "../common/app-paths"; configurePackages(); @@ -69,7 +68,8 @@ type AppComponent = React.ComponentType & { init?(rootElem: HTMLElement): Promise; }; -export async function bootstrap(App: AppComponent) { +export async function bootstrap(comp: () => Promise) { + await AppPaths.init(); const rootElem = document.getElementById("app"); await attachChromeDebugger(); @@ -124,9 +124,10 @@ export async function bootstrap(App: AppComponent) { cs.registerIpcListener(); // init app's dependencies if any - if (App.init) { - await App.init(rootElem); - } + const App = await comp(); + + await App.init(rootElem); + render(<> {isMac &&
} {DefaultProps(App)} @@ -134,7 +135,11 @@ export async function bootstrap(App: AppComponent) { } // run -bootstrap(process.isMainFrame ? LensApp : App); +bootstrap( + async () => process.isMainFrame + ? (await import("./lens-app")).LensApp + : (await import("./components/app")).App +); /** diff --git a/src/renderer/components/+catalog/catalog.test.tsx b/src/renderer/components/+catalog/catalog.test.tsx index 3357a7e7f3..47395fb008 100644 --- a/src/renderer/components/+catalog/catalog.test.tsx +++ b/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: () =>
menu item
- }; -}); +jest.mock("./hotbar-toggle-menu-item", () => ({ + HotbarToggleMenuItem: () =>
menu item
+})); class MockCatalogEntity extends CatalogEntity { public apiVersion = "api"; diff --git a/src/renderer/components/+catalog/catalog.tsx b/src/renderer/components/+catalog/catalog.tsx index 06fdb5b21b..8b491ec765 100644 --- a/src/renderer/components/+catalog/catalog.tsx +++ b/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 { this.catalogEntityStore = props.catalogEntityStore; } static defaultProps = { - catalogEntityStore: new CatalogEntityStore(), + catalogEntityStore: new CatalogEntityStore(), }; get routeActiveTab(): string { diff --git a/src/renderer/components/+extensions/__tests__/extensions.test.tsx b/src/renderer/components/+extensions/__tests__/extensions.test.tsx index 85e88b9792..08dfb6dc47 100644 --- a/src/renderer/components/+extensions/__tests__/extensions.test.tsx +++ b/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("../../../../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({ diff --git a/src/renderer/components/+extensions/extensions.tsx b/src/renderer/components/+extensions/extensions.tsx index eb5bf4edec..46b7a26919 100644 --- a/src/renderer/components/+extensions/extensions.tsx +++ b/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", diff --git a/src/renderer/components/delete-cluster-dialog/__tests__/delete-cluster-dialog.test.tsx b/src/renderer/components/delete-cluster-dialog/__tests__/delete-cluster-dialog.test.tsx index 7d861a71c7..e175b0449d 100644 --- a/src/renderer/components/delete-cluster-dialog/__tests__/delete-cluster-dialog.test.tsx +++ b/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: diff --git a/src/renderer/components/dock/__test__/dock-tabs.test.tsx b/src/renderer/components/dock/__test__/dock-tabs.test.tsx index fea2b99013..d9858ae4b9 100644 --- a/src/renderer/components/dock/__test__/dock-tabs.test.tsx +++ b/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, }, diff --git a/src/renderer/components/dock/__test__/log-resource-selector.test.tsx b/src/renderer/components/dock/__test__/log-resource-selector.test.tsx index 9912815483..bff6c631e9 100644 --- a/src/renderer/components/dock/__test__/log-resource-selector.test.tsx +++ b/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 ( 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)); diff --git a/src/renderer/components/hotbar/__tests__/hotbar-remove-command.test.tsx b/src/renderer/components/hotbar/__tests__/hotbar-remove-command.test.tsx index 119212753d..2880aa12d6 100644 --- a/src/renderer/components/hotbar/__tests__/hotbar-remove-command.test.tsx +++ b/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", diff --git a/src/renderer/utils/createStorage.ts b/src/renderer/utils/createStorage.ts index e2ff3dc314..c717784ecf 100755 --- a/src/renderer/utils/createStorage.ts +++ b/src/renderer/utils/createStorage.ts @@ -26,7 +26,6 @@ import { comparer, observable, reaction, toJS, when } from "mobx"; import fse from "fs-extra"; import { StorageHelper } from "./storageHelper"; import logger from "../../main/logger"; -import { getHostedClusterId, getPath } from "../../common/utils"; import { isTestEnv } from "../../common/vars"; const storage = observable({ @@ -37,55 +36,48 @@ const storage = observable({ /** * Creates a helper for saving data under the "key" intended for window.localStorage - * @param key - * @param defaultValue + * @param key The descriptor of the data + * @param defaultValue The default value of the data, must be JSON serializable */ export function createStorage(key: string, defaultValue: T) { - return createAppStorage(key, defaultValue, getHostedClusterId()); -} - -export function createAppStorage(key: string, defaultValue: T, clusterId?: string | undefined) { const { logPrefix } = StorageHelper; - const folder = path.resolve(getPath("userData"), "lens-local-storage"); - const fileName = `${clusterId ?? "app"}.json`; - const filePath = path.resolve(folder, fileName); if (!storage.initialized) { - init(); // called once per cluster-view - } - - function init() { storage.initialized = true; - // read previously saved state (if any) - fse.readJson(filePath) - .then(data => storage.data = data) - .catch(() => null) // ignore empty / non-existing / invalid json files - .finally(() => { + (async () => { + const filePath = await StorageHelper.getLocalStoragePath(); + + try { + storage.data = await fse.readJson(filePath); + } catch {} finally { if (!isTestEnv) { logger.info(`${logPrefix} loading finished for ${filePath}`); } + storage.loaded = true; + } + + // bind auto-saving data changes to %storage-file.json + reaction(() => toJS(storage.data), saveFile, { + delay: 250, // lazy, avoid excessive writes to fs + equals: comparer.structural, // save only when something really changed }); - // bind auto-saving data changes to %storage-file.json - reaction(() => toJS(storage.data), saveFile, { - delay: 250, // lazy, avoid excessive writes to fs - equals: comparer.structural, // save only when something really changed - }); + async function saveFile(state: Record = {}) { + logger.info(`${logPrefix} saving ${filePath}`); - async function saveFile(state: Record = {}) { - logger.info(`${logPrefix} saving ${filePath}`); - - try { - await fse.ensureDir(folder, { mode: 0o755 }); - await fse.writeJson(filePath, state, { spaces: 2 }); - } catch (error) { - logger.error(`${logPrefix} saving failed: ${error}`, { - json: state, jsonFilePath: filePath - }); + try { + await fse.ensureDir(path.dirname(filePath), { mode: 0o755 }); + await fse.writeJson(filePath, state, { spaces: 2 }); + } catch (error) { + logger.error(`${logPrefix} saving failed: ${error}`, { + json: state, jsonFilePath: filePath + }); + } } - } + })() + .catch(error => logger.error(`${logPrefix} Failed to initialize storage: ${error}`)); } return new StorageHelper(key, { diff --git a/src/renderer/utils/storageHelper.ts b/src/renderer/utils/storageHelper.ts index 8ff99c5b84..cb3d6a9fed 100755 --- a/src/renderer/utils/storageHelper.ts +++ b/src/renderer/utils/storageHelper.ts @@ -24,6 +24,9 @@ import { action, comparer, makeObservable, observable, toJS, when, } from "mobx" import produce, { Draft, isDraft } from "immer"; import { isEqual, isPlainObject } from "lodash"; import logger from "../../main/logger"; +import { getHostedClusterId } from "../../common/utils"; +import path from "path"; +import { AppPaths } from "../../common/app-paths"; export interface StorageAdapter { [metadata: string]: any; @@ -40,6 +43,10 @@ export interface StorageHelperOptions { } export class StorageHelper { + static async getLocalStoragePath() { + return path.resolve(await AppPaths.getAsync("userData"), "lens-local-storage", `${getHostedClusterId() || "app"}.json`); + } + static logPrefix = "[StorageHelper]:"; readonly storage: StorageAdapter;