Cleanup 'Cluster' to remove environment specific details (#6951)

- requestNamespaceListPermissions is infallable so no need to have the extra try/catch

- Refactor isMetricHidden method away from Cluster

- Refactor shouldShowResource out of Cluster

- Refactor isInLocalKubeconfig out of Cluster

- Remove depecrated and unused workspace from Cluster

- Refactor out kubectl as a dependency of Cluster

- Remove from cluster getter used only once

- Split out ClusterConnection from Cluster

- Also split out KubeAuthProxyServer from ContextHandler

- Rename ContextHandler to PrometheusHandler

- Cleanup onNetworkOffline/Online impls within ClusterManager

- Remove annotations from ClusterConnection

- Remove mobx annotations from Cluster

- Rename loadConfigFromFileInjectable

- Remove all uses of dead createClusterInjectionToken

- Fix type errors related to broadcastConnectionUpdate

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

packages/core/src/main/shell-session/local-shell-session/local-shell-session.ts

@@ -52,16 +52,16 @@ export class LocalShellSession extends ShellSession {
   protected async getShellArgs(shell: string): Promise<string[]> {
     const pathFromPreferences = this.dependencies.userStore.kubectlBinariesPath || this.kubectl.getBundledPath();
     const kubectlPathDir = this.dependencies.userStore.downloadKubectlBinaries
-      ? await this.kubectlBinDirP
+      ? this.dependencies.directoryContainingKubectl
       : this.dependencies.getDirnameOfPath(pathFromPreferences);
 
     switch(this.dependencies.getBasenameOfPath(shell)) {
       case "powershell.exe":
         return ["-NoExit", "-command", `& {$Env:PATH="${kubectlPathDir};${this.dependencies.directoryForBinaries};$Env:PATH"}`];
       case "bash":
-        return ["--init-file", this.dependencies.joinPaths(await this.kubectlBinDirP, ".bash_set_path")];
+        return ["--init-file", this.dependencies.joinPaths(this.dependencies.directoryContainingKubectl, ".bash_set_path")];
       case "fish":
-        return ["--login", "--init-command", `export PATH="${kubectlPathDir}:${this.dependencies.directoryForBinaries}:$PATH"; export KUBECONFIG="${await this.kubeconfigPathP}"`];
+        return ["--login", "--init-command", `export PATH="${kubectlPathDir}:${this.dependencies.directoryForBinaries}:$PATH"; export KUBECONFIG="${await this.dependencies.proxyKubeconfigPath}"`];
       case "zsh":
         return ["--login"];
       default:

packages/core/src/main/shell-session/local-shell-session/open.injectable.ts

@@ -24,6 +24,7 @@ import appNameInjectable from "../../../common/vars/app-name.injectable";
 import buildVersionInjectable from "../../vars/build-version/build-version.injectable";
 import emitAppEventInjectable from "../../../common/app-event-bus/emit-event.injectable";
 import statInjectable from "../../../common/fs/stat.injectable";
+import kubeconfigManagerInjectable from "../../kubeconfig-manager/kubeconfig-manager.injectable";
 
 export interface OpenLocalShellSessionArgs {
   websocket: WebSocket;
@@ -38,7 +39,7 @@ const openLocalShellSessionInjectable = getInjectable({
 
   instantiate: (di): OpenLocalShellSession => {
     const createKubectl = di.inject(createKubectlInjectable);
-    const dependencies: LocalShellSessionDependencies = {
+    const dependencies: Omit<LocalShellSessionDependencies, "proxyKubeconfigPath" | "directoryContainingKubectl"> = {
       directoryForBinaries: di.inject(directoryForBinariesInjectable),
       isMac: di.inject(isMacInjectable),
       isWindows: di.inject(isWindowsInjectable),
@@ -57,9 +58,17 @@ const openLocalShellSessionInjectable = getInjectable({
       stat: di.inject(statInjectable),
     };
 
-    return (args) => {
-      const kubectl = createKubectl(args.cluster.version);
-      const session = new LocalShellSession(dependencies, { kubectl, ...args });
+    return async (args) => {
+      const kubectl = createKubectl(args.cluster.version.get());
+      const kubeconfigManager = di.inject(kubeconfigManagerInjectable, args.cluster);
+      const proxyKubeconfigPath = await kubeconfigManager.ensurePath();
+      const directoryContainingKubectl = await kubectl.binDir();
+
+      const session = new LocalShellSession({
+        ...dependencies,
+        proxyKubeconfigPath,
+        directoryContainingKubectl,
+      }, { kubectl, ...args });
 
       return session.open();
     };

packages/core/src/main/shell-session/local-shell-session/techincal.test.ts

@@ -5,8 +5,9 @@
 
 import type { DiContainer } from "@ogre-tools/injectable";
 import type WebSocket from "ws";
+import directoryForTempInjectable from "../../../common/app-paths/directory-for-temp/directory-for-temp.injectable";
 import directoryForUserDataInjectable from "../../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable";
-import type { Cluster } from "../../../common/cluster/cluster";
+import { Cluster } from "../../../common/cluster/cluster";
 import pathExistsSyncInjectable from "../../../common/fs/path-exists-sync.injectable";
 import pathExistsInjectable from "../../../common/fs/path-exists.injectable";
 import readJsonSyncInjectable from "../../../common/fs/read-json-sync.injectable";
@@ -14,8 +15,11 @@ import statInjectable from "../../../common/fs/stat.injectable";
 import writeJsonSyncInjectable from "../../../common/fs/write-json-sync.injectable";
 import platformInjectable from "../../../common/vars/platform.injectable";
 import { getDiForUnitTesting } from "../../getDiForUnitTesting";
+import type { KubeconfigManager } from "../../kubeconfig-manager/kubeconfig-manager";
+import kubeconfigManagerInjectable from "../../kubeconfig-manager/kubeconfig-manager.injectable";
 import createKubectlInjectable from "../../kubectl/create-kubectl.injectable";
 import type { Kubectl } from "../../kubectl/kubectl";
+import lensProxyPortInjectable from "../../lens-proxy/lens-proxy-port.injectable";
 import buildVersionInjectable from "../../vars/build-version/build-version.injectable";
 import type { OpenShellSession } from "../create-shell-session.injectable";
 import type { SpawnPty } from "../spawn-pty.injectable";
@@ -29,6 +33,7 @@ describe("technical unit tests for local shell sessions", () => {
     di = getDiForUnitTesting();
 
     di.override(directoryForUserDataInjectable, () => "/some-directory-for-user-data");
+    di.override(directoryForTempInjectable, () => "/some-directory-for-tmp");
     di.override(buildVersionInjectable, () => ({
       get: () => "1.1.1",
     }));
@@ -37,6 +42,7 @@ describe("technical unit tests for local shell sessions", () => {
     di.override(readJsonSyncInjectable, () => () => { throw new Error("tried call readJsonSync without override"); });
     di.override(writeJsonSyncInjectable, () => () => { throw new Error("tried call writeJsonSync without override"); });
     di.override(statInjectable, () => () => { throw new Error("tried call stat without override"); });
+    di.inject(lensProxyPortInjectable).set(1111);
   });
 
   describe("when on windows", () => {
@@ -54,6 +60,10 @@ describe("technical unit tests for local shell sessions", () => {
         getBundledPath: () => "/some-bundled-kubectl-path",
       }) as Partial<Kubectl> as Kubectl);
 
+      di.override(kubeconfigManagerInjectable, () => ({
+        ensurePath: async () => "/some-proxy-kubeconfig-file",
+      } as Partial<KubeconfigManager> as KubeconfigManager));
+
       openLocalShellSession = di.inject(openLocalShellSessionInjectable);
     });
 
@@ -89,11 +99,16 @@ describe("technical unit tests for local shell sessions", () => {
           once: jest.fn(() => websocket),
         } as Partial<WebSocket> as WebSocket;
 
+        const cluster = new Cluster({
+          contextName: "some-context-name",
+          id: "some-cluster-id",
+          kubeConfigPath: "/some-kube-config-path",
+        }, {
+          clusterServerUrl: "https://localhost:9999",
+        });
+
         await openLocalShellSession({
-          cluster: {
-            getProxyKubeconfigPath: async () => "/some-proxy-kubeconfig",
-            preferences: {},
-          } as Partial<Cluster> as Cluster,
+          cluster,
           tabId: "my-tab-id",
           websocket,
         });

packages/core/src/main/shell-session/node-shell-session/node-shell-session.ts

@@ -13,6 +13,8 @@ import { NodeApi } from "../../../common/k8s-api/endpoints";
 import { TerminalChannels } from "../../../common/terminal/channels";
 import type { CreateKubeJsonApiForCluster } from "../../../common/k8s-api/create-kube-json-api-for-cluster.injectable";
 import type { CreateKubeApi } from "../../../common/k8s-api/create-kube-api.injectable";
+import { initialNodeShellImage } from "../../../common/cluster-types";
+import type { LoadProxyKubeconfig } from "../../cluster/load-proxy-kubeconfig.injectable";
 
 export interface NodeShellSessionArgs extends ShellSessionArgs {
   nodeName: string;
@@ -21,6 +23,7 @@ export interface NodeShellSessionArgs extends ShellSessionArgs {
 export interface NodeShellSessionDependencies extends ShellSessionDependencies {
   createKubeJsonApiForCluster: CreateKubeJsonApiForCluster;
   createKubeApi: CreateKubeApi;
+  loadProxyKubeconfig: LoadProxyKubeconfig;
 }
 
 export class NodeShellSession extends ShellSession {
@@ -36,9 +39,8 @@ export class NodeShellSession extends ShellSession {
   }
 
   public async open() {
-    const kc = await this.cluster.getProxyKubeconfig();
-    const coreApi = kc.makeApiClient(CoreV1Api);
-    const shell = await this.kubectl.getPath();
+    const proxyKubeconfig = await this.dependencies.loadProxyKubeconfig();
+    const coreApi = proxyKubeconfig.makeApiClient(CoreV1Api);
 
     const cleanup = once(() => {
       coreApi
@@ -50,7 +52,7 @@ export class NodeShellSession extends ShellSession {
 
     try {
       await this.createNodeShellPod(coreApi);
-      await this.waitForRunningPod(kc);
+      await this.waitForRunningPod(proxyKubeconfig);
     } catch (error) {
       cleanup();
 
@@ -92,13 +94,18 @@ export class NodeShellSession extends ShellSession {
         break;
     }
 
-    await this.openShellProcess(shell, args, env);
+    await this.openShellProcess(this.dependencies.directoryContainingKubectl, args, env);
   }
 
   protected createNodeShellPod(coreApi: CoreV1Api) {
-    const imagePullSecrets = this.cluster.imagePullSecret
+    const {
+      imagePullSecret,
+      nodeShellImage,
+    } = this.cluster.preferences;
+
+    const imagePullSecrets = imagePullSecret
       ? [{
-        name: this.cluster.imagePullSecret,
+        name: imagePullSecret,
       }]
       : undefined;
 
@@ -121,7 +128,7 @@ export class NodeShellSession extends ShellSession {
           priorityClassName: "system-node-critical",
           containers: [{
             name: "shell",
-            image: this.cluster.nodeShellImage,
+            image: nodeShellImage || initialNodeShellImage,
             securityContext: {
               privileged: true,
             },

packages/core/src/main/shell-session/node-shell-session/open.injectable.ts

@@ -20,6 +20,8 @@ import buildVersionInjectable from "../../vars/build-version/build-version.injec
 import emitAppEventInjectable from "../../../common/app-event-bus/emit-event.injectable";
 import statInjectable from "../../../common/fs/stat.injectable";
 import createKubeApiInjectable from "../../../common/k8s-api/create-kube-api.injectable";
+import loadProxyKubeconfigInjectable from "../../cluster/load-proxy-kubeconfig.injectable";
+import kubeconfigManagerInjectable from "../../kubeconfig-manager/kubeconfig-manager.injectable";
 
 export interface NodeShellSessionArgs {
   websocket: WebSocket;
@@ -34,7 +36,7 @@ const openNodeShellSessionInjectable = getInjectable({
   id: "open-node-shell-session",
   instantiate: (di): OpenNodeShellSession => {
     const createKubectl = di.inject(createKubectlInjectable);
-    const dependencies: NodeShellSessionDependencies = {
+    const dependencies: Omit<NodeShellSessionDependencies, "proxyKubeconfigPath" | "loadProxyKubeconfig" | "directoryContainingKubectl"> = {
       isMac: di.inject(isMacInjectable),
       isWindows: di.inject(isWindowsInjectable),
       logger: di.inject(loggerInjectable),
@@ -50,8 +52,18 @@ const openNodeShellSessionInjectable = getInjectable({
     };
 
     return async (args) => {
-      const kubectl = createKubectl(args.cluster.version);
-      const session = new NodeShellSession(dependencies, { kubectl, ...args });
+      const kubectl = createKubectl(args.cluster.version.get());
+      const kubeconfigManager = di.inject(kubeconfigManagerInjectable, args.cluster);
+      const loadProxyKubeconfig = di.inject(loadProxyKubeconfigInjectable, args.cluster);
+      const proxyKubeconfigPath = await kubeconfigManager.ensurePath();
+      const directoryContainingKubectl = await kubectl.binDir();
+
+      const session = new NodeShellSession({
+        ...dependencies,
+        loadProxyKubeconfig,
+        proxyKubeconfigPath,
+        directoryContainingKubectl,
+      }, { kubectl, ...args });
 
       return session.open();
     };

packages/core/src/main/shell-session/shell-session.ts

@@ -111,6 +111,8 @@ export interface ShellSessionDependencies {
   readonly userShellSetting: IComputedValue<string>;
   readonly appName: string;
   readonly buildVersion: InitializableState<string>;
+  readonly proxyKubeconfigPath: string;
+  readonly directoryContainingKubectl: string;
   computeShellEnvironment: ComputeShellEnvironment;
   spawnPty: SpawnPty;
   emitAppEvent: EmitAppEvent;
@@ -147,8 +149,6 @@ export abstract class ShellSession {
   }
 
   protected running = false;
-  protected readonly kubectlBinDirP: Promise<string>;
-  protected readonly kubeconfigPathP: Promise<string>;
   protected readonly terminalId: string;
   protected readonly kubectl: Kubectl;
   protected readonly websocket: WebSocket;
@@ -179,8 +179,6 @@ export abstract class ShellSession {
     this.kubectl = kubectl;
     this.websocket = websocket;
     this.cluster = cluster;
-    this.kubeconfigPathP = this.cluster.getProxyKubeconfigPath();
-    this.kubectlBinDirP = this.kubectl.binDir();
     this.terminalId = `${cluster.id}:${terminalId}`;
   }
 
@@ -297,7 +295,7 @@ export abstract class ShellSession {
               code !== WebSocketCloseEvent.AbnormalClosure
               && code !== WebSocketCloseEvent.GoingAway
             )
-            || this.cluster.disconnected
+            || this.cluster.disconnected.get()
           );
 
         if (stopShellSession) {
@@ -350,7 +348,7 @@ export abstract class ShellSession {
     })();
 
     const env = clearKubeconfigEnvVars(JSON.parse(JSON.stringify(rawEnv)));
-    const pathStr = [await this.kubectlBinDirP, ...this.getPathEntries(), env.PATH].join(path.delimiter);
+    const pathStr = [this.dependencies.directoryContainingKubectl, ...this.getPathEntries(), env.PATH].join(path.delimiter);
 
     delete env.DEBUG; // don't pass DEBUG into shells
 
@@ -373,12 +371,12 @@ export abstract class ShellSession {
 
     if (path.basename(env.PTYSHELL) === "zsh") {
       env.OLD_ZDOTDIR = env.ZDOTDIR || env.HOME;
-      env.ZDOTDIR = await this.kubectlBinDirP;
+      env.ZDOTDIR = this.dependencies.directoryContainingKubectl;
       env.DISABLE_AUTO_UPDATE = "true";
     }
 
     env.PTYPID = process.pid.toString();
-    env.KUBECONFIG = await this.kubeconfigPathP;
+    env.KUBECONFIG = this.dependencies.proxyKubeconfigPath;
     env.TERM_PROGRAM = this.dependencies.appName;
     env.TERM_PROGRAM_VERSION = this.dependencies.buildVersion.get();