github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.6] [Enterprise Search] Improve connector status signaling (#146194) (#146269)

Browse source 
# Backport

This will backport the following commits from `main` to `8.6`:
- [[Enterprise Search] Improve connector status signaling
(#146194)](https://github.com/elastic/kibana/pull/146194)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Sander
Philipse","email":"94373878+sphilipse@users.noreply.github.com"},"sourceCommit":{"committedDate":"2022-11-24T10:18:09Z","message":"[Enterprise
Search] Improve connector status signaling (#146194)\n\nThis improves
the connector status signals by:\r\n- Showing the last sync's error if
available and the connector doesn't\r\nhave its own error\r\n- Showing
errors in the config page\r\n- Showing a success message for connected
native connectors\r\n\r\nIt also sets the configuration to edit mode if
it needs
configuration\r\nchanges.","sha":"04e3772104a128cab26ad0e9688fa26b2b6c39ab","branchLabelMapping":{"^v8.7.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:EnterpriseSearch","v8.6.0","v8.7.0"],"number":146194,"url":"https://github.com/elastic/kibana/pull/146194","mergeCommit":{"message":"[Enterprise
Search] Improve connector status signaling (#146194)\n\nThis improves
the connector status signals by:\r\n- Showing the last sync's error if
available and the connector doesn't\r\nhave its own error\r\n- Showing
errors in the config page\r\n- Showing a success message for connected
native connectors\r\n\r\nIt also sets the configuration to edit mode if
it needs
configuration\r\nchanges.","sha":"04e3772104a128cab26ad0e9688fa26b2b6c39ab"}},"sourceBranch":"main","suggestedTargetBranches":["8.6"],"targetPullRequestStates":[{"branch":"8.6","label":"v8.6.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.7.0","labelRegex":"^v8.7.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/146194","number":146194,"mergeCommit":{"message":"[Enterprise
Search] Improve connector status signaling (#146194)\n\nThis improves
the connector status signals by:\r\n- Showing the last sync's error if
available and the connector doesn't\r\nhave its own error\r\n- Showing
errors in the config page\r\n- Showing a success message for connected
native connectors\r\n\r\nIt also sets the configuration to edit mode if
it needs
configuration\r\nchanges.","sha":"04e3772104a128cab26ad0e9688fa26b2b6c39ab"}}]}]
BACKPORT-->

Co-authored-by: Sander Philipse <94373878+sphilipse@users.noreply.github.com>
This commit is contained in:
Kibana Machine 2022-11-24 06:40:43 -05:00 • committed by GitHub
parent d9f0ccc247
commit d4567dc2ea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 96 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

27
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/connector/connector_configuration_config.tsx
View file

@ -9,14 +9,24 @@ import React from 'react';
import { useActions, useValues } from 'kea';
import { EuiButton, EuiDescriptionList, EuiFlexGroup, EuiFlexItem } from '@elastic/eui';
import {
EuiButton,
EuiCallOut,
EuiDescriptionList,
EuiFlexGroup,
EuiFlexItem,
EuiText,
} from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { IndexViewLogic } from '../index_view_logic';
import { ConnectorConfigurationForm } from './connector_configuration_form';
import { ConnectorConfigurationLogic } from './connector_configuration_logic';
export const ConnectorConfigurationConfig: React.FC = ({ children }) => {
const { error } = useValues(IndexViewLogic);
const { configView, isEditing } = useValues(ConnectorConfigurationLogic);
const { setIsEditing } = useActions(ConnectorConfigurationLogic);
@ -58,6 +68,21 @@ export const ConnectorConfigurationConfig: React.FC = ({ children }) => {
)
)}
</EuiFlexItem>
{!!error && (
<EuiFlexItem>
<EuiCallOut
color="danger"
title={i18n.translate(
'xpack.enterpriseSearch.content.indices.configurationConnector.config.error.title',
{
defaultMessage: 'Connector error',
}
)}
>
<EuiText size="s">{error}</EuiText>
</EuiCallOut>
</EuiFlexItem>
)}
</EuiFlexGroup>
);
};

14
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/connector/connector_configuration_logic.ts
View file

@ -9,7 +9,7 @@ import { kea, MakeLogicType } from 'kea';
import { i18n } from '@kbn/i18n';
import { ConnectorConfiguration } from '../../../../../../common/types/connectors';
import { ConnectorConfiguration, ConnectorStatus } from '../../../../../../common/types/connectors';
import { Actions } from '../../../../shared/api_logic/create_api_logic';
import {
clearFlashMessages,
@ -82,10 +82,18 @@ export const ConnectorConfigurationLogic = kea<
values: [CachedFetchIndexApiLogic, ['indexData as index']],
},
events: ({ actions, values }) => ({
afterMount: () =>
afterMount: () => {
actions.setConfigState(
isConnectorIndex(values.index) ? values.index.connector.configuration : {}
),
);
if (
isConnectorIndex(values.index) &&
(values.index.connector.status === ConnectorStatus.CREATED ||
values.index.connector.status === ConnectorStatus.NEEDS_CONFIGURATION)
) {
actions.setIsEditing(true);
}
},
}),
listeners: ({ actions, values }) => ({
apiError: (error) => flashAPIErrors(error),

5
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/connector/native_connector_configuration/native_connector_configuration.tsx
View file

@ -102,7 +102,10 @@ export const NativeConnectorConfiguration: React.FC = () => {
},
{
children: (
<NativeConnectorConfigurationConfig nativeConnector={nativeConnector} />
<NativeConnectorConfigurationConfig
nativeConnector={nativeConnector}
status={index.connector.status}
/>
),
status: hasConfigured ? 'complete' : 'incomplete',
title: i18n.translate(

25
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/connector/native_connector_configuration/native_connector_configuration_config.tsx
View file

@ -7,10 +7,12 @@
import React from 'react';
import { EuiSpacer, EuiLink, EuiText, EuiFlexGroup, EuiFlexItem } from '@elastic/eui';
import { EuiSpacer, EuiLink, EuiText, EuiFlexGroup, EuiFlexItem, EuiCallOut } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { ConnectorStatus } from '../../../../../../../common/types/connectors';
import { docLinks } from '../../../../../shared/doc_links';
import { ConnectorConfigurationConfig } from '../connector_configuration_config';
@ -18,11 +20,12 @@ import { NativeConnector } from '../types';
interface NativeConnectorConfigurationConfigProps {
nativeConnector: NativeConnector;
status: ConnectorStatus;
}
export const NativeConnectorConfigurationConfig: React.FC<
NativeConnectorConfigurationConfigProps
> = ({ nativeConnector }) => {
> = ({ nativeConnector, status }) => {
return (
<ConnectorConfigurationConfig>
<EuiText size="s">
@ -62,6 +65,24 @@ export const NativeConnectorConfigurationConfig: React.FC<
</EuiFlexItem>
)}
</EuiFlexGroup>
{status === ConnectorStatus.CONNECTED && (
<>
<EuiSpacer />
<EuiCallOut
iconType="check"
color="success"
title={i18n.translate(
'xpack.enterpriseSearch.content.indices.configurationConnector.nativeConnector.connectorConnected',
{
defaultMessage:
'Your connector {name} has connected to Enterprise Search successfully.',
values: { name: nativeConnector.name },
}
)}
/>
</>
)}
</ConnectorConfigurationConfig>
);
};

20
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/index_view_logic.test.ts
View file

@ -32,6 +32,7 @@ import { IndexViewLogic } from './index_view_logic';
const DEFAULT_VALUES = {
connector: undefined,
connectorId: null,
error: null,
fetchIndexApiData: undefined,
fetchIndexApiStatus: Status.LOADING,
hasAdvancedFilteringFeature: false,
@ -247,4 +248,23 @@ describe('IndexViewLogic', () => {
});
});
});
describe('selectors', () => {
describe('error', () => {
it('should return connector error if available', () => {
IndexViewLogic.actions.fetchIndexApiSuccess({
...CONNECTOR_VALUES.index,
connector: { ...connectorIndex.connector, error: 'error' },
});
expect(IndexViewLogic.values.error).toEqual('error');
});
it('should return connector last sync error if available and error is undefined', () => {
IndexViewLogic.actions.fetchIndexApiSuccess({
...CONNECTOR_VALUES.index,
connector: { ...connectorIndex.connector, last_sync_error: 'last sync error' },
});
expect(IndexViewLogic.values.error).toEqual('last sync error');
});
});
});
});

