[Lens] Make date histogram interval more customizable (#49217) (#49654)

elastic · Oct 29, 2019 · f90855e · f90855e
1 parent 150e822
commit f90855e
Show file tree

Hide file tree

Showing 17 changed files with 463 additions and 239 deletions.
diff --git a/src/legacy/ui/public/agg_types/utils.ts b/src/legacy/ui/public/agg_types/utils.ts
@@ -49,7 +49,7 @@ function isValidJson(value: string): boolean {
   }
 }
 
-function isValidInterval(value: string, baseInterval: string) {
+function isValidInterval(value: string, baseInterval?: string) {
   if (baseInterval) {
     return _parseWithBase(value, baseInterval);
   } else {

diff --git a/x-pack/legacy/plugins/lens/public/editor_frame_plugin/editor_frame/editor_frame.test.tsx b/x-pack/legacy/plugins/lens/public/editor_frame_plugin/editor_frame/editor_frame.test.tsx
@@ -807,30 +807,38 @@ describe('editor_frame', () => {
       await waitForPromises();
 
       expect(mockDatasource.getPublicAPI).toHaveBeenCalledWith(
-        datasource1State,
-        expect.anything(),
-        'first'
+        expect.objectContaining({
+          state: datasource1State,
+          setState: expect.anything(),
+          layerId: 'first',
+        })
       );
       expect(mockDatasource2.getPublicAPI).toHaveBeenCalledWith(
-        datasource2State,
-        expect.anything(),
-        'second'
+        expect.objectContaining({
+          state: datasource2State,
+          setState: expect.anything(),
+          layerId: 'second',
+        })
       );
       expect(mockDatasource2.getPublicAPI).toHaveBeenCalledWith(
-        datasource2State,
-        expect.anything(),
-        'third'
+        expect.objectContaining({
+          state: datasource2State,
+          setState: expect.anything(),
+          layerId: 'third',
+        })
       );
     });
 
     it('should give access to the datasource state in the datasource factory function', async () => {
       const datasourceState = {};
+      const dateRange = { fromDate: 'now-1w', toDate: 'now' };
       mockDatasource.initialize.mockResolvedValue(datasourceState);
       mockDatasource.getLayers.mockReturnValue(['first']);
 
       mount(
         <EditorFrame
           {...getDefaultProps()}
+          dateRange={dateRange}
           visualizationMap={{
             testVis: mockVisualization,
           }}
@@ -845,11 +853,12 @@ describe('editor_frame', () => {
 
       await waitForPromises();
 
-      expect(mockDatasource.getPublicAPI).toHaveBeenCalledWith(
-        datasourceState,
-        expect.any(Function),
-        'first'
-      );
+      expect(mockDatasource.getPublicAPI).toHaveBeenCalledWith({
+        dateRange,
+        state: datasourceState,
+        setState: expect.any(Function),
+        layerId: 'first',
+      });
     });
 
     it('should re-create the public api after state has been set', async () => {
@@ -872,15 +881,17 @@ describe('editor_frame', () => {
       await waitForPromises();
 
       const updatedState = {};
-      const setDatasourceState = mockDatasource.getPublicAPI.mock.calls[0][1];
+      const setDatasourceState = mockDatasource.getPublicAPI.mock.calls[0][0].setState;
       act(() => {
         setDatasourceState(updatedState);
       });
 
       expect(mockDatasource.getPublicAPI).toHaveBeenLastCalledWith(
-        updatedState,
-        expect.any(Function),
-        'first'
+        expect.objectContaining({
+          state: updatedState,
+          setState: expect.any(Function),
+          layerId: 'first',
+        })
       );
     });
   });

diff --git a/x-pack/legacy/plugins/lens/public/editor_frame_plugin/editor_frame/editor_frame.tsx b/x-pack/legacy/plugins/lens/public/editor_frame_plugin/editor_frame/editor_frame.tsx
@@ -89,18 +89,19 @@ export function EditorFrame(props: EditorFrameProps) {
 
       const layers = datasource.getLayers(datasourceState);
       layers.forEach(layer => {
-        const publicAPI = props.datasourceMap[id].getPublicAPI(
-          datasourceState,
-          (newState: unknown) => {
+        const publicAPI = props.datasourceMap[id].getPublicAPI({
+          state: datasourceState,
+          setState: (newState: unknown) => {
             dispatch({
               type: 'UPDATE_DATASOURCE_STATE',
               datasourceId: id,
               updater: newState,
               clearStagedPreview: true,
             });
           },
-          layer
-        );
+          layerId: layer,
+          dateRange: props.dateRange,
+        });
 
         datasourceLayers[layer] = publicAPI;
       });

diff --git a/x-pack/legacy/plugins/lens/public/editor_frame_plugin/editor_frame/suggestion_panel.tsx b/x-pack/legacy/plugins/lens/public/editor_frame_plugin/editor_frame/suggestion_panel.tsx
@@ -367,7 +367,12 @@ function getPreviewExpression(
     const changedLayers = datasource.getLayers(visualizableState.datasourceState);
     changedLayers.forEach(layerId => {
       if (updatedLayerApis[layerId]) {
-        updatedLayerApis[layerId] = datasource.getPublicAPI(datasourceState, () => {}, layerId);
+        updatedLayerApis[layerId] = datasource.getPublicAPI({
+          layerId,
+          dateRange: frame.dateRange,
+          state: datasourceState,
+          setState: () => {},
+        });
       }
     });
   }

diff --git a/x-pack/legacy/plugins/lens/public/editor_frame_plugin/mocks.tsx b/x-pack/legacy/plugins/lens/public/editor_frame_plugin/mocks.tsx
@@ -53,7 +53,7 @@ export function createMockDatasource(): DatasourceMock {
     getDatasourceSuggestionsForField: jest.fn((_state, item) => []),
     getDatasourceSuggestionsFromCurrentState: jest.fn(_state => []),
     getPersistableState: jest.fn(),
-    getPublicAPI: jest.fn((_state, _setState, _layerId) => publicAPIMock),
+    getPublicAPI: jest.fn().mockReturnValue(publicAPIMock),
     initialize: jest.fn((_state?) => Promise.resolve()),
     renderDataPanel: jest.fn(),
     toExpression: jest.fn((_frame, _state) => null),

diff --git a/x-pack/legacy/plugins/lens/public/indexpattern_plugin/auto_date.ts b/x-pack/legacy/plugins/lens/public/indexpattern_plugin/auto_date.ts
@@ -10,25 +10,38 @@ import {
   ExpressionFunction,
   KibanaContext,
 } from '../../../../../../src/plugins/expressions/common';
+import { DateRange } from '../../common';
 
 interface LensAutoDateProps {
   aggConfigs: string;
 }
 
-export function getAutoInterval(ctx?: KibanaContext | null) {
-  if (!ctx || !ctx.timeRange) {
-    return;
+export function autoIntervalFromDateRange(dateRange?: DateRange, defaultValue: string = '1h') {
+  if (!dateRange) {
+    return defaultValue;
   }
 
-  const { timeRange } = ctx;
   const buckets = new TimeBuckets();
   buckets.setInterval('auto');
   buckets.setBounds({
-    min: dateMath.parse(timeRange.from),
-    max: dateMath.parse(timeRange.to, { roundUp: true }),
+    min: dateMath.parse(dateRange.fromDate),
+    max: dateMath.parse(dateRange.toDate, { roundUp: true }),
   });
 
-  return buckets.getInterval();
+  return buckets.getInterval().expression;
+}
+
+function autoIntervalFromContext(ctx?: KibanaContext | null) {
+  if (!ctx || !ctx.timeRange) {
+    return;
+  }
+
+  const { timeRange } = ctx;
+
+  return autoIntervalFromDateRange({
+    fromDate: timeRange.from,
+    toDate: timeRange.to,
+  });
 }
 
 /**
@@ -56,7 +69,7 @@ export const autoDate: ExpressionFunction<
     },
   },
   fn(ctx: KibanaContext, args: LensAutoDateProps) {
-    const interval = getAutoInterval(ctx);
+    const interval = autoIntervalFromContext(ctx);
 
     if (!interval) {
       return args.aggConfigs;

diff --git a/...k/legacy/plugins/lens/public/indexpattern_plugin/dimension_panel/dimension_panel.test.tsx b/...k/legacy/plugins/lens/public/indexpattern_plugin/dimension_panel/dimension_panel.test.tsx
@@ -129,6 +129,7 @@ describe('IndexPatternDimensionPanel', () => {
       dragDropContext,
       state,
       setState,
+      dateRange: { fromDate: 'now-1d', toDate: 'now' },
       columnId: 'col1',
       layerId: 'first',
       uniqueLabel: 'stuff',

diff --git a/x-pack/legacy/plugins/lens/public/indexpattern_plugin/dimension_panel/dimension_panel.tsx b/x-pack/legacy/plugins/lens/public/indexpattern_plugin/dimension_panel/dimension_panel.tsx
@@ -23,6 +23,7 @@ import { changeColumn, deleteColumn } from '../state_helpers';
 import { isDraggedField, hasField } from '../utils';
 import { IndexPatternPrivateState, IndexPatternField } from '../types';
 import { trackUiEvent } from '../../lens_ui_telemetry';
+import { DateRange } from '../../../common';
 
 export type IndexPatternDimensionPanelProps = DatasourceDimensionPanelProps & {
   state: IndexPatternPrivateState;
@@ -34,6 +35,7 @@ export type IndexPatternDimensionPanelProps = DatasourceDimensionPanelProps & {
   layerId: string;
   http: HttpServiceBase;
   uniqueLabel: string;
+  dateRange: DateRange;
 };
 
 export interface OperationFieldSupportMatrix {

diff --git a/x-pack/legacy/plugins/lens/public/indexpattern_plugin/dimension_panel/popover_editor.tsx b/x-pack/legacy/plugins/lens/public/indexpattern_plugin/dimension_panel/popover_editor.tsx
@@ -368,6 +368,7 @@ export function PopoverEditor(props: PopoverEditorProps) {
                       savedObjectsClient={props.savedObjectsClient}
                       layerId={layerId}
                       http={props.http}
+                      dateRange={props.dateRange}
                     />
                     <EuiSpacer size="m" />
                   </>

diff --git a/x-pack/legacy/plugins/lens/public/indexpattern_plugin/indexpattern.test.ts b/x-pack/legacy/plugins/lens/public/indexpattern_plugin/indexpattern.test.ts
@@ -414,7 +414,15 @@ describe('IndexPattern Data Source', () => {
 
     beforeEach(async () => {
       const initialState = stateFromPersistedState(persistedState);
-      publicAPI = indexPatternDatasource.getPublicAPI(initialState, () => {}, 'first');
+      publicAPI = indexPatternDatasource.getPublicAPI({
+        state: initialState,
+        setState: () => {},
+        layerId: 'first',
+        dateRange: {
+          fromDate: 'now-30d',
+          toDate: 'now',
+        },
+      });
     });
 
     describe('getTableSpec', () => {
@@ -453,8 +461,8 @@ describe('IndexPattern Data Source', () => {
             suggestedPriority: 2,
           },
         };
-        const api = indexPatternDatasource.getPublicAPI(
-          {
+        const api = indexPatternDatasource.getPublicAPI({
+          state: {
             ...initialState,
             layers: {
               first: {
@@ -465,8 +473,12 @@ describe('IndexPattern Data Source', () => {
             },
           },
           setState,
-          'first'
-        );
+          layerId: 'first',
+          dateRange: {
+            fromDate: 'now-1y',
+            toDate: 'now',
+          },
+        });
 
         api.removeColumnInTableSpec('b');
 

diff --git a/x-pack/legacy/plugins/lens/public/indexpattern_plugin/indexpattern.tsx b/x-pack/legacy/plugins/lens/public/indexpattern_plugin/indexpattern.tsx
@@ -16,6 +16,7 @@ import {
   DatasourceDataPanelProps,
   Operation,
   DatasourceLayerPanelProps,
+  PublicAPIProps,
 } from '../types';
 import { loadInitialState, changeIndexPattern, changeLayerIndexPattern } from './loader';
 import { toExpression } from './to_expression';
@@ -196,11 +197,12 @@ export function getIndexPatternDatasource({
       );
     },
 
-    getPublicAPI(
-      state: IndexPatternPrivateState,
-      setState: StateSetter<IndexPatternPrivateState>,
-      layerId: string
-    ) {
+    getPublicAPI({
+      state,
+      setState,
+      layerId,
+      dateRange,
+    }: PublicAPIProps<IndexPatternPrivateState>) {
       const columnLabelMap = uniqueLabels(state.layers);
 
       return {
@@ -237,6 +239,7 @@ export function getIndexPatternDatasource({
                   layerId={props.layerId}
                   http={core.http}
                   uniqueLabel={columnLabelMap[props.columnId]}
+                  dateRange={dateRange}
                   {...props}
                 />
               </KibanaContextProvider>