[Vis Builder] Misc Bar chart fixes (#2401) (#2447)

* consolidates state to saved object serialization Signed-off-by: Ashwin P Chandran <[email protected]> * fixes histogram agg Signed-off-by: Ashwin P Chandran <[email protected]> * fixes orderBy Signed-off-by: Ashwin P Chandran <[email protected]> * style fixes Signed-off-by: Ashwin P Chandran <[email protected]> * updates base test Signed-off-by: Ashwin P Chandran <[email protected]> * Updates changelog Signed-off-by: Ashwin P Chandran <[email protected]> Signed-off-by: Ashwin P Chandran <[email protected]> (cherry picked from commit 83f1306) Co-authored-by: Ashwin P Chandran <[email protected]>
opensearch-project · Sep 29, 2022 · 0c808dc · 0c808dc
1 parent f52ef60
commit 0c808dc
Show file tree

Hide file tree

Showing 19 changed files with 214 additions and 77 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,9 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### 📈 Features/Enhancements
 
 ### 🐛 Bug Fixes
+* [Vis Builder] Fixes auto bounds for timeseries bar chart visualization ([2401](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2401))
+* [Vis Builder] Fixes visualization shift when editing agg ([2401](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2401))
+* [Vis Builder] Renames "Histogram" to "Bar" in vis type picker ([2401](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2401))
 
 ### 🚞 Infrastructure
 

diff --git a/src/plugins/wizard/opensearch_dashboards.json b/src/plugins/wizard/opensearch_dashboards.json
@@ -5,19 +5,19 @@
   "server": true,
   "ui": true,
   "requiredPlugins": [
+    "dashboard",
+    "data",
+    "embeddable",
+    "expressions",
     "navigation",
+    "savedObjects",
+    "visualizations"
+  ],
+  "requiredBundles": [
     "charts",
-    "data",
     "opensearchDashboardsReact",
     "opensearchDashboardsUtils",
-    "savedObjects",
-    "embeddable",
-    "expressions",
-    "dashboard",
-    "visualizations",
-    "opensearchUiShared",
     "visDefaultEditor",
     "visTypeVislib"
-  ],
-  "optionalPlugins": []
+  ]
 }
diff --git a/src/plugins/wizard/public/application/components/data_tab/config_panel.scss b/src/plugins/wizard/public/application/components/data_tab/config_panel.scss
@@ -36,6 +36,10 @@
     position: absolute;
     top: 0;
     left: 100%;
+
+    .visEditorAggParam--half {
+      margin: $euiSize 0;
+    }
   }
 
   &.showSecondary > .wizConfig__section {

diff --git a/src/plugins/wizard/public/application/components/data_tab/secondary_panel.tsx b/src/plugins/wizard/public/application/components/data_tab/secondary_panel.tsx
@@ -19,7 +19,9 @@ import { setValidity } from '../../utils/state_management/metadata_slice';
 const EDITOR_KEY = 'CONFIG_PANEL';
 
 export function SecondaryPanel() {
-  const draftAgg = useTypedSelector((state) => state.visualization.activeVisualization!.draftAgg);
+  const { draftAgg, aggConfigParams } = useTypedSelector(
+    (state) => state.visualization.activeVisualization!
+  );
   const isEditorValid = useTypedSelector((state) => state.metadata.editor.validity[EDITOR_KEY]);
   const [touched, setTouched] = useState(false);
   const dispatch = useTypedDispatch();
@@ -39,9 +41,21 @@ export function SecondaryPanel() {
       indexPattern && draftAgg && aggService.createAggConfigs(indexPattern, [cloneDeep(draftAgg)])
     );
   }, [draftAgg, aggService, indexPattern]);
-
   const aggConfig = aggConfigs?.aggs[0];
 
