[8.x] [Lens][Datatable] Fix share export and inspect data (#193780) (#…

…197696) # Backport This will backport the following commits from `main` to `8.x`: - [[Lens][Datatable] Fix share export and inspect data (#193780)](#193780)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Nick Partridge <[email protected]>
elastic · Oct 24, 2024 · c7a27b8 · c7a27b8
1 parent 0ffda7b
commit c7a27b8
Show file tree

Hide file tree

Showing 52 changed files with 478 additions and 280 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -945,6 +945,7 @@ packages/kbn-tinymath @elastic/kibana-visualizations
 packages/kbn-tooling-log @elastic/kibana-operations
 x-pack/plugins/transform @elastic/ml-ui
 x-pack/plugins/translations @elastic/kibana-localization
+packages/kbn-transpose-utils @elastic/kibana-visualizations
 x-pack/examples/triggers_actions_ui_example @elastic/response-ops
 x-pack/plugins/triggers_actions_ui @elastic/response-ops
 packages/kbn-triggers-actions-ui-types @elastic/response-ops

diff --git a/package.json b/package.json
@@ -945,6 +945,7 @@
     "@kbn/tinymath": "link:packages/kbn-tinymath",
     "@kbn/transform-plugin": "link:x-pack/plugins/transform",
     "@kbn/translations-plugin": "link:x-pack/plugins/translations",
+    "@kbn/transpose-utils": "link:packages/kbn-transpose-utils",
     "@kbn/triggers-actions-ui-example-plugin": "link:x-pack/examples/triggers_actions_ui_example",
     "@kbn/triggers-actions-ui-plugin": "link:x-pack/plugins/triggers_actions_ui",
     "@kbn/triggers-actions-ui-types": "link:packages/kbn-triggers-actions-ui-types",

diff --git a/packages/kbn-transpose-utils/README.md b/packages/kbn-transpose-utils/README.md
@@ -0,0 +1,3 @@
+# @kbn/transpose-utils
+
+Utility functions used to identify and convert transposed column ids.
diff --git a/packages/kbn-transpose-utils/index.test.ts b/packages/kbn-transpose-utils/index.test.ts
@@ -0,0 +1,35 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { getOriginalId, getTransposeId, isTransposeId } from '.';
+
+describe('transpose utils', () => {
+  it('should covert value and id to transposed id', () => {
+    expect(getTransposeId('test', 'column-1')).toBe('test---column-1');
+  });
+
+  it('should know if id is transposed', () => {
+    const testId = getTransposeId('test', 'column-1');
+    expect(isTransposeId(testId)).toBe(true);
+  });
+
+  it('should know if id is not transposed', () => {
+    expect(isTransposeId('test')).toBe(false);
+  });
+
+  it('should return id for transposed id', () => {
+    const testId = getTransposeId('test', 'column-1');
+
+    expect(getOriginalId(testId)).toBe('column-1');
+  });
+
+  it('should return id for non-transposed id', () => {
+    expect(getOriginalId('test')).toBe('test');
+  });
+});
diff --git a/packages/kbn-transpose-utils/index.ts b/packages/kbn-transpose-utils/index.ts
@@ -0,0 +1,36 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+/**
+ * Used to delimitate felids of a transposed column id
+ */
+export const TRANSPOSE_SEPARATOR = '---';
+
+/**
+ * Visual deliminator between felids of a transposed column id
+ *
+ * Meant to align with the `MULTI_FIELD_KEY_SEPARATOR` from the data plugin
+ */
+export const TRANSPOSE_VISUAL_SEPARATOR = '›';
+
+export function getTransposeId(value: string, columnId: string) {
+  return `${value}${TRANSPOSE_SEPARATOR}${columnId}`;
+}
+
+export function isTransposeId(id: string): boolean {
+  return id.split(TRANSPOSE_SEPARATOR).length > 1;
+}
+
+export function getOriginalId(id: string) {
+  if (id.includes(TRANSPOSE_SEPARATOR)) {
+    const idParts = id.split(TRANSPOSE_SEPARATOR);
+    return idParts[idParts.length - 1];
+  }
+  return id;
+}
diff --git a/packages/kbn-transpose-utils/jest.config.js b/packages/kbn-transpose-utils/jest.config.js
@@ -0,0 +1,14 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+module.exports = {
+  preset: '@kbn/test',
+  rootDir: '../..',
+  roots: ['<rootDir>/packages/kbn-transpose-utils'],
+};
diff --git a/packages/kbn-transpose-utils/kibana.jsonc b/packages/kbn-transpose-utils/kibana.jsonc
@@ -0,0 +1,5 @@
+{
+  "type": "shared-common",
+  "id": "@kbn/transpose-utils",
+  "owner": "@elastic/kibana-visualizations"
+}
diff --git a/packages/kbn-transpose-utils/package.json b/packages/kbn-transpose-utils/package.json
@@ -0,0 +1,6 @@
+{
+  "name": "@kbn/transpose-utils",
+  "private": true,
+  "version": "1.0.0",
+  "license": "Elastic License 2.0 OR AGPL-3.0-only OR SSPL-1.0"
+}
diff --git a/packages/kbn-transpose-utils/tsconfig.json b/packages/kbn-transpose-utils/tsconfig.json
@@ -0,0 +1,19 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "target/types",
+    "types": [
+      "jest",
+      "node",
+      "react"
+    ]
+  },
+  "include": [
+    "**/*.ts",
+    "**/*.tsx",
+  ],
+  "exclude": [
+    "target/**/*"
+  ],
+  "kbn_references": []
+}
diff --git a/src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts b/src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts
@@ -11,6 +11,8 @@ import { $Values } from '@kbn/utility-types';
 import type { PaletteOutput, CustomPaletteParams } from '@kbn/coloring';
 import {
   Datatable,
+  DefaultInspectorAdapters,
+  ExecutionContext,
   ExpressionFunctionDefinition,
   ExpressionValueRender,
 } from '@kbn/expressions-plugin/common';
