Move ensureDefaultIndexPattern into data plugin

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

@@ -20,5 +20,5 @@ export interface DataPublicPluginStart
 |  [indexPatterns](./kibana-plugin-plugins-data-public.datapublicpluginstart.indexpatterns.md) | <code>IndexPatternsContract</code> |  |
 |  [query](./kibana-plugin-plugins-data-public.datapublicpluginstart.query.md) | <code>QueryStart</code> |  |
 |  [search](./kibana-plugin-plugins-data-public.datapublicpluginstart.search.md) | <code>ISearchStart</code> |  |
-|  [ui](./kibana-plugin-plugins-data-public.datapublicpluginstart.ui.md) | <code>{</code><br/><code>        IndexPatternSelect: React.ComponentType&lt;IndexPatternSelectProps&gt;;</code><br/><code>        SearchBar: React.ComponentType&lt;StatefulSearchBarProps&gt;;</code><br/><code>    }</code> |  |
+|  [ui](./kibana-plugin-plugins-data-public.datapublicpluginstart.ui.md) | <code>{</code><br/><code>        IndexPatternSelect: React.ComponentType&lt;IndexPatternSelectProps&gt;;</code><br/><code>        SearchBar: React.ComponentType&lt;StatefulSearchBarProps&gt;;</code><br/><code>        ensureDefaultIndexPattern: EnsureDefaultIndexPattern;</code><br/><code>    }</code> |  |
 

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.datapublicpluginstart.ui.md

