fix(#134): COO-946: Incorrect mapping of k8s event resources

K8s event resources were originally in the core API group, now are also in the 'events.k8s.io' group.
Fix the troubleshooting panel to account for both possibilities.

Also
- added class name to context menus to disambiguate nodes with same Kind but different API version.

fixes #134

Author: alanconway

web/locales/en/plugin__troubleshooting-panel-console-plugin.json

@@ -1,25 +1,24 @@
 {
   "Correlation result was empty.": "Correlation result was empty.",
-  "Date and Time Range": "Date and Time Range",
+  "Depth": "Depth",
   "Find related resources.": "Find related resources.",
   "Focus": "Focus",
-  "Goal class: ": "Goal class: ",
-  "Hide Query": "Hide Query",
-  "Korrel8 query selecting the starting points for correlation.": "Starting query",
+  "Generate a correlation graph starting from resources in the current view.": "Generate a correlation graph starting from resources in the current view.",
+  "Goal directed search": "Goal directed search",
   "Korrel8r Error": "Korrel8r Error",
   "Logging Plugin Disabled": "Logging Plugin Disabled",
-  "Neighbourhood depth: ": "Neighbourhood depth: ",
+  "Neighbourhood search": "Neighbourhood search",
   "Netflow Plugin Disabled": "Netflow Plugin Disabled",
   "No Correlated Signals Found": "No Correlated Signals Found",
   "Open the Troubleshooting Panel": "Open the Troubleshooting Panel",
-  "Query": "Query",
-  "Re-calculate the correlation graph starting from resources on the current console page.": "Re-calculate the correlation graph starting from resources on the current console page.",
+  "Query to select the starting resources for correlation.": "Query to select the starting resources for correlation.",
+  "Refresh the graph using the current search settings": "Refresh the graph using the current search settings",
   "Request Failed": "Request Failed",
-  "Show graph of connected classes up to the specified depth.": "Show graph of connected classes up to the specified depth.",
-  "Show graph of paths to signals of the specified class.": "Show graph of paths to signals of the specified class.",
-  "Show Query": "Show Query",
-  "The current console page is not supported for correlation.": "The current console page is not supported for correlation.",
+  "Search for  correlated resources up to the specified depth.": "Search for  correlated resources up to the specified depth.",
+  "Search for paths to resources of the specified class.": "Search for paths to resources of the specified class.",
+  "The current view does not support correlation.": "The current view does not support correlation.",
   "Troubleshooting": "Troubleshooting",
   "Troubleshooting Panel": "Troubleshooting Panel",
-  "Unable to find Console Link": "Unable to find Console Link"
+  "Unable to find Console Link": "Unable to find Console Link",
+  "Update": "Update"
 }

web/src/__tests__/k8s.spec.ts

@@ -1,5 +1,5 @@
-import { URIRef, Query } from '../korrel8r/types';
 import { K8sDomain } from '../korrel8r/k8s';
+import { Query, URIRef } from '../korrel8r/types';
 
 const k8s = new K8sDomain();
 
@@ -138,10 +138,6 @@ describe('K8sNode.fromQuery', () => {
     },
 
     // Variations on korrel8r class spec.
-    { query: `k8s:Role:{"namespace":"x", "name":"y"}`, u: `k8s/ns/x/roles/y` },
-    { query: `k8s:Role.:{"namespace":"x", "name":"y"}`, u: `k8s/ns/x/roles/y` },
-    { query: `k8s:Role.v1:{"namespace":"x", "name":"y"}`, u: `k8s/ns/x/roles/y` },
-    { query: `k8s:Role.v1:{"namespace":"x", "name":"y"}`, u: `k8s/ns/x/roles/y` },
     {
       query: `k8s:Role.v1.rbac.authorization.k8s.io:{"namespace":"x", "name":"y"}`,
       u: `k8s/ns/x/roles/y`,

web/src/components/topology/Korrel8rTopology.tsx

@@ -1,4 +1,4 @@
-import { Badge } from '@patternfly/react-core';
+import { Badge, Title } from '@patternfly/react-core';
 import { ClusterIcon } from '@patternfly/react-icons';
 import {
   action,
@@ -147,7 +147,8 @@ export const Korrel8rTopology: React.FC<{
   const navigateToQuery = React.useCallback(
     (query: korrel8r.Query) => {
       try {
-        navigate('/' + allDomains.queryToLink(query));
+        const link = allDomains.queryToLink(query);
+        navigate(link.startsWith('/') ? link : `/${link}`);
       } catch (e) {
         // eslint-disable-next-line no-console
         console.error(`navigateToQuery failed for: ${query.toString()}: `, e);
@@ -170,18 +171,27 @@ export const Korrel8rTopology: React.FC<{
   const nodeMenu = React.useCallback(
     (e: GraphElement<ElementModel, korrel8r.Node>): React.ReactElement[] => {
       const node = e.getData();
-      return nodeQueries(node).map((qc) => (
-        <ContextMenuItem
-          key={qc.query.toString()}
-          onClick={() => {
-            navigateToQuery(qc.query);
-            setSelectedIds([node.id]);
-            navigator.clipboard.writeText(qc.query.toString());
-          }}
-        >
-          <Badge>{`${qc.count}`}</Badge> {`${qc.query.selector}`}
-        </ContextMenuItem>
-      ));
+      const menu = [
+        <ContextMenuItem isDisabled={true} key={node.class.toString()}>
+          <Title headingLevel="h4">{node.class.toString()}</Title>
+        </ContextMenuItem>,
+      ];
+      nodeQueries(node).forEach((qc) =>
+        menu.push(
+          <ContextMenuItem
+            key={qc.query.toString()}
+            onClick={() => {
+              navigateToQuery(qc.query);
+              setSelectedIds([node.id]);
+              navigator.clipboard.writeText(qc.query.toString());
+            }}
+            icon={<Badge>{`${qc.count}`}</Badge>}
+          >
+            {`${qc.query.selector}`}
+          </ContextMenuItem>,
+        ),
+      );
+      return menu;
     },
     [navigateToQuery, setSelectedIds],
   );

web/src/korrel8r/k8s.ts

@@ -1,5 +1,5 @@
 import { getCachedResources } from '../getResources';
-import { Domain, Class, Query, URIRef, keyValueList } from './types';
+import { Class, Domain, Query, URIRef, keyValueList } from './types';
 
 // k8s model type stored in browser cache.
 type Model = {
@@ -18,17 +18,18 @@ type Selector = {
   fields?: { [key: string]: string };
 };
 
-const pathRegex = new RegExp(
+const PATH_RE = new RegExp(
   '(?:k8s|search)/(?:(?:ns/([^/]+))|cluster|all-namespaces)(?:/([^/]+)(?:/([^/]+))?)?(/events)?/?$',
 );
+const CLASS_RE = new RegExp('^([^./]+)(?:.(v[0-9]+(?:(?:alpha|beta)[0-9]*)?))?(?:.([^/]*))?$');
 
 export class K8sDomain extends Domain {
   constructor() {
     super('k8s');
   }
 
   class(name: string): Class {
-    const m = name.match(/^([^.]+)(?:\.([^.]*)(?:\.(.*))?)?$/) ?? [];
+    const m = name.match(CLASS_RE);
     if (!m) throw this.badClass(name);
     const model = findGVK(m[3], m[2], m[1]);
     if (!model) throw this.badClass(name);
@@ -42,7 +43,7 @@ export class K8sDomain extends Domain {
   }
 
   linkToQuery(link: URIRef): Query {
-    const m = link.pathname.match(pathRegex);
+    const m = link.pathname.match(PATH_RE);
     if (!m) throw this.badLink(link);
     const [, namespace, resource, name, events] = m;
     const model = findResource(resource, link.searchParams.get('kind'));
@@ -57,7 +58,7 @@ export class K8sDomain extends Domain {
           'involvedObject.kind': model.kind,
         },
       };
-      return this.class('Event.v1').query(JSON.stringify(data));
+      return this.modelClass(eventModel()).query(JSON.stringify(data));
     } else {
       const data = {
         namespace: namespace,
@@ -79,27 +80,28 @@ export class K8sDomain extends Domain {
     if (!m) throw this.badQuery(query);
     let model = findGVK(m[3], m[2], m[1]);
     if (!model) throw this.badQuery(query);
-    let namespace = data.namespace,
-      name = data.name,
-      events = '';
-    if (model.kind == 'Event' && model.apiVersion == 'v1' && !model.apiGroup) {
+    let namespace = data.namespace;
+    let name = data.name;
+    let events = '';
+    if (isEvent(model)) {
       // Special treatment for event objects: focus on the involved object, not the event.
       events = '/events';
+      const about = eventAboutField(model);
       model = findGVK(
-        data.fields['involvedObject.apiGroup'],
-        data.fields['involvedObject.apiVersion'],
-        data.fields['involvedObject.kind'],
+        data.fields[`${about}.apiGroup`],
+        data.fields[`${about}.apiVersion`],
+        data.fields[`${about}.kind`],
       );
-      if (!model) throw this.badQuery(query);
-      namespace = data.fields['involvedObject.namespace'] || '';
-      name = data.fields['involvedObject.name'] || '';
+      if (!model)
+        throw this.badQuery(query, `no resource for '${about}' field in ${query.selector}`);
+      namespace = data.fields[`${about}.namespace`] || '';
+      name = data.fields[`${about}.name`] || '';
     }
     // Prepare parts of the URL
     const nsPath = namespace ? `ns/${namespace}` : 'all-namespaces';
     const labelsParam = data.labels
       ? `?labels=${encodeURIComponent(keyValueList(data.labels))}`
       : '';
-    model;
     if (!name && !namespace && labelsParam) {
       // Search URL
       return (
@@ -124,15 +126,41 @@ export class K8sDomain extends Domain {
   }
 }
 
+// Original k8s Event resource was in the core group, modern Event is in the events.k8s.io group.
+// Event.v1 has an 'involvedObject' field, Event.v1.events.k8s.io has a 'regarding' field.
+// Handle both variations.
+const EVENT = {
+  group: 'events.k8s.io',
+  version: 'v1',
+  kind: 'Event',
+};
+function isEvent(m: Model): boolean {
+  return (
+    m.kind == EVENT.kind &&
+    m.apiVersion == EVENT.version &&
+    (!m.apiGroup || m.apiGroup === EVENT.group)
+  );
+}
+function eventModel(): Model {
+  return findGVK(EVENT.group, EVENT.version, EVENT.kind) || findGVK('', EVENT.version, EVENT.kind);
+}
+
+function eventAboutField(m: Model): string {
+  return m?.apiGroup === EVENT.group ? 'regarding' : 'involvedObject';
+}
+
+// Find the cached resource model for a GVK. Same defaulting rules as korrel8r..
 function findGVK(group: string, version: string, kind: string): Model {
-  const model = getCachedResources()?.models.find(
-    (m: Model) =>
+  version = version || 'v1';
+  group = group || '';
+  return getCachedResources()?.models.find((m: Model) => {
+    return (
       m.kind === kind &&
       m.verbs.includes('watch') &&
-      (!group || group === m.apiGroup) &&
-      (!version || version === m.apiVersion),
-  );
-  return model || undefined;
+      m.apiVersion === version &&
+      (m.apiGroup || '') === group
+    );
+  });
 }
 
 // Return a model for the resource (path) or undefined