diff --git a/extensions/metrics-cluster-feature/renderer.tsx b/extensions/metrics-cluster-feature/renderer.tsx index 9192b10364..b1afd1e570 100644 --- a/extensions/metrics-cluster-feature/renderer.tsx +++ b/extensions/metrics-cluster-feature/renderer.tsx @@ -10,9 +10,9 @@ export default class ClusterMetricsFeatureExtension extends LensRendererExtensio Description: () => { return ( - Enable timeseries data visualization (Prometheus stack) for your cluster. - Install this only if you don't have existing Prometheus stack installed. - You can see preview of manifests here. + Enable timeseries data visualization (Prometheus stack) for your cluster. + Install this only if you don't have existing Prometheus stack installed. + You can see preview of manifests here. ); } diff --git a/integration/__tests__/app.tests.ts b/integration/__tests__/app.tests.ts index 35891ee5fb..c8c7af7c8b 100644 --- a/integration/__tests__/app.tests.ts +++ b/integration/__tests__/app.tests.ts @@ -16,8 +16,8 @@ jest.setTimeout(60000); // FIXME (!): improve / simplify all css-selectors + use [data-test-id="some-id"] (already used in some tests below) describe("Lens integration tests", () => { const TEST_NAMESPACE = "integration-tests"; - const BACKSPACE = "\uE003"; + let app: Application; const appStart = async () => { @@ -37,23 +37,33 @@ describe("Lens integration tests", () => { const minikubeReady = (): boolean => { // determine if minikube is running - let status = spawnSync("minikube status", { shell: true }); - if (status.status !== 0) { - console.warn("minikube not running"); - return false; + { + const { status } = spawnSync("minikube status", { shell: true }); + if (status !== 0) { + console.warn("minikube not running"); + return false; + } } // Remove TEST_NAMESPACE if it already exists - status = spawnSync(`minikube kubectl -- get namespace ${TEST_NAMESPACE}`, { shell: true }); - if (status.status === 0) { - console.warn(`Removing existing ${TEST_NAMESPACE} namespace`); - status = spawnSync(`minikube kubectl -- delete namespace ${TEST_NAMESPACE}`, { shell: true }); - if (status.status !== 0) { - console.warn(`Error removing ${TEST_NAMESPACE} namespace: ${status.stderr.toString()}`); - return false; + { + const { status } = spawnSync(`minikube kubectl -- get namespace ${TEST_NAMESPACE}`, { shell: true }); + if (status === 0) { + console.warn(`Removing existing ${TEST_NAMESPACE} namespace`); + + const { status, stdout, stderr } = spawnSync( + `minikube kubectl -- delete namespace ${TEST_NAMESPACE}`, + { shell: true }, + ); + if (status !== 0) { + console.warn(`Error removing ${TEST_NAMESPACE} namespace: ${stderr.toString()}`); + return false; + } + + console.log(stdout.toString()); } - console.log(status.stdout.toString()); } + return true; }; const ready = minikubeReady(); @@ -62,8 +72,8 @@ describe("Lens integration tests", () => { beforeAll(appStart, 20000); afterAll(async () => { - if (app && app.isRunning()) { - return util.tearDown(app); + if (app?.isRunning()) { + await util.tearDown(app); } }); diff --git a/integration/helpers/utils.ts b/integration/helpers/utils.ts index 32b7bece35..9df2d9ed66 100644 --- a/integration/helpers/utils.ts +++ b/integration/helpers/utils.ts @@ -8,9 +8,8 @@ const AppPaths: Partial> = { export function setup(): Application { return new Application({ - // path to electron app + path: AppPaths[process.platform], // path to electron app args: [], - path: AppPaths[process.platform], startTimeout: 30000, waitTimeout: 60000, env: { @@ -19,9 +18,10 @@ export function setup(): Application { }); } +type AsyncPidGetter = () => Promise; + export async function tearDown(app: Application) { - const mpid: any = app.mainProcess.pid; - const pid = await mpid(); + const pid = await (app.mainProcess.pid as any as AsyncPidGetter)(); await app.stop(); try { process.kill(pid, "SIGKILL"); diff --git a/src/common/vars.ts b/src/common/vars.ts index 1957a6dcff..ab566bb675 100644 --- a/src/common/vars.ts +++ b/src/common/vars.ts @@ -6,8 +6,8 @@ import { defineGlobal } from "./utils/defineGlobal"; export const isMac = process.platform === "darwin"; export const isWindows = process.platform === "win32"; export const isLinux = process.platform === "linux"; -export const isDebugging = process.env.DEBUG === "true"; -export const isSnap = !!process.env["SNAP"]; +export const isDebugging = ["true", "1", "yes", "y", "on"].includes((process.env.DEBUG ?? "").toLowerCase()); +export const isSnap = !!process.env.SNAP; export const isProduction = process.env.NODE_ENV === "production"; export const isTestEnv = !!process.env.JEST_WORKER_ID; export const isDevelopment = !isTestEnv && !isProduction; diff --git a/src/extensions/extension-loader.ts b/src/extensions/extension-loader.ts index 18840da5fc..af0e9d6f86 100644 --- a/src/extensions/extension-loader.ts +++ b/src/extensions/extension-loader.ts @@ -131,21 +131,25 @@ export class ExtensionLoader { protected autoInitExtensions(register: (ext: LensExtension) => Promise) { return reaction(() => this.toJSON(), installedExtensions => { for (const [extId, ext] of installedExtensions) { - let instance = this.instances.get(extId); - if (ext.isEnabled && !instance) { + const alreadyInit = this.instances.has(extId); + + if (ext.isEnabled && !alreadyInit) { try { - const LensExtensionClass: LensExtensionConstructor = this.requireExtension(ext); - if (!LensExtensionClass) continue; - instance = new LensExtensionClass(ext); + const LensExtensionClass = this.requireExtension(ext); + if (!LensExtensionClass) { + continue; + } + + const instance = new LensExtensionClass(ext); instance.whenEnabled(() => register(instance)); instance.enable(); this.instances.set(extId, instance); } catch (err) { logger.error(`${logModule}: activation extension error`, { ext, err }); } - } else if (!ext.isEnabled && instance) { - logger.info(`${logModule} deleting extension ${extId}`); + } else if (!ext.isEnabled && alreadyInit) { try { + const instance = this.instances.get(extId); instance.disable(); this.instances.delete(extId); } catch (err) { @@ -158,7 +162,7 @@ export class ExtensionLoader { }); } - protected requireExtension(extension: InstalledExtension) { + protected requireExtension(extension: InstalledExtension): LensExtensionConstructor { let extEntrypoint = ""; try { if (ipcRenderer && extension.manifest.renderer) { diff --git a/src/extensions/lens-extension.ts b/src/extensions/lens-extension.ts index 0dd6980102..1af3300ff0 100644 --- a/src/extensions/lens-extension.ts +++ b/src/extensions/lens-extension.ts @@ -1,5 +1,6 @@ import type { InstalledExtension } from "./extension-discovery"; import { action, observable, reaction } from "mobx"; +import { filesystemProvisionerStore } from "../main/extension-filesystem"; import logger from "../main/logger"; export type LensExtensionId = string; // path to manifest (package.json) @@ -39,6 +40,17 @@ export class LensExtension { return this.manifest.version; } + /** + * getExtensionFileFolder returns the path to an already created folder. This + * folder is for the sole use of this extension. + * + * Note: there is no security done on this folder, only obfiscation of the + * folder name. + */ + async getExtensionFileFolder(): Promise { + return filesystemProvisionerStore.requestDirectory(this.id); + } + get description() { return this.manifest.description; } diff --git a/src/main/extension-filesystem.ts b/src/main/extension-filesystem.ts new file mode 100644 index 0000000000..fb3a4060be --- /dev/null +++ b/src/main/extension-filesystem.ts @@ -0,0 +1,57 @@ +import { randomBytes } from "crypto"; +import { SHA256 } from "crypto-js"; +import { app } from "electron"; +import fse from "fs-extra"; +import { action, observable, toJS } from "mobx"; +import path from "path"; +import { BaseStore } from "../common/base-store"; +import { LensExtensionId } from "../extensions/lens-extension"; + +interface FSProvisionModel { + extensions: Record; // extension names to paths +} + +export class FilesystemProvisionerStore extends BaseStore { + @observable registeredExtensions = observable.map(); + + private constructor() { + super({ + configName: "lens-filesystem-provisioner-store", + accessPropertiesByDotNotation: false, // To make dots safe in cluster context names + }); + } + + /** + * This function retrieves the saved path to the folder which the extension + * can saves files to. If the folder is not present then it is created. + * @param extensionName the name of the extension requesting the path + * @returns path to the folder that the extension can safely write files to. + */ + async requestDirectory(extensionName: string): Promise { + if (!this.registeredExtensions.has(extensionName)) { + const salt = randomBytes(32).toString("hex"); + const hashedName = SHA256(`${extensionName}/${salt}`).toString(); + const dirPath = path.resolve(app.getPath("userData"), "extension_data", hashedName); + this.registeredExtensions.set(extensionName, dirPath); + } + + const dirPath = this.registeredExtensions.get(extensionName); + await fse.ensureDir(dirPath); + return dirPath; + } + + @action + protected fromStore({ extensions }: FSProvisionModel = { extensions: {} }): void { + this.registeredExtensions.merge(extensions); + } + + toJSON(): FSProvisionModel { + return toJS({ + extensions: this.registeredExtensions.toJSON(), + }, { + recurseEverything: true + }); + } +} + +export const filesystemProvisionerStore = FilesystemProvisionerStore.getInstance(); diff --git a/src/main/index.ts b/src/main/index.ts index d0e3740058..1d6aadfd43 100644 --- a/src/main/index.ts +++ b/src/main/index.ts @@ -25,6 +25,7 @@ import { extensionsStore } from "../extensions/extensions-store"; import { InstalledExtension, extensionDiscovery } from "../extensions/extension-discovery"; import type { LensExtensionId } from "../extensions/lens-extension"; import { installDeveloperTools } from "./developer-tools"; +import { filesystemProvisionerStore } from "./extension-filesystem"; const workingDir = path.join(app.getPath("appData"), appName); let proxyPort: number; @@ -59,6 +60,7 @@ app.on("ready", async () => { clusterStore.load(), workspaceStore.load(), extensionsStore.load(), + filesystemProvisionerStore.load(), ]); // find free port diff --git a/src/renderer/bootstrap.tsx b/src/renderer/bootstrap.tsx index 7aa78f1682..ef22e72736 100644 --- a/src/renderer/bootstrap.tsx +++ b/src/renderer/bootstrap.tsx @@ -15,6 +15,7 @@ import { i18nStore } from "./i18n"; import { themeStore } from "./theme.store"; import { extensionsStore } from "../extensions/extensions-store"; import { extensionLoader } from "../extensions/extension-loader"; +import { filesystemProvisionerStore } from "../main/extension-filesystem"; type AppComponent = React.ComponentType & { init?(): Promise; @@ -39,6 +40,7 @@ export async function bootstrap(App: AppComponent) { workspaceStore.load(), clusterStore.load(), extensionsStore.load(), + filesystemProvisionerStore.load(), i18nStore.init(), themeStore.init(), ]);