Fix jsonPath functions (#6530)

* Fix jsonPath functions
- Add handling of / shorthand
- Update tests to show new behaviour of safeJSONPathValue so that it is more usable

Signed-off-by: Sebastian Malton <sebastian@malton.name>

* Defend CRDResourceDetails against bad jsonPaths

Signed-off-by: Sebastian Malton <sebastian@malton.name>

* Update CRDResources for new behaviour of helper function

Signed-off-by: Sebastian Malton <sebastian@malton.name>

* Update snapshots

Signed-off-by: Sebastian Malton <sebastian@malton.name>

Signed-off-by: Sebastian Malton <sebastian@malton.name>

src/renderer/components/+custom-resources/__tests__/__snapshots__/custom-resource-details.test.tsx.snap

@@ -45,11 +45,7 @@ exports[`<CustomResourceDetails /> with a CRD with a boolean field should displa
       <span
         class="value"
       >
-        <ul>
+        false
-          <li>
-            false
-          </li>
-        </ul>
       </span>
     </div>
   </div>
@@ -101,11 +97,7 @@ exports[`<CustomResourceDetails /> with a CRD with a boolean field should displa
       <span
         class="value"
       >
-        <ul>
+        true
-          <li>
-            true
-          </li>
-        </ul>
       </span>
     </div>
   </div>
@@ -157,11 +149,7 @@ exports[`<CustomResourceDetails /> with a CRD with a number field should display
       <span
         class="value"
       >
-        <ul>
+        0
-          <li>
-            0
-          </li>
-        </ul>
       </span>
     </div>
   </div>
@@ -213,11 +201,7 @@ exports[`<CustomResourceDetails /> with a CRD with a number field should display
       <span
         class="value"
       >
-        <ul>
+        1234
-          <li>
-            1234
-          </li>
-        </ul>
       </span>
     </div>
   </div>

src/renderer/components/+custom-resources/crd-resource-details.tsx

@@ -15,11 +15,10 @@ import { KubeObjectMeta } from "../kube-object-meta";
 import { Input } from "../input";
 import type { AdditionalPrinterColumnsV1 } from "../../../common/k8s-api/endpoints/custom-resource-definition.api";
 import { CustomResourceDefinition } from "../../../common/k8s-api/endpoints/custom-resource-definition.api";
-import { convertKubectlJsonPathToNodeJsonPath } from "../../utils/jsonPath";
+import { safeJSONPathValue } from "../../utils/jsonPath";
 import type { KubeObjectMetadata, KubeObjectStatus } from "../../../common/k8s-api/kube-object";
 import { KubeObject } from "../../../common/k8s-api/kube-object";
 import logger from "../../../common/logger";
-import { JSONPath } from "@astronautlabs/jsonpath";
 
 export interface CustomResourceDetailsProps extends KubeObjectDetailsProps<KubeObject> {
   crd: CustomResourceDefinition;
@@ -66,7 +65,7 @@ export class CustomResourceDetails extends React.Component<CustomResourceDetails
   renderAdditionalColumns(resource: KubeObject, columns: AdditionalPrinterColumnsV1[]) {
     return columns.map(({ name, jsonPath }) => (
       <DrawerItem key={name} name={name}>
-        {convertSpecValue(JSONPath.query(resource, convertKubectlJsonPathToNodeJsonPath(jsonPath)))}
+        {convertSpecValue(safeJSONPathValue(resource, jsonPath))}
       </DrawerItem>
     ));
   }

src/renderer/components/+custom-resources/crd-resources.tsx

@@ -11,7 +11,7 @@ import { KubeObjectListLayout } from "../kube-object-list-layout";
 import type { IComputedValue } from "mobx";
 import { computed, makeObservable } from "mobx";
 import type { ApiManager } from "../../../common/k8s-api/api-manager";
-import { safeJSONPathValue } from "../../utils/jsonPath";
+import { formatJSONValue, safeJSONPathValue } from "../../utils/jsonPath";
 import { TabLayout } from "../layout/tab-layout-2";
 import { withInjectables } from "@ogre-tools/injectable-react";
 import customResourcesRouteParametersInjectable from "./custom-resources-route-parameters.injectable";
@@ -73,7 +73,7 @@ class NonInjectedCustomResources extends React.Component<Dependencies> {
             [columnId.age]: customResource => -customResource.getCreationTimestamp(),
             ...Object.fromEntries(extraColumns.map(({ name, jsonPath }) => [
               name,
-              customResource => safeJSONPathValue(customResource, jsonPath),
+              customResource => formatJSONValue(safeJSONPathValue(customResource, jsonPath)),
             ])),
           }}
           searchFilters={[

src/renderer/utils/__tests__/jsonPath.test.ts

@@ -5,7 +5,7 @@
 
 import { convertKubectlJsonPathToNodeJsonPath, safeJSONPathValue } from "../jsonPath";
 
-describe("parseJsonPath", () => {
+describe("convertKubectlJsonPathToNodeJsonPath", () => {
   it("should convert \\. to use indexed notation", () => {
     const res = convertKubectlJsonPathToNodeJsonPath(".metadata.labels.kubesphere\\.io/alias-name");
 
@@ -82,13 +82,13 @@ describe("safeJSONPathValue", () => {
   it("should convert boolean values to strings", () => {
     const res = safeJSONPathValue({ bar: false }, ".bar");
 
-    expect(res).toBe("false");
+    expect(res).toBe(false);
   });
 
   it("should convert number values to strings", () => {
     const res = safeJSONPathValue({ bar: 0 }, ".bar");
 
-    expect(res).toBe("0");
+    expect(res).toBe(0);
   });
 
   it("should join sliced entries with commas only", () => {
@@ -103,7 +103,7 @@ describe("safeJSONPathValue", () => {
       ],
     }, ".bar[].foo");
 
-    expect(res).toBe("1");
+    expect(res).toBe(1);
   });
 
   it("should join an array of values using JSON.stringify", () => {
@@ -114,7 +114,7 @@ describe("safeJSONPathValue", () => {
       ],
     }, ".bar");
 
-    expect(res).toBe(`["world","hello"]`);
+    expect(res).toEqual(["world", "hello"]);
   });
 
   it("should stringify an object value", () => {
@@ -122,7 +122,7 @@ describe("safeJSONPathValue", () => {
       foo: { bar: "bat" },
     }, ".foo");
 
-    expect(res).toBe(`{"bar":"bat"}`);
+    expect(res).toEqual({ "bar":"bat" });
   });
 
   it("should use convertKubectlJsonPathToNodeJsonPath", () => {
@@ -155,7 +155,7 @@ describe("safeJSONPathValue", () => {
 
     const res = safeJSONPathValue(obj, ".spec.metrics[*].external.highWatermark..");
 
-    expect(res).toBe("100, 100");
+    expect(res).toEqual(["100", "100"]);
   });
 
   it("should not throw if path is invalid jsonpath", () => {
@@ -163,6 +163,16 @@ describe("safeJSONPathValue", () => {
       foo: { "hello.world": "bat" },
     }, "asd[");
 
-    expect(res).toBe("<unknown>");
+    expect(res).toBe(undefined);
+  });
+
+  it("should retrive value with '/' in jsonpath", () => {
+    const res = safeJSONPathValue({
+      foo: {
+        "hello/world": "bat",
+      },
+    }, ".foo.hello/world");
+
+    expect(res).toBe("bat");
   });
 });

src/renderer/utils/jsonPath.ts

@@ -6,7 +6,7 @@
 import { JSONPath } from "@astronautlabs/jsonpath";
 import { TypedRegEx } from "typed-regex";
 
-const slashDashSearch = /[\\-]/g;
+const slashDashSearch = /[/\\-]/g;
 const pathByBareDots = /(?<=\w)\./;
 const textBeforeFirstSquare = /^.*(?=\[)/g;
 const backSlash = /\\/g;
@@ -22,6 +22,7 @@ const trailingDotDot = /\.\.$/;
  *
  * Known shorthands:
  * - Leading `$` is optional (but implied)
+ * - The string `/` can be used without a leading `\` escapement
  * - The string `\.` is used to denote the "value of '.'" and not "next key"
  * - The string `-` can be used while not in quotes
  * - `[]` as shorthand for `[0]`
@@ -75,7 +76,15 @@ function convertToIndexNotation(key: string, firstItem = false) {
   }
 }
 
-function formatJSONValue(value: unknown) {
+export function formatJSONValue(value: unknown): string {
+  if (value == null) {
+    return "";
+  }
+
+  if (Array.isArray(value)) {
+    return value.map(formatJSONValue).join(", ");
+  }
+
   if (typeof value === "object") {
     return JSON.stringify(value);
   }
@@ -88,21 +97,21 @@ function formatJSONValue(value: unknown) {
  *
  * This function will also stringify the value retreived from the object
  */
-export function safeJSONPathValue(obj: object, path: string): string {
+export function safeJSONPathValue(obj: object, path: string): unknown {
   try {
     const parsedPath = JSONPath.parse(convertKubectlJsonPathToNodeJsonPath(path));
-    const isSlice = parsedPath.some((exp: any) => exp.expression.type === "slice" || "wildcard");
+    const isSlice = parsedPath.some((exp: any) => exp.expression.type === "slice" || exp.expression.type === "wildcard");
     const value = JSONPath.query(obj, JSONPath.stringify(parsedPath), isSlice ? Infinity : 1);
 
     if (isSlice) {
-      return value.map(formatJSONValue).join(", ");
+      return value;
     }
 
-    return formatJSONValue(value[0]);
+    return value[0];
   } catch (error) {
     // something failed
     console.warn("[JSON-PATH]: failed to parse jsonpath", error);
 
-    return "<unknown>";
+    return undefined;
   }
 }