Fix links to the numeral formatting in the index pattern field settin…

…gs (elastic#84167)
dokmic · Mar 17, 2021 · 28d4fb1 · 28d4fb1
1 parent 9073407
commit 28d4fb1
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 3 deletions.
diff --git a/src/core/public/doc_links/doc_links_service.ts b/src/core/public/doc_links/doc_links_service.ts
@@ -122,6 +122,7 @@ export class DocLinksService {
         indexPatterns: {
           loadingData: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/tutorial-load-dataset.html`,
           introduction: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/index-patterns.html`,
+          fieldFormattersNumber: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/numeral.html`,
           fieldFormattersString: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/field-formatters-string.html`,
         },
         addData: `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/connect-to-elasticsearch.html`,
@@ -392,6 +393,8 @@ export interface DocLinksStart {
     readonly indexPatterns: {
       readonly loadingData: string;
       readonly introduction: string;
+      readonly fieldFormattersNumber: string;
+      readonly fieldFormattersString: string;
     };
     readonly addData: string;
     readonly kibana: string;

diff --git a/...r/public/components/field_format_editor/editors/number/__snapshots__/number.test.tsx.snap b/...r/public/components/field_format_editor/editors/number/__snapshots__/number.test.tsx.snap
diff --git a/...pattern_field_editor/public/components/field_format_editor/editors/number/number.test.tsx b/...pattern_field_editor/public/components/field_format_editor/editors/number/number.test.tsx
@@ -8,10 +8,14 @@
 
 import React from 'react';
 import { shallow } from 'enzyme';
+import { coreMock } from 'src/core/public/mocks';
+import { createKibanaReactContext } from '../../../../../../kibana_react/public';
 import { FieldFormat } from 'src/plugins/data/public';
 
 import { NumberFormatEditor } from './number';
 
+type NumberFormatEditorProps = React.ComponentProps<typeof NumberFormatEditor>;
+
 const fieldType = 'number';
 const format = {
   getConverterFor: jest.fn().mockImplementation(() => (input: number) => input * 2),
@@ -25,7 +29,19 @@ const formatParams = {
 const onChange = jest.fn();
 const onError = jest.fn();
 
+const KibanaReactContext = createKibanaReactContext(
+  coreMock.createStart({ basePath: 'my-base-path' })
+);
+
 describe('NumberFormatEditor', () => {
+  beforeAll(() => {
+    // @see https://github.com/airbnb/enzyme/issues/1553
+    (NumberFormatEditor as React.ComponentType<NumberFormatEditorProps>).contextTypes = {
+      services: () => null,
+    };
+    delete (NumberFormatEditor as Partial<typeof NumberFormatEditor>).contextType;
+  });
+
   it('should have a formatId', () => {
     expect(NumberFormatEditor.formatId).toEqual('number');
   });
@@ -38,7 +54,8 @@ describe('NumberFormatEditor', () => {
         formatParams={formatParams}
         onChange={onChange}
         onError={onError}
-      />
+      />,
+      { context: KibanaReactContext.value }
     );
     expect(component).toMatchSnapshot();
   });

diff --git a/...ndex_pattern_field_editor/public/components/field_format_editor/editors/number/number.tsx b/...ndex_pattern_field_editor/public/components/field_format_editor/editors/number/number.tsx
@@ -15,12 +15,17 @@ import { DefaultFormatEditor, defaultState } from '../default';
 
 import { FormatEditorSamples } from '../../samples';
 
+import { context as contextType } from '../../../../../../kibana_react/public';
+
 export interface NumberFormatEditorParams {
   pattern: string;
 }
 
 export class NumberFormatEditor extends DefaultFormatEditor<NumberFormatEditorParams> {
+  static contextType = contextType;
   static formatId = 'number';
+
+  context!: React.ContextType<typeof contextType>;
   state = {
     ...defaultState,
     sampleInputs: [10000, 12.345678, -1, -999, 0.52],
@@ -43,7 +48,10 @@ export class NumberFormatEditor extends DefaultFormatEditor<NumberFormatEditorPa
           }
           helpText={
             <span>
-              <EuiLink target="_blank" href="https://adamwdraper.github.io/Numeral-js/">
+              <EuiLink
+                target="_blank"
+                href={this.context.services.docLinks?.links.indexPatterns.fieldFormattersNumber}
+              >
                 <FormattedMessage
                   id="indexPatternFieldEditor.number.documentationLabel"
                   defaultMessage="Documentation"