From 9171743e8368a47503cf5892a8b7e47d35b42319 Mon Sep 17 00:00:00 2001 From: Sander Philipse <94373878+sphilipse@users.noreply.github.com> Date: Thu, 19 Jun 2025 19:34:32 +0200 Subject: [PATCH] [Search] Remove website search guided onboarding (#224538) ## Summary This removes the deprecated website search guided onboarding from Kibana. Deprecated because we no longer offer a managed web crawler. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> --- .../public/components/main.tsx | 8 +------ .../__snapshots__/guide_cards.test.tsx.snap | 24 ------------------- .../classic_version/guide_cards.constants.tsx | 10 -------- .../guide/guide_cards.constants.tsx | 10 -------- .../shared/kbn-guided-onboarding/src/types.ts | 2 +- .../apis/guided_onboarding/get_config.ts | 11 --------- .../translations/translations/fr-FR.json | 1 - .../translations/translations/ja-JP.json | 1 - .../translations/translations/zh-CN.json | 1 - .../guided_onboarding/search_guide_config.ts | 6 +---- .../components/search_index/search_index.tsx | 11 --------- .../enterprise_search/server/plugin.ts | 6 ----- .../apis/guided_onboarding/get_guides.ts | 11 ++------- .../apis/guided_onboarding/put_state.ts | 14 ++--------- x-pack/solutions/search/test/tsconfig.json | 1 - 15 files changed, 7 insertions(+), 110 deletions(-) diff --git a/examples/guided_onboarding_example/public/components/main.tsx b/examples/guided_onboarding_example/public/components/main.tsx index d172cfbb0c8f..d60bdda2ad0b 100644 --- a/examples/guided_onboarding_example/public/components/main.tsx +++ b/examples/guided_onboarding_example/public/components/main.tsx @@ -36,13 +36,7 @@ interface MainProps { notifications: CoreStart['notifications']; } -const exampleGuideIds: GuideId[] = [ - 'websiteSearch', - 'databaseSearch', - 'siem', - 'kubernetes', - 'testGuide', -]; +const exampleGuideIds: GuideId[] = ['databaseSearch', 'siem', 'kubernetes', 'testGuide']; const selectOptions: EuiSelectOption[] = exampleGuideIds.map((guideId) => ({ value: guideId, text: guideId, diff --git a/src/platform/packages/shared/kbn-guided-onboarding/src/components/landing_page/classic_version/__snapshots__/guide_cards.test.tsx.snap b/src/platform/packages/shared/kbn-guided-onboarding/src/components/landing_page/classic_version/__snapshots__/guide_cards.test.tsx.snap index 2471b221f87d..270fbe459b69 100644 --- a/src/platform/packages/shared/kbn-guided-onboarding/src/components/landing_page/classic_version/__snapshots__/guide_cards.test.tsx.snap +++ b/src/platform/packages/shared/kbn-guided-onboarding/src/components/landing_page/classic_version/__snapshots__/guide_cards.test.tsx.snap @@ -93,30 +93,6 @@ exports[`guide cards snapshots should render all cards 1`] = ` size="m" /> - - - - { - it(`does not returns config for ${guideId}`, async () => { - await supertest - .get(`${getConfigsPath}/${guideId}`) - .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana') - .expect(404); - }); - }); }); } diff --git a/x-pack/platform/plugins/private/translations/translations/fr-FR.json b/x-pack/platform/plugins/private/translations/translations/fr-FR.json index c8f101da9f28..817d1686f507 100644 --- a/x-pack/platform/plugins/private/translations/translations/fr-FR.json +++ b/x-pack/platform/plugins/private/translations/translations/fr-FR.json @@ -3997,7 +3997,6 @@ "guidedOnboardingPackage.gettingStarted.cards.syntheticsObservability.title": "Créer un moniteur synthétique", "guidedOnboardingPackage.gettingStarted.cards.universalProfilingObservability.title": "Optimiser mes charges de travail avec Universal Profiling", "guidedOnboardingPackage.gettingStarted.cards.vectorSearch.title": "Configurer une recherche vectorielle", - "guidedOnboardingPackage.gettingStarted.cards.websiteSearch.title": "Ajouter la recherche à mon site web", "guidedOnboardingPackage.gettingStarted.guideFilter.all.buttonLabel": "Tous", "guidedOnboardingPackage.gettingStarted.guideFilter.observability.buttonLabel": "Observabilité", "guidedOnboardingPackage.gettingStarted.guideFilter.search.buttonLabel": "Elasticsearch", diff --git a/x-pack/platform/plugins/private/translations/translations/ja-JP.json b/x-pack/platform/plugins/private/translations/translations/ja-JP.json index 4a6b959681a3..d7d949c92146 100644 --- a/x-pack/platform/plugins/private/translations/translations/ja-JP.json +++ b/x-pack/platform/plugins/private/translations/translations/ja-JP.json @@ -3991,7 +3991,6 @@ "guidedOnboardingPackage.gettingStarted.cards.syntheticsObservability.title": "シンセティック監視を作成", "guidedOnboardingPackage.gettingStarted.cards.universalProfilingObservability.title": "ユニバーサルプロファイリングでワークロードを最適化", "guidedOnboardingPackage.gettingStarted.cards.vectorSearch.title": "ベクトル検索を設定", - "guidedOnboardingPackage.gettingStarted.cards.websiteSearch.title": "検索をWebサイトに追加", "guidedOnboardingPackage.gettingStarted.guideFilter.all.buttonLabel": "すべて", "guidedOnboardingPackage.gettingStarted.guideFilter.observability.buttonLabel": "Observability", "guidedOnboardingPackage.gettingStarted.guideFilter.search.buttonLabel": "Elasticsearch", diff --git a/x-pack/platform/plugins/private/translations/translations/zh-CN.json b/x-pack/platform/plugins/private/translations/translations/zh-CN.json index fef186f20353..f42e0165ffdb 100644 --- a/x-pack/platform/plugins/private/translations/translations/zh-CN.json +++ b/x-pack/platform/plugins/private/translations/translations/zh-CN.json @@ -3997,7 +3997,6 @@ "guidedOnboardingPackage.gettingStarted.cards.syntheticsObservability.title": "创建 Synthetic 监测", "guidedOnboardingPackage.gettingStarted.cards.universalProfilingObservability.title": "使用 Universal Profiling 优化我的工作负载", "guidedOnboardingPackage.gettingStarted.cards.vectorSearch.title": "设置矢量搜索", - "guidedOnboardingPackage.gettingStarted.cards.websiteSearch.title": "添加搜索到我的网站", "guidedOnboardingPackage.gettingStarted.guideFilter.all.buttonLabel": "全部", "guidedOnboardingPackage.gettingStarted.guideFilter.observability.buttonLabel": "Observability", "guidedOnboardingPackage.gettingStarted.guideFilter.search.buttonLabel": "Elasticsearch", diff --git a/x-pack/solutions/search/plugins/enterprise_search/common/guided_onboarding/search_guide_config.ts b/x-pack/solutions/search/plugins/enterprise_search/common/guided_onboarding/search_guide_config.ts index 5d6c5e9f11df..084e69e00ad9 100644 --- a/x-pack/solutions/search/plugins/enterprise_search/common/guided_onboarding/search_guide_config.ts +++ b/x-pack/solutions/search/plugins/enterprise_search/common/guided_onboarding/search_guide_config.ts @@ -8,15 +8,13 @@ import type { GuideConfig, StepConfig } from '@kbn/guided-onboarding'; import { i18n } from '@kbn/i18n'; -export const websiteSearchGuideId = 'websiteSearch'; export const databaseSearchGuideId = 'databaseSearch'; const apiRoutes = { [databaseSearchGuideId]: '/connectors/select_connector', - [websiteSearchGuideId]: '/crawlers', }; -export type EnterpriseSearchGuideIds = typeof websiteSearchGuideId | typeof databaseSearchGuideId; +export type EnterpriseSearchGuideIds = typeof databaseSearchGuideId; const getAddDataStep: (method?: EnterpriseSearchGuideIds) => StepConfig = (method) => { return { @@ -83,6 +81,4 @@ const getGuideConfig: (telemetryId: EnterpriseSearchGuideIds) => GuideConfig = ( }; }; -export const websiteSearchGuideConfig: GuideConfig = getGuideConfig(websiteSearchGuideId); - export const databaseSearchGuideConfig: GuideConfig = getGuideConfig(databaseSearchGuideId); diff --git a/x-pack/solutions/search/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/search_index.tsx b/x-pack/solutions/search/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/search_index.tsx index 90ec6f101fc1..320bfb03b75f 100644 --- a/x-pack/solutions/search/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/search_index.tsx +++ b/x-pack/solutions/search/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/search_index.tsx @@ -73,17 +73,6 @@ export const SearchIndex: React.FC = () => { updateSideNavDefinition, } = useValues(KibanaLogic); - useEffect(() => { - const subscription = guidedOnboarding?.guidedOnboardingApi - ?.isGuideStepActive$('websiteSearch', 'add_data') - .subscribe((isStepActive) => { - if (isStepActive && index?.count) { - guidedOnboarding?.guidedOnboardingApi?.completeGuideStep('websiteSearch', 'add_data'); - } - }); - return () => subscription?.unsubscribe(); - }, [guidedOnboarding, index?.count]); - useEffect(() => { const subscription = guidedOnboarding?.guidedOnboardingApi ?.isGuideStepActive$('databaseSearch', 'add_data') diff --git a/x-pack/solutions/search/plugins/enterprise_search/server/plugin.ts b/x-pack/solutions/search/plugins/enterprise_search/server/plugin.ts index 445a8255216e..848561763b83 100644 --- a/x-pack/solutions/search/plugins/enterprise_search/server/plugin.ts +++ b/x-pack/solutions/search/plugins/enterprise_search/server/plugin.ts @@ -36,9 +36,7 @@ import { } from '../common/constants'; import { - websiteSearchGuideId, databaseSearchGuideId, - websiteSearchGuideConfig, databaseSearchGuideConfig, } from '../common/guided_onboarding/search_guide_config'; @@ -303,10 +301,6 @@ export class EnterpriseSearchPlugin implements Plugin { - await createGuides(kibanaServer, [ - testGuideStep1ActiveState, - { ...testGuideStep1ActiveState, guideId: websiteSearchGuideId }, - ]); + await createGuides(kibanaServer, [testGuideStep1ActiveState]); const response = await supertest .get(getGuidesPath) .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana') .expect(200); expect(response.body).not.to.be.empty(); - expect(response.body.state).to.eql([ - testGuideStep1ActiveState, - { ...testGuideStep1ActiveState, guideId: websiteSearchGuideId }, - ]); + expect(response.body.state).to.eql([testGuideStep1ActiveState]); }); }); } diff --git a/x-pack/solutions/search/test/api_integration/apis/guided_onboarding/put_state.ts b/x-pack/solutions/search/test/api_integration/apis/guided_onboarding/put_state.ts index 1d252b3bdd69..4c278ca77b9a 100644 --- a/x-pack/solutions/search/test/api_integration/apis/guided_onboarding/put_state.ts +++ b/x-pack/solutions/search/test/api_integration/apis/guided_onboarding/put_state.ts @@ -19,7 +19,6 @@ import { guideStateSavedObjectsType, } from '@kbn/guided-onboarding-plugin/server/saved_objects/guided_setup'; import { testGuideId } from '@kbn/guided-onboarding'; -import { websiteSearchGuideId } from '@kbn/enterprise-search-plugin/common/guided_onboarding/search_guide_config'; import { API_BASE_PATH } from '@kbn/guided-onboarding-plugin/common'; import { X_ELASTIC_INTERNAL_ORIGIN_REQUEST } from '@kbn/core-http-common'; import { @@ -135,11 +134,8 @@ export default function testPutState({ getService }: FtrProviderContext) { }); it('updates any existing active guides to inactive', async () => { - // create an active guide and an inactive guide - await createGuides(kibanaServer, [ - testGuideStep1ActiveState, - { ...testGuideNotActiveState, guideId: websiteSearchGuideId }, - ]); + // create an active guide + await createGuides(kibanaServer, [testGuideStep1ActiveState]); // Create a new guide with isActive: true await supertest @@ -161,12 +157,6 @@ export default function testPutState({ getService }: FtrProviderContext) { }); expect(testGuideSO.attributes.isActive).to.eql(false); - const searchGuideSO = await kibanaServer.savedObjects.get({ - type: guideStateSavedObjectsType, - id: websiteSearchGuideId, - }); - expect(searchGuideSO.attributes.isActive).to.eql(false); - const kubernetesGuide = await kibanaServer.savedObjects.get({ type: guideStateSavedObjectsType, id: 'kubernetes', diff --git a/x-pack/solutions/search/test/tsconfig.json b/x-pack/solutions/search/test/tsconfig.json index e1dd392c45e9..0a20d09eeb14 100644 --- a/x-pack/solutions/search/test/tsconfig.json +++ b/x-pack/solutions/search/test/tsconfig.json @@ -24,7 +24,6 @@ "@kbn/test-suites-xpack-platform", "@kbn/expect", "@kbn/guided-onboarding-plugin", - "@kbn/enterprise-search-plugin", "@kbn/test-suites-src", "@kbn/guided-onboarding", "@kbn/search-playground",