@@ -86,7 +88,8 @@ export type GaugeExpressionFunctionDefinition = ExpressionFunctionDefinition<
   typeof EXPRESSION_GAUGE_NAME,
   GaugeInput,
   GaugeArguments,
-  ExpressionValueRender<GaugeExpressionProps>
+  ExpressionValueRender<GaugeExpressionProps>,
+  ExecutionContext<DefaultInspectorAdapters>
 >;
 
 export interface Accessors {

diff --git a/src/plugins/chart_expressions/expression_heatmap/common/types/expression_functions.ts b/src/plugins/chart_expressions/expression_heatmap/common/types/expression_functions.ts
@@ -11,6 +11,8 @@ import { Position } from '@elastic/charts';
 import type { PaletteOutput } from '@kbn/coloring';
 import {
   Datatable,
+  DefaultInspectorAdapters,
+  ExecutionContext,
   ExpressionFunctionDefinition,
   ExpressionValueRender,
 } from '@kbn/expressions-plugin/common';
@@ -114,7 +116,8 @@ export type HeatmapExpressionFunctionDefinition = ExpressionFunctionDefinition<
   typeof EXPRESSION_HEATMAP_NAME,
   HeatmapInput,
   HeatmapArguments,
-  ExpressionValueRender<HeatmapExpressionProps>
+  ExpressionValueRender<HeatmapExpressionProps>,
+  ExecutionContext<DefaultInspectorAdapters>
 >;
 
 export type HeatmapLegendExpressionFunctionDefinition = ExpressionFunctionDefinition<

diff --git a/src/plugins/chart_expressions/expression_heatmap/public/components/helpers.ts b/src/plugins/chart_expressions/expression_heatmap/public/components/helpers.ts
@@ -18,6 +18,7 @@ import {
   DEFAULT_MAX_STOP,
   DEFAULT_MIN_STOP,
 } from '@kbn/coloring';
+import { getOriginalId } from '@kbn/transpose-utils';
 
 import type { Datatable, DatatableColumn } from '@kbn/expressions-plugin/public';
 import { FormatFactory, IFieldFormat } from '@kbn/field-formats-plugin/common';
@@ -83,22 +84,14 @@ export function applyPaletteParams<T extends PaletteOutput<CustomPaletteParams>>
   return displayStops;
 }
 
-function getId(id: string) {
-  return id;
-}
-
 export function getNumericValue(rowValue: number | number[] | undefined) {
   if (rowValue == null || Array.isArray(rowValue)) {
     return;
   }
   return rowValue;
 }
 
