Rename engine_overview folder to engines

- To better match ent-search folder structure - Also rename/clarify pluralization of "Engines" where possible, to distinguish between individual Engine Overview pages
elastic · Nov 5, 2020 · 69dd473 · 69dd473
1 parent 074ef6f
commit 69dd473
Show file tree

Hide file tree

Showing 18 changed files with 52 additions and 49 deletions.
diff --git a/...ts/engine_overview/assets/engine_icon.tsx → ...components/engines/assets/engine_icon.tsx b/...ts/engine_overview/assets/engine_icon.tsx → ...components/engines/assets/engine_icon.tsx
diff --git a/...gine_overview/assets/meta_engine_icon.tsx → ...nents/engines/assets/meta_engine_icon.tsx b/...gine_overview/assets/meta_engine_icon.tsx → ...nents/engines/assets/meta_engine_icon.tsx
diff --git a/...gine_overview/components/empty_state.scss → ...nents/engines/components/empty_state.scss b/...gine_overview/components/empty_state.scss → ...nents/engines/components/empty_state.scss
diff --git a/..._overview/components/empty_state.test.tsx → ...s/engines/components/empty_state.test.tsx b/..._overview/components/empty_state.test.tsx → ...s/engines/components/empty_state.test.tsx
diff --git a/...ngine_overview/components/empty_state.tsx → ...onents/engines/components/empty_state.tsx b/...ngine_overview/components/empty_state.tsx → ...onents/engines/components/empty_state.tsx
@@ -14,7 +14,7 @@ import { getAppSearchUrl } from '../../../../shared/enterprise_search_url';
 import { SetAppSearchChrome as SetPageChrome } from '../../../../shared/kibana_chrome';
 import { CREATE_ENGINES_PATH } from '../../../routes';
 
-import { EngineOverviewHeader } from './header';
+import { EnginesOverviewHeader } from './header';
 
 import './empty_state.scss';
 
