[Enterprise Search] Add eslint import/order rules (#90530)

* Add import rules

- newlines between each group
- mocks in test files before everything else
- React before all other externals

* Run --fix on public/applications/workplace_search

* Manually fix errors still present in WS public files

- these appear to be mostly due to jest.mock() or const mixed in with imports, which confuses the autofixer

* Run --fix on public/applications/app_search

+ some manual fixes/tweaks along the way

* Run --fix on public/applications/shared

- some opinionated changes, particularly around IFlashMessages and grouping together types coming from Kibana (src->../../src)

* Run --fix on public/applications/enterprise_search

- mostly straightforward

* Run --fix on public/applications/__mocks__

* Fix remaining top-level public files

- Some opinionated changes (src/core -> ../../src/core) to keep types/mocks together

* Run --fix on server/ files

- same opinionated src->../src changes to keep deps grouped together

- opinionated require->import fetch change in enterprise_esarch_config_api.test.ts

- opinionated [] inclusion of builtins & external imports together (mostly for enterprise_search_request_handler.ts)

.eslintrc.js

@@ -1119,6 +1119,39 @@ module.exports = {
       // All files
       files: ['x-pack/plugins/enterprise_search/**/*.{ts,tsx}'],
       rules: {
+        'import/order': [
+          'error',
+          {
+            groups: ['unknown', ['builtin', 'external'], 'internal', 'parent', 'sibling', 'index'],
+            pathGroups: [
+              {
+                pattern:
+                  '{../../../../../../,../../../../../,../../../../,../../../,../../,../}{common/,*}__mocks__{*,/**}',
+                group: 'unknown',
+              },
+              {
+                pattern: '{**,.}/*.mock',
+                group: 'unknown',
+              },
+              {
+                pattern: 'react*',
+                group: 'external',
+                position: 'before',
+              },
+              {
+                pattern: '{@elastic/**,@kbn/**,src/**}',
+                group: 'internal',
+              },
+            ],
+            pathGroupsExcludedImportTypes: [],
+            alphabetize: {
+              order: 'asc',
+              caseInsensitive: true,
+            },
+            'newlines-between': 'always-and-inside-groups',
+          },
+        ],
+        'import/newline-after-import': 'error',
         'react-hooks/exhaustive-deps': 'off',
         'react/jsx-boolean-value': ['error', 'never'],
       },

x-pack/plugins/enterprise_search/public/applications/__mocks__/kea.mock.ts

@@ -11,11 +11,11 @@
  * NOTE: These variable names MUST start with 'mock*' in order for
  * Jest to accept its use within a jest.mock()
  */
+import { mockFlashMessagesValues, mockFlashMessagesActions } from './flash_messages_logic.mock';
+import { mockHttpValues } from './http_logic.mock';
 import { mockKibanaValues } from './kibana_logic.mock';
 import { mockLicensingValues } from './licensing_logic.mock';
-import { mockHttpValues } from './http_logic.mock';
 import { mockTelemetryActions } from './telemetry_logic.mock';
-import { mockFlashMessagesValues, mockFlashMessagesActions } from './flash_messages_logic.mock';
 
 export const mockAllValues = {
   ...mockKibanaValues,

x-pack/plugins/enterprise_search/public/applications/__mocks__/kibana_logic.mock.ts

@@ -6,6 +6,7 @@
  */
 
 import { chartPluginMock } from '../../../../../../src/plugins/charts/public/mocks';
+
 import { mockHistory } from './';
 
 export const mockKibanaValues = {

x-pack/plugins/enterprise_search/public/applications/__mocks__/mount_async.mock.tsx

@@ -6,8 +6,9 @@
  */
 
 import React from 'react';
-import { act } from 'react-dom/test-utils';
+
 import { mount, ReactWrapper } from 'enzyme';
+import { act } from 'react-dom/test-utils';
 
 import { mountWithIntl } from './';
 

x-pack/plugins/enterprise_search/public/applications/__mocks__/mount_with_i18n.mock.tsx

@@ -6,7 +6,9 @@
  */
 
 import React from 'react';
+
 import { mount } from 'enzyme';
+
 import { I18nProvider } from '@kbn/i18n/react';
 
 /**

x-pack/plugins/enterprise_search/public/applications/__mocks__/shallow_with_i18n.mock.tsx

@@ -8,6 +8,7 @@
 import React from 'react';
 
 import { shallow, mount, ReactWrapper } from 'enzyme';
+
 import { I18nProvider, __IntlProvider } from '@kbn/i18n/react';
 
 // Use fake component to extract `intl` property to use in tests.

x-pack/plugins/enterprise_search/public/applications/app_search/app_logic.test.ts

@@ -5,9 +5,9 @@
  * 2.0.
  */
 
+import { DEFAULT_INITIAL_APP_DATA } from '../../../common/__mocks__';
 import { LogicMounter } from '../__mocks__';
 
-import { DEFAULT_INITIAL_APP_DATA } from '../../../common/__mocks__';
 import { AppLogic } from './app_logic';
 
 describe('AppLogic', () => {

x-pack/plugins/enterprise_search/public/applications/app_search/app_logic.ts

@@ -8,6 +8,7 @@
 import { kea, MakeLogicType } from 'kea';
 
 import { InitialAppData } from '../../../common/types';
+
 import { ConfiguredLimits, Account, Role } from './types';
 
 import { getRoleAbilities } from './utils/role';

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/analytics_layout.test.tsx

@@ -11,14 +11,15 @@ import { mockKibanaValues, setMockValues, setMockActions, rerender } from '../..
 
 import React from 'react';
 import { useParams } from 'react-router-dom';
+
 import { shallow } from 'enzyme';
 
-import { Loading } from '../../../shared/loading';
 import { FlashMessages } from '../../../shared/flash_messages';
+import { Loading } from '../../../shared/loading';
 import { LogRetentionCallout } from '../log_retention';
-import { AnalyticsHeader, AnalyticsUnavailable } from './components';
 
 import { AnalyticsLayout } from './analytics_layout';
+import { AnalyticsHeader, AnalyticsUnavailable } from './components';
 
 describe('AnalyticsLayout', () => {
   const { history } = mockKibanaValues;

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/analytics_layout.tsx

@@ -7,18 +7,21 @@
 
 import React, { useEffect } from 'react';
 import { useParams } from 'react-router-dom';
+
 import { useValues, useActions } from 'kea';
+
 import { EuiSpacer } from '@elastic/eui';
 
-import { KibanaLogic } from '../../../shared/kibana';
 import { FlashMessages } from '../../../shared/flash_messages';
+import { KibanaLogic } from '../../../shared/kibana';
 import { Loading } from '../../../shared/loading';
 
 import { LogRetentionCallout, LogRetentionOptions } from '../log_retention';
 
-import { AnalyticsLogic } from './';
 import { AnalyticsHeader, AnalyticsUnavailable } from './components';
 
+import { AnalyticsLogic } from './';
+
 interface Props {
   title: string;
   isQueryView?: boolean;

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/analytics_logic.test.ts

@@ -19,6 +19,7 @@ jest.mock('../engine', () => ({
 import { nextTick } from '@kbn/test/jest';
 
 import { DEFAULT_START_DATE, DEFAULT_END_DATE } from './constants';
+
 import { AnalyticsLogic } from './';
 
 describe('AnalyticsLogic', () => {

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/analytics_logic.ts

@@ -8,9 +8,9 @@
 import { kea, MakeLogicType } from 'kea';
 import queryString from 'query-string';
 
-import { KibanaLogic } from '../../../shared/kibana';
-import { HttpLogic } from '../../../shared/http';
 import { flashAPIErrors } from '../../../shared/flash_messages';
+import { HttpLogic } from '../../../shared/http';
+import { KibanaLogic } from '../../../shared/kibana';
 import { EngineLogic } from '../engine';
 
 import { DEFAULT_START_DATE, DEFAULT_END_DATE } from './constants';

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/analytics_router.test.tsx

@@ -8,9 +8,11 @@
 import '../../__mocks__/engine_logic.mock';
 
 import React from 'react';
-import { shallow } from 'enzyme';
+
 import { Route, Switch } from 'react-router-dom';
 
+import { shallow } from 'enzyme';
+
 import { AnalyticsRouter } from './';
 
 describe('AnalyticsRouter', () => {

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_cards.test.tsx

@@ -6,7 +6,9 @@
  */
 
 import React from 'react';
+
 import { shallow } from 'enzyme';
+
 import { EuiStat } from '@elastic/eui';
 
 import { AnalyticsCards } from './';

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_cards.tsx

@@ -6,6 +6,7 @@
  */
 
 import React from 'react';
+
 import { EuiFlexGroup, EuiFlexItem, EuiPanel, EuiStat } from '@elastic/eui';
 
 interface Props {

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_chart.test.tsx

@@ -8,7 +8,9 @@
 import { mockKibanaValues } from '../../../../__mocks__';
 
 import React from 'react';
+
 import { shallow } from 'enzyme';
+
 import { Chart, Settings, LineSeries, Axis } from '@elastic/charts';
 
 import { AnalyticsChart } from './';

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_chart.tsx

@@ -6,9 +6,11 @@
  */
 
 import React from 'react';
+
 import { useValues } from 'kea';
 
 import moment from 'moment';
+
 import { Chart, Settings, LineSeries, CurveType, Axis } from '@elastic/charts';
 
 import { KibanaLogic } from '../../../../shared/kibana';

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_header.test.tsx

@@ -8,13 +8,16 @@
 import { setMockValues, mockKibanaValues } from '../../../../__mocks__';
 
 import React, { ReactElement } from 'react';
+
 import { shallow, ShallowWrapper } from 'enzyme';
 import moment, { Moment } from 'moment';
+
 import { EuiPageHeader, EuiSelect, EuiDatePickerRange, EuiButton } from '@elastic/eui';
 
 import { LogRetentionTooltip } from '../../log_retention';
 
 import { DEFAULT_START_DATE, DEFAULT_END_DATE } from '../constants';
+
 import { AnalyticsHeader } from './';
 
 describe('AnalyticsHeader', () => {

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_header.tsx

@@ -6,12 +6,11 @@
  */
 
 import React, { useState } from 'react';
-import { useValues } from 'kea';
 
-import queryString from 'query-string';
+import { useValues } from 'kea';
 import moment from 'moment';
+import queryString from 'query-string';
 
-import { i18n } from '@kbn/i18n';
 import {
   EuiPageHeader,
   EuiPageHeaderSection,
@@ -23,11 +22,12 @@ import {
   EuiDatePicker,
   EuiButton,
 } from '@elastic/eui';
+import { i18n } from '@kbn/i18n';
 
+import { AnalyticsLogic } from '../';
 import { KibanaLogic } from '../../../../shared/kibana';
 import { LogRetentionTooltip, LogRetentionOptions } from '../../log_retention';
 
-import { AnalyticsLogic } from '../';
 import { DEFAULT_START_DATE, DEFAULT_END_DATE, SERVER_DATE_FORMAT } from '../constants';
 import { convertTagsToSelectOptions } from '../utils';
 

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_search.test.tsx

@@ -9,7 +9,9 @@ import { mockKibanaValues } from '../../../../__mocks__';
 import '../../../__mocks__/engine_logic.mock';
 
 import React from 'react';
+
 import { shallow } from 'enzyme';
+
 import { EuiFieldSearch } from '@elastic/eui';
 
 import { AnalyticsSearch } from './';

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_search.tsx

@@ -6,10 +6,11 @@
  */
 
 import React, { useState } from 'react';
+
 import { useValues } from 'kea';
 
-import { i18n } from '@kbn/i18n';
 import { EuiFlexGroup, EuiFlexItem, EuiFieldSearch, EuiButton, EuiSpacer } from '@elastic/eui';
+import { i18n } from '@kbn/i18n';
 
 import { KibanaLogic } from '../../../../shared/kibana';
 import { ENGINE_ANALYTICS_QUERY_DETAIL_PATH } from '../../../routes';

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_section.test.tsx

@@ -6,6 +6,7 @@
  */
 
 import React from 'react';
+
 import { shallow } from 'enzyme';
 
 import { AnalyticsSection } from './';

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/analytics_table.test.tsx

@@ -9,6 +9,7 @@ import { mountWithIntl, mockKibanaValues } from '../../../../../__mocks__';
 import '../../../../__mocks__/engine_logic.mock';
 
 import React from 'react';
+
 import { EuiBasicTable, EuiBadge, EuiEmptyPrompt } from '@elastic/eui';
 
 import { AnalyticsTable } from './';

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/analytics_table.tsx

@@ -6,10 +6,12 @@
  */
 
 import React from 'react';
-import { i18n } from '@kbn/i18n';
+
 import { EuiBasicTable, EuiBasicTableColumn, EuiEmptyPrompt } from '@elastic/eui';
+import { i18n } from '@kbn/i18n';
 
 import { Query } from '../../types';
+
 import {
   TERM_COLUMN_PROPS,
   TAGS_COLUMN,

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/inline_tags_list.test.tsx

@@ -6,7 +6,9 @@
  */
 
 import React from 'react';
+
 import { shallow } from 'enzyme';
+
 import { EuiBadge, EuiToolTip } from '@elastic/eui';
 
 import { InlineTagsList } from './inline_tags_list';

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/inline_tags_list.tsx

@@ -6,8 +6,9 @@
  */
 
 import React from 'react';
-import { i18n } from '@kbn/i18n';
+
 import { EuiBadgeGroup, EuiBadge, EuiToolTip } from '@elastic/eui';
+import { i18n } from '@kbn/i18n';
 
 import { Query } from '../../types';
 

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/query_clicks_table.test.tsx

@@ -9,6 +9,7 @@ import { mountWithIntl } from '../../../../../__mocks__';
 import '../../../../__mocks__/engine_logic.mock';
 
 import React from 'react';
+
 import { EuiBasicTable, EuiLink, EuiBadge, EuiEmptyPrompt } from '@elastic/eui';
 
 import { QueryClicksTable } from './';

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/query_clicks_table.tsx

@@ -7,15 +7,16 @@
 
 import React from 'react';
 
-import { i18n } from '@kbn/i18n';
 import { EuiBasicTable, EuiBasicTableColumn, EuiEmptyPrompt } from '@elastic/eui';
+import { i18n } from '@kbn/i18n';
 
 import { EuiLinkTo } from '../../../../../shared/react_router_helpers';
 import { ENGINE_DOCUMENT_DETAIL_PATH } from '../../../../routes';
-import { generateEnginePath } from '../../../engine';
 import { DOCUMENTS_TITLE } from '../../../documents';
+import { generateEnginePath } from '../../../engine';
 
 import { QueryClick } from '../../types';
+
 import { FIRST_COLUMN_PROPS, TAGS_COLUMN, COUNT_COLUMN_PROPS } from './shared_columns';
 
 interface Props {

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/recent_queries_table.test.tsx

@@ -9,6 +9,7 @@ import { mountWithIntl, mockKibanaValues } from '../../../../../__mocks__';
 import '../../../../__mocks__/engine_logic.mock';
 
 import React from 'react';
+
 import { EuiBasicTable, EuiBadge, EuiEmptyPrompt } from '@elastic/eui';
 
 import { RecentQueriesTable } from './';

x-pack/plugins/enterprise_search/public/applications/app_search/components/analytics/components/analytics_tables/recent_queries_table.tsx

@@ -7,11 +7,12 @@
 
 import React from 'react';
 
+import { EuiBasicTable, EuiBasicTableColumn, EuiEmptyPrompt } from '@elastic/eui';
 import { i18n } from '@kbn/i18n';
 import { FormattedDate, FormattedTime } from '@kbn/i18n/react';
-import { EuiBasicTable, EuiBasicTableColumn, EuiEmptyPrompt } from '@elastic/eui';
 
 import { RecentQuery } from '../../types';
+
 import {
   TERM_COLUMN_PROPS,
   TAGS_COLUMN,