Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Enterprise Search] Name and description flyout for connectors #143827

Merged
merged 8 commits into from
Nov 15, 2022
Merged

[Enterprise Search] Name and description flyout for connectors #143827

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c3a9ffa
WIP of name and description flyout
byronhulcher Oct 23, 2022
6981b0f
i18n
byronhulcher Oct 24, 2022
861bd8b
Adding optional label
byronhulcher Oct 24, 2022
0e3420c
Fix test mocks
byronhulcher Oct 24, 2022
22122cb
Merge branch 'main' into name-description-flyout
kibanamachine Oct 27, 2022
171c9c6
isDisabled -> isLoading
byronhulcher Oct 28, 2022
4d0d98a
Merge remote-tracking branch 'origin/main' into name-description-flyout
byronhulcher Oct 28, 2022
6dc4474
Merge remote-tracking branch 'origin/main' into name-description-flyout
byronhulcher Nov 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...ise_search/public/applications/enterprise_search_content/__mocks__/search_indices.mock.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ export const indices: ElasticsearchIndexWithIngestion[] = [
count: 1,
crawler: {
id: '5',
index_name: 'crawler',
index_name: 'connector-crawler',
},
hidden: false,
name: 'crawler',
Expand Down
2 changes: 1 addition & 1 deletion ...erprise_search/public/applications/enterprise_search_content/__mocks__/view_index.mock.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ export const crawlerIndex: CrawlerViewIndex = {
count: 1,
crawler: {
id: '5',
index_name: 'crawler',
index_name: 'connector-crawler',
},
hidden: false,
ingestionMethod: IngestionMethod.CRAWLER,
Expand Down
99 changes: 99 additions & 0 deletions ..._index/connector/connector_name_and_description/connector_name_and_description_flyout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
/*
* 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 { useValues, useActions } from 'kea';

import {
EuiFlyout,
EuiFlyoutHeader,
EuiFlyoutBody,
EuiFormRow,
EuiText,
EuiSpacer,
EuiFlyoutFooter,
EuiButtonEmpty,
EuiButton,
EuiTitle,
EuiFlexGroup,
EuiFlexItem,
} from '@elastic/eui';

import { i18n } from '@kbn/i18n';

import { Status } from '../../../../../../../common/types/api';
import { CANCEL_BUTTON_LABEL } from '../../../../../shared/constants';

import { ConnectorNameAndDescriptionApiLogic } from '../../../../api/connector/update_connector_name_and_description_api_logic';

import { ConnectorNameAndDescriptionFormContent } from './connector_name_and_description_form_content';
import { ConnectorNameAndDescriptionLogic } from './connector_name_and_description_logic';

export const ConnectorNameAndDescriptionFlyout: React.FC = () => {
const { status } = useValues(ConnectorNameAndDescriptionApiLogic);
const { isEditing } = useValues(ConnectorNameAndDescriptionLogic);
const { saveNameAndDescription, setIsEditing } = useActions(ConnectorNameAndDescriptionLogic);

if (!isEditing) return null;

return (
<EuiFlyout onClose={() => setIsEditing(false)} size="s">
<EuiFlyoutHeader>
<EuiTitle size="m">
<h3>
{i18n.translate(
'xpack.enterpriseSearch.content.indices.configurationConnector.nameAndDescriptionFlyout.title',
{
defaultMessage: 'Describe this crawler',
}
)}
</h3>
</EuiTitle>
</EuiFlyoutHeader>

<EuiFlyoutBody>
<EuiFormRow>
<EuiText size="s">
{i18n.translate(
'xpack.enterpriseSearch.content.indices.configurationConnector.nameAndDescriptionFlyout.description',
{
defaultMessage:
'By naming and describing this connector your colleagues and wider team will know what this connector is meant for.',
}
)}
</EuiText>
</EuiFormRow>
<EuiSpacer />
<ConnectorNameAndDescriptionFormContent />
</EuiFlyoutBody>

<EuiFlyoutFooter>
<EuiFlexGroup justifyContent="spaceBetween">
<EuiFlexItem grow={false}>
<EuiButtonEmpty
onClick={() => setIsEditing(false)}
isLoading={status === Status.LOADING}
>
{CANCEL_BUTTON_LABEL}
</EuiButtonEmpty>
</EuiFlexItem>
<EuiFlexItem grow={false}>
<EuiButton isLoading={status === Status.LOADING} fill onClick={saveNameAndDescription}>
{i18n.translate(
'xpack.enterpriseSearch.content.indices.configurationConnector.nameAndDescriptionFlyout.saveButtonLabel',
{
defaultMessage: 'Save name and description',
}
)}
</EuiButton>
</EuiFlexItem>
</EuiFlexGroup>
</EuiFlyoutFooter>
</EuiFlyout>
);
};
42 changes: 4 additions & 38 deletions ...ch_index/connector/connector_name_and_description/connector_name_and_description_form.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,40 +12,23 @@ import { useActions, useValues } from 'kea';
import {
EuiButton,
EuiButtonEmpty,
EuiFieldText,
EuiFlexGroup,
EuiFlexItem,
EuiForm,
EuiFormRow,
EuiTextArea,
} from '@elastic/eui';

import { Status } from '../../../../../../../common/types/api';
import {
NAME_LABEL,
DESCRIPTION_LABEL,
SAVE_BUTTON_LABEL,
CANCEL_BUTTON_LABEL,
} from '../../../../../shared/constants';
import { SAVE_BUTTON_LABEL, CANCEL_BUTTON_LABEL } from '../../../../../shared/constants';
import { ConnectorNameAndDescriptionApiLogic } from '../../../../api/connector/update_connector_name_and_description_api_logic';
import { isConnectorIndex } from '../../../../utils/indices';
import { IndexViewLogic } from '../../index_view_logic';

import { ConnectorNameAndDescriptionFormContent } from './connector_name_and_description_form_content';
import { ConnectorNameAndDescriptionLogic } from './connector_name_and_description_logic';

export const ConnectorNameAndDescriptionForm: React.FC = () => {
const { index } = useValues(IndexViewLogic);
const { status } = useValues(ConnectorNameAndDescriptionApiLogic);
const {
localNameAndDescription: { name, description },
} = useValues(ConnectorNameAndDescriptionLogic);
const { saveNameAndDescription, setIsEditing, updateLocalNameAndDescription } = useActions(
ConnectorNameAndDescriptionLogic
);

if (!isConnectorIndex(index)) {
return <></>;
}
const { saveNameAndDescription, setIsEditing } = useActions(ConnectorNameAndDescriptionLogic);

return (
<EuiForm
Expand All @@ -55,24 +38,7 @@ export const ConnectorNameAndDescriptionForm: React.FC = () => {
}}
component="form"
>
<EuiFormRow label={NAME_LABEL}>
<EuiFieldText
required
value={name ?? ''}
onChange={(event) => {
updateLocalNameAndDescription({ name: event.target.value });
}}
/>
</EuiFormRow>
<EuiFormRow label={DESCRIPTION_LABEL}>
<EuiTextArea
placeholder={'Optional'}
value={description || ''}
onChange={(event) => {
updateLocalNameAndDescription({ description: event.target.value });
}}
/>
</EuiFormRow>
<ConnectorNameAndDescriptionFormContent />
<EuiFormRow>
<EuiFlexGroup>
<EuiFlexItem grow={false}>
Expand Down
46 changes: 46 additions & 0 deletions .../connector/connector_name_and_description/connector_name_and_description_form_content.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 { useActions, useValues } from 'kea';

import { EuiFieldText, EuiFormRow, EuiTextArea } from '@elastic/eui';

import { NAME_LABEL, DESCRIPTION_LABEL, OPTIONAL_LABEL } from '../../../../../shared/constants';

import { ConnectorNameAndDescriptionLogic } from './connector_name_and_description_logic';

export const ConnectorNameAndDescriptionFormContent: React.FC = () => {
const {
localNameAndDescription: { name, description },
} = useValues(ConnectorNameAndDescriptionLogic);
const { updateLocalNameAndDescription } = useActions(ConnectorNameAndDescriptionLogic);

return (
<>
<EuiFormRow label={NAME_LABEL}>
<EuiFieldText
required
value={name ?? ''}
onChange={(event) => {
updateLocalNameAndDescription({ name: event.target.value });
}}
/>
</EuiFormRow>
<EuiFormRow label={DESCRIPTION_LABEL}>
<EuiTextArea
placeholder={OPTIONAL_LABEL}
value={description || ''}
onChange={(event) => {
updateLocalNameAndDescription({ description: event.target.value });
}}
/>
</EuiFormRow>
</>
);
};
8 changes: 5 additions & 3 deletions ...ch_index/connector/connector_name_and_description/connector_name_and_description_logic.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import {
CachedFetchIndexApiLogicActions,
} from '../../../../api/index/cached_fetch_index_api_logic';
import { FetchIndexApiResponse } from '../../../../api/index/fetch_index_api_logic';
import { isConnectorIndex } from '../../../../utils/indices';
import { isConnectorIndex, isCrawlerIndex } from '../../../../utils/indices';

type NameAndDescription = Partial<Pick<Connector, 'name' | 'description'>>;

Expand Down Expand Up @@ -72,7 +72,9 @@ export const ConnectorNameAndDescriptionLogic = kea<
},
events: ({ actions, values }) => ({
afterMount: () =>
actions.setNameAndDescription(isConnectorIndex(values.index) ? values.index.connector : {}),
actions.setNameAndDescription(
isConnectorIndex(values.index) || isCrawlerIndex(values.index) ? values.index.connector : {}
),
}),
listeners: ({ actions, values }) => ({
apiError: (error) => flashAPIErrors(error),
Expand All @@ -92,7 +94,7 @@ export const ConnectorNameAndDescriptionLogic = kea<
},
makeRequest: () => clearFlashMessages(),
saveNameAndDescription: () => {
if (isConnectorIndex(values.index)) {
if (isConnectorIndex(values.index) || isCrawlerIndex(values.index)) {
actions.makeRequest({
connectorId: values.index.connector.id,
indexName: values.index.connector.index_name,
Expand Down
32 changes: 22 additions & 10 deletions ...ic/applications/enterprise_search_content/components/search_index/crawler_total_stats.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,18 @@ import React from 'react';

import { useValues } from 'kea';

import { EuiStatProps, EuiFlexGroup, EuiFlexItem, EuiPanel, EuiStat } from '@elastic/eui';
import {
EuiStatProps,
EuiFlexGroup,
EuiFlexItem,
EuiPanel,
EuiStat,
EuiSpacer,
} from '@elastic/eui';
import { i18n } from '@kbn/i18n';

import { CrawlerLogic } from './crawler/crawler_logic';
import { NameAndDescriptionStats } from './name_and_description_stats';
import { OverviewLogic } from './overview.logic';

export const CrawlerTotalStats: React.FC = () => {
Expand Down Expand Up @@ -60,14 +68,18 @@ export const CrawlerTotalStats: React.FC = () => {
];

return (
<EuiFlexGroup direction="row">
{stats.map((item, index) => (
<EuiFlexItem key={index}>
<EuiPanel color={index === 0 ? 'primary' : 'subdued'} hasShadow={false} paddingSize="l">
<EuiStat {...item} />
</EuiPanel>
</EuiFlexItem>
))}
</EuiFlexGroup>
<>
<NameAndDescriptionStats />
<EuiSpacer />
<EuiFlexGroup direction="row">
{stats.map((item, index) => (
<EuiFlexItem key={index}>
<EuiPanel color={index === 0 ? 'primary' : 'subdued'} hasShadow={false} paddingSize="l">
<EuiStat {...item} />
</EuiPanel>
</EuiFlexItem>
))}
</EuiFlexGroup>
</>
);
};
Loading