+  const metricAggs = useMemo(
+    () =>
+      indexPattern
+        ? aggService.createAggConfigs(
+            indexPattern,
+            cloneDeep(
+              aggConfigParams.filter((aggConfigParam) => aggConfigParam.schema === 'metric')
+            )
+          ).aggs
+        : [],
+    [aggConfigParams, aggService, indexPattern]
+  );
+
   const selectedSchema = useMemo(
     () => schemas.find((schema) => schema.name === aggConfig?.schema),
     [aggConfig?.schema, schemas]
@@ -93,7 +107,7 @@ export function SecondaryPanel() {
           schemas={schemas}
           formIsTouched={touched}
           groupName={selectedSchema?.group ?? 'none'}
-          metricAggs={[]}
+          metricAggs={metricAggs}
           state={{
             data: {},
             description: '',

diff --git a/src/plugins/wizard/public/application/components/top_nav.tsx b/src/plugins/wizard/public/application/components/top_nav.tsx
@@ -16,6 +16,7 @@ import { useIndexPatterns, useSavedWizardVis } from '../utils/use';
 import { useTypedSelector, useTypedDispatch } from '../utils/state_management';
 import { setEditorState } from '../utils/state_management/metadata_slice';
 import { useCanSave } from '../utils/use/use_can_save';
+import { saveStateToSavedObject } from '../../saved_visualizations/transforms';
 
 export const TopNav = () => {
   // id will only be set for the edit route
@@ -32,26 +33,29 @@ export const TopNav = () => {
 
   const saveDisabledReason = useCanSave();
   const savedWizardVis = useSavedWizardVis(visualizationIdFromUrl);
+  const { selected: indexPattern } = useIndexPatterns();
 
   const config = useMemo(() => {
-    if (savedWizardVis === undefined) return;
-
-    const { visualization: visualizationState, style: styleState } = rootState;
+    if (!savedWizardVis || !indexPattern) return;
 
     return getTopNavConfig(
       {
         visualizationIdFromUrl,
-        savedWizardVis,
-        visualizationState,
-        styleState,
+        savedWizardVis: saveStateToSavedObject(savedWizardVis, rootState, indexPattern),
         saveDisabledReason,
         dispatch,
       },
       services
     );
-  }, [rootState, savedWizardVis, services, visualizationIdFromUrl, saveDisabledReason, dispatch]);
-
-  const indexPattern = useIndexPatterns().selected;
+  }, [
+    savedWizardVis,
+    visualizationIdFromUrl,
+    rootState,
+    indexPattern,
+    saveDisabledReason,
+    dispatch,
+    services,
+  ]);
 
   // reset validity before component destroyed
   useUnmount(() => {
@@ -65,6 +69,7 @@ export const TopNav = () => {
         config={config}
         setMenuMountPoint={setHeaderActionMenu}
         indexPatterns={indexPattern ? [indexPattern] : []}
+        showDatePicker={!!indexPattern?.timeFieldName ?? true}
         showSearchBar
         showSaveQuery
         useDefaultBehaviors

diff --git a/src/plugins/wizard/public/application/components/workspace.scss b/src/plugins/wizard/public/application/components/workspace.scss
@@ -2,6 +2,12 @@
  * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  */
+
+$animation-time: 3;
+$animation-multiplier: 5;
+$total-duartion: $animation-time * $animation-multiplier;
+$keyframe-multiplier: 1 / $animation-multiplier;
+
 .wizWorkspace {
   display: grid;
   -ms-grid-rows: auto $euiSizeM 1fr;
@@ -21,22 +27,28 @@
   }
 
   &__handFieldSvg {
-    animation: wizDragAnimation 6s ease-in-out infinite forwards;
+    animation: wizDragAnimation #{$total-duartion}s ease-in-out infinite forwards;
     position: absolute;
     top: 34.5%;
   }
 }
 
+@media (prefers-reduced-motion) {
+  .wizWorkspace__handFieldSvg {
+    animation: none;
+  }
+}
+
 @keyframes wizDragAnimation {
   0% {
     transform: none;
   }
 
-  30% {
+  #{$keyframe-multiplier * 50%} {
     transform: translate(116%, -80%);
   }
 
-  60% {
+  #{$keyframe-multiplier * 100%} {
     transform: none;
   }
 

diff --git a/src/plugins/wizard/public/application/utils/get_top_nav_config.tsx b/src/plugins/wizard/public/application/utils/get_top_nav_config.tsx
@@ -38,33 +38,19 @@ import {
 } from '../../../../saved_objects/public';
 import { WizardServices } from '../..';
 import { WizardVisSavedObject } from '../../types';
-import { StyleState, VisualizationState, AppDispatch } from './state_management';
+import { AppDispatch } from './state_management';
 import { EDIT_PATH } from '../../../common';
 import { setEditorState } from './state_management/metadata_slice';
 interface TopNavConfigParams {
   visualizationIdFromUrl: string;
   savedWizardVis: WizardVisSavedObject;
-  visualizationState: VisualizationState;
-  styleState: StyleState;
   saveDisabledReason?: string;
   dispatch: AppDispatch;
 }
 
 export const getTopNavConfig = (
-  {
-    visualizationIdFromUrl,
-    savedWizardVis,
-    visualizationState,
-    styleState,
-    saveDisabledReason,
-    dispatch,
-  }: TopNavConfigParams,
-  {
-    history,
-    toastNotifications,
-    i18n: { Context: I18nContext },
-    data: { indexPatterns },
-  }: WizardServices
+  { visualizationIdFromUrl, savedWizardVis, saveDisabledReason, dispatch }: TopNavConfigParams,
+  { history, toastNotifications, i18n: { Context: I18nContext } }: WizardServices
 ) => {
   const topNavConfig: TopNavMenuData[] = [
     {
@@ -94,16 +80,6 @@ export const getTopNavConfig = (
             return;
           }
           const currentTitle = savedWizardVis.title;
-          const indexPattern = await indexPatterns.get(visualizationState.indexPattern || '');
-          savedWizardVis.searchSourceFields = {
-            index: indexPattern,
-          };
-          const vizStateWithoutIndex = {
-            searchField: visualizationState.searchField,
-            activeVisualization: visualizationState.activeVisualization,
-          };
-          savedWizardVis.visualizationState = JSON.stringify(vizStateWithoutIndex);
-          savedWizardVis.styleState = JSON.stringify(styleState);
           savedWizardVis.title = newTitle;
           savedWizardVis.description = newDescription;
           savedWizardVis.copyOnSave = newCopyOnSave;

diff --git a/src/plugins/wizard/public/application/utils/use/use_index_pattern.tsx b/src/plugins/wizard/public/application/utils/use/use_index_pattern.tsx
@@ -17,7 +17,7 @@ export const useIndexPatterns = () => {
     services: { data },
   } = useOpenSearchDashboards<WizardServices>();
 
-  let foundSelected: IndexPattern;
+  let foundSelected: IndexPattern | undefined;
   if (!loading && !error) {
     foundSelected = indexPatterns.filter((p) => p.id === indexId)[0];
     if (foundSelected === undefined) {
@@ -47,6 +47,6 @@ export const useIndexPatterns = () => {
     indexPatterns,
     error,
     loading,
-    selected: foundSelected!,
+    selected: foundSelected,
   };
 };
diff --git a/src/plugins/wizard/public/plugin.ts b/src/plugins/wizard/public/plugin.ts
@@ -26,7 +26,7 @@ import { EDIT_PATH, PLUGIN_ID, PLUGIN_NAME, WIZARD_SAVED_OBJECT } from '../commo
 import { TypeService } from './services/type_service';
 import { getPreloadedStore } from './application/utils/state_management';
 import {
-  setAggService,
+  setSearchService,
   setIndexPatterns,
   setHttp,
   setSavedWizardLoader,
@@ -150,7 +150,7 @@ export class WizardPlugin
     });
 
     // Register plugin services
-    setAggService(data.search.aggs);
+    setSearchService(data.search);
     setExpressionLoader(expressions.ExpressionLoader);
     setReactExpressionRenderer(expressions.ReactExpressionRenderer);
     setHttp(core.http);

diff --git a/src/plugins/wizard/public/plugin_services.ts b/src/plugins/wizard/public/plugin_services.ts
@@ -10,9 +10,9 @@ import { HttpStart, IUiSettingsClient } from '../../../core/public';
 import { ExpressionsStart } from '../../expressions/public';
 import { TypeServiceStart } from './services/type_service';
 
-export const [getAggService, setAggService] = createGetterSetter<
-  DataPublicPluginStart['search']['aggs']
->('data.search.aggs');
+export const [getSearchService, setSearchService] = createGetterSetter<
+  DataPublicPluginStart['search']
+>('data.search');
 
 export const [getExpressionLoader, setExpressionLoader] = createGetterSetter<
   ExpressionsStart['ExpressionLoader']

diff --git a/src/plugins/wizard/public/saved_visualizations/transforms.test.ts b/src/plugins/wizard/public/saved_visualizations/transforms.test.ts
@@ -0,0 +1,64 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { coreMock } from '../../../../core/public/mocks';
+import { getStubIndexPattern } from '../../../../plugins/data/public/test_utils';
+import { IndexPattern } from '../../../data/public';
+import { RootState } from '../application/utils/state_management';
+import { WizardVisSavedObject } from '../types';
+import { saveStateToSavedObject } from './transforms';
+
+const getConfig = (cfg: any) => cfg;
+
+describe('transforms', () => {
+  describe('saveStateToSavedObject', () => {
+    let TEST_INDEX_PATTERN_ID;
+    let savedObject;
+    let rootState: RootState;
+    let indexPattern: IndexPattern;
+
+    beforeEach(() => {
+      TEST_INDEX_PATTERN_ID = 'test-pattern';
+      savedObject = {} as WizardVisSavedObject;
+      rootState = {
+        metadata: { editor: { state: 'loading', validity: {} } },
+        style: '',
+        visualization: {
+          searchField: '',
+          indexPattern: TEST_INDEX_PATTERN_ID,
+          activeVisualization: {
+            name: 'bar',
+            aggConfigParams: [],
+          },
+        },
+      };
+      indexPattern = getStubIndexPattern(
+        TEST_INDEX_PATTERN_ID,
+        getConfig,
+        null,
+        [],
+        coreMock.createSetup()
+      );
+    });
+
+    test('should save root state information into saved object', async () => {
+      saveStateToSavedObject(savedObject, rootState, indexPattern);
+
+      expect(savedObject.visualizationState).not.toContain(TEST_INDEX_PATTERN_ID);
+      expect(savedObject.styleState).toEqual(JSON.stringify(rootState.style));
+      expect(savedObject.searchSourceFields?.index?.id).toEqual(TEST_INDEX_PATTERN_ID);
+    });
+
+    test('should fail if the index pattern does not match the value on state', () => {
+      rootState.visualization.indexPattern = 'Some-other-pattern';
+
+      expect(() =>
+        saveStateToSavedObject(savedObject, rootState, indexPattern)
+      ).toThrowErrorMatchingInlineSnapshot(
+        `"indexPattern id should match the value in redux state"`
+      );
+    });
+  });
+});
diff --git a/src/plugins/wizard/public/saved_visualizations/transforms.ts b/src/plugins/wizard/public/saved_visualizations/transforms.ts
@@ -0,0 +1,28 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import produce from 'immer';
+import { IndexPattern } from '../../../data/public';
+import { RootState, VisualizationState } from '../application/utils/state_management';
+import { WizardVisSavedObject } from '../types';
+
+export const saveStateToSavedObject = (
+  obj: WizardVisSavedObject,
+  state: RootState,
+  indexPattern: IndexPattern
+): WizardVisSavedObject => {
+  if (state.visualization.indexPattern !== indexPattern.id)
+    throw new Error('indexPattern id should match the value in redux state');
+
+  obj.visualizationState = JSON.stringify(
+    produce(state.visualization, (draft: VisualizationState) => {
+      delete draft.indexPattern;
+    })
+  );
+  obj.styleState = JSON.stringify(state.style);
+  obj.searchSourceFields = { index: indexPattern };
+
+  return obj;
+};