Catalog & Hotbar - initial groundwork (#2418)

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

src/renderer/api/__tests__/catalog-entity-registry.test.ts

@@ -0,0 +1,135 @@
+import { CatalogEntityRegistry } from "../catalog-entity-registry";
+import "../../../common/catalog-entities";
+import { catalogCategoryRegistry } from "../../../common/catalog-category-registry";
+
+describe("CatalogEntityRegistry", () => {
+  describe("updateItems", () => {
+    it("adds new catalog item", () => {
+      const catalog = new CatalogEntityRegistry(catalogCategoryRegistry);
+      const items = [{
+        apiVersion: "entity.k8slens.dev/v1alpha1",
+        kind: "KubernetesCluster",
+        metadata: {
+          uid: "123",
+          name: "foobar",
+          source: "test",
+          labels: {}
+        },
+        status: {
+          phase: "disconnected"
+        },
+        spec: {}
+      }];
+
+      catalog.updateItems(items);
+      expect(catalog.items.length).toEqual(1);
+
+      items.push({
+        apiVersion: "entity.k8slens.dev/v1alpha1",
+        kind: "KubernetesCluster",
+        metadata: {
+          uid: "456",
+          name: "barbaz",
+          source: "test",
+          labels: {}
+        },
+        status: {
+          phase: "disconnected"
+        },
+        spec: {}
+      });
+
+      catalog.updateItems(items);
+      expect(catalog.items.length).toEqual(2);
+    });
+
+    it("ignores unknown items", () => {
+      const catalog = new CatalogEntityRegistry(catalogCategoryRegistry);
+      const items = [{
+        apiVersion: "entity.k8slens.dev/v1alpha1",
+        kind: "FooBar",
+        metadata: {
+          uid: "123",
+          name: "foobar",
+          source: "test",
+          labels: {}
+        },
+        status: {
+          phase: "disconnected"
+        },
+        spec: {}
+      }];
+
+      catalog.updateItems(items);
+      expect(catalog.items.length).toEqual(0);
+    });
+
+    it("updates existing items", () => {
+      const catalog = new CatalogEntityRegistry(catalogCategoryRegistry);
+      const items = [{
+        apiVersion: "entity.k8slens.dev/v1alpha1",
+        kind: "KubernetesCluster",
+        metadata: {
+          uid: "123",
+          name: "foobar",
+          source: "test",
+          labels: {}
+        },
+        status: {
+          phase: "disconnected"
+        },
+        spec: {}
+      }];
+
+      catalog.updateItems(items);
+      expect(catalog.items.length).toEqual(1);
+      expect(catalog.items[0].status.phase).toEqual("disconnected");
+
+      items[0].status.phase = "connected";
+
+      catalog.updateItems(items);
+      expect(catalog.items.length).toEqual(1);
+      expect(catalog.items[0].status.phase).toEqual("connected");
+    });
+
+    it("removes deleted items", () => {
+      const catalog = new CatalogEntityRegistry(catalogCategoryRegistry);
+      const items = [
+        {
+          apiVersion: "entity.k8slens.dev/v1alpha1",
+          kind: "KubernetesCluster",
+          metadata: {
+            uid: "123",
+            name: "foobar",
+            source: "test",
+            labels: {}
+          },
+          status: {
+            phase: "disconnected"
+          },
+          spec: {}
+        },
+        {
+          apiVersion: "entity.k8slens.dev/v1alpha1",
+          kind: "KubernetesCluster",
+          metadata: {
+            uid: "456",
+            name: "barbaz",
+            source: "test",
+            labels: {}
+          },
+          status: {
+            phase: "disconnected"
+          },
+          spec: {}
+        }
+      ];
+
+      catalog.updateItems(items);
+      items.splice(0, 1);
+      catalog.updateItems(items);
+      expect(catalog.items.length).toEqual(1);
+      expect(catalog.items[0].metadata.uid).toEqual("456");
+    });
+  });
+});

src/renderer/api/__tests__/pods.test.ts

@@ -145,10 +145,10 @@ function getDummyPod(opts: GetDummyPodOptions = getDummyPodDefaultOptions()): Po
 describe("Pods", () => {
   const podTests = [];
 
-  for (let r = 0; r < 10; r += 1) {
-    for (let d = 0; d < 10; d += 1) {
-      for (let ir = 0; ir < 10; ir += 1) {
-        for (let id = 0; id < 10; id += 1) {
+  for (let r = 0; r < 3; r += 1) {
+    for (let d = 0; d < 3; d += 1) {
+      for (let ir = 0; ir < 3; ir += 1) {
+        for (let id = 0; id < 3; id += 1) {
           podTests.push([r, d, ir, id]);
         }
       }

src/renderer/api/catalog-entity-registry.ts

@@ -0,0 +1,61 @@
+import { action, observable } from "mobx";
+import { broadcastMessage, subscribeToBroadcast } from "../../common/ipc";
+import { CatalogCategory, CatalogEntity, CatalogEntityData } from "../../common/catalog-entity";
+import { catalogCategoryRegistry, CatalogCategoryRegistry } from "../../common/catalog-category-registry";
+import "../../common/catalog-entities";
+
+export class CatalogEntityRegistry {
+  @observable protected _items: CatalogEntity[] = observable.array([], { deep: true });
+
+  constructor(private categoryRegistry: CatalogCategoryRegistry) {}
+
+  init() {
+    subscribeToBroadcast("catalog:items", (ev, items: CatalogEntityData[]) => {
+      this.updateItems(items);
+    });
+    broadcastMessage("catalog:broadcast");
+  }
+
+  @action updateItems(items: CatalogEntityData[]) {
+    this._items.forEach((item, index) => {
+      const foundIndex = items.findIndex((i) => i.apiVersion === item.apiVersion && i.kind === item.kind && i.metadata.uid === item.metadata.uid);
+
+      if (foundIndex === -1) {
+        this._items.splice(index, 1);
+      }
+    });
+
+    items.forEach((data) => {
+      const item = this.categoryRegistry.getEntityForData(data);
+
+      if (!item) return; // invalid data
+
+      const index = this._items.findIndex((i) => i.apiVersion === item.apiVersion && i.kind === item.kind && i.metadata.uid === item.metadata.uid);
+
+      if (index === -1) {
+        this._items.push(item);
+      } else {
+        this._items.splice(index, 1, item);
+      }
+    });
+  }
+
+  get items() {
+    return this._items;
+  }
+
+  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[];
+  }
+
+  getItemsForCategory<T extends CatalogEntity>(category: CatalogCategory): T[] {
+    const supportedVersions = category.spec.versions.map((v) => `${category.spec.group}/${v.name}`);
+    const items = this._items.filter((item) => supportedVersions.includes(item.apiVersion) && item.kind === category.spec.names.kind);
+
+    return items as T[];
+  }
+}
+
+export const catalogEntityRegistry = new CatalogEntityRegistry(catalogCategoryRegistry);

src/renderer/api/catalog-entity.ts

@@ -0,0 +1,12 @@
+import { navigate } from "../navigation";
+import { commandRegistry } from "../../extensions/registries";
+import { CatalogEntity } from "../../common/catalog-entity";
+
+export { CatalogEntity, CatalogEntityData, CatalogEntityActionContext, CatalogEntityContextMenu, CatalogEntityContextMenuContext } from "../../common/catalog-entity";
+
+export const catalogEntityRunContext = {
+  navigate: (url: string) => navigate(url),
+  setCommandPaletteContext: (entity?: CatalogEntity) => {
+    commandRegistry.activeEntity = entity;
+  }
+};

src/renderer/api/kube-api.ts

@@ -62,7 +62,9 @@ export interface IKubeResourceList {
 }
 
 export interface IKubeApiCluster {
-  id: string;
+  metadata: {
+    uid: string;
+  }
 }
 
 export function forCluster<T extends KubeObject>(cluster: IKubeApiCluster, kubeClass: IKubeObjectConstructor<T>): KubeApi<T> {
@@ -71,7 +73,7 @@ export function forCluster<T extends KubeObject>(cluster: IKubeApiCluster, kubeC
     debug: isDevelopment,
   }, {
     headers: {
-      "X-Cluster-ID": cluster.id
+      "X-Cluster-ID": cluster.metadata.uid
     }
   });