Fix kubeconfig-sync issues (#2692)

- Removed `getFreePort` as its use is always a race condition. Change
  all uses of it to retrive the port after listening

- Added `getPortFrom` as a helper function to read a port from a stream

- Remove `Cluster.ownerRef` as it is outdated and no longer needed for 5.0

- Remove `Cluster.enabled`, no longer needed because of above

- Removed `Cluster.init`, moved its contents into `Cluster.constructor`
  as nothing in that function is asyncronous. Currently only being run
  on `main` as a stop gap until `renderer` gets its own version of
  `Cluster`

- Refactored `LensProxy` so as to prevent `pty.node` (a NodeJS
  extension) being included in `webpack.extension.ts`'s run

- Removed the passing around of the proxy port as that can now be
  accessed from an instance of `LensProxy`

- purge ContextHandler's cache on disconnect

Co-authored-by: Sebastian Malton <sebastian@malton.name>

src/renderer/components/+add-cluster/add-cluster.scss

@@ -3,8 +3,8 @@
   $spacing: $padding * 2;
 
   .AceEditor {
-    min-height: 200px;
-    max-height: 400px;
+    min-height: 600px;
+    max-height: 600px;
     border: 1px solid var(--colorVague);
     border-radius: $radius;
 
@@ -17,24 +17,6 @@
     }
   }
 
-  .Select {
-    .kube-context {
-      --flex-gap: #{$padding};
-    }
-
-    // todo: extract to component, merge with namespace-select.scss
-    &__placeholder {
-      width: 100%;
-      white-space: nowrap;
-      text-overflow: ellipsis;
-      overflow: hidden;
-    }
-
-    &__control {
-      box-shadow: 0 0 0 1px $borderFaintColor;
-    }
-  }
-
   code {
     color: $pink-400;
   }

src/renderer/components/+add-cluster/add-cluster.tsx

@@ -1,51 +1,35 @@
 import "./add-cluster.scss";
-import os from "os";
 import React from "react";
 import { observer } from "mobx-react";
 import { action, observable, runInAction } from "mobx";
-import { remote } from "electron";
 import { KubeConfig } from "@kubernetes/client-node";
-import { Select, SelectOption } from "../select";
-import { DropFileInput, Input } from "../input";
 import { AceEditor } from "../ace-editor";
 import { Button } from "../button";
-import { Icon } from "../icon";
-import { kubeConfigDefaultPath, loadConfig, splitConfig, validateConfig, validateKubeConfig } from "../../../common/kube-helpers";
+import { loadConfig, splitConfig, validateKubeConfig } from "../../../common/kube-helpers";
 import { ClusterStore } from "../../../common/cluster-store";
 import { v4 as uuid } from "uuid";
 import { navigate } from "../../navigation";
 import { UserStore } from "../../../common/user-store";
-import { cssNames } from "../../utils";
 import { Notifications } from "../notifications";
-import { Tab, Tabs } from "../tabs";
 import { ExecValidationNotFoundError } from "../../../common/custom-errors";
 import { appEventBus } from "../../../common/event-bus";
 import { PageLayout } from "../layout/page-layout";
 import { docsUrl } from "../../../common/vars";
 import { catalogURL } from "../+catalog";
