From 84d999d7478bce6656877cdc259b552c59463076 Mon Sep 17 00:00:00 2001
From: Constance <constancecchen@users.noreply.github.com>
Date: Tue, 22 Jun 2021 09:01:25 -0700
Subject: [PATCH] [App Search] Convert Search UI view to new page template +
 minor UI polish (#102813)

* Convert Search UI view to use new page template

+ update tests TODO

* [UX polish] Add empty state to Search UI view

- On a totally new engine, all pages except this one* had an empty state, so per Davey's recommendations I whipped up a new empty state for this page

* Overview has a custom 'empty' state, analytics does not have an empty state

* Update router

* Fix bad merge conflict resolution

* [Polish] Copy feedback proposed by Davey

- see https://github.com/elastic/kibana/pull/101958/commits/cbc3706223eb47be3d854a1cf4e3c7275d88ca39
---
 .../components/engine/engine_router.tsx       |  10 +-
 .../search_ui/components/empty_state.test.tsx |  27 ++++
 .../search_ui/components/empty_state.tsx      |  46 +++++++
 .../components/search_ui/search_ui.test.tsx   |  13 +-
 .../components/search_ui/search_ui.tsx        | 120 ++++++++----------
 5 files changed, 143 insertions(+), 73 deletions(-)
 create mode 100644 x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/components/empty_state.test.tsx
 create mode 100644 x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/components/empty_state.tsx

diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine/engine_router.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine/engine_router.tsx
index b390b1a52b9278..3e18c9e680de22 100644
--- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine/engine_router.tsx
+++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/engine/engine_router.tsx
@@ -109,6 +109,11 @@ export const EngineRouter: React.FC = () => {
           <Documents />
         </Route>
       )}
