Release 6.4.0 (#7250)

* General fixes for release-tool (#7238)

* General fixes for release-tool

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

* Revert change to number of PRs retrieved

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

---------

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

* Throw on errors in kubectlApplyFolder (#7239)

Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>

* Quick fix for store migration version being wrong (#7243)

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

* Revert "Renderer file logging transport (#6795)" (#7245)

Renderer file logging still caused UI freezing (at least on apple silicon macs) when cluster frame was open and main frame was reloaded.

See #544

This reverts commit ac2d0e46ff.

Signed-off-by: Sami Tiilikainen <97873007+samitiilikainen@users.noreply.github.com>

* Fix extension install (#7247)

* Fix extension install

- Remove old bundled extension dependencies
- Make sure external extensions are installed as optional

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

* Ignore ENOENT errors

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

* Add comment

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

---------

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

* Release 6.4.0

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

* Fix lint

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

---------

Signed-off-by: Sebastian Malton <sebastian@malton.name>
Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>
Signed-off-by: Sami Tiilikainen <97873007+samitiilikainen@users.noreply.github.com>
Co-authored-by: Panu Horsmalahti <phorsmalahti@mirantis.com>
Co-authored-by: Sami Tiilikainen <97873007+samitiilikainen@users.noreply.github.com>

packages/core/src/common/__tests__/create-resource-stack.test.ts

@@ -0,0 +1,61 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type { DiContainer } from "@ogre-tools/injectable";
+import kubectlApplyAllInjectable from "../../main/kubectl/kubectl-apply-all.injectable";
+import { getDiForUnitTesting } from "../../main/getDiForUnitTesting";
+import type { KubernetesCluster } from "../catalog-entities";
+import readDirectoryInjectable from "../fs/read-directory.injectable";
+import readFileInjectable from "../fs/read-file.injectable";
+import createResourceStackInjectable from "../k8s/create-resource-stack.injectable";
+import appPathsStateInjectable from "../app-paths/app-paths-state.injectable";
+import directoryForUserDataInjectable from "../app-paths/directory-for-user-data/directory-for-user-data.injectable";
+
+describe("create resource stack tests", () => {
+  let di: DiContainer;
+  let cluster: KubernetesCluster;
+
+  beforeEach(async () => {
+    di = getDiForUnitTesting({ doGeneralOverrides: true });
+    cluster = {
+      getId: () => "test-cluster",
+    } as any;
+
+    di.override(readDirectoryInjectable, () => () => Promise.resolve(["file1"]) as any);
+    di.override(readFileInjectable, () => () => Promise.resolve("filecontents"));
+    di.override(appPathsStateInjectable, () => ({
+      get: () => ({}),
+    }));
+    di.override(directoryForUserDataInjectable, () => "/some-directory-for-user-data");
+  
+  });
+
+  describe("kubectlApplyFolder", () => {
+    it("returns response", async () => {
+      di.override(kubectlApplyAllInjectable, () => () => Promise.resolve({
+        callWasSuccessful: true as const,
+        response: "success",
+      }));
+
+      const createResourceStack = di.inject(createResourceStackInjectable);
+      const resourceStack = createResourceStack(cluster, "test");
+
+      const response = await resourceStack.kubectlApplyFolder("/foo/bar");
+
+      expect(response).toEqual("success");
+    });
+
+    it("throws on error", async () => {
+      di.override(kubectlApplyAllInjectable, () => () => Promise.resolve({
+        callWasSuccessful: false as const,
+        error: "No permissions",
+      }));
+
+      const createResourceStack = di.inject(createResourceStackInjectable);
+      const resourceStack = createResourceStack(cluster, "test");
+
+      await expect(() => resourceStack.kubectlApplyFolder("/foo/bar")).rejects.toThrow("No permissions");
+    });
+  });
+});

packages/core/src/common/fs/fs.injectable.ts

@@ -7,7 +7,7 @@ import type { ReadOptions } from "fs-extra";
 import fse from "fs-extra";
 
 /**
- * NOTE: Add corrisponding a corrisponding override of this injecable in `src/test-utils/override-fs-with-fakes.ts`
+ * NOTE: Add corresponding override of this injectable in `src/test-utils/override-fs-with-fakes.ts`
  */
 const fsInjectable = getInjectable({
   id: "fs",

packages/core/src/common/k8s/resource-stack.ts

@@ -51,7 +51,7 @@ export class ResourceStack {
 
     this.dependencies.logger.warn(`[RESOURCE-STACK]: failed to apply resources: ${result.error}`);
 
-    return "";
+    throw new Error(result.error);
   }
 
   /**

packages/core/src/common/logger.injectable.ts

@@ -3,13 +3,20 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 import { getInjectable } from "@ogre-tools/injectable";
+import { createLogger, format } from "winston";
 import type { Logger } from "./logger";
-import winstonLoggerInjectable from "./winston-logger.injectable";
+import { loggerTransportInjectionToken } from "./logger/transports";
 
 const loggerInjectable = getInjectable({
   id: "logger",
   instantiate: (di): Logger => {
-    const baseLogger = di.inject(winstonLoggerInjectable);
+    const baseLogger = createLogger({
+      format: format.combine(
+        format.splat(),
+        format.simple(),
+      ),
+      transports: di.injectMany(loggerTransportInjectionToken),
+    });
 
     return {
       debug: (message, ...data) => baseLogger.debug(message, ...data),

packages/core/src/common/vars/store-migration-version.injectable.ts

@@ -3,11 +3,10 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 import { getInjectable } from "@ogre-tools/injectable";
-import { applicationInformationToken } from "./application-information-token";
 
 const storeMigrationVersionInjectable = getInjectable({
   id: "store-migration-version",
-  instantiate: (di) => di.inject(applicationInformationToken).version,
+  instantiate: () => "6.4.0",
 });
 
 export default storeMigrationVersionInjectable;

packages/core/src/common/winston-logger.injectable.ts

@@ -1,20 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-import { getInjectable } from "@ogre-tools/injectable";
-import { createLogger, format } from "winston";
-import { loggerTransportInjectionToken } from "./logger/transports";
-
-const winstonLoggerInjectable = getInjectable({
-  id: "winston-logger",
-  instantiate: (di) => createLogger({
-    format: format.combine(
-      format.splat(),
-      format.simple(),
-    ),
-    transports: di.injectMany(loggerTransportInjectionToken),
-  }),
-});
-
-export default winstonLoggerInjectable;

packages/core/src/extensions/extension-discovery/extension-discovery.injectable.ts

@@ -8,8 +8,8 @@ import extensionLoaderInjectable from "../extension-loader/extension-loader.inje
 import isCompatibleExtensionInjectable from "./is-compatible-extension/is-compatible-extension.injectable";
 import extensionsStoreInjectable from "../extensions-store/extensions-store.injectable";
 import extensionInstallationStateStoreInjectable from "../extension-installation-state-store/extension-installation-state-store.injectable";
-import installExtensionInjectable from "../extension-installer/install-extension/install-extension.injectable";
-import extensionPackageRootDirectoryInjectable from "../extension-installer/extension-package-root-directory/extension-package-root-directory.injectable";
+import installExtensionInjectable from "../install-extension/install-extension.injectable";
+import extensionPackageRootDirectoryInjectable from "../install-extension/extension-package-root-directory.injectable";
 import readJsonFileInjectable from "../../common/fs/read-json-file.injectable";
 import loggerInjectable from "../../common/logger.injectable";
 import pathExistsInjectable from "../../common/fs/path-exists.injectable";

packages/core/src/extensions/extension-discovery/extension-discovery.test.ts

@@ -7,7 +7,7 @@ import type { FSWatcher } from "chokidar";
 import { getDiForUnitTesting } from "../../main/getDiForUnitTesting";
 import extensionDiscoveryInjectable from "../extension-discovery/extension-discovery.injectable";
 import type { ExtensionDiscovery } from "../extension-discovery/extension-discovery";
-import installExtensionInjectable from "../extension-installer/install-extension/install-extension.injectable";
+import installExtensionInjectable from "../install-extension/install-extension.injectable";
 import directoryForUserDataInjectable from "../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable";
 import { delay } from "../../renderer/utils";
 import { observable, runInAction, when } from "mobx";

packages/core/src/extensions/extension-installer/extension-installer.injectable.ts

@@ -1,21 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-import { getInjectable } from "@ogre-tools/injectable";
-import pathToNpmCliInjectable from "../../common/app-paths/path-to-npm-cli.injectable";
-import loggerInjectable from "../../common/logger.injectable";
-import { ExtensionInstaller } from "./extension-installer";
-import extensionPackageRootDirectoryInjectable from "./extension-package-root-directory/extension-package-root-directory.injectable";
-
-const extensionInstallerInjectable = getInjectable({
-  id: "extension-installer",
-
-  instantiate: (di) => new ExtensionInstaller({
-    extensionPackageRootDirectory: di.inject(extensionPackageRootDirectoryInjectable),
-    logger: di.inject(loggerInjectable),
-    pathToNpmCli: di.inject(pathToNpmCliInjectable),
-  }),
-});
-
-export default extensionInstallerInjectable;

packages/core/src/extensions/extension-installer/extension-installer.ts

@@ -1,78 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-
-import AwaitLock from "await-lock";
-import child_process from "child_process";
-import type { Logger } from "../../common/logger";
-
-const logModule = "[EXTENSION-INSTALLER]";
-
-interface Dependencies {
-  readonly extensionPackageRootDirectory: string;
-  readonly logger: Logger;
-  readonly pathToNpmCli: string;
-}
-
-const baseNpmInstallArgs = [
-  "install",
-  "--audit=false",
-  "--fund=false",
-  // NOTE: we do not omit the `optional` dependencies because that is how we specify the non-bundled extensions
-  "--omit=dev",
-  "--omit=peer",
-  "--prefer-offline",
-];
-
-/**
- * Installs dependencies for extensions
- */
-export class ExtensionInstaller {
-  private readonly installLock = new AwaitLock();
-
-  constructor(private readonly dependencies: Dependencies) {}
-
-  /**
-   * Install single package using npm
-   */
-  installPackage = async (name: string): Promise<void> => {
-    // Mutual exclusion to install packages in sequence
-    await this.installLock.acquireAsync();
-
-    try {
-      this.dependencies.logger.info(`${logModule} installing package from ${name} to ${this.dependencies.extensionPackageRootDirectory}`);
-      await this.npm(...baseNpmInstallArgs, name);
-      this.dependencies.logger.info(`${logModule} package ${name} installed to ${this.dependencies.extensionPackageRootDirectory}`);
-    } finally {
-      this.installLock.release();
-    }
-  };
-
-  private npm(...args: string[]): Promise<void> {
-    return new Promise((resolve, reject) => {
-      const child = child_process.fork(this.dependencies.pathToNpmCli, args, {
-        cwd: this.dependencies.extensionPackageRootDirectory,
-        silent: true,
-        env: {},
-      });
-      let stderr = "";
-
-      child.stderr?.on("data", data => {
-        stderr += String(data);
-      });
-
-      child.on("close", (code) => {
-        if (code !== 0) {
-          reject(new Error(stderr));
-        } else {
-          resolve();
-        }
-      });
-
-      child.on("error", error => {
-        reject(error);
-      });
-    });
-  }
-}

packages/core/src/extensions/extension-installer/install-extension/install-extension.injectable.ts

@@ -1,13 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-import { getInjectable } from "@ogre-tools/injectable";
-import extensionInstallerInjectable from "../extension-installer.injectable";
-
-const installExtensionInjectable = getInjectable({
-  id: "install-extension",
-  instantiate: (di) => di.inject(extensionInstallerInjectable).installPackage,
-});
-
-export default installExtensionInjectable;

packages/core/src/extensions/install-extension/extension-package-root-directory.injectable.ts

@@ -3,7 +3,7 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 import { getInjectable } from "@ogre-tools/injectable";
-import directoryForUserDataInjectable from "../../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable";
+import directoryForUserDataInjectable from "../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable";
 
 const extensionPackageRootDirectoryInjectable = getInjectable({
   id: "extension-package-root-directory",

packages/core/src/extensions/install-extension/install-extension.injectable.ts

@@ -0,0 +1,111 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable } from "@ogre-tools/injectable";
+import { fork } from "child_process";
+import AwaitLock from "await-lock";
+import pathToNpmCliInjectable from "../../common/app-paths/path-to-npm-cli.injectable";
+import extensionPackageRootDirectoryInjectable from "./extension-package-root-directory.injectable";
+import prefixedLoggerInjectable from "../../common/logger/prefixed-logger.injectable";
+import readJsonFileInjectable from "../../common/fs/read-json-file.injectable";
+import joinPathsInjectable from "../../common/path/join-paths.injectable";
+import type { PackageJson } from "../common-api";
+import writeJsonFileInjectable from "../../common/fs/write-json-file.injectable";
+import { once } from "lodash";
+import { isErrnoException } from "../../common/utils";
+
+const baseNpmInstallArgs = [
+  "install",
+  "--save-optional",
+  "--audit=false",
+  "--fund=false",
+  // NOTE: we do not omit the `optional` dependencies because that is how we specify the non-bundled extensions
+  "--omit=dev",
+  "--omit=peer",
+  "--prefer-offline",
+];
+
+export type InstallExtension = (name: string) => Promise<void>;
+
+const installExtensionInjectable = getInjectable({
+  id: "install-extension",
+  instantiate: (di): InstallExtension => {
+    const pathToNpmCli = di.inject(pathToNpmCliInjectable);
+    const extensionPackageRootDirectory = di.inject(extensionPackageRootDirectoryInjectable);
+    const readJsonFile = di.inject(readJsonFileInjectable);
+    const writeJsonFile = di.inject(writeJsonFileInjectable);
+    const joinPaths = di.inject(joinPathsInjectable);
+    const logger = di.inject(prefixedLoggerInjectable, "EXTENSION-INSTALLER");
+
+    const forkNpm = (...args: string[]) => new Promise<void>((resolve, reject) => {
+      const child = fork(pathToNpmCli, args, {
+        cwd: extensionPackageRootDirectory,
+        silent: true,
+        env: {},
+      });
+      let stderr = "";
+
+      child.stderr?.on("data", data => {
+        stderr += String(data);
+      });
+
+      child.on("close", (code) => {
+        if (code !== 0) {
+          reject(new Error(stderr));
+        } else {
+          resolve();
+        }
+      });
+
+      child.on("error", error => {
+        reject(error);
+      });
+    });
+
+    const packageJsonPath = joinPaths(extensionPackageRootDirectory, "package.json");
+
+    /**
+     * NOTES:
+     *   - We have to keep the `package.json` because `npm install` removes files from `node_modules`
+     *     if they are no longer in the `package.json`
+     *   - In v6.2.X we saved bundled extensions as `"dependencies"` and external extensions as
+     *     `"optionalDependencies"` at startup. This was done because `"optionalDependencies"` can
+     *     fail to install and that is OK.
+     *   - We continue to maintain this behavior here by only installing new dependencies as
+     *     `"optionalDependencies"`
+     */
+    const fixupPackageJson = once(async () => {
+      try {
+        const packageJson = await readJsonFile(packageJsonPath) as PackageJson;
+
+        delete packageJson.dependencies;
+
+        await writeJsonFile(packageJsonPath, packageJson);
+      } catch (error) {
+        if (isErrnoException(error) && error.code === "ENOENT") {
+          return;
+        }
+
+        throw error;
+      }
+    });
+
+    const installLock = new AwaitLock();
+
+    return async (name) => {
+      await installLock.acquireAsync();
+      await fixupPackageJson();
+
+      try {
+        logger.info(`installing package for extension "${name}"`);
+        await forkNpm(...baseNpmInstallArgs, name);
+        logger.info(`installed package for extension "${name}"`);
+      } finally {
+        installLock.release();
+      }
+    };
+  },
+});
+
+export default installExtensionInjectable;

packages/core/src/renderer/bootstrap.tsx

@@ -46,9 +46,7 @@ export async function bootstrap(di: DiContainer) {
   }
 
   try {
-    await initializeApp(() => {
-      unmountComponentAtNode(rootElem);
-    });
+    await initializeApp(() => unmountComponentAtNode(rootElem));
   } catch (error) {
     console.error(`[BOOTSTRAP]: view initialization error: ${error}`, {
       origin: location.href,

packages/core/src/renderer/frames/cluster-frame/init-cluster-frame/init-cluster-frame.injectable.ts

@@ -12,7 +12,6 @@ import emitAppEventInjectable from "../../../../common/app-event-bus/emit-event.
 import loadExtensionsInjectable from "../../load-extensions.injectable";
 import loggerInjectable from "../../../../common/logger.injectable";
 import showErrorNotificationInjectable from "../../../components/notifications/show-error-notification.injectable";
-import closeRendererLogFileInjectable from "../../../logger/close-renderer-log-file.injectable";
 
 const initClusterFrameInjectable = getInjectable({
   id: "init-cluster-frame",
@@ -30,7 +29,6 @@ const initClusterFrameInjectable = getInjectable({
       emitAppEvent: di.inject(emitAppEventInjectable),
       logger: di.inject(loggerInjectable),
       showErrorNotification: di.inject(showErrorNotificationInjectable),
-      closeFileLogging: di.inject(closeRendererLogFileInjectable),
     });
   },
 });

packages/core/src/renderer/frames/cluster-frame/init-cluster-frame/init-cluster-frame.ts

@@ -2,7 +2,6 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
-import { once } from "lodash";
 import type { Cluster } from "../../../../common/cluster/cluster";
 import type { CatalogEntityRegistry } from "../../../api/catalog/entity/registry";
 import type { ShowNotification } from "../../../components/notifications";
@@ -19,7 +18,6 @@ interface Dependencies {
   emitAppEvent: EmitAppEvent;
   logger: Logger;
   showErrorNotification: ShowNotification;
-  closeFileLogging: () => void;
 }
 
 const logPrefix = "[CLUSTER-FRAME]:";
@@ -32,7 +30,6 @@ export const initClusterFrame = ({
   emitAppEvent,
   logger,
   showErrorNotification,
-  closeFileLogging,
 }: Dependencies) =>
   async (unmountRoot: () => void) => {
     // TODO: Make catalogEntityRegistry already initialized when passed as dependency
@@ -76,14 +73,11 @@ export const initClusterFrame = ({
       });
     });
 
-    const onCloseFrame = once(() => {
+    window.onbeforeunload = () => {
       logger.info(
         `${logPrefix} Unload dashboard, clusterId=${(hostedCluster.id)}, frameId=${frameRoutingId}`,
       );
-      closeFileLogging();
-      unmountRoot();
-    });
 
-    window.addEventListener("beforeunload", onCloseFrame);
-    window.addEventListener("pagehide", onCloseFrame);
+      unmountRoot();
+    };
   };

packages/core/src/renderer/frames/root-frame/init-root-frame.injectable.ts

@@ -13,7 +13,6 @@ import loggerInjectable from "../../../common/logger.injectable";
 import { delay } from "../../../common/utils";
 import { broadcastMessage } from "../../../common/ipc";
 import { bundledExtensionsLoaded } from "../../../common/ipc/extension-handling";
-import closeRendererLogFileInjectable from "../../logger/close-renderer-log-file.injectable";
 
 const initRootFrameInjectable = getInjectable({
   id: "init-root-frame",
@@ -25,7 +24,6 @@ const initRootFrameInjectable = getInjectable({
     const lensProtocolRouterRenderer = di.inject(lensProtocolRouterRendererInjectable);
     const catalogEntityRegistry = di.inject(catalogEntityRegistryInjectable);
     const logger = di.inject(loggerInjectable);
-    const closeRendererLogFile = di.inject(closeRendererLogFileInjectable);
 
     return async (unmountRoot: () => void) => {
       catalogEntityRegistry.init();
@@ -61,7 +59,7 @@ const initRootFrameInjectable = getInjectable({
 
       window.addEventListener("beforeunload", () => {
         logger.info("[ROOT-FRAME]: Unload app");
-        closeRendererLogFile();
+
         unmountRoot();
       });
     };

packages/core/src/renderer/logger/close-renderer-log-file.injectable.ts

@@ -1,22 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-import { getInjectable } from "@ogre-tools/injectable";
-import winstonLoggerInjectable from "../../common/winston-logger.injectable";
-import rendererFileLoggerTransportInjectable from "./file-transport.injectable";
-
-const closeRendererLogFileInjectable = getInjectable({
-  id: "close-renderer-log-file",
-  instantiate: (di) => {
-    const winstonLogger = di.inject(winstonLoggerInjectable);
-    const fileLoggingTransport = di.inject(rendererFileLoggerTransportInjectable);
-
-    return () => {
-      fileLoggingTransport.close?.();
-      winstonLogger.remove(fileLoggingTransport);
-    };
-  },
-});
-
-export default closeRendererLogFileInjectable;

packages/core/src/renderer/logger/file-transport.injectable.ts

@@ -1,44 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-import { getInjectable } from "@ogre-tools/injectable";
-import { transports } from "winston";
-import directoryForLogsInjectable from "../../common/app-paths/directory-for-logs.injectable";
-import { loggerTransportInjectionToken } from "../../common/logger/transports";
-import windowLocationInjectable from "../../common/k8s-api/window-location.injectable";
-import currentlyInClusterFrameInjectable from "../routes/currently-in-cluster-frame.injectable";
-import { getClusterIdFromHost } from "../utils";
-
-const rendererFileLoggerTransportInjectable = getInjectable({
-  id: "renderer-file-logger-transport",
-  instantiate: (di) => {
-    let frameId: string;
-
-    const currentlyInClusterFrame = di.inject(
-      currentlyInClusterFrameInjectable,
-    );
-
-    if (currentlyInClusterFrame) {
-      const { host } = di.inject(windowLocationInjectable);
-      const clusterId = getClusterIdFromHost(host);
-
-      frameId = clusterId ? `cluster-${clusterId}` : "cluster";
-    } else {
-      frameId = "main";
-    }
-
-    return new transports.File({
-      handleExceptions: false,
-      level: "info",
-      filename: `lens-renderer-${frameId}.log`,
-      dirname: di.inject(directoryForLogsInjectable),
-      maxsize: 1024 * 1024,
-      maxFiles: 2,
-      tailable: true,
-    });
-  },
-  injectionToken: loggerTransportInjectionToken,
-});
-
-export default rendererFileLoggerTransportInjectable;