Simplify add cluster view (#2716)

- Only shows editor, and will save all text to file

- Reports some validation errors, but doesn't block the add cluster
  button

- Cleanup kube helpers to facilitate clearer FS interactions

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

src/main/catalog-sources/kubeconfig-sync.ts

@@ -29,7 +29,7 @@ import type stream from "stream";
 import { Disposer, ExtendedObservableMap, iter, Singleton } from "../../common/utils";
 import logger from "../logger";
 import type { KubeConfig } from "@kubernetes/client-node";
-import { loadConfigFromString, splitConfig, validateKubeConfig } from "../../common/kube-helpers";
+import { loadConfigFromString, splitConfig } from "../../common/kube-helpers";
 import { Cluster } from "../cluster";
 import { catalogEntityFromCluster } from "../cluster-manager";
 import { UserStore } from "../../common/user-store";
@@ -130,18 +130,16 @@ export class KubeconfigSyncManager extends Singleton {
 }
 
 // exported for testing
-export function configToModels(config: KubeConfig, filePath: string): UpdateClusterModel[] {
+export function configToModels(rootConfig: KubeConfig, filePath: string): UpdateClusterModel[] {
   const validConfigs = [];
 
-  for (const contextConfig of splitConfig(config)) {
-    const error = validateKubeConfig(contextConfig, contextConfig.currentContext);
-
+  for (const { config, error } of splitConfig(rootConfig)) {
     if (error) {
-      logger.debug(`${logPrefix} context failed validation: ${error}`, { context: contextConfig.currentContext, filePath });
+      logger.debug(`${logPrefix} context failed validation: ${error}`, { context: config.currentContext, filePath });
     } else {
       validConfigs.push({
         kubeConfigPath: filePath,
-        contextName: contextConfig.currentContext,
+        contextName: config.currentContext,
       });
     }
   }
@@ -156,7 +154,13 @@ type RootSource = ObservableMap<string, RootSourceValue>;
 export function computeDiff(contents: string, source: RootSource, filePath: string): void {
   runInAction(() => {
     try {
-      const rawModels = configToModels(loadConfigFromString(contents), filePath);
+      const { config, error } = loadConfigFromString(contents);
+
+      if (error) {
+        logger.warn(`${logPrefix} encountered errors while loading config: ${error.message}`, { filePath, details: error.details });
+      }
+
+      const rawModels = configToModels(config, filePath);
       const models = new Map(rawModels.map(m => [m.contextName, m]));
 
       logger.debug(`${logPrefix} File now has ${models.size} entries`, { filePath });

src/main/cluster.ts

@@ -27,7 +27,7 @@ import { ContextHandler } from "./context-handler";
 import { AuthorizationV1Api, CoreV1Api, HttpError, KubeConfig, V1ResourceAttributes } from "@kubernetes/client-node";
 import { Kubectl } from "./kubectl";
 import { KubeconfigManager } from "./kubeconfig-manager";
-import { loadConfig, validateKubeConfig } from "../common/kube-helpers";
+import { loadConfigFromFile, loadConfigFromFileSync, validateKubeConfig } from "../common/kube-helpers";
 import { apiResourceRecord, apiResources, KubeApiResource, KubeResource } from "../common/rbac";
 import logger from "./logger";
 import { VersionDetector } from "./cluster-detectors/version-detector";
@@ -258,14 +258,14 @@ export class Cluster implements ClusterModel, ClusterState {
     this.id = model.id;
     this.updateModel(model);
 
-    const kubeconfig = this.getKubeconfig();
-    const error = validateKubeConfig(kubeconfig, this.contextName, { validateCluster: true, validateUser: false, validateExec: false});
+    const { config } = loadConfigFromFileSync(this.kubeConfigPath);
+    const validationError = validateKubeConfig(config, this.contextName);
 
-    if (error) {
-      throw error;
+    if (validationError) {
+      throw validationError;
     }
 
-    this.apiUrl = kubeconfig.getCluster(kubeconfig.getContextObject(this.contextName).cluster).server;
+    this.apiUrl = config.getCluster(config.getContextObject(this.contextName).cluster).server;
 
     if (ipcMain) {
       // for the time being, until renderer gets its own cluster type
@@ -470,17 +470,20 @@ export class Cluster implements ClusterModel, ClusterState {
     this.allowedResources = await this.getAllowedResources();
   }
 
-  protected getKubeconfig(): KubeConfig {
-    return loadConfig(this.kubeConfigPath);
+  async getKubeconfig(): Promise<KubeConfig> {
+    const { config } = await loadConfigFromFile(this.kubeConfigPath);
+
+    return config;
   }
 
   /**
    * @internal
    */
   async getProxyKubeconfig(): Promise<KubeConfig> {
-    const kubeconfigPath = await this.getProxyKubeconfigPath();
+    const proxyKCPath = await this.getProxyKubeconfigPath();
+    const { config } = await loadConfigFromFile(proxyKCPath);
 
-    return loadConfig(kubeconfigPath);
+    return config;
   }
 
   /**

src/main/kubeconfig-manager.ts

@@ -25,7 +25,7 @@ import type { ContextHandler } from "./context-handler";
 import { app } from "electron";
 import path from "path";
 import fs from "fs-extra";
-import { dumpConfigYaml, loadConfig } from "../common/kube-helpers";
+import { dumpConfigYaml } from "../common/kube-helpers";
 import logger from "./logger";
 import { LensProxy } from "./proxy/lens-proxy";
 
@@ -86,9 +86,9 @@ export class KubeconfigManager {
    */
   protected async createProxyKubeconfig(): Promise<string> {
     const { configDir, cluster } = this;
-    const { contextName, kubeConfigPath, id } = cluster;
-    const tempFile = path.normalize(path.join(configDir, `kubeconfig-${id}`));
-    const kubeConfig = loadConfig(kubeConfigPath);
+    const { contextName, id } = cluster;
+    const tempFile = path.join(configDir, `kubeconfig-${id}`);
+    const kubeConfig = await cluster.getKubeconfig();
     const proxyConfig: Partial<KubeConfig> = {
       currentContext: contextName,
       clusters: [