Cascade different refactorings to eliminate global shared state from app paths

Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com>

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

src/main/shell-session/create-shell-session.injectable.ts

@@ -0,0 +1,45 @@
+/**
+ * Copyright (c) 2021 OpenLens Authors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
+import type { Cluster } from "../../common/cluster/cluster";
+import type WebSocket from "ws";
+import localShellSessionInjectable from "./local-shell-session/local-shell-session.injectable";
+import nodeShellSessionInjectable from "./node-shell-session/node-shell-session.injectable";
+
+interface Args {
+  webSocket: WebSocket;
+  cluster: Cluster;
+  tabId: string;
+  nodeName?: string;
+}
+
+const createShellSessionInjectable = getInjectable({
+  instantiate:
+    (di) =>
+      ({ nodeName, ...rest }: Args) =>
+        !nodeName
+          ? di.inject(localShellSessionInjectable, rest)
+          : di.inject(nodeShellSessionInjectable, { nodeName, ...rest }),
+
+  lifecycle: lifecycleEnum.singleton,
+});
+
+export default createShellSessionInjectable;

src/main/shell-session/index.ts

@@ -19,5 +19,5 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-export * from "./node-shell-session";
-export * from "./local-shell-session";
+export * from "./node-shell-session/node-shell-session";
+export * from "./local-shell-session/local-shell-session";

src/main/shell-session/local-shell-session/local-shell-session.injectable.ts

@@ -0,0 +1,45 @@
+/**
+ * Copyright (c) 2021 OpenLens Authors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
+import { LocalShellSession } from "./local-shell-session";
+import type { Cluster } from "../../../common/cluster/cluster";
+import type WebSocket from "ws";
+import createKubectlInjectable from "../../kubectl/create-kubectl.injectable";
+
+interface InstantiationParameter {
+  webSocket: WebSocket;
+  cluster: Cluster;
+  tabId: string;
+}
+
+const localShellSessionInjectable = getInjectable({
+  instantiate: (di, { cluster, tabId, webSocket }: InstantiationParameter) => {
+    const createKubectl = di.inject(createKubectlInjectable);
+
+    const kubectl = createKubectl(cluster.version);
+
+    return new LocalShellSession(kubectl, webSocket, cluster, tabId);
+  },
+
+  lifecycle: lifecycleEnum.transient,
+});
+
+export default localShellSessionInjectable;

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

@@ -20,9 +20,9 @@
  */
 
 import path from "path";
-import { helmCli } from "../helm/helm-cli";
-import { UserStore } from "../../common/user-store";
-import { ShellSession } from "./shell-session";
+import { helmCli } from "../../helm/helm-cli";
+import { UserStore } from "../../../common/user-store";
+import { ShellSession } from "../shell-session";
 
 export class LocalShellSession extends ShellSession {
   ShellType = "shell";

src/main/shell-session/node-shell-session/node-shell-session.injectable.ts

@@ -0,0 +1,46 @@
+/**
+ * Copyright (c) 2021 OpenLens Authors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
+import type { Cluster } from "../../../common/cluster/cluster";
+import type WebSocket from "ws";
+import createKubectlInjectable from "../../kubectl/create-kubectl.injectable";
+import { NodeShellSession } from "./node-shell-session";
+
+interface InstantiationParameter {
+  webSocket: WebSocket;
+  cluster: Cluster;
+  tabId: string;
+  nodeName: string;
+}
+
+const nodeShellSessionInjectable = getInjectable({
+  instantiate: (di, { cluster, tabId, webSocket, nodeName }: InstantiationParameter) => {
+    const createKubectl = di.inject(createKubectlInjectable);
+
+    const kubectl = createKubectl(cluster.version);
+
+    return new NodeShellSession(nodeName, kubectl, webSocket, cluster, tabId);
+  },
+
+  lifecycle: lifecycleEnum.transient,
+});
+
+export default nodeShellSessionInjectable;

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

@@ -23,13 +23,14 @@ import type WebSocket from "ws";
 import { v4 as uuid } from "uuid";
 import * as k8s from "@kubernetes/client-node";
 import type { KubeConfig } from "@kubernetes/client-node";
-import type { Cluster } from "../cluster";
-import { ShellOpenError, ShellSession } from "./shell-session";
+import type { Cluster } from "../../../common/cluster/cluster";
+import { ShellOpenError, ShellSession } from "../shell-session";
 import { get } from "lodash";
-import { Node, NodesApi } from "../../common/k8s-api/endpoints";
-import { KubeJsonApi } from "../../common/k8s-api/kube-json-api";
-import logger from "../logger";
-import { TerminalChannels } from "../../renderer/api/terminal-api";
+import { Node, NodesApi } from "../../../common/k8s-api/endpoints";
+import { KubeJsonApi } from "../../../common/k8s-api/kube-json-api";
+import logger from "../../logger";
+import { TerminalChannels } from "../../../renderer/api/terminal-api";
+import type { Kubectl } from "../../kubectl/kubectl";
 
 export class NodeShellSession extends ShellSession {
   ShellType = "node-shell";
@@ -39,8 +40,8 @@ export class NodeShellSession extends ShellSession {
 
   protected readonly cwd: string | undefined = undefined;
 
-  constructor(socket: WebSocket, cluster: Cluster, protected nodeName: string, terminalId: string) {
-    super(socket, cluster, terminalId);
+  constructor(protected nodeName: string, kubectl: Kubectl, socket: WebSocket, cluster: Cluster, terminalId: string) {
+    super(kubectl, socket, cluster, terminalId);
   }
 
   public async open() {

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

@@ -19,8 +19,8 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-import type { Cluster } from "../cluster";
-import { Kubectl } from "../kubectl";
+import type { Cluster } from "../../common/cluster/cluster";
+import type { Kubectl } from "../kubectl/kubectl";
 import type WebSocket from "ws";
 import { shellEnv } from "../utils/shell-env";
 import { app } from "electron";
@@ -30,7 +30,7 @@ import os from "os";
 import { isMac, isWindows } from "../../common/vars";
 import { UserStore } from "../../common/user-store";
 import * as pty from "node-pty";
-import { appEventBus } from "../../common/event-bus";
+import { appEventBus } from "../../common/app-event-bus/event-bus";
 import logger from "../logger";
 import { TerminalChannels, TerminalMessage } from "../../renderer/api/terminal-api";
 import { deserialize, serialize } from "v8";
@@ -140,7 +140,6 @@ export abstract class ShellSession {
     this.processes.clear();
   }
 
-  protected kubectl: Kubectl;
   protected running = false;
   protected kubectlBinDirP: Promise<string>;
   protected kubeconfigPathP: Promise<string>;
@@ -170,8 +169,7 @@ export abstract class ShellSession {
     return { shellProcess, resume };
   }
 
-  constructor(protected websocket: WebSocket, protected cluster: Cluster, terminalId: string) {
-    this.kubectl = new Kubectl(cluster.version);
+  constructor(protected kubectl: Kubectl, protected websocket: WebSocket, protected cluster: Cluster, terminalId: string) {
     this.kubeconfigPathP = this.cluster.getProxyKubeconfigPath();
     this.kubectlBinDirP = this.kubectl.binDir();
     this.terminalId = `${cluster.id}:${terminalId}`;