@@ -10,5 +10,6 @@
 ui: {
         IndexPatternSelect: React.ComponentType<IndexPatternSelectProps>;
         SearchBar: React.ComponentType<StatefulSearchBarProps>;
+        ensureDefaultIndexPattern: EnsureDefaultIndexPattern;
     };
 ```

src/legacy/core_plugins/kibana/public/discover/kibana_services.ts

@@ -53,11 +53,7 @@ export const [getUrlTracker, setUrlTracker] = createGetterSetter<{
 }>('urlTracker');
 
 export const { getRequestInspectorStats, getResponseInspectorStats, tabifyAggResponse } = search;
-export {
-  unhashUrl,
-  redirectWhenMissing,
-  ensureDefaultIndexPattern,
-} from '../../../../../plugins/kibana_utils/public';
+export { unhashUrl, redirectWhenMissing } from '../../../../../plugins/kibana_utils/public';
 export {
   formatMsg,
   formatStack,

src/legacy/core_plugins/kibana/public/discover/np_ready/angular/discover.js

@@ -49,7 +49,6 @@ import {
   subscribeWithScope,
   tabifyAggResponse,
   getAngularModule,
-  ensureDefaultIndexPattern,
   redirectWhenMissing,
 } from '../../kibana_services';
 
@@ -118,7 +117,7 @@ app.config($routeProvider => {
     resolve: {
       savedObjects: function($route, Promise) {
         const savedSearchId = $route.current.params.id;
-        return ensureDefaultIndexPattern(core, data, history).then(() => {
+        return data.ui.ensureDefaultIndexPattern(history).then(() => {
           const { appStateContainer } = getState({ history });
           const { index } = appStateContainer.getState();
           return Promise.props({

src/legacy/core_plugins/kibana/public/visualize/np_ready/legacy_app.js

@@ -24,7 +24,6 @@ import { createHashHistory } from 'history';
 import {
   createKbnUrlStateStorage,
   redirectWhenMissing,
-  ensureDefaultIndexPattern,
 } from '../../../../../../plugins/kibana_utils/public';
 
 import editorTemplate from './editor/editor.html';
@@ -126,7 +125,7 @@ export function initVisualizeApp(app, deps) {
         controllerAs: 'listingController',
         resolve: {
           createNewVis: () => false,
-          hasDefaultIndex: history => ensureDefaultIndexPattern(deps.core, deps.data, history),
+          hasDefaultIndex: history => deps.data.ui.ensureDefaultIndexPattern(history),
         },
       })
       .when(VisualizeConstants.WIZARD_STEP_1_PAGE_PATH, {
@@ -137,7 +136,7 @@ export function initVisualizeApp(app, deps) {
         controllerAs: 'listingController',
         resolve: {
           createNewVis: () => true,
-          hasDefaultIndex: history => ensureDefaultIndexPattern(deps.core, deps.data, history),
+          hasDefaultIndex: history => deps.data.ui.ensureDefaultIndexPattern(history),
         },
       })
       .when(VisualizeConstants.CREATE_PATH, {
@@ -146,7 +145,7 @@ export function initVisualizeApp(app, deps) {
         k7Breadcrumbs: getCreateBreadcrumbs,
         resolve: {
           resolved: function($route, history) {
-            const { core, data, savedVisualizations, visualizations, toastNotifications } = deps;
+            const { data, savedVisualizations, visualizations, toastNotifications } = deps;
             const visTypes = visualizations.all();
             const visType = find(visTypes, { name: $route.current.params.type });
             const shouldHaveIndex = visType.requiresSearch && visType.options.showIndexSelection;
@@ -163,7 +162,8 @@ export function initVisualizeApp(app, deps) {
               );
             }
 
-            return ensureDefaultIndexPattern(core, data, history)
+            return data.ui
+              .ensureDefaultIndexPattern(history)
               .then(() => savedVisualizations.get($route.current.params))
               .then(getResolvedResults(deps))
               .catch(
@@ -182,9 +182,10 @@ export function initVisualizeApp(app, deps) {
         k7Breadcrumbs: getEditBreadcrumbs,
         resolve: {
           resolved: function($route, history) {
-            const { chrome, core, data, savedVisualizations, toastNotifications } = deps;
+            const { chrome, data, savedVisualizations, toastNotifications } = deps;
 
-            return ensureDefaultIndexPattern(core, data, history)
+            return data.ui
+              .ensureDefaultIndexPattern(history)
               .then(() => savedVisualizations.get($route.current.params.id))
               .then(savedVis => {
                 chrome.recentlyAccessed.add(savedVis.getFullPath(), savedVis.title, savedVis.id);

src/plugins/dashboard/public/application/legacy_app.js

@@ -28,7 +28,6 @@ import { initDashboardAppDirective } from './dashboard_app';
 import { createDashboardEditUrl, DashboardConstants } from '../dashboard_constants';
 import {
   createKbnUrlStateStorage,
-  ensureDefaultIndexPattern,
   redirectWhenMissing,
   InvalidJSONProperty,
   SavedObjectNotFound,
@@ -138,7 +137,7 @@ export function initDashboardApp(app, deps) {
         },
         resolve: {
           dash: function($route, history) {
-            return ensureDefaultIndexPattern(deps.core, deps.data, history).then(() => {
+            return deps.data.ui.ensureDefaultIndexPattern(history).then(() => {
               const savedObjectsClient = deps.savedObjectsClient;
               const title = $route.current.params.title;
               if (title) {
@@ -173,7 +172,8 @@ export function initDashboardApp(app, deps) {
         requireUICapability: 'dashboard.createNew',
         resolve: {
           dash: history =>
-            ensureDefaultIndexPattern(deps.core, deps.data, history)
+            deps.data.ui
+              .ensureDefaultIndexPattern(history)
               .then(() => deps.savedDashboards.get())
               .catch(
                 redirectWhenMissing({
@@ -194,7 +194,8 @@ export function initDashboardApp(app, deps) {
           dash: function($route, history) {
             const id = $route.current.params.id;
 
-            return ensureDefaultIndexPattern(deps.core, deps.data, history)
+            return deps.data.ui
+              .ensureDefaultIndexPattern(history)
               .then(() => deps.savedDashboards.get(id))
               .then(savedDashboard => {
                 deps.chrome.recentlyAccessed.add(

src/plugins/data/public/mocks.ts

@@ -54,6 +54,7 @@ const createStartContract = (): Start => {
     ui: {
       IndexPatternSelect: jest.fn(),
       SearchBar: jest.fn(),
+      ensureDefaultIndexPattern: jest.fn(),
     },
     indexPatterns: ({
       make: () => ({

src/plugins/data/public/plugin.ts

@@ -70,6 +70,7 @@ import {
   ACTION_VALUE_CLICK,
   ValueClickActionContext,
 } from './actions/value_click_action';
+import { createEnsureDefaultIndexPattern } from './ui/ensure_default_index_pattern';
 
 declare module '../../ui_actions/public' {
   export interface ActionContextMapping {
@@ -182,6 +183,7 @@ export class DataPublicPlugin implements Plugin<DataPublicPluginSetup, DataPubli
       ui: {
         IndexPatternSelect: createIndexPatternSelect(core.savedObjects.client),
         SearchBar,
+        ensureDefaultIndexPattern: createEnsureDefaultIndexPattern(core, indexPatterns),
       },
     };
   }

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

@@ -268,6 +268,7 @@ export interface DataPublicPluginStart {
     ui: {
         IndexPatternSelect: React.ComponentType<IndexPatternSelectProps>;
         SearchBar: React.ComponentType<StatefulSearchBarProps>;
+        ensureDefaultIndexPattern: EnsureDefaultIndexPattern;
     };
 }
 
@@ -1898,8 +1899,9 @@ export type TSearchStrategyProvider<T extends TStrategyTypes> = (context: ISearc
 // src/plugins/data/public/index.ts:412:1 - (ae-forgotten-export) The symbol "toAbsoluteDates" needs to be exported by the entry point index.d.ts
 // src/plugins/data/public/query/state_sync/connect_to_query_state.ts:33:33 - (ae-forgotten-export) The symbol "FilterStateStore" needs to be exported by the entry point index.d.ts
 // src/plugins/data/public/query/state_sync/connect_to_query_state.ts:37:1 - (ae-forgotten-export) The symbol "QueryStateChange" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/types.ts:52:5 - (ae-forgotten-export) The symbol "createFiltersFromEvent" needs to be exported by the entry point index.d.ts
-// src/plugins/data/public/types.ts:60:5 - (ae-forgotten-export) The symbol "IndexPatternSelectProps" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/types.ts:53:5 - (ae-forgotten-export) The symbol "createFiltersFromEvent" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/types.ts:61:5 - (ae-forgotten-export) The symbol "IndexPatternSelectProps" needs to be exported by the entry point index.d.ts
+// src/plugins/data/public/types.ts:63:5 - (ae-forgotten-export) The symbol "EnsureDefaultIndexPattern" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

src/plugins/data/public/types.ts

@@ -30,6 +30,7 @@ import { QuerySetup, QueryStart } from './query';
 import { IndexPatternSelectProps } from './ui/index_pattern_select';
 import { IndexPatternsContract } from './index_patterns';
 import { StatefulSearchBarProps } from './ui/search_bar/create_search_bar';
+import { EnsureDefaultIndexPattern } from './ui/ensure_default_index_pattern';
 
 export interface DataSetupDependencies {
   expressions: ExpressionsSetup;
@@ -59,6 +60,7 @@ export interface DataPublicPluginStart {
   ui: {
     IndexPatternSelect: React.ComponentType<IndexPatternSelectProps>;
     SearchBar: React.ComponentType<StatefulSearchBarProps>;
+    ensureDefaultIndexPattern: EnsureDefaultIndexPattern;
   };
 }
 

src/plugins/data/public/ui/ensure_default_index_pattern/ensure_default_index_pattern.tsx

@@ -0,0 +1,101 @@
+/*
+ * 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 { contains } from 'lodash';
+import React from 'react';
+import { History } from 'history';
+import { i18n } from '@kbn/i18n';
+import { EuiCallOut } from '@elastic/eui';
+import { CoreStart } from 'kibana/public';
+import { toMountPoint } from '../../../../kibana_react/public';
+import { IndexPatternsContract } from '../../index_patterns';
+
+export type EnsureDefaultIndexPattern = (history: History) => Promise<unknown> | undefined;
+
+export const createEnsureDefaultIndexPattern = (
+  core: CoreStart,
+  indexPatterns: IndexPatternsContract
+) => {
+  let bannerId: string;
+  let timeoutId: NodeJS.Timeout | undefined;
+
+  /**
+   * Checks whether a default index pattern is set and exists and defines
+   * one otherwise.
+   *
+   * If there are no index patterns, redirect to management page and show
+   * banner. In this case the promise returned from this function will never
+   * resolve to wait for the URL change to happen.
+   */
+  return async function ensureDefaultIndexPattern(history: History) {
+    const patterns = await indexPatterns.getIds();
+    let defaultId = core.uiSettings.get('defaultIndex');
+    let defined = !!defaultId;
+    const exists = contains(patterns, defaultId);
+
+    if (defined && !exists) {
+      core.uiSettings.remove('defaultIndex');
+      defaultId = defined = false;
+    }
+
+    if (defined) {
+      return;
+    }
+
+    // If there is any index pattern created, set the first as default
+    if (patterns.length >= 1) {
+      defaultId = patterns[0];
+      core.uiSettings.set('defaultIndex', defaultId);
+    } else {
+      const canManageIndexPatterns = core.application.capabilities.management.kibana.index_patterns;
+      const redirectTarget = canManageIndexPatterns ? '/management/kibana/index_pattern' : '/home';
+
+      if (timeoutId) {
+        clearTimeout(timeoutId);
+      }
+
+      // Avoid being hostile to new users who don't have an index pattern setup yet
+      // give them a friendly info message instead of a terse error message
+      bannerId = core.overlays.banners.replace(
+        bannerId,
+        toMountPoint(
+          <EuiCallOut
+            color="warning"
+            iconType="iInCircle"
+            title={i18n.translate('data.ensureDefaultIndexPattern.bannerLabel', {
+              defaultMessage:
+                "In order to visualize and explore data in Kibana, you'll need to create an index pattern to retrieve data from Elasticsearch.",
+            })}
+          />
+        )
+      );
+
+      // hide the message after the user has had a chance to acknowledge it -- so it doesn't permanently stick around
+      timeoutId = setTimeout(() => {
+        core.overlays.banners.remove(bannerId);
+        timeoutId = undefined;
+      }, 15000);
+
+      history.push(redirectTarget);
+
+      // return never-resolving promise to stop resolving and wait for the url change
+      return new Promise(() => {});
+    }
+  };
+};

src/plugins/data/public/ui/ensure_default_index_pattern/index.ts

@@ -0,0 +1,23 @@
+/*
+ * 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.
+ */
+
+export {
+  createEnsureDefaultIndexPattern,
+  EnsureDefaultIndexPattern,
+} from './ensure_default_index_pattern';