-export const findMinMaxByColumnId = (
-  columnIds: string[],
-  table: Datatable | undefined,
-  getOriginalId: (id: string) => string = getId
-) => {
+export const findMinMaxByColumnId = (columnIds: string[], table: Datatable | undefined) => {
   const minMax: Record<string, { min: number; max: number; fallback?: boolean }> = {};
 
   if (table != null) {

diff --git a/src/plugins/chart_expressions/expression_heatmap/tsconfig.json b/src/plugins/chart_expressions/expression_heatmap/tsconfig.json
@@ -28,6 +28,7 @@
     "@kbn/chart-expressions-common",
     "@kbn/visualization-utils",
     "@kbn/react-kibana-context-render",
+    "@kbn/transpose-utils",
   ],
   "exclude": [
     "target/**/*",

diff --git a/src/plugins/chart_expressions/expression_legacy_metric/common/types/expression_functions.ts b/src/plugins/chart_expressions/expression_legacy_metric/common/types/expression_functions.ts
@@ -10,6 +10,8 @@
 import type { PaletteOutput } from '@kbn/coloring';
 import {
   Datatable,
+  DefaultInspectorAdapters,
+  ExecutionContext,
   ExpressionFunctionDefinition,
   ExpressionValueRender,
   Style,
@@ -47,5 +49,6 @@ export type MetricVisExpressionFunctionDefinition = ExpressionFunctionDefinition
   typeof EXPRESSION_METRIC_NAME,
   MetricInput,
   MetricArguments,
-  ExpressionValueRender<MetricVisRenderConfig>
+  ExpressionValueRender<MetricVisRenderConfig>,
+  ExecutionContext<DefaultInspectorAdapters>
 >;
diff --git a/src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts b/src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts
@@ -12,6 +12,8 @@ import { LayoutDirection, MetricStyle, MetricWTrend } from '@elastic/charts';
 import { $Values } from '@kbn/utility-types';
 import {
   Datatable,
+  DefaultInspectorAdapters,
+  ExecutionContext,
   ExpressionFunctionDefinition,
   ExpressionValueRender,
 } from '@kbn/expressions-plugin/common';
@@ -64,7 +66,8 @@ export type MetricVisExpressionFunctionDefinition = ExpressionFunctionDefinition
   typeof EXPRESSION_METRIC_NAME,
   MetricInput,
   MetricArguments,
-  ExpressionValueRender<MetricVisRenderConfig>
+  ExpressionValueRender<MetricVisRenderConfig>,
+  ExecutionContext<DefaultInspectorAdapters>
 >;
 
 export interface TrendlineArguments {

diff --git a/src/plugins/chart_expressions/expression_partition_vis/common/types/expression_functions.ts b/src/plugins/chart_expressions/expression_partition_vis/common/types/expression_functions.ts
@@ -14,6 +14,8 @@ import {
   Datatable,
   ExpressionValueRender,
   ExpressionValueBoxed,
+  DefaultInspectorAdapters,
+  ExecutionContext,
 } from '@kbn/expressions-plugin/common';
 import {
   PARTITION_LABELS_VALUE,
@@ -66,28 +68,32 @@ export type PieVisExpressionFunctionDefinition = ExpressionFunctionDefinition<
   typeof PIE_VIS_EXPRESSION_NAME,
   Datatable,
   PieVisConfig,
-  ExpressionValueRender<PartitionChartProps>
+  ExpressionValueRender<PartitionChartProps>,
+  ExecutionContext<DefaultInspectorAdapters>
 >;
 
 export type TreemapVisExpressionFunctionDefinition = ExpressionFunctionDefinition<
   typeof TREEMAP_VIS_EXPRESSION_NAME,
   Datatable,
   TreemapVisConfig,
-  ExpressionValueRender<PartitionChartProps>
+  ExpressionValueRender<PartitionChartProps>,
+  ExecutionContext<DefaultInspectorAdapters>
 >;
 
 export type MosaicVisExpressionFunctionDefinition = ExpressionFunctionDefinition<
   typeof MOSAIC_VIS_EXPRESSION_NAME,
   Datatable,
   MosaicVisConfig,
-  ExpressionValueRender<PartitionChartProps>
+  ExpressionValueRender<PartitionChartProps>,
+  ExecutionContext<DefaultInspectorAdapters>
 >;
 
 export type WaffleVisExpressionFunctionDefinition = ExpressionFunctionDefinition<
   typeof WAFFLE_VIS_EXPRESSION_NAME,
   Datatable,
   WaffleVisConfig,
-  ExpressionValueRender<PartitionChartProps>
+  ExpressionValueRender<PartitionChartProps>,
+  ExecutionContext<DefaultInspectorAdapters>
 >;
 
 export enum ChartTypes {
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# @kbn/transpose-utils

		Utility functions used to identify and convert transposed column ids.