+      {canManageEngineSearchUi && (
+        <Route path={ENGINE_SEARCH_UI_PATH}>
+          <SearchUI />
+        </Route>
+      )}
       {/* TODO: Remove layout once page template migration is over */}
       <Layout navigation={<AppSearchNav />}>
         {canViewEngineSchema && (
@@ -141,11 +146,6 @@ export const EngineRouter: React.FC = () => {
             <ApiLogs />
           </Route>
         )}
-        {canManageEngineSearchUi && (
-          <Route path={ENGINE_SEARCH_UI_PATH}>
-            <SearchUI />
-          </Route>
-        )}
         {canViewMetaEngineSourceEngines && (
           <Route path={META_ENGINE_SOURCE_ENGINES_PATH}>
             <SourceEngines />
diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/components/empty_state.test.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/components/empty_state.test.tsx
new file mode 100644
index 00000000000000..39f0cb376b325c
--- /dev/null
+++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/components/empty_state.test.tsx
@@ -0,0 +1,27 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import React from 'react';
+
+import { shallow } from 'enzyme';
+
+import { EuiEmptyPrompt, EuiButton } from '@elastic/eui';
+
+import { EmptyState } from './empty_state';
+
+describe('EmptyState', () => {
+  it('renders', () => {
+    const wrapper = shallow(<EmptyState />)
+      .find(EuiEmptyPrompt)
+      .dive();
+
+    expect(wrapper.find('h2').text()).toEqual('Add documents to generate a Search UI');
+    expect(wrapper.find(EuiButton).prop('href')).toEqual(
+      expect.stringContaining('/reference-ui-guide.html')
+    );
+  });
+});
diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/components/empty_state.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/components/empty_state.tsx
new file mode 100644
index 00000000000000..b7665a58de300b
--- /dev/null
+++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/components/empty_state.tsx
@@ -0,0 +1,46 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import React from 'react';
+
+import { EuiButton, EuiEmptyPrompt } from '@elastic/eui';
+import { i18n } from '@kbn/i18n';
+
+import { DOCS_PREFIX } from '../../../routes';
+
+export const EmptyState: React.FC = () => (
+  <EuiEmptyPrompt
+    iconType="search"
+    title={
+      <h2>
+        {i18n.translate('xpack.enterpriseSearch.appSearch.engine.searchUI.empty.title', {
+          defaultMessage: 'Add documents to generate a Search UI',
+        })}
+      </h2>
+    }
+    body={
+      <p>
+        {i18n.translate('xpack.enterpriseSearch.appSearch.engine.searchUI.empty.description', {
+          defaultMessage:
+            'A schema will be automatically created for you after you index some documents.',
+        })}
+      </p>
+    }
+    actions={
+      <EuiButton
+        size="s"
+        target="_blank"
+        iconType="popout"
+        href={`${DOCS_PREFIX}/reference-ui-guide.html`}
+      >
+        {i18n.translate('xpack.enterpriseSearch.appSearch.engine.searchUI.empty.buttonLabel', {
+          defaultMessage: 'Read the Search UI guide',
+        })}
+      </EuiButton>
+    }
+  />
+);
diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/search_ui.test.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/search_ui.test.tsx
index edec376dd3edd1..f9f0dd611b9539 100644
--- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/search_ui.test.tsx
+++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/search_ui.test.tsx
@@ -6,14 +6,17 @@
  */
 
 import '../../../__mocks__/shallow_useeffect.mock';
-import '../../__mocks__/engine_logic.mock';
 
-import { setMockActions } from '../../../__mocks__/kea_logic';
+import { setMockActions, setMockValues } from '../../../__mocks__/kea_logic';
+import { mockEngineValues } from '../../__mocks__/engine_logic.mock';
 
 import React from 'react';
 
 import { shallow } from 'enzyme';
 
+import { SearchUIForm } from './components/search_ui_form';
+import { SearchUIGraphic } from './components/search_ui_graphic';
+
 import { SearchUI } from './';
 
 describe('SearchUI', () => {
@@ -24,11 +27,13 @@ describe('SearchUI', () => {
   beforeEach(() => {
     jest.clearAllMocks();
     setMockActions(actions);
+    setMockValues(mockEngineValues);
   });
 
   it('renders', () => {
-    shallow(<SearchUI />);
-    // TODO: Check for form
+    const wrapper = shallow(<SearchUI />);
+    expect(wrapper.find(SearchUIForm).exists()).toBe(true);
+    expect(wrapper.find(SearchUIGraphic).exists()).toBe(true);
   });
 
   it('initializes data on mount', () => {
diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/search_ui.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/search_ui.tsx
index e75bc36177151f..0ac59a33068baf 100644
--- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/search_ui.tsx
+++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/search_ui/search_ui.tsx
@@ -7,25 +7,16 @@
 
 import React, { useEffect } from 'react';
 
-import { useActions } from 'kea';
+import { useActions, useValues } from 'kea';
 
-import {
-  EuiPageHeader,
-  EuiPageContentBody,
-  EuiText,
-  EuiFlexItem,
-  EuiFlexGroup,
-  EuiSpacer,
-  EuiLink,
-} from '@elastic/eui';
+import { EuiText, EuiFlexItem, EuiFlexGroup, EuiSpacer, EuiLink } from '@elastic/eui';
 import { FormattedMessage } from '@kbn/i18n/react';
 
-import { FlashMessages } from '../../../shared/flash_messages';
-import { SetAppSearchChrome as SetPageChrome } from '../../../shared/kibana_chrome';
-
 import { DOCS_PREFIX } from '../../routes';
-import { getEngineBreadcrumbs } from '../engine';
+import { EngineLogic, getEngineBreadcrumbs } from '../engine';
+import { AppSearchPageTemplate } from '../layout';
 
+import { EmptyState } from './components/empty_state';
 import { SearchUIForm } from './components/search_ui_form';
 import { SearchUIGraphic } from './components/search_ui_graphic';
 import { SEARCH_UI_TITLE } from './i18n';
@@ -33,61 +24,62 @@ import { SearchUILogic } from './search_ui_logic';
 
 export const SearchUI: React.FC = () => {
   const { loadFieldData } = useActions(SearchUILogic);
+  const { engine } = useValues(EngineLogic);
 
   useEffect(() => {
     loadFieldData();
   }, []);
 
   return (
-    <>
-      <SetPageChrome trail={getEngineBreadcrumbs([SEARCH_UI_TITLE])} />
-      <EuiPageHeader pageTitle={SEARCH_UI_TITLE} />
-      <FlashMessages />
-      <EuiPageContentBody>
-        <EuiFlexGroup alignItems="flexStart">
-          <EuiFlexItem>
-            <EuiText size="s" color="subdued">
-              <p>
-                <FormattedMessage
-                  id="xpack.enterpriseSearch.appSearch.engine.searchUI.bodyDescription"
-                  defaultMessage="Search UI is a free and open library for building search experiences with React. {link}."
-                  values={{
-                    link: (
-                      <EuiLink target="_blank" href="https://github.com/elastic/search-ui">
-                        <FormattedMessage
-                          id="xpack.enterpriseSearch.appSearch.engine.searchUI.repositoryLinkText"
-                          defaultMessage="Learn more"
-                        />
-                      </EuiLink>
-                    ),
-                  }}
-                />
-              </p>
-              <p>
-                <FormattedMessage
-                  id="xpack.enterpriseSearch.appSearch.engine.searchUI.lowerBodyDescription"
-                  defaultMessage="Use the fields below to generate a sample search experience built with Search UI. Use the sample to preview search results, or build upon it to create your own custom search experience. {link}."
-                  values={{
-                    link: (
-                      <EuiLink target="_blank" href={`${DOCS_PREFIX}/reference-ui-guide.html`}>
-                        <FormattedMessage
-                          id="xpack.enterpriseSearch.appSearch.engine.searchUI.guideLinkText"
-                          defaultMessage="Learn more"
-                        />
-                      </EuiLink>
-                    ),
-                  }}
-                />
-              </p>
-            </EuiText>
-            <EuiSpacer />
-            <SearchUIForm />
-          </EuiFlexItem>
-          <EuiFlexItem>
-            <SearchUIGraphic />
-          </EuiFlexItem>
-        </EuiFlexGroup>
-      </EuiPageContentBody>
-    </>
+    <AppSearchPageTemplate
+      pageChrome={getEngineBreadcrumbs([SEARCH_UI_TITLE])}
+      pageHeader={{ pageTitle: SEARCH_UI_TITLE }}
+      isEmptyState={Object.keys(engine.schema || {}).length === 0}
+      emptyState={<EmptyState />}
+    >
+      <EuiFlexGroup alignItems="flexStart">
+        <EuiFlexItem>
+          <EuiText size="s" color="subdued">
+            <p>
+              <FormattedMessage
+                id="xpack.enterpriseSearch.appSearch.engine.searchUI.bodyDescription"
+                defaultMessage="Search UI is a free and open library for building search experiences with React. {link}."
+                values={{
+                  link: (
+                    <EuiLink target="_blank" href="https://github.com/elastic/search-ui">
+                      <FormattedMessage
+                        id="xpack.enterpriseSearch.appSearch.engine.searchUI.repositoryLinkText"
+                        defaultMessage="View the Github repo"
+                      />
+                    </EuiLink>
+                  ),
+                }}
+              />
+            </p>
+            <p>
+              <FormattedMessage
+                id="xpack.enterpriseSearch.appSearch.engine.searchUI.lowerBodyDescription"
+                defaultMessage="Use the fields below to generate a sample search experience built with Search UI. Use the sample to preview search results, or build upon it to create your own custom search experience. {link}."
+                values={{
+                  link: (
+                    <EuiLink target="_blank" href={`${DOCS_PREFIX}/reference-ui-guide.html`}>
+                      <FormattedMessage
+                        id="xpack.enterpriseSearch.appSearch.engine.searchUI.guideLinkText"
+                        defaultMessage="Learn more about Search UI"
+                      />
+                    </EuiLink>
+                  ),
+                }}
+              />
+            </p>
+          </EuiText>
+          <EuiSpacer />
+          <SearchUIForm />
+        </EuiFlexItem>
+        <EuiFlexItem>
+          <SearchUIGraphic />
+        </EuiFlexItem>
+      </EuiFlexGroup>
+    </AppSearchPageTemplate>
   );
 };