Skip to content

Commit

Permalink
[Search][Ent Search deprecation] Web Crawler tile points out GH repo …
Browse files Browse the repository at this point in the history
…instead become disabled (elastic#194743)

## Summary

This PR sets the Web Crawler tile to point out the external Open Web
Crawler repo when there is no ent-search node running rather than become
disabled using the `crawlerDisabled`

Before:

![CleanShot 2024-10-02 at 18 25
57@2x](https://github.com/user-attachments/assets/2cffe7c8-fbb1-4192-956f-69ba8ec5529a)

After:

![CleanShot 2024-10-02 at 18 25
11@2x](https://github.com/user-attachments/assets/fcf7ac0f-2985-4b7a-9100-3968054505c7)


Also the empty state of Web crawler points out to the Source code repo
when there is no ent-search instance running using the
`errorConnectingMessage`. This improvement should fix this issue
elastic/search-team#8319

![CleanShot 2024-10-08 at 11 48
44@2x](https://github.com/user-attachments/assets/1dedc24e-e23a-4188-a676-f910a9b2ce6c)


### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces—unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes—Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
  • Loading branch information
JoseLuisGJ and elasticmachine authored Oct 14, 2024
1 parent cd60c66 commit 414ae5d
Show file tree
Hide file tree
Showing 8 changed files with 106 additions and 25 deletions.
4 changes: 4 additions & 0 deletions x-pack/plugins/enterprise_search/common/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -281,5 +281,9 @@ export const PLUGIN_ID = 'enterpriseSearch';
export const CONNECTOR_NATIVE_TYPE = 'native';
export const CONNECTOR_CLIENTS_TYPE = 'connector_clients';

export const CRAWLER = {
github_repo: 'https://github.com/elastic/crawler',
};

// TODO remove this once the connector service types are no longer in "example" state
export const EXAMPLE_CONNECTOR_SERVICE_TYPES = ['opentext_documentum'];
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ import { useValues } from 'kea';
import { EuiButton, EuiEmptyPrompt, EuiPanel } from '@elastic/eui';
import { i18n } from '@kbn/i18n';

import { CRAWLER } from '../../../../../common/constants';
import { HttpLogic } from '../../../shared/http';
import { GithubIcon } from '../../../shared/icons/github_icon';
import { KibanaLogic } from '../../../shared/kibana';
import { NEW_CRAWLER_PATH } from '../../routes';

Expand Down Expand Up @@ -40,19 +42,36 @@ export const CrawlerEmptyState: React.FC = () => {
</p>
}
actions={
<EuiButton
data-test-subj="entSearchContent-crawlers-emptyState-createCrawlerButton"
data-telemetry-id="entSearchContent-crawlers-emptyState-createCrawlerButton"
color="primary"
disabled={Boolean(errorConnectingMessage)}
fill
iconType="plusInCircle"
onClick={() => KibanaLogic.values.navigateToUrl(NEW_CRAWLER_PATH)}
>
{i18n.translate('xpack.enterpriseSearch.crawlerEmptyState.newWebCrawlerButtonLabel', {
defaultMessage: 'New web crawler',
})}
</EuiButton>
Boolean(errorConnectingMessage) ? (
<EuiButton
data-test-subj="entSearchContent-crawlers-emptyState-createCrawlerButton"
data-telemetry-id="entSearchContent-crawlers-emptyState-createCrawlerButton"
color="primary"
fill
iconType={GithubIcon}
href={CRAWLER.github_repo}
>
{i18n.translate(
'xpack.enterpriseSearch.crawlerEmptyState.openSourceCrawlerButtonLabel',
{
defaultMessage: 'Source code',
}
)}
</EuiButton>
) : (
<EuiButton
data-test-subj="entSearchContent-crawlers-emptyState-createCrawlerButton"
data-telemetry-id="entSearchContent-crawlers-emptyState-createCrawlerButton"
color="primary"
fill
iconType="plusInCircle"
onClick={() => KibanaLogic.values.navigateToUrl(NEW_CRAWLER_PATH)}
>
{i18n.translate('xpack.enterpriseSearch.crawlerEmptyState.newWebCrawlerButtonLabel', {
defaultMessage: 'New web crawler',
})}
</EuiButton>
)
}
/>
</EuiPanel>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,16 @@ import {
IconType,
} from '@elastic/eui';

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

import { EuiLinkTo } from '../../../../shared/react_router_helpers';

interface IngestionCardProps {
buttonIcon: IconType;
buttonLabel: string;
description: string;
href?: string;
isBeta?: boolean;
isDisabled?: boolean;
logo: IconType;
onClick?: () => void;
Expand All @@ -37,13 +40,23 @@ export const IngestionCard: React.FC<IngestionCardProps> = ({
description,
href,
isDisabled,
isBeta,
logo,
onClick,
title,
}) => {
return (
<EuiCard
hasBorder
betaBadgeProps={
isBeta
? {
label: i18n.translate('xpack.enterpriseSearch.ingestionCard.betaBadgeLabel', {
defaultMessage: 'Beta',
}),
}
: undefined
}
isDisabled={isDisabled}
textAlign="left"
titleElement="h3"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import { i18n } from '@kbn/i18n';
import {
ENTERPRISE_SEARCH_CONTENT_PLUGIN,
ENTERPRISE_SEARCH_ELASTICSEARCH_URL,
CRAWLER,
} from '../../../../../common/constants';

import apiLogo from '../../../../assets/images/api_image.png';
Expand All @@ -37,6 +38,7 @@ import { HttpLogic } from '../../../shared/http/http_logic';

import { ConnectorIcon } from '../../../shared/icons/connector';
import { CrawlerIcon } from '../../../shared/icons/crawler';
import { GithubIcon } from '../../../shared/icons/github_icon';
import { KibanaLogic } from '../../../shared/kibana';

export const IngestionSelector: React.FC = () => {
Expand Down Expand Up @@ -76,22 +78,36 @@ export const IngestionSelector: React.FC = () => {
{productFeatures.hasWebCrawler && (
<EuiFlexItem>
<IngestionCard
buttonLabel={i18n.translate(
'xpack.enterpriseSearch.ingestSelector.method.crawlerButtonLabel',
{
defaultMessage: 'Crawl URL',
}
)}
buttonIcon={CrawlerIcon}
buttonLabel={
crawlerDisabled
? i18n.translate(
'xpack.enterpriseSearch.ingestSelector.method.sourceCodeButtonLabel',
{
defaultMessage: 'Source code',
}
)
: i18n.translate(
'xpack.enterpriseSearch.ingestSelector.method.crawler.description',
{
defaultMessage:
'Discover, extract, and index searchable content from websites and knowledge bases.',
}
)
}
buttonIcon={crawlerDisabled ? GithubIcon : CrawlerIcon}
description={i18n.translate(
'xpack.enterpriseSearch.ingestSelector.method.crawler.description',
{
defaultMessage:
'Discover, extract, and index searchable content from websites and knowledge bases.',
}
)}
href={generatePath(ENTERPRISE_SEARCH_CONTENT_PLUGIN.URL + NEW_CRAWLER_PATH)}
isDisabled={crawlerDisabled}
href={
crawlerDisabled
? CRAWLER.github_repo
: generatePath(ENTERPRISE_SEARCH_CONTENT_PLUGIN.URL + NEW_CRAWLER_PATH)
}
isBeta={crawlerDisabled}
logo={crawlerLogo}
title={i18n.translate('xpack.enterpriseSearch.ingestSelector.method.crawler', {
defaultMessage: 'Web Crawler',
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/*
* 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';

export const GithubIcon = () => {
return (
<svg
xmlns="http://www.w3.org/2000/svg"
width="16"
height="16"
fill="currentColor"
viewBox="0 0 16 16"
>
<g clipPath="url(#a)">
<path
fill="currentColor"
d="M8 0C3.582 0 0 3.672 0 8.2c0 3.624 2.292 6.697 5.471 7.781.4.075.546-.178.546-.394 0-.196-.007-.842-.011-1.527-2.225.495-2.695-.967-2.695-.967-.364-.947-.888-1.2-.888-1.2-.727-.508.055-.498.055-.498.803.057 1.226.845 1.226.845.714 1.253 1.873.891 2.328.68.073-.528.28-.89.508-1.094-1.776-.207-3.644-.911-3.644-4.053 0-.896.312-1.627.823-2.2-.082-.21-.357-1.043.079-2.172 0 0 .67-.22 2.2.84A7.441 7.441 0 0 1 8 3.967c.68.003 1.364.094 2.003.277 1.526-1.062 2.198-.841 2.198-.841.438 1.13.162 1.963.08 2.17.513.574.822 1.305.822 2.2 0 3.15-1.87 3.845-3.653 4.048.288.254.543.753.543 1.517 0 1.096-.01 1.98-.01 2.25 0 .219.145.474.55.394C13.71 14.895 16 11.821 16 8.201 16 3.67 12.418 0 8 0Z"
/>
</g>
<defs>
<clipPath id="a">
<path fill="currentColor" d="M0 0h16v16H0z" />
</clipPath>
</defs>
</svg>
);
};
1 change: 0 additions & 1 deletion x-pack/plugins/translations/translations/fr-FR.json
Original file line number Diff line number Diff line change
Expand Up @@ -17385,7 +17385,6 @@
"xpack.enterpriseSearch.ingestSelector.method.connectors.description": "Extraire, transformer, indexer et synchroniser des données issues d'une source de données tiers.",
"xpack.enterpriseSearch.ingestSelector.method.crawler": "Robot d'indexation",
"xpack.enterpriseSearch.ingestSelector.method.crawler.description": "Découvrir, extraire et indexer du contenu interrogeable provenant de sites web et de bases de connaissances.",
"xpack.enterpriseSearch.ingestSelector.method.crawlerButtonLabel": "Indexer l'URL",
"xpack.enterpriseSearch.ingestSelector.method.fileUpload": "Charger un fichier",
"xpack.enterpriseSearch.ingestSelector.method.fileUpload.description": "Fichiers texte délimités, tels que CSV et TSV, JSON délimité par une nouvelle ligne.",
"xpack.enterpriseSearch.ingestSelector.method.fileUploadLabel": "Choisir un fichier",
Expand Down
1 change: 0 additions & 1 deletion x-pack/plugins/translations/translations/ja-JP.json
Original file line number Diff line number Diff line change
Expand Up @@ -17131,7 +17131,6 @@
"xpack.enterpriseSearch.ingestSelector.method.connectors.description": "サードパーティのデータソースからデータを抽出、変換、インデックス化、同期します。",
"xpack.enterpriseSearch.ingestSelector.method.crawler": "Webクローラー",
"xpack.enterpriseSearch.ingestSelector.method.crawler.description": "Webサイトやナレッジベースから検索可能なコンテンツを検出、抽出、インデックス化します。",
"xpack.enterpriseSearch.ingestSelector.method.crawlerButtonLabel": "クロールURL",
"xpack.enterpriseSearch.ingestSelector.method.fileUpload": "ファイルをアップロード",
"xpack.enterpriseSearch.ingestSelector.method.fileUpload.description": "CSVやTSV、改行区切りのJSONなどの区切られたテキストファイル。",
"xpack.enterpriseSearch.ingestSelector.method.fileUploadLabel": "ファイルを選択",
Expand Down
1 change: 0 additions & 1 deletion x-pack/plugins/translations/translations/zh-CN.json
Original file line number Diff line number Diff line change
Expand Up @@ -17160,7 +17160,6 @@
"xpack.enterpriseSearch.ingestSelector.method.connectors.description": "提取、转换、索引和同步来自第三方数据源的数据。",
"xpack.enterpriseSearch.ingestSelector.method.crawler": "网络爬虫",
"xpack.enterpriseSearch.ingestSelector.method.crawler.description": "发现、提取和索引网站和知识库中的可搜索内容。",
"xpack.enterpriseSearch.ingestSelector.method.crawlerButtonLabel": "爬网 URL",
"xpack.enterpriseSearch.ingestSelector.method.fileUpload": "上传文件",
"xpack.enterpriseSearch.ingestSelector.method.fileUpload.description": "分隔的文本文件,例如 CSV 和 TSV、换行符分隔的 JSON。",
"xpack.enterpriseSearch.ingestSelector.method.fileUploadLabel": "选择文件",
Expand Down

0 comments on commit 414ae5d

Please sign in to comment.