[Enterprise Search] Update apps to use a service for docs links (#89425)

* Create DocLinksService * Set docLinks on app start * Update routes modules to use service * Update component and test to use service * Remove legacy files * Add comment Co-authored-by: Constance <[email protected]> * Add new line Co-authored-by: Constance <[email protected]> * Refactor test * Rename class and remove extra route segments * Update test names Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Constance <[email protected]>
elastic · Jan 29, 2021 · 67014a7 · 67014a7
1 parent da65019
commit 67014a7
Show file tree

Hide file tree

Showing 11 changed files with 86 additions and 38 deletions.
diff --git a/x-pack/plugins/enterprise_search/common/version.ts b/x-pack/plugins/enterprise_search/common/version.ts
diff --git a/.../public/applications/app_search/components/engine_overview/engine_overview_empty.test.tsx b/.../public/applications/app_search/components/engine_overview/engine_overview_empty.test.tsx
@@ -8,7 +8,7 @@ import React from 'react';
 import { shallow, ShallowWrapper } from 'enzyme';
 import { EuiButton } from '@elastic/eui';
 
-import { CURRENT_MAJOR_VERSION } from '../../../../../common/version';
+import { docLinks } from '../../../shared/doc_links';
 
 import { DocumentCreationButtons, DocumentCreationFlyout } from '../document_creation';
 import { EmptyEngineOverview } from './engine_overview_empty';
@@ -24,10 +24,8 @@ describe('EmptyEngineOverview', () => {
     expect(wrapper.find('h1').text()).toEqual('Engine setup');
   });
 
-  it('renders correctly versioned documentation URLs', () => {
-    expect(wrapper.find(EuiButton).prop('href')).toEqual(
-      `https://www.elastic.co/guide/en/app-search/${CURRENT_MAJOR_VERSION}/index.html`
-    );
+  it('renders a documentation link', () => {
+    expect(wrapper.find(EuiButton).prop('href')).toEqual(`${docLinks.appSearchBase}/index.html`);
   });
 
   it('renders document creation components', () => {

diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/routes.ts b/x-pack/plugins/enterprise_search/public/applications/app_search/routes.ts
@@ -4,9 +4,9 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { CURRENT_MAJOR_VERSION } from '../../../common/version';
+import { docLinks } from '../shared/doc_links';
 
-export const DOCS_PREFIX = `https://www.elastic.co/guide/en/app-search/${CURRENT_MAJOR_VERSION}`;
+export const DOCS_PREFIX = docLinks.appSearchBase;
 
 export const ROOT_PATH = '/';
 export const SETUP_GUIDE_PATH = '/setup_guide';

diff --git a/x-pack/plugins/enterprise_search/public/applications/shared/constants/documentation_links.ts b/x-pack/plugins/enterprise_search/public/applications/shared/constants/documentation_links.ts
diff --git a/x-pack/plugins/enterprise_search/public/applications/shared/constants/index.ts b/x-pack/plugins/enterprise_search/public/applications/shared/constants/index.ts
@@ -5,4 +5,3 @@
  */
 
 export { DEFAULT_META } from './default_meta';
-export * from './documentation_links';
diff --git a/x-pack/plugins/enterprise_search/public/applications/shared/doc_links/doc_links.test.ts b/x-pack/plugins/enterprise_search/public/applications/shared/doc_links/doc_links.test.ts
@@ -0,0 +1,30 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { docLinks } from './';
+
+describe('DocLinks', () => {
+  it('setDocLinks', () => {
+    const links = {
+      DOC_LINK_VERSION: '',
+      ELASTIC_WEBSITE_URL: 'https://elastic.co/',
+      links: {
+        enterpriseSearch: {
+          base: 'http://elastic.enterprise.search',
+          appSearchBase: 'http://elastic.app.search',
+          workplaceSearchBase: 'http://elastic.workplace.search',
+        },
+      },
+    };
+
+    docLinks.setDocLinks(links as any);
+
+    expect(docLinks.enterpriseSearchBase).toEqual('http://elastic.enterprise.search');
+    expect(docLinks.appSearchBase).toEqual('http://elastic.app.search');
+    expect(docLinks.workplaceSearchBase).toEqual('http://elastic.workplace.search');
+    expect(docLinks.cloudBase).toEqual('https://elastic.co/guide/en/cloud/current');
+  });
+});
diff --git a/x-pack/plugins/enterprise_search/public/applications/shared/doc_links/doc_links.ts b/x-pack/plugins/enterprise_search/public/applications/shared/doc_links/doc_links.ts
@@ -0,0 +1,30 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { DocLinksStart } from 'kibana/public';
+
+class DocLinks {
+  public enterpriseSearchBase: string;
+  public appSearchBase: string;
+  public workplaceSearchBase: string;
+  public cloudBase: string;
+
+  constructor() {
+    this.enterpriseSearchBase = '';
+    this.appSearchBase = '';
+    this.workplaceSearchBase = '';
+    this.cloudBase = '';
+  }
+
+  public setDocLinks(docLinks: DocLinksStart): void {
+    this.enterpriseSearchBase = docLinks.links.enterpriseSearch.base;
+    this.appSearchBase = docLinks.links.enterpriseSearch.appSearchBase;
+    this.workplaceSearchBase = docLinks.links.enterpriseSearch.workplaceSearchBase;
+    this.cloudBase = `${docLinks.ELASTIC_WEBSITE_URL}guide/en/cloud/current`;
+  }
+}
+
+export const docLinks = new DocLinks();
diff --git a/x-pack/plugins/enterprise_search/public/applications/shared/doc_links/index.ts b/x-pack/plugins/enterprise_search/public/applications/shared/doc_links/index.ts
@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export { docLinks } from './doc_links';
diff --git a/...k/plugins/enterprise_search/public/applications/shared/setup_guide/cloud/instructions.tsx b/...k/plugins/enterprise_search/public/applications/shared/setup_guide/cloud/instructions.tsx
@@ -9,7 +9,7 @@ import { FormattedMessage } from '@kbn/i18n/react';
 import { i18n } from '@kbn/i18n';
 import { EuiPageContent, EuiSteps, EuiText, EuiLink, EuiCallOut } from '@elastic/eui';
 
-import { CLOUD_DOCS_PREFIX, ENT_SEARCH_DOCS_PREFIX } from '../../constants';
+import { docLinks } from '../../doc_links';
 
 interface Props {
   productName: string;
@@ -73,7 +73,7 @@ export const CloudSetupInstructions: React.FC<Props> = ({ productName, cloudDepl
                   values={{
                     optionsLink: (
                       <EuiLink
-                        href={`${ENT_SEARCH_DOCS_PREFIX}/configuration.html`}
+                        href={`${docLinks.enterpriseSearchBase}/configuration.html`}
                         target="_blank"
                       >
                         configurable options
@@ -115,7 +115,7 @@ export const CloudSetupInstructions: React.FC<Props> = ({ productName, cloudDepl
                     productName,
                     configurePolicyLink: (
                       <EuiLink
-                        href={`${CLOUD_DOCS_PREFIX}/ec-configure-index-management.html`}
+                        href={`${docLinks.cloudBase}/ec-configure-index-management.html`}
                         target="_blank"
                       >
                         configure an index lifecycle policy

diff --git a/x-pack/plugins/enterprise_search/public/applications/workplace_search/routes.ts b/x-pack/plugins/enterprise_search/public/applications/workplace_search/routes.ts
@@ -6,8 +6,7 @@
 
 import { generatePath } from 'react-router-dom';
 
-import { CURRENT_MAJOR_VERSION } from '../../../common/version';
-import { ENT_SEARCH_DOCS_PREFIX } from '../shared/constants';
+import { docLinks } from '../shared/doc_links';
 
 export const SETUP_GUIDE_PATH = '/setup_guide';
 
@@ -16,7 +15,7 @@ export const NOT_FOUND_PATH = '/404';
 export const LEAVE_FEEDBACK_EMAIL = '[email protected]';
 export const LEAVE_FEEDBACK_URL = `mailto:${LEAVE_FEEDBACK_EMAIL}?Subject=Elastic%20Workplace%20Search%20Feedback`;
 
-export const DOCS_PREFIX = `https://www.elastic.co/guide/en/workplace-search/${CURRENT_MAJOR_VERSION}`;
+export const DOCS_PREFIX = docLinks.workplaceSearchBase;
 export const DOCUMENT_PERMISSIONS_DOCS_URL = `${DOCS_PREFIX}/workplace-search-sources-document-permissions.html`;
 export const DOCUMENT_PERMISSIONS_SYNC_DOCS_URL = `${DOCUMENT_PERMISSIONS_DOCS_URL}#sources-permissions-synchronizing`;
 export const PRIVATE_SOURCES_DOCS_URL = `${DOCUMENT_PERMISSIONS_DOCS_URL}#sources-permissions-org-private`;
@@ -42,7 +41,7 @@ export const ZENDESK_DOCS_URL = `${DOCS_PREFIX}/workplace-search-zendesk-connect
 export const CUSTOM_SOURCE_DOCS_URL = `${DOCS_PREFIX}/workplace-search-custom-api-sources.html`;
 export const CUSTOM_API_DOCS_URL = `${DOCS_PREFIX}/workplace-search-custom-sources-api.html`;
 export const CUSTOM_API_DOCUMENT_PERMISSIONS_DOCS_URL = `${CUSTOM_SOURCE_DOCS_URL}#custom-api-source-document-level-access-control`;
-export const ENT_SEARCH_LICENSE_MANAGEMENT = `${ENT_SEARCH_DOCS_PREFIX}/license-management.html`;
+export const ENT_SEARCH_LICENSE_MANAGEMENT = `${docLinks.enterpriseSearchBase}/license-management.html`;
 
 export const PERSONAL_PATH = '/p';
 

diff --git a/x-pack/plugins/enterprise_search/public/plugin.ts b/x-pack/plugins/enterprise_search/public/plugin.ts
@@ -6,6 +6,7 @@
 
 import {
   AppMountParameters,
+  CoreStart,
   CoreSetup,
   HttpSetup,
   Plugin,
@@ -27,6 +28,8 @@ import {
 } from '../common/constants';
 import { InitialAppData } from '../common/types';
 
+import { docLinks } from './applications/shared/doc_links';
+
 export interface ClientConfigType {
   host?: string;
 }
@@ -153,7 +156,11 @@ export class EnterpriseSearchPlugin implements Plugin {
     }
   }
 
-  public start() {}
+  public start(core: CoreStart) {
+    // This must be called here in start() and not in `applications/index.tsx` to prevent loading
+    // race conditions with our apps' `routes.ts` being initialized before `renderApp()`
+    docLinks.setDocLinks(core.docLinks);
+  }
 
   public stop() {}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,3 @@
		*/

		export { DEFAULT_META } from './default_meta';
		export * from './documentation_links';