Use documentation link service for runtime fields (elastic#95256)

lcawl · Mar 26, 2021 · 8cc7ef0 · 8cc7ef0
1 parent 394d674
commit 8cc7ef0
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 20 deletions.
diff --git a/docs/development/core/public/kibana-plugin-core-public.doclinksstart.links.md b/docs/development/core/public/kibana-plugin-core-public.doclinksstart.links.md
@@ -87,7 +87,9 @@ readonly links: {
             readonly sum: string;
             readonly top_hits: string;
         };
-        readonly runtimeFields: string;
+        readonly runtimeFields: {
+            readonly mapping: string;
+        };
         readonly scriptedFields: {
             readonly scriptFields: string;
             readonly scriptAggs: string;

diff --git a/docs/development/core/public/kibana-plugin-core-public.doclinksstart.md b/docs/development/core/public/kibana-plugin-core-public.doclinksstart.md
diff --git a/src/core/public/doc_links/doc_links_service.ts b/src/core/public/doc_links/doc_links_service.ts
@@ -108,7 +108,9 @@ export class DocLinksService {
           sum: `${ELASTICSEARCH_DOCS}search-aggregations-metrics-sum-aggregation.html`,
           top_hits: `${ELASTICSEARCH_DOCS}search-aggregations-metrics-top-hits-aggregation.html`,
         },
-        runtimeFields: `${ELASTICSEARCH_DOCS}runtime.html`,
+        runtimeFields: {
+          mapping: `${ELASTICSEARCH_DOCS}runtime-mapping-fields.html`,
+        },
         scriptedFields: {
           scriptFields: `${ELASTICSEARCH_DOCS}search-request-script-fields.html`,
           scriptAggs: `${ELASTICSEARCH_DOCS}search-aggregations.html`,
@@ -381,7 +383,9 @@ export interface DocLinksStart {
       readonly sum: string;
       readonly top_hits: string;
     };
-    readonly runtimeFields: string;
+    readonly runtimeFields: {
+      readonly mapping: string;
+    };
     readonly scriptedFields: {
       readonly scriptFields: string;
       readonly scriptAggs: string;

diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
@@ -559,7 +559,9 @@ export interface DocLinksStart {
             readonly sum: string;
             readonly top_hits: string;
         };
-        readonly runtimeFields: string;
+        readonly runtimeFields: {
+            readonly mapping: string;
+        };
         readonly scriptedFields: {
             readonly scriptFields: string;
             readonly scriptAggs: string;

diff --git a/...tion/components/mappings_editor/__jest__/client_integration/helpers/setup_environment.tsx b/...tion/components/mappings_editor/__jest__/client_integration/helpers/setup_environment.tsx
@@ -7,7 +7,10 @@
 
 import React from 'react';
 import { GlobalFlyout } from '../../../../../../../../../../src/plugins/es_ui_shared/public';
-import { uiSettingsServiceMock } from '../../../../../../../../../../src/core/public/mocks';
+import {
+  docLinksServiceMock,
+  uiSettingsServiceMock,
+} from '../../../../../../../../../../src/core/public/mocks';
 import { MappingsEditorProvider } from '../../../mappings_editor_context';
 import { createKibanaReactContext } from '../../../shared_imports';
 
@@ -80,10 +83,7 @@ const { Provider: KibanaReactContextProvider } = createKibanaReactContext({
 });
 
 const defaultProps = {
-  docLinks: {
-    DOC_LINK_VERSION: 'master',
-    ELASTIC_WEBSITE_URL: 'https://jest.elastic.co',
-  },
+  docLinks: docLinksServiceMock.createStartContract(),
 };
 
 export const WithAppDependencies = (Comp: any) => (props: any) => (

diff --git a/...ugins/runtime_fields/public/components/runtime_field_editor/runtime_field_editor.test.tsx b/...ugins/runtime_fields/public/components/runtime_field_editor/runtime_field_editor.test.tsx
@@ -24,7 +24,10 @@ const setup = (props?: Props) =>
 const docLinks: DocLinksStart = {
   ELASTIC_WEBSITE_URL: 'https://jestTest.elastic.co',
   DOC_LINK_VERSION: 'jest',
-  links: {} as any,
+  links: {
+    runtimeFields: { mapping: 'https://jestTest.elastic.co/to-be-defined.html' },
+    scriptedFields: {} as any,
+  } as any,
 };
 
 describe('Runtime field editor', () => {

diff --git a/...mponents/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.test.tsx b/...mponents/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.test.tsx
@@ -23,7 +23,10 @@ const setup = (props?: Props) =>
 const docLinks: DocLinksStart = {
   ELASTIC_WEBSITE_URL: 'htts://jestTest.elastic.co',
   DOC_LINK_VERSION: 'jest',
-  links: {} as any,
+  links: {
+    runtimeFields: { mapping: 'https://jestTest.elastic.co/to-be-defined.html' },
+    scriptedFields: {} as any,
+  } as any,
 };
 
 const noop = () => {};

diff --git a/x-pack/plugins/runtime_fields/public/lib/documentation.ts b/x-pack/plugins/runtime_fields/public/lib/documentation.ts
@@ -7,14 +7,11 @@
 
 import { DocLinksStart } from 'src/core/public';
 
-export const getLinks = (docLinks: DocLinksStart) => {
-  const { DOC_LINK_VERSION, ELASTIC_WEBSITE_URL } = docLinks;
-  const docsBase = `${ELASTIC_WEBSITE_URL}guide/en`;
-  const esDocsBase = `${docsBase}/elasticsearch/reference/${DOC_LINK_VERSION}`;
-  const painlessDocsBase = `${docsBase}/elasticsearch/painless/${DOC_LINK_VERSION}`;
-
+export const getLinks = ({ links }: DocLinksStart) => {
+  const runtimePainless = `${links.runtimeFields.mapping}`;
+  const painlessSyntax = `${links.scriptedFields.painlessLangSpec}`;
   return {
-    runtimePainless: `${esDocsBase}/runtime.html#runtime-mapping-fields`,
-    painlessSyntax: `${painlessDocsBase}/painless-lang-spec.html`,
+    runtimePainless,
+    painlessSyntax,
   };
 };