Restructure to monorepo (#6907)

* wip: restructure to monorepo

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* refactor create-release-pr to a package

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* build fixes

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* github workflow fixes

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix typo

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* add webpack-env types to core

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix github workflows

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* refactor/fix integration tests

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* lint fix

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* yarn run dev

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* eslint settings for vscode

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* move templates to right package

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* open-lens build fixes

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* integration test fix

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix nx task dependencies

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* use bash shell for unit tests in test workflow

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix test:unit for windows

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix win-ca webpack error in open-lens

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix win-ca webpack error in open-lens

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* fix build:app on windows

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* remove ELECTRON_BUILDER_EXTRA_ARGS

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* sync src/ from master

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

* remove Makefile from core

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>

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

@@ -0,0 +1,71 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import type { UserStore } from "../../../common/user-store";
+import type { ShellSessionArgs, ShellSessionDependencies } from "../shell-session";
+import { ShellSession } from "../shell-session";
+import type { ModifyTerminalShellEnv } from "../shell-env-modifier/modify-terminal-shell-env.injectable";
+import type { JoinPaths } from "../../../common/path/join-paths.injectable";
+import type { GetDirnameOfPath } from "../../../common/path/get-dirname.injectable";
+import type { GetBasenameOfPath } from "../../../common/path/get-basename.injectable";
+
+export interface LocalShellSessionDependencies extends ShellSessionDependencies {
+  readonly directoryForBinaries: string;
+  readonly userStore: UserStore;
+  modifyTerminalShellEnv: ModifyTerminalShellEnv;
+  joinPaths: JoinPaths;
+  getDirnameOfPath: GetDirnameOfPath;
+  getBasenameOfPath: GetBasenameOfPath;
+}
+
+export class LocalShellSession extends ShellSession {
+  ShellType = "shell";
+
+  constructor(protected readonly dependencies: LocalShellSessionDependencies, args: ShellSessionArgs) {
+    super(dependencies, args);
+  }
+
+  protected getPathEntries(): string[] {
+    return [this.dependencies.directoryForBinaries];
+  }
+
+  protected get cwd(): string | undefined {
+    return this.cluster.preferences?.terminalCWD;
+  }
+
+  public async open() {
+    // extensions can modify the env
+    const env = this.dependencies.modifyTerminalShellEnv(this.cluster.id, await this.getCachedShellEnv());
+    const shell = env.PTYSHELL;
+
+    if (!shell) {
+      throw new Error("PTYSHELL is not defined with the environment");
+    }
+
+    const args = await this.getShellArgs(shell);
+
+    await this.openShellProcess(shell, args, env);
+  }
+
+  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.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")];
+      case "fish":
+        return ["--login", "--init-command", `export PATH="${kubectlPathDir}:${this.dependencies.directoryForBinaries}:$PATH"; export KUBECONFIG="${await this.kubeconfigPathP}"`];
+      case "zsh":
+        return ["--login"];
+      default:
+        return [];
+    }
+  }
+}

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

@@ -0,0 +1,69 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable } from "@ogre-tools/injectable";
+import type { LocalShellSessionDependencies } from "./local-shell-session";
+import { LocalShellSession } from "./local-shell-session";
+import createKubectlInjectable from "../../kubectl/create-kubectl.injectable";
+import modifyTerminalShellEnvInjectable from "../shell-env-modifier/modify-terminal-shell-env.injectable";
+import directoryForBinariesInjectable from "../../../common/app-paths/directory-for-binaries/directory-for-binaries.injectable";
+import isMacInjectable from "../../../common/vars/is-mac.injectable";
+import type { Cluster } from "../../../common/cluster/cluster";
+import isWindowsInjectable from "../../../common/vars/is-windows.injectable";
+import loggerInjectable from "../../../common/logger.injectable";
+import userStoreInjectable from "../../../common/user-store/user-store.injectable";
+import type WebSocket from "ws";
+import getDirnameOfPathInjectable from "../../../common/path/get-dirname.injectable";
+import joinPathsInjectable from "../../../common/path/join-paths.injectable";
+import getBasenameOfPathInjectable from "../../../common/path/get-basename.injectable";
+import computeShellEnvironmentInjectable from "../../../features/shell-sync/main/compute-shell-environment.injectable";
+import spawnPtyInjectable from "../spawn-pty.injectable";
+import userShellSettingInjectable from "../../../common/user-store/shell-setting.injectable";
+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";
+
+export interface OpenLocalShellSessionArgs {
+  websocket: WebSocket;
+  cluster: Cluster;
+  tabId: string;
+}
+
+export type OpenLocalShellSession = (args: OpenLocalShellSessionArgs) => Promise<void>;
+
+const openLocalShellSessionInjectable = getInjectable({
+  id: "open-local-shell-session",
+
+  instantiate: (di): OpenLocalShellSession => {
+    const createKubectl = di.inject(createKubectlInjectable);
+    const dependencies: LocalShellSessionDependencies = {
+      directoryForBinaries: di.inject(directoryForBinariesInjectable),
+      isMac: di.inject(isMacInjectable),
+      isWindows: di.inject(isWindowsInjectable),
+      logger: di.inject(loggerInjectable),
+      userStore: di.inject(userStoreInjectable),
+      userShellSetting: di.inject(userShellSettingInjectable),
+      appName: di.inject(appNameInjectable),
+      buildVersion: di.inject(buildVersionInjectable),
+      modifyTerminalShellEnv: di.inject(modifyTerminalShellEnvInjectable),
+      emitAppEvent: di.inject(emitAppEventInjectable),
+      getDirnameOfPath: di.inject(getDirnameOfPathInjectable),
+      joinPaths: di.inject(joinPathsInjectable),
+      getBasenameOfPath: di.inject(getBasenameOfPathInjectable),
+      computeShellEnvironment: di.inject(computeShellEnvironmentInjectable),
+      spawnPty: di.inject(spawnPtyInjectable),
+      stat: di.inject(statInjectable),
+    };
+
+    return (args) => {
+      const kubectl = createKubectl(args.cluster.version);
+      const session = new LocalShellSession(dependencies, { kubectl, ...args });
+
+      return session.open();
+    };
+  },
+});
+
+export default openLocalShellSessionInjectable;

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