-
-enum KubeConfigSourceTab {
-  FILE = "file",
-  TEXT = "text"
-}
-
+import { preferencesURL } from "../+preferences";
+import { Input } from "../input";
 @observer
 export class AddCluster extends React.Component {
   @observable.ref kubeConfigLocal: KubeConfig;
   @observable.ref error: React.ReactNode;
-
-  @observable kubeContexts = observable.map<string, KubeConfig>(); // available contexts from kubeconfig-file or user-input
-  @observable selectedContexts = observable.array<string>();
-  @observable sourceTab = KubeConfigSourceTab.FILE;
-  @observable kubeConfigPath = "";
   @observable customConfig = "";
   @observable proxyServer = "";
   @observable isWaiting = false;
   @observable showSettings = false;
 
+  kubeContexts = observable.map<string, KubeConfig>();
+
   componentDidMount() {
-    ClusterStore.getInstance().setActive(null);
-    this.setKubeConfig(UserStore.getInstance().kubeConfigPath);
     appEventBus.emit({ name: "cluster-add", action: "start" });
   }
 
@@ -53,52 +37,19 @@ export class AddCluster extends React.Component {
     UserStore.getInstance().markNewContextsAsSeen();
   }
 
-  @action
-  setKubeConfig(filePath: string, { throwError = false } = {}) {
-    try {
-      this.kubeConfigLocal = loadConfig(filePath);
-      validateConfig(this.kubeConfigLocal);
-      this.refreshContexts();
-      this.kubeConfigPath = filePath;
-      UserStore.getInstance().kubeConfigPath = filePath; // save to store
-    } catch (err) {
-      if (!UserStore.getInstance().isDefaultKubeConfigPath) {
-        Notifications.error(
-          <div>Can&apos;t setup <code>{filePath}</code> as kubeconfig: {String(err)}</div>
-        );
-      }
-
-      if (throwError) {
-        throw err;
-      }
-    }
-  }
-
   @action
   refreshContexts() {
-    this.selectedContexts.clear();
     this.kubeContexts.clear();
 
-    switch (this.sourceTab) {
-      case KubeConfigSourceTab.FILE:
-        const contexts = this.getContexts(this.kubeConfigLocal);
+    try {
+      this.error = "";
+      const contexts = this.getContexts(loadConfig(this.customConfig || "{}"));
 
-        this.kubeContexts.replace(contexts);
-        break;
-      case KubeConfigSourceTab.TEXT:
-        try {
-          this.error = "";
-          const contexts = this.getContexts(loadConfig(this.customConfig || "{}"));
+      console.log(contexts);
 
-          this.kubeContexts.replace(contexts);
-        } catch (err) {
-          this.error = String(err);
-        }
-        break;
-    }
-
-    if (this.kubeContexts.size === 1) {
-      this.selectedContexts.push(this.kubeContexts.keys().next().value);
+      this.kubeContexts.replace(contexts);
+    } catch (err) {
+      this.error = String(err);
     }
   }
 
@@ -112,36 +63,14 @@ export class AddCluster extends React.Component {
     return contexts;
   }
 
-  selectKubeConfigDialog = async () => {
-    const { dialog, BrowserWindow } = remote;
-    const { canceled, filePaths } = await dialog.showOpenDialog(BrowserWindow.getFocusedWindow(), {
-      defaultPath: this.kubeConfigPath,
-      properties: ["openFile", "showHiddenFiles"],
-      message: `Select custom kubeconfig file`,
-      buttonLabel: `Use configuration`,
-    });
-
-    if (!canceled && filePaths.length) {
-      this.setKubeConfig(filePaths[0]);
-    }
-  };
-
-  onDropKubeConfig = (files: File[]) => {
-    this.sourceTab = KubeConfigSourceTab.FILE;
-    this.setKubeConfig(files[0].path);
-  };
-
   @action
   addClusters = (): void => {
     try {
-      if (!this.selectedContexts.length) {
-        return void (this.error = "Please select at least one cluster context");
-      }
 
       this.error = "";
       this.isWaiting = true;
       appEventBus.emit({ name: "cluster-add", action: "click" });
-      const newClusters = this.selectedContexts.filter(context => {
+      const newClusters = Array.from(this.kubeContexts.keys()).filter(context => {
         const kubeConfig = this.kubeContexts.get(context);
         const error = validateKubeConfig(kubeConfig, context);
 
@@ -157,9 +86,7 @@ export class AddCluster extends React.Component {
       }).map(context => {
         const clusterId = uuid();
         const kubeConfig = this.kubeContexts.get(context);
-        const kubeConfigPath = this.sourceTab === KubeConfigSourceTab.FILE
-          ? this.kubeConfigPath // save link to original kubeconfig in file-system
-          : ClusterStore.embedCustomKubeConfig(clusterId, kubeConfig); // save in app-files folder
+        const kubeConfigPath = ClusterStore.embedCustomKubeConfig(clusterId, kubeConfig); // save in app-files folder
 
         return {
           id: clusterId,
@@ -193,9 +120,8 @@ export class AddCluster extends React.Component {
   renderInfo() {
     return (
       <p>
-        Add clusters by clicking the <span className="text-primary">Add Cluster</span> button.
-        You&apos;ll need to obtain a working kubeconfig for the cluster you want to add.
-        You can either browse it from the file system or paste it as a text from the clipboard.
+        Paste kubeconfig as a text from the clipboard to the textarea below.
+        If you want to add clusters from kubeconfigs that exists on filesystem, please add those files (or folders) to kubeconfig sync via <a onClick={() => navigate(preferencesURL())}>Preferences</a>.
         Read more about adding clusters <a href={`${docsUrl}/clusters/adding-clusters/`} rel="noreferrer" target="_blank">here</a>.
       </p>
     );
@@ -204,180 +130,66 @@ export class AddCluster extends React.Component {
   renderKubeConfigSource() {
     return (
       <>
-        <Tabs onChange={this.onKubeConfigTabChange}>
-          <Tab
-            value={KubeConfigSourceTab.FILE}
-            label="Select kubeconfig file"
-            active={this.sourceTab == KubeConfigSourceTab.FILE}/>
-          <Tab
-            value={KubeConfigSourceTab.TEXT}
-            label="Paste as text"
-            active={this.sourceTab == KubeConfigSourceTab.TEXT}
+        <div className="flex column">
+          <AceEditor
+            autoFocus
+            showGutter={false}
+            mode="yaml"
+            value={this.customConfig}
+            wrap={true}
+            onChange={value => {
+              this.customConfig = value;
+              this.refreshContexts();
+            }}
           />
-        </Tabs>
-        {this.sourceTab === KubeConfigSourceTab.FILE && (
-          <div>
-            <div className="kube-config-select flex gaps align-center">
-              <Input
-                theme="round-black"
-                className="kube-config-path box grow"
-                value={this.kubeConfigPath}
-                onChange={v => this.kubeConfigPath = v}
-                onBlur={this.onKubeConfigInputBlur}
-              />
-              {this.kubeConfigPath !== kubeConfigDefaultPath && (
-                <Icon
-                  material="settings_backup_restore"
-                  onClick={() => this.setKubeConfig(kubeConfigDefaultPath)}
-                  tooltip="Reset"
-                />
-              )}
-              <Icon
-                material="folder"
-                onClick={this.selectKubeConfigDialog}
-                tooltip="Browse"
-              />
-            </div>
-            <small className="hint">
-              Pro-Tip: you can also drag-n-drop kubeconfig file to this area
-            </small>
-          </div>
-        )}
-        {this.sourceTab === KubeConfigSourceTab.TEXT && (
-          <div className="flex column">
-            <AceEditor
-              autoFocus
-              showGutter={false}
-              mode="yaml"
-              value={this.customConfig}
-              onChange={value => {
-                this.customConfig = value;
-                this.refreshContexts();
-              }}
-            />
-            <small className="hint">
-              Pro-Tip: paste kubeconfig to get available contexts
-            </small>
-          </div>
-        )}
+        </div>
       </>
     );
   }
 
-  renderContextSelector() {
-    const allContexts = Array.from(this.kubeContexts.keys());
-    const placeholder = this.selectedContexts.length > 0
-      ? <>Selected contexts: <b>{this.selectedContexts.length}</b></>
-      : "Select contexts";
-
-    return (
-      <div>
-        <Select
-          id="kubecontext-select" // todo: provide better mapping for integration tests (e.g. data-test-id="..")
-          placeholder={placeholder}
-          controlShouldRenderValue={false}
-          closeMenuOnSelect={false}
-          isOptionSelected={() => false}
-          options={allContexts}
-          formatOptionLabel={this.formatContextLabel}
-          noOptionsMessage={() => `No contexts available or they have been added already`}
-          onChange={({ value: ctx }: SelectOption<string>) => {
-            if (this.selectedContexts.includes(ctx)) {
-              this.selectedContexts.remove(ctx);
-            } else {
-              this.selectedContexts.push(ctx);
-            }
-          }}
-        />
-        {this.selectedContexts.length > 0 && (
-          <small className="hint">
-            <span>Applying contexts:</span>{" "}
-            <code>{this.selectedContexts.join(", ")}</code>
-          </small>
-        )}
-      </div>
-    );
-  }
-
-  onKubeConfigInputBlur = () => {
-    const isChanged = this.kubeConfigPath !== UserStore.getInstance().kubeConfigPath;
-
-    if (isChanged) {
-      this.kubeConfigPath = this.kubeConfigPath.replace("~", os.homedir());
-
-      try {
-        this.setKubeConfig(this.kubeConfigPath, { throwError: true });
-      } catch (err) {
-        this.setKubeConfig(UserStore.getInstance().kubeConfigPath); // revert to previous valid path
-      }
-    }
-  };
-
-  onKubeConfigTabChange = (tabId: KubeConfigSourceTab) => {
-    this.sourceTab = tabId;
-    this.error = "";
-    this.refreshContexts();
-  };
-
-  protected formatContextLabel = ({ value: context }: SelectOption<string>) => {
-    const isNew = UserStore.getInstance().newContexts.has(context);
-    const isSelected = this.selectedContexts.includes(context);
-
-    return (
-      <div className={cssNames("kube-context flex gaps align-center", context)}>
-        <span>{context}</span>
-        {isNew && <Icon small material="fiber_new"/>}
-        {isSelected && <Icon small material="check" className="box right"/>}
-      </div>
-    );
-  };
-
   render() {
-    const submitDisabled = this.selectedContexts.length === 0;
+    const submitDisabled = this.kubeContexts.size === 0;
 
     return (
-      <DropFileInput onDropFiles={this.onDropKubeConfig}>
-        <PageLayout className="AddClusters" showOnTop={true}>
-          <h2>Add Clusters from Kubeconfig</h2>
-          {this.renderInfo()}
-          {this.renderKubeConfigSource()}
-          {this.renderContextSelector()}
-          <div className="cluster-settings">
-            <a href="#" onClick={() => this.showSettings = !this.showSettings}>
-              Proxy settings
-            </a>
-          </div>
-          {this.showSettings && (
-            <div className="proxy-settings">
-              <p>HTTP Proxy server. Used for communicating with Kubernetes API.</p>
-              <Input
-                autoFocus
-                value={this.proxyServer}
-                onChange={value => this.proxyServer = value}
-                theme="round-black"
-              />
-              <small className="hint">
-                {"A HTTP proxy server URL (format: http://<address>:<port>)."}
-              </small>
-            </div>
-          )}
-          {this.error && (
-            <div className="error">{this.error}</div>
-          )}
-
-          <div className="actions-panel">
-            <Button
-              primary
-              disabled={submitDisabled}
-              label={this.selectedContexts.length < 2 ? "Add cluster" : "Add clusters"}
-              onClick={this.addClusters}
-              waiting={this.isWaiting}
-              tooltip={submitDisabled ? "Select at least one cluster to add." : undefined}
-              tooltipOverrideDisabled
+      <PageLayout className="AddClusters" showOnTop={true}>
+        <h2>Add Clusters from Kubeconfig</h2>
+        {this.renderInfo()}
+        {this.renderKubeConfigSource()}
+        <div className="cluster-settings">
+          <a href="#" onClick={() => this.showSettings = !this.showSettings}>
+            Proxy settings
+          </a>
+        </div>
+        {this.showSettings && (
+          <div className="proxy-settings">
+            <p>HTTP Proxy server. Used for communicating with Kubernetes API.</p>
+            <Input
+              autoFocus
+              value={this.proxyServer}
+              onChange={value => this.proxyServer = value}
+              theme="round-black"
             />
+            <small className="hint">
+              {"A HTTP proxy server URL (format: http://<address>:<port>)."}
+            </small>
           </div>
-        </PageLayout>
-      </DropFileInput>
+        )}
+        {this.error && (
+          <div className="error">{this.error}</div>
+        )}
+
+        <div className="actions-panel">
+          <Button
+            primary
+            disabled={submitDisabled}
+            label={this.kubeContexts.keys.length < 2 ? "Add cluster" : "Add clusters"}
+            onClick={this.addClusters}
+            waiting={this.isWaiting}
+            tooltip={submitDisabled ? "Paste a valid kubeconfig." : undefined}
+            tooltipOverrideDisabled
+          />
+        </div>
+      </PageLayout>
     );
   }
 }

src/renderer/components/cluster-settings/cluster-settings.tsx

@@ -13,13 +13,7 @@ import { CatalogEntity } from "../../api/catalog-entity";
 
 
 function getClusterForEntity(entity: CatalogEntity) {
-  const cluster = ClusterStore.getInstance().getById(entity.metadata.uid);
-
-  if (!cluster?.enabled) {
-    return null;
-  }
-
-  return cluster;
+  return ClusterStore.getInstance().getById(entity.metadata.uid);
 }
 
 entitySettingRegistry.add([

src/renderer/components/cluster-settings/components/remove-cluster-button.tsx

@@ -27,10 +27,8 @@ export class RemoveClusterButton extends React.Component<Props> {
   }
 
   render() {
-    const { cluster } = this.props;
-
     return (
-      <Button accent onClick={this.confirmRemoveCluster} className="button-area" disabled={cluster.isManaged}>
+      <Button accent onClick={this.confirmRemoveCluster} className="button-area">
         Remove Cluster
       </Button>
     );

src/renderer/components/layout/__test__/main-layout-header.test.tsx

@@ -7,20 +7,50 @@ import "@testing-library/jest-dom/extend-expect";
 import { MainLayoutHeader } from "../main-layout-header";
 import { Cluster } from "../../../../main/cluster";
 import { ClusterStore } from "../../../../common/cluster-store";
-
-const cluster: Cluster = new Cluster({
-  id: "foo",
-  contextName: "minikube",
-  kubeConfigPath: "minikube-config.yml",
-});
+import mockFs from "mock-fs";
 
 describe("<MainLayoutHeader />", () => {
+  let cluster: Cluster;
+
   beforeEach(() => {
+    const mockOpts = {
+      "minikube-config.yml": JSON.stringify({
+        apiVersion: "v1",
+        clusters: [{
+          name: "minikube",
+          cluster: {
+            server: "https://192.168.64.3:8443",
+          },
+        }],
+        contexts: [{
+          context: {
+            cluster: "minikube",
+            user: "minikube",
+          },
+          name: "minikube",
+        }],
+        users: [{
+          name: "minikube",
+        }],
+        kind: "Config",
+        preferences: {},
+      })
+    };
+
+    mockFs(mockOpts);
+
     ClusterStore.createInstance();
+
+    cluster = new Cluster({
+      id: "foo",
+      contextName: "minikube",
+      kubeConfigPath: "minikube-config.yml",
+    });
   });
 
   afterEach(() => {
     ClusterStore.resetInstance();
+    mockFs.restore();
   });
 
   it("renders w/o errors", () => {