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>
2025-05-20 05:10:56 +00:00 · 2023-01-24 10:46:26 -08:00
1 parent 0066ca4ea2
commit 2657df2293
@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type { PathName } from "./app-path-names";
+
+export type AppPaths = Record<PathName, string>;
@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type { app as electronApp } from "electron";
+
+export type PathName = Parameters<typeof electronApp["getPath"]>[0] | "currentApp";
+
+export const pathNames: PathName[] = [
+  "currentApp",
+  "home",
+  "appData",
+  "userData",
+  "cache",
+  "temp",
+  "exe",
+  "module",
+  "desktop",
+  "documents",
+  "downloads",
+  "music",
+  "pictures",
+  "videos",
+  "logs",
+  "crashDumps",
+  "recent",
+];
@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type { AppPaths } from "./app-path-injection-token";
+import type { RequestChannel } from "../utils/channel/request-channel-listener-injection-token";
+
+export type AppPathsChannel = RequestChannel<void, AppPaths>;
+
+export const appPathsChannel: AppPathsChannel = {
+  id: "app-paths",
+};
+
@@ -0,0 +1,34 @@
+/**
+ * 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 { AppPaths } from "./app-path-injection-token";
+
+const appPathsStateInjectable = getInjectable({
+  id: "app-paths-state",
+
+  instantiate: () => {
+    let state: AppPaths;
+
+    return {
+      get: () =>{
+        if (!state) {
+          throw new Error("Tried to get app paths before state is setupped.");
+        }
+
+        return state;
+      },
+
+      set: (newState: AppPaths) => {
+        if (state) {
+          throw new Error("Tried to overwrite existing state of app paths.");
+        }
+
+        state = newState;
+      },
+    };
+  },
+});
+
+export default appPathsStateInjectable;
@@ -0,0 +1,13 @@
+/**
+ * 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 appPathsStateInjectable from "./app-paths-state.injectable";
+
+const appPathsInjectable = getInjectable({
+  id: "app-paths",
+  instantiate: (di) => di.inject(appPathsStateInjectable).get(),
+});
+
+export default appPathsInjectable;
@@ -0,0 +1,153 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type { AppPaths } from "./app-path-injection-token";
+import getElectronAppPathInjectable from "../../main/app-paths/get-electron-app-path/get-electron-app-path.injectable";
+import type { PathName } from "./app-path-names";
+import setElectronAppPathInjectable from "../../main/app-paths/set-electron-app-path/set-electron-app-path.injectable";
+import directoryForIntegrationTestingInjectable from "../../main/app-paths/directory-for-integration-testing/directory-for-integration-testing.injectable";
+import type { ApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
+import { getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
+import type { DiContainer } from "@ogre-tools/injectable";
+import appPathsInjectable from "./app-paths.injectable";
+
+describe("app-paths", () => {
+  let builder: ApplicationBuilder;
+
+  beforeEach(() => {
+    builder = getApplicationBuilder();
+
+    const defaultAppPathsStub: AppPaths = {
+      currentApp: "/some-current-app",
+      appData: "/some-app-data",
+      cache: "/some-cache",
+      crashDumps: "/some-crash-dumps",
+      desktop: "/some-desktop",
+      documents: "/some-documents",
+      downloads: "/some-downloads",
+      exe: "/some-exe",
+      home: "/some-home-path",
+      logs: "/some-logs",
+      module: "/some-module",
+      music: "/some-music",
+      pictures: "/some-pictures",
+      recent: "/some-recent",
+      temp: "/some-temp",
+      videos: "/some-videos",
+      userData: "/some-irrelevant-user-data",
+    };
+
+    builder.beforeApplicationStart((mainDi) => {
+      mainDi.override(
+        getElectronAppPathInjectable,
+        () =>
+          (key: PathName): string | null =>
+            defaultAppPathsStub[key],
+      );
+
+      mainDi.override(
+        setElectronAppPathInjectable,
+        () =>
+          (key: PathName, path: string): void => {
+            defaultAppPathsStub[key] = path;
+          },
+      );
+    });
+  });
+
+  describe("normally", () => {
+    let windowDi: DiContainer;
+    let mainDi: DiContainer;
+
+    beforeEach(async () => {
+      await builder.render();
+
+      windowDi = builder.applicationWindow.only.di;
+      mainDi = builder.mainDi;
+    });
+
+    it("given in renderer, when injecting app paths, returns application specific app paths", () => {
+      const actual = windowDi.inject(appPathsInjectable);
+
+      expect(actual).toEqual({
+        currentApp: "/some-current-app",
+        appData: "/some-app-data",
+        cache: "/some-cache",
+        crashDumps: "/some-crash-dumps",
+        desktop: "/some-desktop",
+        documents: "/some-documents",
+        downloads: "/some-downloads",
+        exe: "/some-exe",
+        home: "/some-home-path",
+        logs: "/some-logs",
+        module: "/some-module",
+        music: "/some-music",
+        pictures: "/some-pictures",
+        recent: "/some-recent",
+        temp: "/some-temp",
+        videos: "/some-videos",
+        userData: "/some-app-data/some-product-name",
+      });
+    });
+
+    it("given in main, when injecting app paths, returns application specific app paths", () => {
+      const actual = mainDi.inject(appPathsInjectable);
+
+      expect(actual).toEqual({
+        currentApp: "/some-current-app",
+        appData: "/some-app-data",
+        cache: "/some-cache",
+        crashDumps: "/some-crash-dumps",
+        desktop: "/some-desktop",
+        documents: "/some-documents",
+        downloads: "/some-downloads",
+        exe: "/some-exe",
+        home: "/some-home-path",
+        logs: "/some-logs",
+        module: "/some-module",
+        music: "/some-music",
+        pictures: "/some-pictures",
+        recent: "/some-recent",
+        temp: "/some-temp",
+        videos: "/some-videos",
+        userData: "/some-app-data/some-product-name",
+      });
+    });
+  });
+
+  describe("when running integration tests", () => {
+    let windowDi: DiContainer;
+
+    beforeEach(async () => {
+      builder.beforeApplicationStart((mainDi) => {
+        mainDi.override(
+          directoryForIntegrationTestingInjectable,
+          () => "/some-integration-testing-app-data",
+        );
+      });
+
+      await builder.render();
+
+      windowDi = builder.applicationWindow.only.di;
+    });
+
+    it("given in renderer, when injecting path for app data, has integration specific app data path", () => {
+      const { appData, userData } = windowDi.inject(appPathsInjectable);
+
+      expect({ appData, userData }).toEqual({
+        appData: "/some-integration-testing-app-data",
+        userData: "/some-integration-testing-app-data/some-product-name",
+      });
+    });
+
+    it("given in main, when injecting path for app data, has integration specific app data path", () => {
+      const { appData, userData } = windowDi.inject(appPathsInjectable);
+
+      expect({ appData, userData }).toEqual({
+        appData: "/some-integration-testing-app-data",
+        userData: "/some-integration-testing-app-data/some-product-name",
+      });
+    });
+  });
+});
@@ -0,0 +1,20 @@
+/**
+ * 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 directoryForUserDataInjectable from "../directory-for-user-data/directory-for-user-data.injectable";
+import joinPathsInjectable from "../../path/join-paths.injectable";
+
+const directoryForBinariesInjectable = getInjectable({
+  id: "directory-for-binaries",
+
+  instantiate: (di) => {
+    const joinPaths = di.inject(joinPathsInjectable);
+    const directoryForUserData = di.inject(directoryForUserDataInjectable);
+
+    return joinPaths(directoryForUserData, "binaries");
+  },
+});
+
+export default directoryForBinariesInjectable;
@@ -0,0 +1,13 @@
+/**
+ * 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 appPathsInjectable from "../app-paths.injectable";
+
+const directoryForDownloadsInjectable = getInjectable({
+  id: "directory-for-downloads",
+  instantiate: (di) => di.inject(appPathsInjectable).downloads,
+});
+
+export default directoryForDownloadsInjectable;
@@ -0,0 +1,13 @@
+/**
+ * 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 appPathsInjectable from "../app-paths.injectable";
+
+const directoryForExesInjectable = getInjectable({
+  id: "directory-for-exes",
+  instantiate: (di) => di.inject(appPathsInjectable).exe,
+});
+
+export default directoryForExesInjectable;
@@ -0,0 +1,20 @@
+/**
+ * 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 directoryForUserDataInjectable from "../directory-for-user-data/directory-for-user-data.injectable";
+import joinPathsInjectable from "../../path/join-paths.injectable";
+
+const directoryForKubeConfigsInjectable = getInjectable({
+  id: "directory-for-kube-configs",
+
+  instantiate: (di) => {
+    const joinPaths = di.inject(joinPathsInjectable);
+    const directoryForUserData = di.inject(directoryForUserDataInjectable);
+
+    return joinPaths(directoryForUserData, "kubeconfigs");
+  },
+});
+
+export default directoryForKubeConfigsInjectable;
@@ -0,0 +1,20 @@
+/**
+ * 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 directoryForBinariesInjectable from "../directory-for-binaries/directory-for-binaries.injectable";
+import joinPathsInjectable from "../../path/join-paths.injectable";
+
+const directoryForKubectlBinariesInjectable = getInjectable({
+  id: "directory-for-kubectl-binaries",
+
+  instantiate: (di) => {
+    const joinPaths = di.inject(joinPathsInjectable);
+    const directoryForBinaries = di.inject(directoryForBinariesInjectable);
+
+    return joinPaths(directoryForBinaries, "kubectl");
+  },
+});
+
+export default directoryForKubectlBinariesInjectable;
@@ -0,0 +1,13 @@
+/**
+ * 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 appPathsInjectable from "./app-paths.injectable";
+
+const directoryForLogsInjectable = getInjectable({
+  id: "directory-for-logs",
+  instantiate: (di) => di.inject(appPathsInjectable).logs,
+});
+
+export default directoryForLogsInjectable;
@@ -0,0 +1,13 @@
+/**
+ * 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 appPathsInjectable from "../app-paths.injectable";
+
+const directoryForTempInjectable = getInjectable({
+  id: "directory-for-temp",
+  instantiate: (di) => di.inject(appPathsInjectable).temp,
+});
+
+export default directoryForTempInjectable;
@@ -0,0 +1,13 @@
+/**
+ * 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 appPathsInjectable from "../app-paths.injectable";
+
+const directoryForUserDataInjectable = getInjectable({
+  id: "directory-for-user-data",
+  instantiate: (di) => di.inject(appPathsInjectable).userData,
+});
+
+export default directoryForUserDataInjectable;
@@ -0,0 +1,22 @@
+/**
+ * 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 directoryForKubeConfigsInjectable from "../directory-for-kube-configs/directory-for-kube-configs.injectable";
+import joinPathsInjectable from "../../path/join-paths.injectable";
+
+export type GetCustomKubeConfigFilePath = (fileName: string) => string;
+
+const getCustomKubeConfigFilePathInjectable = getInjectable({
+  id: "get-custom-kube-config-directory",
+
+  instantiate: (di): GetCustomKubeConfigFilePath => {
+    const directoryForKubeConfigs = di.inject(directoryForKubeConfigsInjectable);
+    const joinPaths = di.inject(joinPathsInjectable);
+
+    return (fileName) => joinPaths(directoryForKubeConfigs, fileName);
+  },
+});
+
+export default getCustomKubeConfigFilePathInjectable;
@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { getGlobalOverride } from "../test-utils/get-global-override";
+import pathToNpmCliInjectable from "./path-to-npm-cli.injectable";
+
+export default getGlobalOverride(pathToNpmCliInjectable, () => "/some/npm/cli/path");
@@ -0,0 +1,13 @@
+/**
+ * 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";
+
+const pathToNpmCliInjectable = getInjectable({
+  id: "path-to-npm-cli",
+  instantiate: () => __non_webpack_require__.resolve("npm"),
+  causesSideEffects: true,
+});
+
+export default pathToNpmCliInjectable;