@@ -0,0 +1,105 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import type { DiContainer } from "@ogre-tools/injectable";
+import type WebSocket from "ws";
+import directoryForUserDataInjectable from "../../../common/app-paths/directory-for-user-data/directory-for-user-data.injectable";
+import type { 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";
+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 createKubectlInjectable from "../../kubectl/create-kubectl.injectable";
+import type { Kubectl } from "../../kubectl/kubectl";
+import buildVersionInjectable from "../../vars/build-version/build-version.injectable";
+import type { OpenShellSession } from "../create-shell-session.injectable";
+import type { SpawnPty } from "../spawn-pty.injectable";
+import spawnPtyInjectable from "../spawn-pty.injectable";
+import openLocalShellSessionInjectable from "./open.injectable";
+
+describe("technical unit tests for local shell sessions", () => {
+  let di: DiContainer;
+
+  beforeEach(() => {
+    di = getDiForUnitTesting({
+      doGeneralOverrides: true,
+    });
+
+    di.override(directoryForUserDataInjectable, () => "/some-directory-for-user-data");
+    di.override(buildVersionInjectable, () => ({
+      get: () => "1.1.1",
+    }));
+    di.override(pathExistsInjectable, () => () => { throw new Error("tried call pathExists without override"); });
+    di.override(pathExistsSyncInjectable, () => () => { throw new Error("tried call pathExistsSync without override"); });
+    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"); });
+  });
+
+  describe("when on windows", () => {
+    let openLocalShellSession: OpenShellSession;
+    let spawnPtyMock: jest.MockedFunction<SpawnPty>;
+
+    beforeEach(() => {
+      di.override(platformInjectable, () => "win32");
+
+      spawnPtyMock = jest.fn();
+      di.override(spawnPtyInjectable, () => spawnPtyMock);
+
+      di.override(createKubectlInjectable, () => () => ({
+        binDir: async () => "/some-kubectl-binary-dir",
+        getBundledPath: () => "/some-bundled-kubectl-path",
+      }) as Partial<Kubectl> as Kubectl);
+
+      openLocalShellSession = di.inject(openLocalShellSessionInjectable);
+    });
+
+    describe("when opening a local shell session", () => {
+      it("should pass through all environment variables to shell", async () => {
+        process.env.MY_TEST_ENV_VAR = "true";
+
+        spawnPtyMock.mockImplementationOnce((file, args, options) => {
+          expect(options.env).toMatchObject({
+            MY_TEST_ENV_VAR: "true",
+          });
+
+          return {
+            cols: 80,
+            rows: 40,
+            pid: 12343,
+            handleFlowControl: false,
+            kill: jest.fn(),
+            onData: jest.fn(),
+            onExit: jest.fn(),
+            pause: jest.fn(),
+            process: "my-pty",
+            resize: jest.fn(),
+            resume: jest.fn(),
+            write: jest.fn(),
+            on: jest.fn(),
+
+          };
+        });
+
+        const websocket = {
+          on: jest.fn(() => websocket),
+          once: jest.fn(() => websocket),
+        } as Partial<WebSocket> as WebSocket;
+
+        await openLocalShellSession({
+          cluster: {
+            getProxyKubeconfigPath: async () => "/some-proxy-kubeconfig",
+            preferences: {},
+          } as Partial<Cluster> as Cluster,
+          tabId: "my-tab-id",
+          websocket,
+        });
+      });
+    });
+  });
+});