[Lens] Last used Index pattern is saved to and retrieved from local s…

…torage (#69511)
elastic · Jun 26, 2020 · 2a68dc7 · 2a68dc7
1 parent c8089a5
commit 2a68dc7
Show file tree

Hide file tree

Showing 4 changed files with 135 additions and 2 deletions.
diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.tsx
@@ -125,6 +125,7 @@ export function getIndexPatternDatasource({
         state,
         savedObjectsClient: await savedObjectsClient,
         defaultIndexPatternId: core.uiSettings.get('defaultIndex'),
+        storage,
       });
     },
 
@@ -207,6 +208,7 @@ export function getIndexPatternDatasource({
                 setState,
                 savedObjectsClient,
                 onError: onIndexPatternLoadError,
+                storage,
               });
             }}
             data={data}
@@ -290,6 +292,7 @@ export function getIndexPatternDatasource({
               layerId: props.layerId,
               onError: onIndexPatternLoadError,
               replaceIfPossible: true,
+              storage,
             });
           }}
           {...props}

diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts b/x-pack/plugins/lens/public/indexpattern_datasource/loader.test.ts
@@ -18,6 +18,15 @@ import { documentField } from './document_field';
 
 jest.mock('./operations');
 
+const createMockStorage = (lastData?: Record<string, string>) => {
+  return {
+    get: jest.fn().mockImplementation(() => lastData),
+    set: jest.fn(),
+    remove: jest.fn(),
+    clear: jest.fn(),
+  };
+};
+
 const sampleIndexPatterns = {
   a: {
     id: 'a',
@@ -269,8 +278,10 @@ describe('loader', () => {
 
   describe('loadInitialState', () => {
     it('should load a default state', async () => {
+      const storage = createMockStorage();
       const state = await loadInitialState({
         savedObjectsClient: mockClient(),
+        storage,
       });
 
       expect(state).toMatchObject({
@@ -285,12 +296,61 @@ describe('loader', () => {
         layers: {},
         showEmptyFields: false,
       });
+      expect(storage.set).toHaveBeenCalledWith('lens-settings', {
+        indexPatternId: 'a',
+      });
+    });
+
+    it('should load a default state when lastUsedIndexPatternId is not found in indexPatternRefs', async () => {
+      const storage = createMockStorage({ indexPatternId: 'c' });
+      const state = await loadInitialState({
+        savedObjectsClient: mockClient(),
+        storage,
+      });
+
+      expect(state).toMatchObject({
+        currentIndexPatternId: 'a',
+        indexPatternRefs: [
+          { id: 'a', title: sampleIndexPatterns.a.title },
+          { id: 'b', title: sampleIndexPatterns.b.title },
+        ],
+        indexPatterns: {
+          a: sampleIndexPatterns.a,
+        },
+        layers: {},
+        showEmptyFields: false,
+      });
+      expect(storage.set).toHaveBeenCalledWith('lens-settings', {
+        indexPatternId: 'a',
+      });
+    });
+
+    it('should load lastUsedIndexPatternId if in localStorage', async () => {
+      const state = await loadInitialState({
+        savedObjectsClient: mockClient(),
+        storage: createMockStorage({ indexPatternId: 'b' }),
+      });
+
+      expect(state).toMatchObject({
+        currentIndexPatternId: 'b',
+        indexPatternRefs: [
+          { id: 'a', title: sampleIndexPatterns.a.title },
+          { id: 'b', title: sampleIndexPatterns.b.title },
+        ],
+        indexPatterns: {
+          b: sampleIndexPatterns.b,
+        },
+        layers: {},
+        showEmptyFields: false,
+      });
     });
 
     it('should use the default index pattern id, if provided', async () => {
+      const storage = createMockStorage();
       const state = await loadInitialState({
         defaultIndexPatternId: 'b',
         savedObjectsClient: mockClient(),
+        storage,
       });
 
       expect(state).toMatchObject({
@@ -305,6 +365,9 @@ describe('loader', () => {
         layers: {},
         showEmptyFields: false,
       });
+      expect(storage.set).toHaveBeenCalledWith('lens-settings', {
+        indexPatternId: 'b',
+      });
     });
 
     it('should initialize from saved state', async () => {
@@ -336,9 +399,11 @@ describe('loader', () => {
           },
         },
       };
+      const storage = createMockStorage({ indexPatternId: 'a' });
       const state = await loadInitialState({
         state: savedState,
         savedObjectsClient: mockClient(),
+        storage,
       });
 
       expect(state).toMatchObject({
@@ -353,6 +418,10 @@ describe('loader', () => {
         layers: savedState.layers,
         showEmptyFields: false,
       });
+
+      expect(storage.set).toHaveBeenCalledWith('lens-settings', {
+        indexPatternId: 'b',
+      });
     });
   });
 
@@ -367,13 +436,15 @@ describe('loader', () => {
         layers: {},
         showEmptyFields: true,
       };
+      const storage = createMockStorage({ indexPatternId: 'b' });
 
       await changeIndexPattern({
         state,
         setState,
         id: 'a',
         savedObjectsClient: mockClient(),
         onError: jest.fn(),
+        storage,
       });
 
       expect(setState).toHaveBeenCalledTimes(1);
@@ -383,6 +454,9 @@ describe('loader', () => {
           a: sampleIndexPatterns.a,
         },
       });
+      expect(storage.set).toHaveBeenCalledWith('lens-settings', {
+        indexPatternId: 'a',
+      });
     });
 
     it('handles errors', async () => {
@@ -398,6 +472,8 @@ describe('loader', () => {
         showEmptyFields: true,
       };
 
+      const storage = createMockStorage({ indexPatternId: 'b' });
+
       await changeIndexPattern({
         state,
         setState,
@@ -409,9 +485,11 @@ describe('loader', () => {
           }),
         },
         onError,
+        storage,
       });
 
       expect(setState).not.toHaveBeenCalled();
+      expect(storage.set).not.toHaveBeenCalled();
       expect(onError).toHaveBeenCalledWith(err);
     });
   });
@@ -452,13 +530,16 @@ describe('loader', () => {
         showEmptyFields: true,
       };
 
+      const storage = createMockStorage({ indexPatternId: 'a' });
+
       await changeLayerIndexPattern({
         state,
         setState,
         indexPatternId: 'b',
         layerId: 'l1',
         savedObjectsClient: mockClient(),
         onError: jest.fn(),
+        storage,
       });
 
       expect(setState).toHaveBeenCalledTimes(1);
@@ -492,6 +573,9 @@ describe('loader', () => {
           },
         },
       });
+      expect(storage.set).toHaveBeenCalledWith('lens-settings', {
+        indexPatternId: 'b',
+      });
     });
 
     it('handles errors', async () => {
@@ -515,6 +599,8 @@ describe('loader', () => {
         showEmptyFields: true,
       };
 
+      const storage = createMockStorage({ indexPatternId: 'b' });
+
       await changeLayerIndexPattern({
         state,
         setState,
@@ -527,9 +613,11 @@ describe('loader', () => {
           }),
         },
         onError,
+        storage,
       });
 
       expect(setState).not.toHaveBeenCalled();
+      expect(storage.set).not.toHaveBeenCalled();
       expect(onError).toHaveBeenCalledWith(err);
     });
   });

diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/loader.ts b/x-pack/plugins/lens/public/indexpattern_datasource/loader.ts
@@ -5,6 +5,7 @@
  */
 
 import _ from 'lodash';
+import { IStorageWrapper } from 'src/plugins/kibana_utils/public';
 import { SavedObjectsClientContract, SavedObjectAttributes, HttpSetup } from 'kibana/public';
 import { SimpleSavedObject } from 'kibana/public';
 import { StateSetter } from '../types';
@@ -24,6 +25,7 @@ import {
   IFieldType,
   IndexPatternTypeMeta,
 } from '../../../../../src/plugins/data/public';
+import { readFromStorage, writeToStorage } from '../settings_storage';
 
 interface SavedIndexPatternAttributes extends SavedObjectAttributes {
   title: string;
@@ -68,31 +70,48 @@ export async function loadIndexPatterns({
   );
 }
 
+const getLastUsedIndexPatternId = (
+  storage: IStorageWrapper,
+  indexPatternRefs: IndexPatternRef[]
+) => {
+  const indexPattern = readFromStorage(storage, 'indexPatternId');
+  return indexPattern && indexPatternRefs.find((i) => i.id === indexPattern)?.id;
+};
+
+const setLastUsedIndexPatternId = (storage: IStorageWrapper, value: string) => {
+  writeToStorage(storage, 'indexPatternId', value);
+};
+
 export async function loadInitialState({
   state,
   savedObjectsClient,
   defaultIndexPatternId,
+  storage,
 }: {
   state?: IndexPatternPersistedState;
   savedObjectsClient: SavedObjectsClient;
   defaultIndexPatternId?: string;
+  storage: IStorageWrapper;
 }): Promise<IndexPatternPrivateState> {
   const indexPatternRefs = await loadIndexPatternRefs(savedObjectsClient);
+  const lastUsedIndexPatternId = getLastUsedIndexPatternId(storage, indexPatternRefs);
+
   const requiredPatterns = _.unique(
     state
       ? Object.values(state.layers)
           .map((l) => l.indexPatternId)
           .concat(state.currentIndexPatternId)
-      : [defaultIndexPatternId || indexPatternRefs[0].id]
+      : [lastUsedIndexPatternId || defaultIndexPatternId || indexPatternRefs[0].id]
   );
 
   const currentIndexPatternId = requiredPatterns[0];
+  setLastUsedIndexPatternId(storage, currentIndexPatternId);
+
   const indexPatterns = await loadIndexPatterns({
     savedObjectsClient,
     cache: {},
     patterns: requiredPatterns,
   });
-
   if (state) {
     return {
       ...state,
@@ -120,12 +139,14 @@ export async function changeIndexPattern({
   state,
   setState,
   onError,
+  storage,
 }: {
   id: string;
   savedObjectsClient: SavedObjectsClient;
   state: IndexPatternPrivateState;
   setState: SetState;
   onError: ErrorHandler;
+  storage: IStorageWrapper;
 }) {
   try {
     const indexPatterns = await loadIndexPatterns({
@@ -145,6 +166,7 @@ export async function changeIndexPattern({
       },
       currentIndexPatternId: id,
     }));
+    setLastUsedIndexPatternId(storage, id);
   } catch (err) {
     onError(err);
   }
@@ -158,6 +180,7 @@ export async function changeLayerIndexPattern({
   setState,
   onError,
   replaceIfPossible,
+  storage,
 }: {
   indexPatternId: string;
   layerId: string;
@@ -166,6 +189,7 @@ export async function changeLayerIndexPattern({
   setState: SetState;
   onError: ErrorHandler;
   replaceIfPossible?: boolean;
+  storage: IStorageWrapper;
 }) {
   try {
     const indexPatterns = await loadIndexPatterns({
@@ -186,6 +210,7 @@ export async function changeLayerIndexPattern({
       },
       currentIndexPatternId: replaceIfPossible ? indexPatternId : s.currentIndexPatternId,
     }));
+    setLastUsedIndexPatternId(storage, indexPatternId);
   } catch (err) {
     onError(err);
   }

diff --git a/x-pack/plugins/lens/public/settings_storage.tsx b/x-pack/plugins/lens/public/settings_storage.tsx
@@ -0,0 +1,17 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { IStorageWrapper } from 'src/plugins/kibana_utils/public';
+
+const STORAGE_KEY = 'lens-settings';
+
+export const readFromStorage = (storage: IStorageWrapper, key: string) => {
+  const data = storage.get(STORAGE_KEY);
+  return data && data[key];
+};
+export const writeToStorage = (storage: IStorageWrapper, key: string, value: string) => {
+  storage.set(STORAGE_KEY, { [key]: value });
+};