[Vis Builder] Bug fixes for datasource picker and auto time interval (#…

…2632) * Fixes auto time interval Signed-off-by: Ashwin P Chandran <[email protected]> * Fixes change datasource while editing agg Signed-off-by: Ashwin P Chandran <[email protected]> * Misc fixes Signed-off-by: Ashwin P Chandran <[email protected]> * Updates Changelog Signed-off-by: Ashwin P Chandran <[email protected]> * Correctly sets timerange Signed-off-by: Ashwin P Chandran <[email protected]> * Fixes rebase Signed-off-by: Ashwin P Chandran <[email protected]> Signed-off-by: Ashwin P Chandran <[email protected]> (cherry picked from commit 7a41d94) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Nov 3, 2022 · 556bf3d · 556bf3d
1 parent 19656d6
commit 556bf3d
Show file tree

Hide file tree

Showing 18 changed files with 165 additions and 64 deletions.
diff --git a/src/core/public/saved_objects/simple_saved_object.ts b/src/core/public/saved_objects/simple_saved_object.ts
@@ -63,8 +63,7 @@ export class SimpleSavedObject<T = unknown> {
       error,
       references,
       migrationVersion,
-      // eslint-disable-next-line @typescript-eslint/naming-convention
-      updated_at,
+      updated_at: updateAt,
     }: SavedObjectType<T>
   ) {
     this.id = id;
@@ -73,7 +72,7 @@ export class SimpleSavedObject<T = unknown> {
     this.references = references || [];
     this._version = version;
     this.migrationVersion = migrationVersion;
-    this.updated_at = updated_at;
+    this.updated_at = updateAt;
     if (error) {
       this.error = error;
     }

diff --git a/src/plugins/vis_builder/public/application/components/data_tab/use/use_dropbox.tsx b/src/plugins/vis_builder/public/application/components/data_tab/use/use_dropbox.tsx
@@ -8,17 +8,17 @@ import { cloneDeep } from 'lodash';
 import { BucketAggType, IndexPatternField, propFilter } from '../../../../../../data/common';
 import { Schema } from '../../../../../../vis_default_editor/public';
 import { COUNT_FIELD, FieldDragDataType } from '../../../utils/drag_drop/types';
-import { useTypedDispatch, useTypedSelector } from '../../../utils/state_management';
+import { useTypedDispatch } from '../../../utils/state_management';
 import { DropboxDisplay, DropboxProps } from '../dropbox';
 import { useDrop } from '../../../utils/drag_drop';
 import {
   editDraftAgg,
   reorderAgg,
   updateAggConfigParams,
 } from '../../../utils/state_management/visualization_slice';
-import { useIndexPatterns } from '../../../utils/use/use_index_pattern';
 import { useOpenSearchDashboards } from '../../../../../../opensearch_dashboards_react/public';
 import { VisBuilderServices } from '../../../../types';
+import { useAggs } from '../../../utils/use';
 
 const filterByName = propFilter('name');
 const filterByType = propFilter('type');
@@ -30,36 +30,34 @@ export interface UseDropboxProps extends Pick<DropboxProps, 'id' | 'label'> {
 export const useDropbox = (props: UseDropboxProps): DropboxProps => {
   const { id: dropboxId, label, schema } = props;
   const [validAggTypes, setValidAggTypes] = useState<string[]>([]);
+  const { aggConfigs, indexPattern, aggs, timeRange } = useAggs();
   const dispatch = useTypedDispatch();
-  const indexPattern = useIndexPatterns().selected;
   const {
     services: {
       data: {
         search: { aggs: aggService },
       },
     },
   } = useOpenSearchDashboards<VisBuilderServices>();
-  const aggConfigParams = useTypedSelector(
-    (state) => state.visualization.activeVisualization?.aggConfigParams
-  );
-
-  const aggConfigs = useMemo(() => {
-    return indexPattern && aggService.createAggConfigs(indexPattern, cloneDeep(aggConfigParams));
-  }, [aggConfigParams, aggService, indexPattern]);
 
-  const aggs = useMemo(() => aggConfigs?.aggs ?? [], [aggConfigs?.aggs]);
-
-  const dropboxAggs = aggs.filter((agg) => agg.schema === schema.name);
+  const dropboxAggs = useMemo(() => aggs.filter((agg) => agg.schema === schema.name), [
+    aggs,
+    schema.name,
+  ]);
 
   const displayFields: DropboxDisplay[] = useMemo(
     () =>
       dropboxAggs?.map(
-        (agg): DropboxDisplay => ({
-          id: agg.id,
-          label: agg.makeLabel(),
-        })
-      ) || [],
-    [dropboxAggs]
+        (agg): DropboxDisplay => {
+          // For timeseries aggregations that have timeinterval set as auto, the current timerange is required to calculate the label accurately
+          agg.aggConfigs.setTimeRange(timeRange);
+          return {
+            id: agg.id,
+            label: agg.makeLabel(),
+          };
+        }
+      ) ?? [],
+    [dropboxAggs, timeRange]
   );
 
   // Event handlers for each dropbox action type

diff --git a/src/plugins/vis_builder/public/application/components/option.tsx b/src/plugins/vis_builder/public/application/components/option.tsx
@@ -20,6 +20,7 @@ export const Option: FC<Props> = ({ title, children, initialIsOpen = false }) =>
         buttonContent={title}
         className="vbOption"
         initialIsOpen={initialIsOpen}
+        data-test-subj={`vbOption-${title.replace(/\s+/g, '-')}`}
       >
         <EuiSpacer size="s" />
         <EuiPanel color="subdued" className="vbOption__panel">

diff --git a/src/plugins/vis_builder/public/application/components/workspace.tsx b/src/plugins/vis_builder/public/application/components/workspace.tsx
@@ -41,7 +41,7 @@ export const Workspace: FC = ({ children }) => {
   useEffect(() => {
     async function loadExpression() {
       const schemas = ui.containerConfig.data.schemas;
-      const [valid, errorMsg] = validateSchemaState(schemas, rootState);
+      const [valid, errorMsg] = validateSchemaState(schemas, rootState.visualization);
 
       if (!valid) {
         if (errorMsg) {
@@ -50,12 +50,13 @@ export const Workspace: FC = ({ children }) => {
         setExpression(undefined);
         return;
       }
-      const exp = await toExpression(rootState);
+
+      const exp = await toExpression(rootState, searchContext);
       setExpression(exp);
     }
 
     loadExpression();
-  }, [rootState, toExpression, toasts, ui.containerConfig.data.schemas]);
+  }, [rootState, toExpression, toasts, ui.containerConfig.data.schemas, searchContext]);
 
   useLayoutEffect(() => {
     const subscription = data.query.state$.subscribe(({ state }) => {

diff --git a/src/plugins/vis_builder/public/application/utils/state_management/store.ts b/src/plugins/vis_builder/public/application/utils/state_management/store.ts
@@ -72,6 +72,7 @@ export const getPreloadedStore = async (services: VisBuilderServices) => {
 
 // Infer the `RootState` and `AppDispatch` types from the store itself
 export type RootState = ReturnType<typeof rootReducer>;
+export type RenderState = Omit<RootState, 'metadata'>; // Remaining state after auxillary states are removed
 type Store = ReturnType<typeof configurePreloadedStore>;
 export type AppDispatch = Store['dispatch'];
 

diff --git a/src/plugins/vis_builder/public/application/utils/state_management/visualization_slice.ts b/src/plugins/vis_builder/public/application/utils/state_management/visualization_slice.ts
@@ -50,6 +50,7 @@ export const slice = createSlice({
     setIndexPattern: (state, action: PayloadAction<string>) => {
       state.indexPattern = action.payload;
       state.activeVisualization!.aggConfigParams = [];
+      state.activeVisualization!.draftAgg = undefined;
     },
     setSearchField: (state, action: PayloadAction<string>) => {
       state.searchField = action.payload;

diff --git a/src/plugins/vis_builder/public/application/utils/use/index.ts b/src/plugins/vis_builder/public/application/utils/use/index.ts
@@ -3,6 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+export { useAggs } from './use_aggs';
 export { useVisualizationType } from './use_visualization_type';
 export { useIndexPatterns } from './use_index_pattern';
 export { useSavedVisBuilderVis } from './use_saved_vis_builder_vis';
diff --git a/src/plugins/vis_builder/public/application/utils/use/use_aggs.ts b/src/plugins/vis_builder/public/application/utils/use/use_aggs.ts
@@ -0,0 +1,57 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { cloneDeep } from 'lodash';
+import { useLayoutEffect, useMemo, useState } from 'react';
+import { useOpenSearchDashboards } from '../../../../../opensearch_dashboards_react/public';
+import { VisBuilderServices } from '../../../types';
+import { useTypedSelector, useTypedDispatch } from '../state_management';
+import { useIndexPatterns } from './use_index_pattern';
+
+/**
+ * Returns common agg parameters from the store and app context
+ * @returns { indexPattern, aggConfigs, aggs, timeRange }
+ */
+export const useAggs = () => {
+  const {
+    services: {
+      data: {
+        search: { aggs: aggService },
+        query: {
+          timefilter: { timefilter },
+        },
+      },
+    },
+  } = useOpenSearchDashboards<VisBuilderServices>();
+  const indexPattern = useIndexPatterns().selected;
+  const [timeRange, setTimeRange] = useState(timefilter.getTime());
+  const aggConfigParams = useTypedSelector(
+    (state) => state.visualization.activeVisualization?.aggConfigParams
+  );
+  const dispatch = useTypedDispatch();
+
+  const aggConfigs = useMemo(() => {
+    const configs =
+      indexPattern && aggService.createAggConfigs(indexPattern, cloneDeep(aggConfigParams));
+    return configs;
+  }, [aggConfigParams, aggService, indexPattern]);
+
+  useLayoutEffect(() => {
+    const subscription = timefilter.getTimeUpdate$().subscribe(() => {
+      setTimeRange(timefilter.getTime());
+    });
+
+    return () => {
+      subscription.unsubscribe();
+    };
+  }, [dispatch, timefilter]);
+
+  return {
+    indexPattern,
+    aggConfigs,
+    aggs: aggConfigs?.aggs ?? [],
+    timeRange,
+  };
+};
diff --git a/src/plugins/vis_builder/public/application/utils/validate_schema_state.ts b/src/plugins/vis_builder/public/application/utils/validate_schema_state.ts
@@ -5,10 +5,19 @@
 
 import { countBy } from 'lodash';
 import { Schemas } from '../../../../vis_default_editor/public';
-import { RootState } from './state_management';
+import { VisualizationState } from './state_management';
 
-export const validateSchemaState = (schemas: Schemas, state: RootState): [boolean, string?] => {
-  const activeViz = state.visualization.activeVisualization;
+/**
+ * Validate if the visualization state fits the  vis type schema criteria
+ * @param schemas Visualization type config Schema objects
+ * @param state visualization state
+ * @returns [Validity, 'Message']
+ */
+export const validateSchemaState = (
+  schemas: Schemas,
+  state: VisualizationState
+): [boolean, string?] => {
+  const activeViz = state.activeVisualization;
   const vizName = activeViz?.name;
   const aggs = activeViz?.aggConfigParams;
 

diff --git a/src/plugins/vis_builder/public/embeddable/vis_builder_embeddable.tsx b/src/plugins/vis_builder/public/embeddable/vis_builder_embeddable.tsx
@@ -30,6 +30,7 @@ import {
 import { validateSchemaState } from '../application/utils/validate_schema_state';
 import { getExpressionLoader, getTypeService } from '../plugin_services';
 import { PersistedState } from '../../../visualizations/public';
+import { RenderState, VisualizationState } from '../application/utils/state_management';
 
 // Apparently this needs to match the saved object type for the clone and replace panel actions to work
 export const VISBUILDER_EMBEDDABLE = VISBUILDER_SAVED_OBJECT;
@@ -121,24 +122,24 @@ export class VisBuilderEmbeddable extends Embeddable<SavedObjectEmbeddableInput,
     const { visualization, style } = this.serializedState;
 
     const vizStateWithoutIndex = JSON.parse(visualization);
-    const visualizationState = {
+    const visualizationState: VisualizationState = {
       searchField: vizStateWithoutIndex.searchField,
       activeVisualization: vizStateWithoutIndex.activeVisualization,
       indexPattern: this.savedVisBuilder?.searchSourceFields?.index,
     };
-    const rootState = {
+    const renderState: RenderState = {
       visualization: visualizationState,
       style: JSON.parse(style),
     };
-    const visualizationName = rootState.visualization?.activeVisualization?.name ?? '';
+    const visualizationName = renderState.visualization?.activeVisualization?.name ?? '';
     const visualizationType = getTypeService().get(visualizationName);
     if (!visualizationType) {
       this.onContainerError(new Error(`Invalid visualization type ${visualizationName}`));
       return;
     }
     const { toExpression, ui } = visualizationType;
     const schemas = ui.containerConfig.data.schemas;
-    const [valid, errorMsg] = validateSchemaState(schemas, rootState);
+    const [valid, errorMsg] = validateSchemaState(schemas, visualizationState);
 
     if (!valid) {
       if (errorMsg) {
@@ -147,7 +148,11 @@ export class VisBuilderEmbeddable extends Embeddable<SavedObjectEmbeddableInput,
       }
     } else {
       // TODO: handle error in Expression creation
-      const exp = await toExpression(rootState);
+      const exp = await toExpression(renderState, {
+        filters: this.filters,
+        query: this.query,
+        timeRange: this.timeRange,
+      });
       return exp;
     }
   };
@@ -268,12 +273,15 @@ export class VisBuilderEmbeddable extends Embeddable<SavedObjectEmbeddableInput,
     // Check if rootState has changed
     if (!isEqual(this.getSerializedState(), this.serializedState)) {
       this.serializedState = this.getSerializedState();
-      this.expression = (await this.getExpression()) ?? '';
       dirty = true;
     }
 
-    if (this.handler && dirty) {
-      this.updateHandler();
+    if (dirty) {
+      this.expression = (await this.getExpression()) ?? '';
+
+      if (this.handler) {
+        this.updateHandler();
+      }
     }
   }
 

diff --git a/src/plugins/vis_builder/public/services/type_service/types.ts b/src/plugins/vis_builder/public/services/type_service/types.ts
@@ -4,8 +4,9 @@
  */
 import { ReactElement } from 'react';
 import { IconType } from '@elastic/eui';
-import { RootState } from '../../application/utils/state_management';
+import { RenderState } from '../../application/utils/state_management';
 import { Schemas } from '../../../../vis_default_editor/public';
+import { IExpressionLoaderParams } from '../../../../expressions/public';
 
 export interface DataTabConfig {
   schemas: Schemas;
@@ -28,5 +29,8 @@ export interface VisualizationTypeOptions<T = any> {
       style: StyleTabConfig<T>;
     };
   };
-  readonly toExpression: (state: RootState) => Promise<string | undefined>;
+  readonly toExpression: (
+    state: RenderState,
+    searchContext: IExpressionLoaderParams['searchContext']
+  ) => Promise<string | undefined>;
 }
diff --git a/src/plugins/vis_builder/public/services/type_service/visualization_type.tsx b/src/plugins/vis_builder/public/services/type_service/visualization_type.tsx
@@ -3,7 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { IconType } from '@elastic/eui';
-import { RootState } from '../../application/utils/state_management';
+import { IExpressionLoaderParams } from '../../../../expressions/public';
+import { RenderState } from '../../application/utils/state_management';
 import { VisualizationTypeOptions } from './types';
 
 type IVisualizationType = VisualizationTypeOptions;
@@ -15,7 +16,10 @@ export class VisualizationType implements IVisualizationType {
   public readonly icon: IconType;
   public readonly stage: 'experimental' | 'production';
   public readonly ui: IVisualizationType['ui'];
-  public readonly toExpression: (state: RootState) => Promise<string | undefined>;
+  public readonly toExpression: (
+    state: RenderState,
+    searchContext: IExpressionLoaderParams['searchContext']
+  ) => Promise<string | undefined>;
 
   constructor(options: VisualizationTypeOptions) {
     this.name = options.name;

diff --git a/src/plugins/vis_builder/public/visualizations/metric/to_expression.ts b/src/plugins/vis_builder/public/visualizations/metric/to_expression.ts
@@ -7,7 +7,7 @@ import { SchemaConfig } from '../../../../visualizations/public';
 import { MetricVisExpressionFunctionDefinition } from '../../../../vis_type_metric/public';
 import { AggConfigs, IAggConfig } from '../../../../data/common';
 import { buildExpression, buildExpressionFunction } from '../../../../expressions/public';
-import { RootState } from '../../application/utils/state_management';
+import { RenderState } from '../../application/utils/state_management';
 import { MetricOptionsDefaults } from './metric_viz_type';
 import { getAggExpressionFunctions } from '../common/expression_helpers';
 
@@ -82,7 +82,7 @@ const getVisSchemas = (aggConfigs: AggConfigs): any => {
   return schemas;
 };
 
-export interface MetricRootState extends RootState {
+export interface MetricRootState extends RenderState {
   style: MetricOptionsDefaults;
 }
 

diff --git a/src/plugins/vis_builder/public/visualizations/vislib/area/to_expression.ts b/src/plugins/vis_builder/public/visualizations/vislib/area/to_expression.ts
@@ -4,22 +4,26 @@
  */
 
 import { buildVislibDimensions } from '../../../../../visualizations/public';
-import { buildExpression, buildExpressionFunction } from '../../../../../expressions/public';
+import {
+  buildExpression,
+  buildExpressionFunction,
+  IExpressionLoaderParams,
+} from '../../../../../expressions/public';
 import { AreaOptionsDefaults } from './area_vis_type';
 import { getAggExpressionFunctions } from '../../common/expression_helpers';
 import { VislibRootState, getValueAxes, getPipelineParams } from '../common';
 import { createVis } from '../common/create_vis';
 
-export const toExpression = async ({
-  style: styleState,
-  visualization,
-}: VislibRootState<AreaOptionsDefaults>) => {
+export const toExpression = async (
+  { style: styleState, visualization }: VislibRootState<AreaOptionsDefaults>,
+  searchContext: IExpressionLoaderParams['searchContext']
+) => {
   const { aggConfigs, expressionFns, indexPattern } = await getAggExpressionFunctions(
     visualization
   );
   const { addLegend, addTooltip, legendPosition, type } = styleState;
 
-  const vis = await createVis(type, aggConfigs, indexPattern);
+  const vis = await createVis(type, aggConfigs, indexPattern, searchContext?.timeRange);
 
   const params = getPipelineParams();
   const dimensions = await buildVislibDimensions(vis, params);