8
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/index_view_logic.ts
View file

@ -69,6 +69,7 @@ export interface IndexViewActions {
export interface IndexViewValues {
connector: Connector | undefined;
connectorId: string | null;
error: string | undefined;
fetchIndexApiData: typeof CachedFetchIndexApiLogic.values.fetchIndexApiData;
fetchIndexApiStatus: Status;
hasAdvancedFilteringFeature: boolean;
@ -207,6 +208,13 @@ export const IndexViewLogic = kea<MakeLogicType<IndexViewValues, IndexViewAction
() => [selectors.indexData],
(index) => (isConnectorViewIndex(index) ? index.connector.id : null),
],
error: [
() => [selectors.indexData],
(index: ElasticsearchViewIndex) =>
isConnectorViewIndex(index)
? index.connector.error || index.connector.last_sync_error
: null,
],
hasAdvancedFilteringFeature: [
() => [selectors.connector],
(connector?: Connector) =>

6
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/overview.tsx
View file

@ -21,16 +21,18 @@ import { CrawlDetailsFlyout } from './crawler/crawl_details_flyout/crawl_details
import { CrawlRequestsPanel } from './crawler/crawl_requests_panel/crawl_requests_panel';
import { CrawlerTotalStats } from './crawler_total_stats';
import { GenerateApiKeyPanel } from './generate_api_key_panel';
import { IndexViewLogic } from './index_view_logic';
import { OverviewLogic } from './overview.logic';
import { SyncJobs } from './sync_jobs/sync_jobs';
export const SearchIndexOverview: React.FC = () => {
const { indexData } = useValues(OverviewLogic);
const { error } = useValues(IndexViewLogic);
return (
<>
<EuiSpacer />
{isConnectorIndex(indexData) && indexData.connector.error && (
{isConnectorIndex(indexData) && error && (
<>
<EuiCallOut
iconType="alert"
@ -43,7 +45,7 @@ export const SearchIndexOverview: React.FC = () => {
)}
>
<EuiSpacer size="s" />
<EuiText size="s">{indexData.connector.error}</EuiText>
<EuiText size="s">{error}</EuiText>
</EuiCallOut>
<EuiSpacer />
</>