@@ -34,7 +34,7 @@ export const EmptyState: React.FC = () => {
   return (
     <>
       <SetPageChrome />
-      <EngineOverviewHeader />
+      <EnginesOverviewHeader />
       <EuiPageContent className="emptyState">
         <EuiEmptyPrompt
           className="emptyState__prompt"

diff --git a/...ngine_overview/components/header.test.tsx → ...onents/engines/components/header.test.tsx b/...ngine_overview/components/header.test.tsx → ...onents/engines/components/header.test.tsx
@@ -11,16 +11,16 @@ import { mockTelemetryActions } from '../../../../__mocks__';
 import React from 'react';
 import { shallow } from 'enzyme';
 
-import { EngineOverviewHeader } from './';
+import { EnginesOverviewHeader } from './';
 
-describe('EngineOverviewHeader', () => {
+describe('EnginesOverviewHeader', () => {
   it('renders', () => {
-    const wrapper = shallow(<EngineOverviewHeader />);
+    const wrapper = shallow(<EnginesOverviewHeader />);
     expect(wrapper.find('h1')).toHaveLength(1);
   });
 
   it('renders a launch app search button that sends telemetry on click', () => {
-    const wrapper = shallow(<EngineOverviewHeader />);
+    const wrapper = shallow(<EnginesOverviewHeader />);
     const button = wrapper.find('[data-test-subj="launchButton"]');
 
     expect(button.prop('href')).toBe('http://localhost:3002/as');

diff --git a/...nts/engine_overview/components/header.tsx → .../components/engines/components/header.tsx b/...nts/engine_overview/components/header.tsx → .../components/engines/components/header.tsx
@@ -19,7 +19,7 @@ import { FormattedMessage } from '@kbn/i18n/react';
 import { TelemetryLogic } from '../../../../shared/telemetry';
 import { getAppSearchUrl } from '../../../../shared/enterprise_search_url';
 
-export const EngineOverviewHeader: React.FC = () => {
+export const EnginesOverviewHeader: React.FC = () => {
   const { sendAppSearchTelemetry } = useActions(TelemetryLogic);
 
   const buttonProps = {
@@ -42,7 +42,7 @@ export const EngineOverviewHeader: React.FC = () => {
           <h1>
             <FormattedMessage
               id="xpack.enterpriseSearch.appSearch.enginesOverview.title"
-              defaultMessage="Engine Overview"
+              defaultMessage="Engines Overview"
             />
           </h1>
         </EuiTitle>

diff --git a/...nents/engine_overview/components/index.ts → ...ch/components/engines/components/index.ts b/...nents/engine_overview/components/index.ts → ...ch/components/engines/components/index.ts
@@ -4,6 +4,6 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-export { EngineOverviewHeader } from './header';
+export { EnginesOverviewHeader } from './header';
 export { LoadingState } from './loading_state';
 export { EmptyState } from './empty_state';
diff --git a/...verview/components/loading_state.test.tsx → ...engines/components/loading_state.test.tsx b/...verview/components/loading_state.test.tsx → ...engines/components/loading_state.test.tsx
diff --git a/...ine_overview/components/loading_state.tsx → ...ents/engines/components/loading_state.tsx b/...ine_overview/components/loading_state.tsx → ...ents/engines/components/loading_state.tsx
@@ -8,13 +8,13 @@ import React from 'react';
 import { EuiPageContent, EuiSpacer, EuiLoadingContent } from '@elastic/eui';
 
 import { SetAppSearchChrome as SetPageChrome } from '../../../../shared/kibana_chrome';
-import { EngineOverviewHeader } from './header';
+import { EnginesOverviewHeader } from './header';
 
 export const LoadingState: React.FC = () => {
   return (
     <>
       <SetPageChrome />
-      <EngineOverviewHeader />
+      <EnginesOverviewHeader />
       <EuiPageContent paddingSize="l">
         <EuiLoadingContent lines={5} />
         <EuiSpacer size="xxl" />

diff --git a/...ents/engine_overview/engine_overview.scss → .../components/engines/engines_overview.scss b/...ents/engine_overview/engine_overview.scss → .../components/engines/engines_overview.scss
@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-.engineOverview {
+.enginesOverview {
   padding: $euiSize;
 
   @include euiBreakpoint('m', 'l', 'xl') {

diff --git a/.../engine_overview/engine_overview.test.tsx → ...ponents/engines/engines_overview.test.tsx b/.../engine_overview/engine_overview.test.tsx → ...ponents/engines/engines_overview.test.tsx
@@ -14,14 +14,14 @@ import { shallow, ReactWrapper } from 'enzyme';
 import { mountAsync, mockHttpValues, setMockValues } from '../../../__mocks__';
 
 import { LoadingState, EmptyState } from './components';
-import { EngineTable } from './engine_table';
+import { EnginesTable } from './engines_table';
 
-import { EngineOverview } from './';
+import { EnginesOverview } from './';
 
-describe('EngineOverview', () => {
+describe('EnginesOverview', () => {
   describe('non-happy-path states', () => {
     it('isLoading', () => {
-      const wrapper = shallow(<EngineOverview />);
+      const wrapper = shallow(<EnginesOverview />);
 
       expect(wrapper.find(LoadingState)).toHaveLength(1);
     });
@@ -36,7 +36,7 @@ describe('EngineOverview', () => {
           }),
         },
       });
-      const wrapper = await mountAsync(<EngineOverview />, { i18n: true });
+      const wrapper = await mountAsync(<EnginesOverview />, { i18n: true });
 
       expect(wrapper.find(EmptyState)).toHaveLength(1);
     });
@@ -69,9 +69,9 @@ describe('EngineOverview', () => {
     });
 
     it('renders and calls the engines API', async () => {
-      const wrapper = await mountAsync(<EngineOverview />, { i18n: true });
+      const wrapper = await mountAsync(<EnginesOverview />, { i18n: true });
 
-      expect(wrapper.find(EngineTable)).toHaveLength(1);
+      expect(wrapper.find(EnginesTable)).toHaveLength(1);
       expect(mockApi).toHaveBeenNthCalledWith(1, '/api/app_search/engines', {
         query: {
           type: 'indexed',
@@ -86,9 +86,9 @@ describe('EngineOverview', () => {
           hasPlatinumLicense: true,
           http: { ...mockHttpValues.http, get: mockApi },
         });
-        const wrapper = await mountAsync(<EngineOverview />, { i18n: true });
+        const wrapper = await mountAsync(<EnginesOverview />, { i18n: true });
 
-        expect(wrapper.find(EngineTable)).toHaveLength(2);
+        expect(wrapper.find(EnginesTable)).toHaveLength(2);
         expect(mockApi).toHaveBeenNthCalledWith(2, '/api/app_search/engines', {
           query: {
             type: 'meta',
@@ -100,18 +100,18 @@ describe('EngineOverview', () => {
 
     describe('pagination', () => {
       const getTablePagination = (wrapper: ReactWrapper) =>
-        wrapper.find(EngineTable).prop('pagination');
+        wrapper.find(EnginesTable).prop('pagination');
 
       it('passes down page data from the API', async () => {
-        const wrapper = await mountAsync(<EngineOverview />, { i18n: true });
+        const wrapper = await mountAsync(<EnginesOverview />, { i18n: true });
         const pagination = getTablePagination(wrapper);
 
         expect(pagination.totalEngines).toEqual(100);
         expect(pagination.pageIndex).toEqual(0);
       });
 
       it('re-polls the API on page change', async () => {
-        const wrapper = await mountAsync(<EngineOverview />, { i18n: true });
+        const wrapper = await mountAsync(<EnginesOverview />, { i18n: true });
         await act(async () => getTablePagination(wrapper).onPaginate(5));
         wrapper.update();
 

diff --git a/...nents/engine_overview/engine_overview.tsx → ...h/components/engines/engines_overview.tsx b/...nents/engine_overview/engine_overview.tsx → ...h/components/engines/engines_overview.tsx
@@ -24,10 +24,10 @@ import { LicensingLogic } from '../../../shared/licensing';
 import { EngineIcon } from './assets/engine_icon';
 import { MetaEngineIcon } from './assets/meta_engine_icon';
 
-import { EngineOverviewHeader, LoadingState, EmptyState } from './components';
-import { EngineTable } from './engine_table';
+import { EnginesOverviewHeader, LoadingState, EmptyState } from './components';
+import { EnginesTable } from './engines_table';
 
-import './engine_overview.scss';
+import './engines_overview.scss';
 
 interface IGetEnginesParams {
   type: string;
@@ -38,7 +38,7 @@ interface ISetEnginesCallbacks {
   setResultsTotal: React.Dispatch<React.SetStateAction<number>>;
 }
 
-export const EngineOverview: React.FC = () => {
+export const EnginesOverview: React.FC = () => {
   const { http } = useValues(HttpLogic);
   const { hasPlatinumLicense } = useValues(LicensingLogic);
 
@@ -88,8 +88,8 @@ export const EngineOverview: React.FC = () => {
       <SetPageChrome />
       <SendTelemetry action="viewed" metric="engines_overview" />
 
-      <EngineOverviewHeader />
-      <EuiPageContent panelPaddingSize="s" className="engineOverview">
+      <EnginesOverviewHeader />
+      <EuiPageContent panelPaddingSize="s" className="enginesOverview">
         <FlashMessages />
         <EuiPageContentHeader>
           <EuiTitle size="s">
@@ -102,7 +102,7 @@ export const EngineOverview: React.FC = () => {
           </EuiTitle>
         </EuiPageContentHeader>
         <EuiPageContentBody data-test-subj="appSearchEngines">
-          <EngineTable
+          <EnginesTable
             data={engines}
             pagination={{
               totalEngines: enginesTotal,
@@ -126,7 +126,7 @@ export const EngineOverview: React.FC = () => {
               </EuiTitle>
             </EuiPageContentHeader>
             <EuiPageContentBody data-test-subj="appSearchMetaEngines">
-              <EngineTable
+              <EnginesTable
                 data={metaEngines}
                 pagination={{
                   totalEngines: metaEnginesTotal,

diff --git a/...nts/engine_overview/engine_table.test.tsx → ...components/engines/engines_table.test.tsx b/...nts/engine_overview/engine_table.test.tsx → ...components/engines/engines_table.test.tsx
@@ -12,13 +12,13 @@ import React from 'react';
 import { EuiBasicTable, EuiPagination, EuiButtonEmpty } from '@elastic/eui';
 import { EuiLink } from '../../../shared/react_router_helpers';
 
-import { EngineTable } from './engine_table';
+import { EnginesTable } from './engines_table';
 
-describe('EngineTable', () => {
+describe('EnginesTable', () => {
   const onPaginate = jest.fn(); // onPaginate updates the engines API call upstream
 
   const wrapper = mountWithIntl(
-    <EngineTable
+    <EnginesTable
       data={[
         {
           name: 'test-engine',
@@ -71,7 +71,10 @@ describe('EngineTable', () => {
 
   it('handles empty data', () => {
     const emptyWrapper = mountWithIntl(
-      <EngineTable data={[]} pagination={{ totalEngines: 0, pageIndex: 0, onPaginate: () => {} }} />
+      <EnginesTable
+        data={[]}
+        pagination={{ totalEngines: 0, pageIndex: 0, onPaginate: () => {} }}
+      />
     );
     const emptyTable = emptyWrapper.find(EuiBasicTable);
 

diff --git a/...mponents/engine_overview/engine_table.tsx → ...arch/components/engines/engines_table.tsx b/...mponents/engine_overview/engine_table.tsx → ...arch/components/engines/engines_table.tsx
@@ -16,28 +16,28 @@ import { getEngineRoute } from '../../routes';
 
 import { ENGINES_PAGE_SIZE } from '../../../../../common/constants';
 
-export interface IEngineTableData {
+interface IEnginesTableData {
   name: string;
   created_at: string;
   document_count: number;
   field_count: number;
 }
-export interface IEngineTablePagination {
+interface IEnginesTablePagination {
   totalEngines: number;
   pageIndex: number;
   onPaginate(pageIndex: number): void;
 }
-export interface IEngineTableProps {
-  data: IEngineTableData[];
-  pagination: IEngineTablePagination;
+interface IEnginesTableProps {
+  data: IEnginesTableData[];
+  pagination: IEnginesTablePagination;
 }
-export interface IOnChange {
+interface IOnChange {
   page: {
     index: number;
   };
 }
 
-export const EngineTable: React.FC<IEngineTableProps> = ({
+export const EnginesTable: React.FC<IEnginesTableProps> = ({
   data,
   pagination: { totalEngines, pageIndex, onPaginate },
 }) => {
@@ -52,7 +52,7 @@ export const EngineTable: React.FC<IEngineTableProps> = ({
       }),
   });
 
-  const columns: Array<EuiBasicTableColumn<IEngineTableData>> = [
+  const columns: Array<EuiBasicTableColumn<IEnginesTableData>> = [
     {
       field: 'name',
       name: i18n.translate('xpack.enterpriseSearch.appSearch.enginesOverview.table.column.name', {

diff --git a/...earch/components/engine_overview/index.ts → ...ns/app_search/components/engines/index.ts b/...earch/components/engine_overview/index.ts → ...ns/app_search/components/engines/index.ts
@@ -4,4 +4,4 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-export { EngineOverview } from './engine_overview';
+export { EnginesOverview } from './engines_overview';
diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/index.test.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/index.test.tsx
@@ -16,7 +16,7 @@ import { shallow } from 'enzyme';
 import { Layout, SideNav, SideNavLink } from '../shared/layout';
 import { SetupGuide } from './components/setup_guide';
 import { ErrorConnecting } from './components/error_connecting';
-import { EngineOverview } from './components/engine_overview';
+import { EnginesOverview } from './components/engines';
 import { EngineRouter } from './components/engine';
 import { AppSearch, AppSearchUnconfigured, AppSearchConfigured, AppSearchNav } from './';
 
@@ -57,7 +57,7 @@ describe('AppSearchConfigured', () => {
 
     expect(wrapper.find(Layout)).toHaveLength(2);
     expect(wrapper.find(Layout).last().prop('readOnlyMode')).toBeFalsy();
-    expect(wrapper.find(EngineOverview)).toHaveLength(1);
+    expect(wrapper.find(EnginesOverview)).toHaveLength(1);
     expect(wrapper.find(EngineRouter)).toHaveLength(1);
   });
 

diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/index.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/index.tsx
@@ -33,7 +33,7 @@ import {
 import { SetupGuide } from './components/setup_guide';
 import { ErrorConnecting } from './components/error_connecting';
 import { NotFound } from '../shared/not_found';
-import { EngineOverview } from './components/engine_overview';
+import { EnginesOverview } from './components/engines';
 import { Settings } from './components/settings';
 import { Credentials } from './components/credentials';
 
@@ -82,7 +82,7 @@ export const AppSearchConfigured: React.FC<IInitialAppData> = (props) => {
                 <Redirect to={ENGINES_PATH} />
               </Route>
               <Route exact path={ENGINES_PATH}>
-                <EngineOverview />
+                <EnginesOverview />
               </Route>
               <Route exact path={SETTINGS_PATH}>
                 <Settings />