Merge branch 'master' into upgrade-typedoc-to-0.20

.github/workflows/test.yml

@@ -20,6 +20,11 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Add the current IP address, long hostname and short hostname record to /etc/hosts file
+        if: runner.os == 'Linux'
+        run: |
+          echo -e "$(ip addr show eth0 | grep "inet\b" | awk '{print $2}' | cut -d/ -f1)\t$(hostname -f) $(hostname -s)" | sudo tee -a /etc/hosts
+
       - name: Using Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v1
         with:

extensions/metrics-cluster-feature/renderer.tsx

@@ -1,9 +1,9 @@
-import { LensRendererExtension, Store, Interface, Component } from "@k8slens/extensions";
+import { LensRendererExtension, Interface, Component, Catalog} from "@k8slens/extensions";
 import { MetricsFeature } from "./src/metrics-feature";
 
 export default class ClusterMetricsFeatureExtension extends LensRendererExtension {
   onActivate() {
-    const category = Store.catalogCategories.getForGroupKind<Store.KubernetesClusterCategory>("entity.k8slens.dev", "KubernetesCluster");
+    const category = Catalog.catalogCategories.getForGroupKind<Catalog.KubernetesClusterCategory>("entity.k8slens.dev", "KubernetesCluster");
 
     if (!category) {
       return;
@@ -12,7 +12,7 @@ export default class ClusterMetricsFeatureExtension extends LensRendererExtensio
     category.on("contextMenuOpen", this.clusterContextMenuOpen.bind(this));
   }
 
-  async clusterContextMenuOpen(cluster: Store.KubernetesCluster, ctx: Interface.CatalogEntityContextMenuContext) {
+  async clusterContextMenuOpen(cluster: Catalog.KubernetesCluster, ctx: Interface.CatalogEntityContextMenuContext) {
     if (!cluster.status.active) {
       return;
     }

extensions/metrics-cluster-feature/src/metrics-feature.ts

@@ -1,4 +1,4 @@
-import { ClusterFeature, Store, K8sApi } from "@k8slens/extensions";
+import { ClusterFeature, Catalog, K8sApi } from "@k8slens/extensions";
 import semver from "semver";
 import * as path from "path";
 
@@ -49,7 +49,7 @@ export class MetricsFeature extends ClusterFeature.Feature {
     storageClass: null,
   };
 
-  async install(cluster: Store.KubernetesCluster): Promise<void> {
+  async install(cluster: Catalog.KubernetesCluster): Promise<void> {
     // Check if there are storageclasses
     const storageClassApi = K8sApi.forCluster(cluster, K8sApi.StorageClass);
     const scs = await storageClassApi.list();
@@ -62,11 +62,11 @@ export class MetricsFeature extends ClusterFeature.Feature {
     super.applyResources(cluster, path.join(__dirname, "../resources/"));
   }
 
-  async upgrade(cluster: Store.KubernetesCluster): Promise<void> {
+  async upgrade(cluster: Catalog.KubernetesCluster): Promise<void> {
     return this.install(cluster);
   }
 
-  async updateStatus(cluster: Store.KubernetesCluster): Promise<ClusterFeature.FeatureStatus> {
+  async updateStatus(cluster: Catalog.KubernetesCluster): Promise<ClusterFeature.FeatureStatus> {
     try {
       const statefulSet = K8sApi.forCluster(cluster, K8sApi.StatefulSet);
       const prometheus = await statefulSet.get({name: "prometheus", namespace: "lens-metrics"});
@@ -87,7 +87,7 @@ export class MetricsFeature extends ClusterFeature.Feature {
     return this.status;
   }
 
-  async uninstall(cluster: Store.KubernetesCluster): Promise<void> {
+  async uninstall(cluster: Catalog.KubernetesCluster): Promise<void> {
     const namespaceApi = K8sApi.forCluster(cluster, K8sApi.Namespace);
     const clusterRoleBindingApi = K8sApi.forCluster(cluster, K8sApi.ClusterRoleBinding);
     const clusterRoleApi = K8sApi.forCluster(cluster, K8sApi.ClusterRole);

extensions/telemetry/src/tracker.ts

@@ -1,4 +1,4 @@
-import { EventBus, Util, Store, App } from "@k8slens/extensions";
+import { EventBus, Util, Catalog, App } from "@k8slens/extensions";
 import ua from "universal-analytics";
 import Analytics from "analytics-node";
 import { machineIdSync } from "node-machine-id";
@@ -102,7 +102,7 @@ export class Tracker extends Util.Singleton {
   }
 
   protected reportData() {
-    const clustersList = Store.catalogEntities.getItemsForApiKind<Store.KubernetesCluster>("entity.k8slens.dev/v1alpha1", "KubernetesCluster");
+    const clustersList = Catalog.catalogEntities.getItemsForApiKind<Catalog.KubernetesCluster>("entity.k8slens.dev/v1alpha1", "KubernetesCluster");
 
     this.event("generic-data", "report", {
       appVersion: App.version,
@@ -117,7 +117,7 @@ export class Tracker extends Util.Singleton {
     });
   }
 
-  protected reportClusterData(cluster: Store.KubernetesCluster) {
+  protected reportClusterData(cluster: Catalog.KubernetesCluster) {
     this.event("cluster-data", "report", {
       id: cluster.metadata.id,
       managed: cluster.metadata.source !== "local",

src/extensions/cluster-feature.ts

@@ -3,7 +3,7 @@ import path from "path";
 import hb from "handlebars";
 import { observable } from "mobx";
 import { ResourceApplier } from "../main/resource-applier";
-import { KubernetesCluster } from "./core-api/stores";
+import { KubernetesCluster } from "./core-api/catalog";
 import logger from "../main/logger";
 import { app } from "electron";
 import { requestMain } from "../common/ipc";

src/extensions/core-api/catalog.ts

@@ -3,6 +3,9 @@ import { computed } from "mobx";
 import { CatalogEntity } from "../../common/catalog-entity";
 import { catalogEntityRegistry as registry } from "../../common/catalog-entity-registry";
 
+export { catalogCategoryRegistry as catalogCategories } from "../../common/catalog-category-registry";
+export * from "../../common/catalog-entities";
+
 export class CatalogEntityRegistry {
   @computed getItemsForApiKind<T extends CatalogEntity>(apiVersion: string, kind: string): T[] {
     return registry.getItemsForApiKind<T>(apiVersion, kind);

src/extensions/core-api/index.ts

@@ -9,10 +9,12 @@ import * as Store from "./stores";
 import * as Util from "./utils";
 import * as ClusterFeature from "./cluster-feature";
 import * as Interface from "../interfaces";
+import * as Catalog from "./catalog";
 
 export {
   App,
   EventBus,
+  Catalog,
   ClusterFeature,
   Interface,
   Store,

src/extensions/core-api/stores.ts

@@ -1,4 +1 @@
 export { ExtensionStore } from "../extension-store";
-export { KubernetesCluster, KubernetesClusterCategory } from "../../common/catalog-entities/kubernetes-cluster";
-export { catalogCategoryRegistry as catalogCategories } from "../../common/catalog-category-registry";
-export { catalogEntities } from "./catalog";

src/renderer/components/kube-object/kube-object-list-layout.tsx

@@ -15,8 +15,14 @@ export interface KubeObjectListLayoutProps extends ItemListLayoutProps {
   dependentStores?: KubeObjectStore[];
 }
 
+const defaultProps: Partial<KubeObjectListLayoutProps> = {
+  onDetails: (item: KubeObject) => showDetails(item.selfLink),
+};
+
 @observer
 export class KubeObjectListLayout extends React.Component<KubeObjectListLayoutProps> {
+  static defaultProps = defaultProps as object;
+
   @computed get selectedItem() {
     return this.props.store.getByPath(kubeSelectedUrlParam.get());
   }
@@ -33,14 +39,6 @@ export class KubeObjectListLayout extends React.Component<KubeObjectListLayoutPr
     ]);
   }
 
-  onDetails = (item: KubeObject) => {
-    if (this.props.onDetails) {
-      this.props.onDetails(item);
-    } else {
-      showDetails(item.selfLink);
-    }
-  };
-
   render() {
     const { className, store, items = store.contextItems, ...layoutProps } = this.props;
 
@@ -52,10 +50,7 @@ export class KubeObjectListLayout extends React.Component<KubeObjectListLayoutPr
         items={items}
         preloadStores={false} // loading handled in kubeWatchApi.subscribeStores()
         detailsItem={this.selectedItem}
-        onDetails={this.onDetails}
-        renderItemMenu={(item) => {
-          return <KubeObjectMenu object={item}/>;
-        }}
+        renderItemMenu={(item: KubeObject) => <KubeObjectMenu object={item} />} // safe because we are dealing with KubeObjects here
       />
     );
   }

src/renderer/components/kube-object/kube-object-menu.tsx

@@ -7,13 +7,13 @@ import { hideDetails } from "./kube-object-details";
 import { apiManager } from "../../api/api-manager";
 import { kubeObjectMenuRegistry } from "../../../extensions/registries/kube-object-menu-registry";
 
-export interface KubeObjectMenuProps<T extends KubeObject = any> extends MenuActionsProps {
-  object: T;
+export interface KubeObjectMenuProps<T> extends MenuActionsProps {
+  object: T | null | undefined;
   editable?: boolean;
   removable?: boolean;
 }
 
-export class KubeObjectMenu extends React.Component<KubeObjectMenuProps> {
+export class KubeObjectMenu<T extends KubeObject> extends React.Component<KubeObjectMenuProps<T>> {
   get store() {
     const { object } = this.props;
 
@@ -52,23 +52,35 @@ export class KubeObjectMenu extends React.Component<KubeObjectMenuProps> {
   @autobind()
   renderRemoveMessage() {
     const { object } = this.props;
-    const resourceKind = object.kind;
-    const resourceName = object.getName();
+
+    if (!object) {
+      return null;
+    }
 
     return (
-      <p>Remove {resourceKind} <b>{resourceName}</b>?</p>
+      <p>Remove {object.kind} <b>{object.getName()}</b>?</p>
     );
   }
 
+  getMenuItems(object: T): React.ReactChild[] {
+    if (!object) {
+      return [];
+    }
+
+    return kubeObjectMenuRegistry
+      .getItemsForKind(object.kind, object.apiVersion)
+      .map(({components: { MenuItem }}, index) => (
+        <MenuItem
+          object={object}
+          key={`menu-item-${index}`}
+          toolbar={toolbar}
+        />
+      ));
+  }
+
   render() {
     const { remove, update, renderRemoveMessage, isEditable, isRemovable } = this;
-    const { className, object, editable, removable, toolbar, ...menuProps } = this.props;
-
-    if (!object) return null;
-
-    const menuItems = kubeObjectMenuRegistry.getItemsForKind(object.kind, object.apiVersion).map((item, index) => {
-      return <item.components.MenuItem object={object} key={`menu-item-${index}`} toolbar={toolbar} />;
-    });
+    const { className, object, editable, removable, ...menuProps } = this.props;
 
     return (
       <MenuActions
@@ -76,10 +88,9 @@ export class KubeObjectMenu extends React.Component<KubeObjectMenuProps> {
         updateAction={isEditable ? update : undefined}
         removeAction={isRemovable ? remove : undefined}
         removeConfirmationMessage={renderRemoveMessage}
-        toolbar={toolbar}
         {...menuProps}
       >
-        {menuItems}
+        {this.getMenuItems(object)}
       </MenuActions>
     );
   }