Refactor CatalogEntityRegistry from common to main (#2824)

* refactor CatalogEntityRegistry from common to main

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

* test fix

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

src/main/catalog-pusher.ts

@@ -21,7 +21,7 @@
 
 import { reaction, toJS } from "mobx";
 import { broadcastMessage, subscribeToBroadcast, unsubscribeFromBroadcast } from "../common/ipc";
-import type { CatalogEntityRegistry} from "../common/catalog";
+import type { CatalogEntityRegistry} from "./catalog";
 import "../common/catalog-entities/kubernetes-cluster";
 import type { Disposer } from "../common/utils";
 

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

@@ -20,7 +20,8 @@
  */
 
 import { action, observable, IComputedValue, computed, ObservableMap, runInAction } from "mobx";
-import { CatalogEntity, catalogEntityRegistry } from "../../common/catalog";
+import type { CatalogEntity } from "../../common/catalog";
+import { catalogEntityRegistry } from "../../main/catalog";
 import { watch } from "chokidar";
 import fs from "fs";
 import fse from "fs-extra";

src/main/catalog/__tests__/catalog-entity-registry.test.ts

@@ -0,0 +1,136 @@
+/**
+ * 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 { observable, reaction } from "mobx";
+import { WebLink, WebLinkSpec, WebLinkStatus } from "../../../common/catalog-entities";
+import { catalogCategoryRegistry, CatalogEntity, CatalogEntityMetadata } from "../../../common/catalog";
+import { CatalogEntityRegistry } from "../catalog-entity-registry";
+
+class InvalidEntity extends CatalogEntity<CatalogEntityMetadata, WebLinkStatus, WebLinkSpec> {
+  public readonly apiVersion = "entity.k8slens.dev/v1alpha1";
+  public readonly kind = "Invalid";
+
+  async onRun() {
+    return;
+  }
+
+  public onSettingsOpen(): void {
+    return;
+  }
+
+  public onDetailsOpen(): void {
+    return;
+  }
+
+  public onContextMenuOpen(): void {
+    return;
+  }
+}
+
+describe("CatalogEntityRegistry", () => {
+  let registry: CatalogEntityRegistry;
+  const entity = new WebLink({
+    metadata: {
+      uid: "test",
+      name: "test-link",
+      source: "test",
+      labels: {}
+    },
+    spec: {
+      url: "https://k8slens.dev"
+    },
+    status: {
+      phase: "valid"
+    }
+  });
+  const invalidEntity = new InvalidEntity({
+    metadata: {
+      uid: "invalid",
+      name: "test-link",
+      source: "test",
+      labels: {}
+    },
+    spec: {
+      url: "https://k8slens.dev"
+    },
+    status: {
+      phase: "valid"
+    }
+  });
+
+  beforeEach(() => {
+    registry = new CatalogEntityRegistry(catalogCategoryRegistry);
+  });
+
+  describe("addSource", () => {
+    it ("allows to add an observable source", () => {
+      const source = observable.array([]);
+
+      registry.addObservableSource("test", source);
+      expect(registry.items.length).toEqual(0);
+
+      source.push(entity);
+
+      expect(registry.items.length).toEqual(1);
+    });
+
+    it ("added source change triggers reaction", (done) => {
+      const source = observable.array([]);
+
+      registry.addObservableSource("test", source);
+      reaction(() => registry.items, () => {
+        done();
+      });
+
+      source.push(entity);
+    });
+  });
+
+  describe("removeSource", () => {
+    it ("removes source", () => {
+      const source = observable.array([]);
+
+      registry.addObservableSource("test", source);
+      source.push(entity);
+      registry.removeSource("test");
+
+      expect(registry.items.length).toEqual(0);
+    });
+  });
+
+  describe("items", () => {
+    it("returns added items", () => {
+      expect(registry.items.length).toBe(0);
+
+      const source = observable.array([entity]);
+
+      registry.addObservableSource("test", source);
+      expect(registry.items.length).toBe(1);
+    });
+
+    it("does not return items without matching category", () => {
+      const source = observable.array([invalidEntity]);
+
+      registry.addObservableSource("test", source);
+      expect(registry.items.length).toBe(0);
+    });
+  });
+});

src/main/catalog/catalog-entity-registry.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 { action, computed, observable, IComputedValue, IObservableArray } from "mobx";
+import { CatalogCategoryRegistry, catalogCategoryRegistry, CatalogEntity } from "../../common/catalog";
+import { iter } from "../../common/utils";
+
+export class CatalogEntityRegistry {
+  protected sources = observable.map<string, IComputedValue<CatalogEntity[]>>([], { deep: true });
+
+  constructor(private categoryRegistry: CatalogCategoryRegistry) {}
+
+  @action addObservableSource(id: string, source: IObservableArray<CatalogEntity>) {
+    this.sources.set(id, computed(() => source));
+  }
+
+  @action addComputedSource(id: string, source: IComputedValue<CatalogEntity[]>) {
+    this.sources.set(id, source);
+  }
+
+  @action removeSource(id: string) {
+    this.sources.delete(id);
+  }
+
+  @computed get items(): CatalogEntity[] {
+    const allItems = Array.from(iter.flatMap(this.sources.values(), source => source.get()));
+
+    return allItems.filter((entity) => this.categoryRegistry.getCategoryForEntity(entity) !== undefined);
+  }
+
+  getItemsForApiKind<T extends CatalogEntity>(apiVersion: string, kind: string): T[] {
+    const items = this.items.filter((item) => item.apiVersion === apiVersion && item.kind === kind);
+
+    return items as T[];
+  }
+}
+
+export const catalogEntityRegistry = new CatalogEntityRegistry(catalogCategoryRegistry);

src/main/catalog/index.ts

@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+
+export * from "./catalog-entity-registry";

src/main/cluster-manager.ts

@@ -28,7 +28,7 @@ import type { Cluster } from "./cluster";
 import logger from "./logger";
 import { apiKubePrefix } from "../common/vars";
 import { Singleton } from "../common/utils";
-import { catalogEntityRegistry } from "../common/catalog";
+import { catalogEntityRegistry } from "./catalog";
 import { KubernetesCluster, KubernetesClusterPrometheusMetrics } from "../common/catalog-entities/kubernetes-cluster";
 
 export class ClusterManager extends Singleton {

src/main/index.ts

@@ -50,7 +50,7 @@ import { bindBroadcastHandlers } from "../common/ipc";
 import { startUpdateChecking } from "./app-updater";
 import { IpcRendererNavigationEvents } from "../renderer/navigation/events";
 import { CatalogPusher } from "./catalog-pusher";
-import { catalogEntityRegistry } from "../common/catalog";
+import { catalogEntityRegistry } from "./catalog";
 import { HotbarStore } from "../common/hotbar-store";
 import { HelmRepoManager } from "./helm/helm-repo-manager";
 import { KubeconfigSyncManager } from "./catalog-sources";