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/catalog-sources/__test__/kubeconfig-sync.test.ts

@@ -22,13 +22,17 @@
 import { ObservableMap } from "mobx";
 import type { CatalogEntity } from "../../../common/catalog";
 import { loadFromOptions } from "../../../common/kube-helpers";
-import type { Cluster } from "../../cluster";
-import { computeDiff, configToModels } from "../kubeconfig-sync";
+import type { Cluster } from "../../../common/cluster/cluster";
+import { computeDiff as computeDiffFor, configToModels } from "../kubeconfig-sync-manager/kubeconfig-sync-manager";
 import mockFs from "mock-fs";
 import fs from "fs";
-import { ClusterStore } from "../../../common/cluster-store";
 import { ClusterManager } from "../../cluster-manager";
-import { AppPaths } from "../../../common/app-paths";
+import clusterStoreInjectable from "../../../common/cluster-store/cluster-store.injectable";
+import { getDiForUnitTesting } from "../../getDiForUnitTesting";
+import { createClusterInjectionToken } from "../../../common/cluster/create-cluster-injection-token";
+import directoryForKubeConfigsInjectable
+  from "../../../common/app-paths/directory-for-kube-configs/directory-for-kube-configs.injectable";
+
 
 jest.mock("electron", () => ({
   app: {
@@ -46,18 +50,28 @@ jest.mock("electron", () => ({
   },
 }));
 
-AppPaths.init();
-
 describe("kubeconfig-sync.source tests", () => {
-  beforeEach(() => {
+  let computeDiff: ReturnType<typeof computeDiffFor>;
+  
+  beforeEach(async () => {
+    const di = getDiForUnitTesting({ doGeneralOverrides: true });
+
     mockFs();
-    ClusterStore.createInstance();
+
+    await di.runSetups();
+
+    computeDiff = computeDiffFor({
+      directoryForKubeConfigs: di.inject(directoryForKubeConfigsInjectable),
+      createCluster: di.inject(createClusterInjectionToken),
+    });
+
+    di.inject(clusterStoreInjectable);
+
     ClusterManager.createInstance();
   });
 
   afterEach(() => {
     mockFs.restore();
-    ClusterStore.resetInstance();
     ClusterManager.resetInstance();
   });
 

src/main/catalog-sources/index.ts

@@ -20,5 +20,4 @@
  */
 
 export { syncWeblinks } from "./weblinks";
-export { KubeconfigSyncManager } from "./kubeconfig-sync";
 export { syncGeneralEntities } from "./general";

src/main/catalog-sources/kubeconfig-sync-manager/kubeconfig-sync-manager.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 directoryForKubeConfigsInjectable from "../../../common/app-paths/directory-for-kube-configs/directory-for-kube-configs.injectable";
+import { KubeconfigSyncManager } from "./kubeconfig-sync-manager";
+import { createClusterInjectionToken } from "../../../common/cluster/create-cluster-injection-token";
+
+const kubeconfigSyncManagerInjectable = getInjectable({
+  instantiate: (di) => new KubeconfigSyncManager({
+    directoryForKubeConfigs: di.inject(directoryForKubeConfigsInjectable),
+    createCluster: di.inject(createClusterInjectionToken),
+  }),
+
+  lifecycle: lifecycleEnum.singleton,
+});
+
+export default kubeconfigSyncManagerInjectable;

src/main/catalog-sources/kubeconfig-sync-manager/kubeconfig-sync-manager.ts

@@ -20,25 +20,25 @@
  */
 
 import { action, observable, IComputedValue, computed, ObservableMap, runInAction, makeObservable, observe } from "mobx";
-import type { CatalogEntity } from "../../common/catalog";
-import { catalogEntityRegistry } from "../../main/catalog";
+import type { CatalogEntity } from "../../../common/catalog";
+import { catalogEntityRegistry } from "../../catalog";
 import { FSWatcher, watch } from "chokidar";
 import fs from "fs";
 import path from "path";
 import type stream from "stream";
-import { bytesToUnits, Disposer, ExtendedObservableMap, iter, noop, Singleton, storedKubeConfigFolder } from "../../common/utils";
-import logger from "../logger";
+import { bytesToUnits, Disposer, ExtendedObservableMap, iter, noop } from "../../../common/utils";
+import logger from "../../logger";
 import type { KubeConfig } from "@kubernetes/client-node";
-import { loadConfigFromString, splitConfig } from "../../common/kube-helpers";
-import { Cluster } from "../cluster";
-import { catalogEntityFromCluster, ClusterManager } from "../cluster-manager";
-import { UserStore } from "../../common/user-store";
-import { ClusterStore } from "../../common/cluster-store";
+import { loadConfigFromString, splitConfig } from "../../../common/kube-helpers";
+import { catalogEntityFromCluster, ClusterManager } from "../../cluster-manager";
+import { UserStore } from "../../../common/user-store";
+import { ClusterStore } from "../../../common/cluster-store/cluster-store";
 import { createHash } from "crypto";
 import { homedir } from "os";
 import globToRegExp from "glob-to-regexp";
 import { inspect } from "util";
-import type { UpdateClusterModel } from "../../common/cluster-types";
+import type { ClusterModel, UpdateClusterModel } from "../../../common/cluster-types";
+import type { Cluster } from "../../../common/cluster/cluster";
 
 const logPrefix = "[KUBECONFIG-SYNC]:";
 
@@ -63,16 +63,19 @@ const ignoreGlobs = [
 const folderSyncMaxAllowedFileReadSize = 2 * 1024 * 1024; // 2 MiB
 const fileSyncMaxAllowedFileReadSize = 16 * folderSyncMaxAllowedFileReadSize; // 32 MiB
 
-export class KubeconfigSyncManager extends Singleton {
+interface Dependencies {
+  directoryForKubeConfigs: string
+  createCluster: (model: ClusterModel) => Cluster
+}
+
+const kubeConfigSyncName = "lens:kube-sync";
+
+export class KubeconfigSyncManager {
   protected sources = observable.map<string, [IComputedValue<CatalogEntity[]>, Disposer]>();
   protected syncing = false;
   protected syncListDisposer?: Disposer;
 
-  protected static readonly syncName = "lens:kube-sync";
-
-  constructor() {
-    super();
-
+  constructor(private dependencies: Dependencies) {
     makeObservable(this);
   }
 
@@ -86,7 +89,7 @@ export class KubeconfigSyncManager extends Singleton {
 
     logger.info(`${logPrefix} starting requested syncs`);
 
-    catalogEntityRegistry.addComputedSource(KubeconfigSyncManager.syncName, computed(() => (
+    catalogEntityRegistry.addComputedSource(kubeConfigSyncName, computed(() => (
       Array.from(iter.flatMap(
         this.sources.values(),
         ([entities]) => entities.get(),
@@ -94,7 +97,7 @@ export class KubeconfigSyncManager extends Singleton {
     )));
 
     // This must be done so that c&p-ed clusters are visible
-    this.startNewSync(storedKubeConfigFolder());
+    this.startNewSync(this.dependencies.directoryForKubeConfigs);
 
     for (const filePath of UserStore.getInstance().syncKubeconfigEntries.keys()) {
       this.startNewSync(filePath);
@@ -120,7 +123,7 @@ export class KubeconfigSyncManager extends Singleton {
       this.stopOldSync(filePath);
     }
 
-    catalogEntityRegistry.removeSource(KubeconfigSyncManager.syncName);
+    catalogEntityRegistry.removeSource(kubeConfigSyncName);
     this.syncing = false;
   }
 
@@ -131,7 +134,11 @@ export class KubeconfigSyncManager extends Singleton {
       return void logger.debug(`${logPrefix} already syncing file/folder`, { filePath });
     }
 
-    this.sources.set(filePath, watchFileChanges(filePath));
+    this.sources.set(
+      filePath,
+      watchFileChanges(filePath, this.dependencies),
+    );
+
     logger.info(`${logPrefix} starting sync of file/folder`, { filePath });
     logger.debug(`${logPrefix} ${this.sources.size} files/folders watched`, { files: Array.from(this.sources.keys()) });
   }
@@ -170,7 +177,7 @@ type RootSourceValue = [Cluster, CatalogEntity];
 type RootSource = ObservableMap<string, RootSourceValue>;
 
 // exported for testing
-export function computeDiff(contents: string, source: RootSource, filePath: string): void {
+export const computeDiff = ({ directoryForKubeConfigs, createCluster }: Dependencies) => (contents: string, source: RootSource, filePath: string): void => {
   runInAction(() => {
     try {
       const { config, error } = loadConfigFromString(contents);
@@ -212,7 +219,8 @@ export function computeDiff(contents: string, source: RootSource, filePath: stri
         // add new clusters to the source
         try {
           const clusterId = createHash("md5").update(`${filePath}:${contextName}`).digest("hex");
-          const cluster = ClusterStore.getInstance().getById(clusterId) || new Cluster({ ...model, id: clusterId });
+
+          const cluster = ClusterStore.getInstance().getById(clusterId) || createCluster({ ...model, id: clusterId });
 
           if (!cluster.apiUrl) {
             throw new Error("Cluster constructor failed, see above error");
@@ -220,7 +228,7 @@ export function computeDiff(contents: string, source: RootSource, filePath: stri
 
           const entity = catalogEntityFromCluster(cluster);
 
-          if (!filePath.startsWith(storedKubeConfigFolder())) {
+          if (!filePath.startsWith(directoryForKubeConfigs)) {
             entity.metadata.labels.file = filePath.replace(homedir(), "~");
           }
           source.set(contextName, [cluster, entity]);
@@ -231,11 +239,12 @@ export function computeDiff(contents: string, source: RootSource, filePath: stri
         }
       }
     } catch (error) {
+      console.log(error);
       logger.warn(`${logPrefix} Failed to compute diff: ${error}`, { filePath });
       source.clear(); // clear source if we have failed so as to not show outdated information
     }
   });
-}
+};
 
 interface DiffChangedConfigArgs {
   filePath: string;
@@ -244,7 +253,7 @@ interface DiffChangedConfigArgs {
   maxAllowedFileReadSize: number;
 }
 
-function diffChangedConfig({ filePath, source, stats, maxAllowedFileReadSize }: DiffChangedConfigArgs): Disposer {
+const diffChangedConfigFor = (dependencies: Dependencies) => ({ filePath, source, stats, maxAllowedFileReadSize }: DiffChangedConfigArgs): Disposer => {
   logger.debug(`${logPrefix} file changed`, { filePath });
 
   if (stats.size >= maxAllowedFileReadSize) {
@@ -293,14 +302,14 @@ function diffChangedConfig({ filePath, source, stats, maxAllowedFileReadSize }:
     })
     .on("end", () => {
       if (!closed) {
-        computeDiff(fileString, source, filePath);
+        computeDiff(dependencies)(fileString, source, filePath);
       }
     });
 
   return cleanup;
-}
+};
 
-function watchFileChanges(filePath: string): [IComputedValue<CatalogEntity[]>, Disposer] {
+const watchFileChanges = (filePath: string, dependencies: Dependencies): [IComputedValue<CatalogEntity[]>, Disposer] => {
   const rootSource = new ExtendedObservableMap<string, ObservableMap<string, RootSourceValue>>();
   const derivedSource = computed(() => Array.from(iter.flatMap(rootSource.values(), from => iter.map(from.values(), child => child[1]))));
 
@@ -328,6 +337,8 @@ function watchFileChanges(filePath: string): [IComputedValue<CatalogEntity[]>, D
         atomic: 150, // for "atomic writes"
       });
 
+      const diffChangedConfig = diffChangedConfigFor(dependencies);
+
       watcher
         .on("change", (childFilePath, stats) => {
           const cleanup = cleanupFns.get(childFilePath);
@@ -378,4 +389,4 @@ function watchFileChanges(filePath: string): [IComputedValue<CatalogEntity[]>, D
   return [derivedSource, () => {
     watcher?.close();
   }];
-}
+};