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/proxy-functions/index.ts

@@ -18,7 +18,5 @@
  * 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.
  */
-
-export * from "./shell-api-request";
 export * from "./kube-api-request";
 export * from "./types";

src/main/proxy-functions/shell-api-request/shell-api-request.injectable.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 { shellApiRequest } from "./shell-api-request";
+import createShellSessionInjectable from "../../shell-session/create-shell-session.injectable";
+import shellRequestAuthenticatorInjectable
+  from "./shell-request-authenticator/shell-request-authenticator.injectable";
+
+const shellApiRequestInjectable = getInjectable({
+  instantiate: (di) => shellApiRequest({
+    createShellSession: di.inject(createShellSessionInjectable),
+    authenticateRequest: di.inject(shellRequestAuthenticatorInjectable).authenticate,
+  }),
+
+  lifecycle: lifecycleEnum.singleton,
+});
+
+export default shellApiRequestInjectable;

src/main/proxy-functions/shell-api-request/shell-api-request.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 logger from "../../logger";
+import WebSocket, { Server as WebSocketServer } from "ws";
+import type { ProxyApiRequestArgs } from "../types";
+import { ClusterManager } from "../../cluster-manager";
+import URLParse from "url-parse";
+import type { Cluster } from "../../../common/cluster/cluster";
+import type { ClusterId } from "../../../common/cluster-types";
+
+interface Dependencies {
+  authenticateRequest: (clusterId: ClusterId, tabId: string, shellToken: string) => boolean,
+
+  createShellSession: (args: {
+    webSocket: WebSocket;
+    cluster: Cluster;
+    tabId: string;
+    nodeName?: string;
+  }) => { open: () => Promise<void> };
+}
+
+export const shellApiRequest = ({ createShellSession, authenticateRequest }: Dependencies) => ({ req, socket, head }: ProxyApiRequestArgs): void => {
+  const cluster = ClusterManager.getInstance().getClusterForRequest(req);
+  const { query: { node: nodeName, shellToken, id: tabId }} = new URLParse(req.url, true);
+
+  if (!cluster || !authenticateRequest(cluster.id, tabId, shellToken)) {
+    socket.write("Invalid shell request");
+
+    return void socket.end();
+  }
+
+  const ws = new WebSocketServer({ noServer: true });
+
+  ws.handleUpgrade(req, socket, head, (webSocket) => {
+    const shell = createShellSession({ webSocket, cluster, tabId, nodeName });
+
+    shell.open()
+      .catch(error => logger.error(`[SHELL-SESSION]: failed to open a ${nodeName ? "node" : "local"} shell`, error));
+  });
+};

src/main/proxy-functions/shell-api-request/shell-request-authenticator/shell-request-authenticator.injectable.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 { ShellRequestAuthenticator } from "./shell-request-authenticator";
+
+const shellRequestAuthenticatorInjectable = getInjectable({
+  instantiate: () => {
+    const authenticator = new ShellRequestAuthenticator();
+
+    authenticator.init();
+
+    return authenticator;
+  },
+  lifecycle: lifecycleEnum.singleton,
+});
+
+export default shellRequestAuthenticatorInjectable;

src/main/proxy-functions/shell-api-request/shell-request-authenticator/shell-request-authenticator.ts

@@ -18,22 +18,15 @@
  * 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 logger from "../logger";
-import { Server as WebSocketServer } from "ws";
-import { NodeShellSession, LocalShellSession } from "../shell-session";
-import type { ProxyApiRequestArgs } from "./types";
-import { ClusterManager } from "../cluster-manager";
-import URLParse from "url-parse";
-import { ExtendedMap, Singleton } from "../../common/utils";
-import type { ClusterId } from "../../common/cluster-types";
-import { ipcMainHandle } from "../../common/ipc";
+import { ExtendedMap } from "../../../../common/utils";
+import type { ClusterId } from "../../../../common/cluster-types";
+import { ipcMainHandle } from "../../../../common/ipc";
 import crypto from "crypto";
 import { promisify } from "util";
 
 const randomBytes = promisify(crypto.randomBytes);
 
-export class ShellRequestAuthenticator extends Singleton {
+export class ShellRequestAuthenticator {
   private tokens = new ExtendedMap<ClusterId, Map<string, Uint8Array>>();
 
   init() {
@@ -75,25 +68,3 @@ export class ShellRequestAuthenticator extends Singleton {
     return false;
   }
 }
-
-export function shellApiRequest({ req, socket, head }: ProxyApiRequestArgs): void {
-  const cluster = ClusterManager.getInstance().getClusterForRequest(req);
-  const { query: { node, shellToken, id: tabId }} = new URLParse(req.url, true);
-
-  if (!cluster || !ShellRequestAuthenticator.getInstance().authenticate(cluster.id, tabId, shellToken)) {
-    socket.write("Invalid shell request");
-
-    return void socket.end();
-  }
-
-  const ws = new WebSocketServer({ noServer: true });
-
-  ws.handleUpgrade(req, socket, head, (webSocket) => {
-    const shell = node
-      ? new NodeShellSession(webSocket, cluster, node, tabId)
-      : new LocalShellSession(webSocket, cluster, tabId);
-
-    shell.open()
-      .catch(error => logger.error(`[SHELL-SESSION]: failed to open a ${node ? "node" : "local"} shell`, error));
-  });
-}

src/main/proxy-functions/types.ts

@@ -21,7 +21,7 @@
 
 import type http from "http";
 import type net from "net";
-import type { Cluster } from "../cluster";
+import type { Cluster } from "../../common/cluster/cluster";
 
 export interface ProxyApiRequestArgs {
   req: http.IncomingMessage,