[Discover] Refactor discover.js controller topnav code

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsource.md

@@ -41,6 +41,7 @@ export declare class SearchSource
 |  [getSearchRequestBody()](./kibana-plugin-plugins-data-public.searchsource.getsearchrequestbody.md) |  | Returns body contents of the search request, often referred as query DSL. |
 |  [getSerializedFields()](./kibana-plugin-plugins-data-public.searchsource.getserializedfields.md) |  | serializes search source fields (which can later be passed to [ISearchStartSearchSource](./kibana-plugin-plugins-data-public.isearchstartsearchsource.md)<!-- -->) |
 |  [onRequestStart(handler)](./kibana-plugin-plugins-data-public.searchsource.onrequeststart.md) |  | Add a handler that will be notified whenever requests start |
+|  [removeField(field)](./kibana-plugin-plugins-data-public.searchsource.removefield.md) |  | remove field |
 |  [serialize()](./kibana-plugin-plugins-data-public.searchsource.serialize.md) |  | Serializes the instance to a JSON string and a set of referenced objects. Use this method to get a representation of the search source which can be stored in a saved object.<!-- -->The references returned by this function can be mixed with other references in the same object, however make sure there are no name-collisions. The references will be named <code>kibanaSavedObjectMeta.searchSourceJSON.index</code> and <code>kibanaSavedObjectMeta.searchSourceJSON.filter[&lt;number&gt;].meta.index</code>.<!-- -->Using <code>createSearchSource</code>, the instance can be re-created. |
 |  [setField(field, value)](./kibana-plugin-plugins-data-public.searchsource.setfield.md) |  | sets value to a single search source field |
 |  [setFields(newFields)](./kibana-plugin-plugins-data-public.searchsource.setfields.md) |  | Internal, do not use. Overrides all search source fields with the new field array. |

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.searchsource.removefield.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) &gt; [removeField](./kibana-plugin-plugins-data-public.searchsource.removefield.md)
+
+## SearchSource.removeField() method
+
+remove field
+
+<b>Signature:</b>
+
+```typescript
+removeField<K extends keyof SearchSourceFields>(field: K): this;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  field | <code>K</code> |  |
+
+<b>Returns:</b>
+
+`this`
+

src/plugins/data/common/search/search_source/mocks.ts

@@ -28,6 +28,7 @@ export const searchSourceInstanceMock: MockedKeys<ISearchSource> = {
   setPreferredSearchStrategyId: jest.fn(),
   setFields: jest.fn().mockReturnThis(),
   setField: jest.fn().mockReturnThis(),
+  removeField: jest.fn().mockReturnThis(),
   getId: jest.fn(),
   getFields: jest.fn(),
   getField: jest.fn(),

src/plugins/data/common/search/search_source/search_source.test.ts

@@ -82,6 +82,15 @@ describe('SearchSource', () => {
     });
   });
 
+  describe('#removeField()', () => {
+    test('remove property', () => {
+      const searchSource = new SearchSource({}, searchSourceDependencies);
+      searchSource.setField('aggs', 5);
+      searchSource.removeField('aggs');
+      expect(searchSource.getField('aggs')).toBeFalsy();
+    });
+  });
+
   describe(`#setField('index')`, () => {
     describe('auto-sourceFiltering', () => {
       describe('new index pattern assigned', () => {

src/plugins/data/common/search/search_source/search_source.ts

@@ -142,13 +142,22 @@ export class SearchSource {
    */
   setField<K extends keyof SearchSourceFields>(field: K, value: SearchSourceFields[K]) {
     if (value == null) {
-      delete this.fields[field];
+      return this.removeField(field);
     } else {
       this.fields[field] = value;
     }
     return this;
   }
 
+  /**
+   * remove field
+   * @param field: field name
+   */
+  removeField<K extends keyof SearchSourceFields>(field: K) {
+    delete this.fields[field];
+    return this;
+  }
+
   /**
    * Internal, do not use. Overrides all search source fields with the new field array.
    *

src/plugins/data/public/public.api.md

@@ -2169,6 +2169,7 @@ export class SearchSource {
     // (undocumented)
     history: SearchRequest[];
     onRequestStart(handler: (searchSource: SearchSource, options?: ISearchOptions) => Promise<unknown>): void;
+    removeField<K extends keyof SearchSourceFields>(field: K): this;
     serialize(): {
         searchSourceJSON: string;
         references: import("src/core/server").SavedObjectReference[];

src/plugins/discover/public/__mocks__/config.ts

@@ -0,0 +1,30 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { IUiSettingsClient } from '../../../../core/public';
+
+export const configMock = ({
+  get: (key: string) => {
+    if (key === 'defaultIndex') {
+      return 'the-index-pattern-id';
+    }
+
+    return '';
+  },
+} as unknown) as IUiSettingsClient;

src/plugins/discover/public/__mocks__/index_pattern.ts

@@ -0,0 +1,74 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { IndexPattern, indexPatterns } from '../kibana_services';
+import { IIndexPatternFieldList } from '../../../data/common/index_patterns/fields';
+
+const fields = [
+  {
+    name: '_index',
+    type: 'string',
+    scripted: false,
+    filterable: true,
+  },
+  {
+    name: 'message',
+    type: 'string',
+    scripted: false,
+    filterable: false,
+  },
+  {
+    name: 'extension',
+    type: 'string',
+    scripted: false,
+    filterable: true,
+  },
+  {
+    name: 'bytes',
+    type: 'number',
+    scripted: false,
+    filterable: true,
+  },
+  {
+    name: 'scripted',
+    type: 'number',
+    scripted: true,
+    filterable: false,
+  },
+] as IIndexPatternFieldList;
+
+fields.getByName = (name: string) => {
+  return fields.find((field) => field.name === name);
+};
+
+const indexPattern = ({
+  id: 'the-index-pattern-id',
+  title: 'the-index-pattern-title',
+  metaFields: ['_index', '_score'],
+  flattenHit: undefined,
+  formatHit: jest.fn((hit) => hit._source),
+  fields,
+  getComputedFields: () => ({}),
+  getSourceFiltering: () => ({}),
+  getFieldByName: () => ({}),
+} as unknown) as IndexPattern;
+
+indexPattern.flattenHit = indexPatterns.flattenHitWrapper(indexPattern, indexPattern.metaFields);
+
+export const indexPatternMock = indexPattern;

src/plugins/discover/public/__mocks__/index_patterns.ts

@@ -0,0 +1,32 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { IndexPatternsService } from '../../../data/common';
+import { indexPatternMock } from './index_pattern';
+
+export const indexPatternsMock = ({
+  getCache: () => {
+    return [indexPatternMock];
+  },
+  get: (id: string) => {
+    if (id === 'the-index-pattern-id') {
+      return indexPatternMock;
+    }
+  },
+} as unknown) as IndexPatternsService;

src/plugins/discover/public/__mocks__/saved_search.ts

@@ -0,0 +1,41 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { SavedSearch } from '../saved_searches';
+
+export const savedSearchMock = ({
+  id: 'the-saved-search-id',
+  type: 'search',
+  attributes: {
+    title: 'the-saved-search-title',
+    kibanaSavedObjectMeta: {
+      searchSourceJSON:
+        '{"highlightAll":true,"version":true,"query":{"query":"foo : \\"bar\\" ","language":"kuery"},"filter":[],"indexRefName":"kibanaSavedObjectMeta.searchSourceJSON.index"}',
+    },
+  },
+  references: [
+    {
+      name: 'kibanaSavedObjectMeta.searchSourceJSON.index',
+      type: 'index-pattern',
+      id: 'the-index-pattern-id',
+    },
+  ],
+  migrationVersion: { search: '7.5.0' },
+  error: undefined,
+} as unknown) as SavedSearch;