Switch CatalogEntity and CatalogCategory abstract classes (#2612)

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

@@ -1,12 +1,10 @@
 import { observable, reaction } from "mobx";
 import { WebLink } from "../catalog-entities";
-import { CatalogEntityRegistry } from "../catalog-entity-registry";
+import { CatalogEntityRegistry } from "../catalog";
 
 describe("CatalogEntityRegistry", () => {
   let registry: CatalogEntityRegistry;
   const entity = new WebLink({
-    apiVersion: "entity.k8slens.dev/v1alpha1",
-    kind: "WebLink",
     metadata: {
       uid: "test",
       name: "test-link",
@@ -17,7 +15,7 @@ describe("CatalogEntityRegistry", () => {
       url: "https://k8slens.dev"
     },
     status: {
-      phase: "ok"
+      phase: "valid"
     }
   });
 

src/common/catalog-entities/kubernetes-cluster.ts

@@ -1,11 +1,10 @@
-import { EventEmitter } from "events";
-import { observable } from "mobx";
-import { catalogCategoryRegistry } from "../catalog-category-registry";
-import { CatalogCategory, CatalogEntity, CatalogEntityActionContext, CatalogEntityAddMenuContext, CatalogEntityContextMenuContext, CatalogEntityData, CatalogEntityMetadata, CatalogEntityStatus } from "../catalog-entity";
+import { catalogCategoryRegistry } from "../catalog/catalog-category-registry";
+import { CatalogEntity, CatalogEntityActionContext, CatalogEntityAddMenuContext, CatalogEntityContextMenuContext, CatalogEntityMetadata, CatalogEntityStatus } from "../catalog";
 import { clusterDisconnectHandler } from "../cluster-ipc";
 import { ClusterStore } from "../cluster-store";
 import { requestMain } from "../ipc";
 import { productName } from "../vars";
+import { CatalogCategory, CatalogCategorySpec } from "../catalog";
 
 export type KubernetesClusterSpec = {
   kubeconfigPath: string;
@@ -16,32 +15,19 @@ export interface KubernetesClusterStatus extends CatalogEntityStatus {
   phase: "connected" | "disconnected";
 }
 
-export class KubernetesCluster implements CatalogEntity {
+export class KubernetesCluster extends CatalogEntity<CatalogEntityMetadata, KubernetesClusterStatus, KubernetesClusterSpec> {
   public readonly apiVersion = "entity.k8slens.dev/v1alpha1";
   public readonly kind = "KubernetesCluster";
-  @observable public metadata: CatalogEntityMetadata;
-  @observable public status: KubernetesClusterStatus;
-  @observable public spec: KubernetesClusterSpec;
-
-  constructor(data: CatalogEntityData) {
-    this.metadata = data.metadata;
-    this.status = data.status as KubernetesClusterStatus;
-    this.spec = data.spec as KubernetesClusterSpec;
-  }
-
-  getId() {
-    return this.metadata.uid;
-  }
-
-  getName() {
-    return this.metadata.name;
-  }
 
   async onRun(context: CatalogEntityActionContext) {
     context.navigate(`/cluster/${this.metadata.uid}`);
   }
 
-  async onDetailsOpen() {
+  onDetailsOpen(): void {
+    //
+  }
+
+  onSettingsOpen(): void {
     //
   }
 
@@ -81,14 +67,14 @@ export class KubernetesCluster implements CatalogEntity {
   }
 }
 
-export class KubernetesClusterCategory extends EventEmitter implements CatalogCategory {
+export class KubernetesClusterCategory extends CatalogCategory {
   public readonly apiVersion = "catalog.k8slens.dev/v1alpha1";
   public readonly kind = "CatalogCategory";
   public metadata = {
     name: "Kubernetes Clusters",
     icon: require(`!!raw-loader!./icons/kubernetes.svg`).default // eslint-disable-line
   };
-  public spec = {
+  public spec: CatalogCategorySpec = {
     group: "entity.k8slens.dev",
     versions: [
       {
@@ -114,10 +100,6 @@ export class KubernetesClusterCategory extends EventEmitter implements CatalogCa
       });
     });
   }
-
-  getId() {
-    return `${this.spec.group}/${this.spec.names.kind}`;
-  }
 }
 
 catalogCategoryRegistry.add(new KubernetesClusterCategory());

src/common/catalog-entities/web-link.ts

@@ -1,6 +1,5 @@
-import { observable } from "mobx";
-import { CatalogCategory, CatalogEntity, CatalogEntityData, CatalogEntityMetadata, CatalogEntityStatus } from "../catalog-entity";
-import { catalogCategoryRegistry } from "../catalog-category-registry";
+import { CatalogCategory, CatalogEntity, CatalogEntityMetadata, CatalogEntityStatus } from "../catalog";
+import { catalogCategoryRegistry } from "../catalog/catalog-category-registry";
 
 export interface WebLinkStatus extends CatalogEntityStatus {
   phase: "valid" | "invalid";
@@ -10,41 +9,28 @@ export type WebLinkSpec = {
   url: string;
 };
 
-export class WebLink implements CatalogEntity {
+export class WebLink extends CatalogEntity<CatalogEntityMetadata, WebLinkStatus, WebLinkSpec> {
   public readonly apiVersion = "entity.k8slens.dev/v1alpha1";
   public readonly kind = "KubernetesCluster";
-  @observable public metadata: CatalogEntityMetadata;
-  @observable public status: WebLinkStatus;
-  @observable public spec: WebLinkSpec;
-
-  constructor(data: CatalogEntityData) {
-    this.metadata = data.metadata;
-    this.status = data.status as WebLinkStatus;
-    this.spec = data.spec as WebLinkSpec;
-  }
-
-  getId() {
-    return this.metadata.uid;
-  }
-
-  getName() {
-    return this.metadata.name;
-  }
 
   async onRun() {
     window.open(this.spec.url, "_blank");
   }
 
-  async onDetailsOpen() {
-    //
+  public onSettingsOpen(): void {
+    return;
   }
 
-  async onContextMenuOpen() {
-    //
+  public onDetailsOpen(): void {
+    return;
+  }
+
+  public onContextMenuOpen(): void {
+    return;
   }
 }
 
-export class WebLinkCategory implements CatalogCategory {
+export class WebLinkCategory extends CatalogCategory {
   public readonly apiVersion = "catalog.k8slens.dev/v1alpha1";
   public readonly kind = "CatalogCategory";
   public metadata = {
@@ -63,10 +49,6 @@ export class WebLinkCategory implements CatalogCategory {
       kind: "WebLink"
     }
   };
-
-  getId() {
-    return `${this.spec.group}/${this.spec.names.kind}`;
-  }
 }
 
 catalogCategoryRegistry.add(new WebLinkCategory());

src/common/catalog-entity.ts

@@ -1,95 +0,0 @@
-export interface CatalogCategoryVersion {
-  name: string;
-  entityClass: { new(data: CatalogEntityData): CatalogEntity };
-}
-
-export interface CatalogCategory {
-  apiVersion: string;
-  kind: string;
-  metadata: {
-    name: string;
-    icon: string;
-  }
-  spec: {
-    group: string;
-    versions: CatalogCategoryVersion[];
-    names: {
-      kind: string;
-    }
-  }
-  getId: () => string;
-}
-
-export type CatalogEntityMetadata = {
-  uid: string;
-  name: string;
-  description?: string;
-  source?: string;
-  labels: {
-    [key: string]: string;
-  }
-  [key: string]: string | object;
-};
-
-export type CatalogEntityStatus = {
-  phase: string;
-  reason?: string;
-  message?: string;
-  active?: boolean;
-};
-
-export interface CatalogEntityActionContext {
-  navigate: (url: string) => void;
-  setCommandPaletteContext: (context?: CatalogEntity) => void;
-}
-
-export type CatalogEntityContextMenu = {
-  icon: string;
-  title: string;
-  onlyVisibleForSource?: string; // show only if empty or if matches with entity source
-  onClick: () => Promise<void>;
-  confirm?: {
-    message: string;
-  }
-};
-
-export type CatalogEntitySettingsMenu = {
-  group?: string;
-  title: string;
-  components: {
-    View: React.ComponentType<any>
-  };
-};
-
-export interface CatalogEntityContextMenuContext {
-  navigate: (url: string) => void;
-  menuItems: CatalogEntityContextMenu[];
-}
-
-export interface CatalogEntitySettingsContext {
-  menuItems: CatalogEntityContextMenu[];
-}
-
-export interface CatalogEntityAddMenuContext {
-  navigate: (url: string) => void;
-  menuItems: CatalogEntityContextMenu[];
-}
-
-export type CatalogEntityData = {
-  apiVersion: string;
-  kind: string;
-  metadata: CatalogEntityMetadata;
-  status: CatalogEntityStatus;
-  spec: {
-    [key: string]: any;
-  }
-};
-
-export interface CatalogEntity extends CatalogEntityData {
-  getId: () => string;
-  getName: () => string;
-  onRun: (context: CatalogEntityActionContext) => Promise<void>;
-  onDetailsOpen: (context: CatalogEntityActionContext) => Promise<void>;
-  onContextMenuOpen: (context: CatalogEntityContextMenuContext) => Promise<void>;
-  onSettingsOpen?: (context: CatalogEntitySettingsContext) => Promise<void>;
-}

src/common/catalog/catalog-category-registry.ts

@@ -1,5 +1,5 @@
 import { action, computed, observable, toJS } from "mobx";
-import { CatalogCategory, CatalogEntityData } from "./catalog-entity";
+import { CatalogCategory, CatalogEntityData, CatalogEntityKindData } from "./catalog-entity";
 
 export class CatalogCategoryRegistry {
   @observable protected categories: CatalogCategory[] = [];
@@ -20,7 +20,7 @@ export class CatalogCategoryRegistry {
     return this.categories.find((c) => c.spec.group === group && c.spec.names.kind === kind) as T;
   }
 
-  getEntityForData(data: CatalogEntityData) {
+  getEntityForData(data: CatalogEntityData & CatalogEntityKindData) {
     const category = this.getCategoryForEntity(data);
 
     if (!category) {
@@ -39,7 +39,7 @@ export class CatalogCategoryRegistry {
     return new specVersion.entityClass(data);
   }
 
-  getCategoryForEntity<T extends CatalogCategory>(data: CatalogEntityData) {
+  getCategoryForEntity<T extends CatalogCategory>(data: CatalogEntityData & CatalogEntityKindData) {
     const splitApiVersion = data.apiVersion.split("/");
     const group = splitApiVersion[0];
 

src/common/catalog/catalog-entity.ts

@@ -0,0 +1,143 @@
+import { EventEmitter } from "events";
+import { observable } from "mobx";
+
+type ExtractEntityMetadataType<Entity> = Entity extends CatalogEntity<infer Metadata> ? Metadata : never;
+type ExtractEntityStatusType<Entity> = Entity extends CatalogEntity<any, infer Status> ? Status : never;
+type ExtractEntitySpecType<Entity> = Entity extends CatalogEntity<any, any, infer Spec> ? Spec : never;
+
+export type CatalogEntityConstructor<Entity extends CatalogEntity> = (
+  (new (data: CatalogEntityData<
+    ExtractEntityMetadataType<Entity>,
+    ExtractEntityStatusType<Entity>,
+    ExtractEntitySpecType<Entity>
+  >) => Entity)
+);
+
+export interface CatalogCategoryVersion<Entity extends CatalogEntity> {
+  name: string;
+  entityClass: CatalogEntityConstructor<Entity>;
+}
+
+export interface CatalogCategorySpec {
+  group: string;
+  versions: CatalogCategoryVersion<CatalogEntity>[];
+  names: {
+    kind: string;
+  };
+}
+
+export abstract class CatalogCategory extends EventEmitter {
+  abstract readonly apiVersion: string;
+  abstract readonly kind: string;
+  abstract metadata: {
+    name: string;
+    icon: string;
+  };
+  abstract spec: CatalogCategorySpec;
+
+  public getId(): string {
+    return `${this.spec.group}/${this.spec.names.kind}`;
+  }
+}
+
+export interface CatalogEntityMetadata {
+  uid: string;
+  name: string;
+  description?: string;
+  source?: string;
+  labels: Record<string, string>;
+  [key: string]: string | object;
+}
+
+export interface CatalogEntityStatus {
+  phase: string;
+  reason?: string;
+  message?: string;
+  active?: boolean;
+}
+
+export interface CatalogEntityActionContext {
+  navigate: (url: string) => void;
+  setCommandPaletteContext: (context?: CatalogEntity) => void;
+}
+
+export interface CatalogEntityContextMenu {
+  icon: string;
+  title: string;
+  onlyVisibleForSource?: string; // show only if empty or if matches with entity source
+  onClick: () => Promise<void>;
+  confirm?: {
+    message: string;
+  }
+}
+
+export interface CatalogEntitySettingsMenu {
+  group?: string;
+  title: string;
+  components: {
+    View: React.ComponentType<any>
+  };
+}
+
+export interface CatalogEntityContextMenuContext {
+  navigate: (url: string) => void;
+  menuItems: CatalogEntityContextMenu[];
+}
+
+export interface CatalogEntitySettingsContext {
+  menuItems: CatalogEntityContextMenu[];
+}
+
+export interface CatalogEntityAddMenuContext {
+  navigate: (url: string) => void;
+  menuItems: CatalogEntityContextMenu[];
+}
+
+export type CatalogEntitySpec = Record<string, any>;
+
+export interface CatalogEntityData<
+  Metadata extends CatalogEntityMetadata = CatalogEntityMetadata,
+  Status extends CatalogEntityStatus = CatalogEntityStatus,
+  Spec extends CatalogEntitySpec = CatalogEntitySpec,
+> {
+  metadata: Metadata;
+  status: Status;
+  spec: Spec;
+}
+
+export interface CatalogEntityKindData {
+  readonly apiVersion: string;
+  readonly kind: string;
+}
+
+export abstract class CatalogEntity<
+  Metadata extends CatalogEntityMetadata = CatalogEntityMetadata,
+  Status extends CatalogEntityStatus = CatalogEntityStatus,
+  Spec extends CatalogEntitySpec = CatalogEntitySpec,
+> implements CatalogEntityKindData {
+  public abstract readonly apiVersion: string;
+  public abstract readonly kind: string;
+
+  @observable metadata: Metadata;
+  @observable status: Status;
+  @observable spec: Spec;
+
+  constructor(data: CatalogEntityData<Metadata, Status, Spec>) {
+    this.metadata = data.metadata;
+    this.status = data.status;
+    this.spec = data.spec;
+  }
+
+  public getId(): string {
+    return this.metadata.uid;
+  }
+
+  public getName(): string {
+    return this.metadata.name;
+  }
+
+  public abstract onRun?(context: CatalogEntityActionContext): void | Promise<void>;
+  public abstract onDetailsOpen(context: CatalogEntityActionContext): void | Promise<void>;
+  public abstract onContextMenuOpen(context: CatalogEntityContextMenuContext): void | Promise<void>;
+  public abstract onSettingsOpen(context: CatalogEntitySettingsContext): void | Promise<void>;
+}

src/common/catalog/index.ts

@@ -0,0 +1,3 @@
+export * from "./catalog-category-registry";
+export * from "./catalog-entity";
+export * from "./catalog-entity-registry";