Fix links to the numeral formatting (#94858)

* Fix links to the numeral formatting in the advanced settings (#84167) * Fix a link to the numeral formatting in the index pattern field settings (#84167)
elastic · Mar 18, 2021 · e9568ce · e9568ce
1 parent 1060f8f
commit e9568ce
Show file tree

Hide file tree

Showing 12 changed files with 83 additions and 14 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
@@ -100,6 +100,8 @@ readonly links: {
         };
         readonly indexPatterns: {
             readonly introduction: string;
+            readonly fieldFormattersNumber: string;
+            readonly fieldFormattersString: string;
         };
         readonly addData: string;
         readonly kibana: 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
@@ -122,6 +122,7 @@ export class DocLinksService {
         },
         indexPatterns: {
           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`,
@@ -391,6 +392,8 @@ export interface DocLinksStart {
     };
     readonly indexPatterns: {
       readonly introduction: string;
+      readonly fieldFormattersNumber: string;
+      readonly fieldFormattersString: string;
     };
     readonly addData: string;
     readonly kibana: string;

diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
@@ -571,6 +571,8 @@ export interface DocLinksStart {
         };
         readonly indexPatterns: {
             readonly introduction: string;
+            readonly fieldFormattersNumber: string;
+            readonly fieldFormattersString: string;
         };
         readonly addData: string;
         readonly kibana: string;

diff --git a/src/plugins/data/server/ui_settings.ts b/src/plugins/data/server/ui_settings.ts
@@ -417,7 +417,7 @@ export function getUiSettings(): Record<string, UiSettingsParams<unknown>> {
           'data.advancedSettings.format.numberFormat.numeralFormatLinkText',
         values: {
           numeralFormatLink:
-            '<a href="http://numeraljs.com/" target="_blank" rel="noopener noreferrer">' +
+            '<a href="https://www.elastic.co/guide/en/kibana/current/numeral.html" target="_blank" rel="noopener">' +
             i18n.translate('data.advancedSettings.format.numberFormat.numeralFormatLinkText', {
               defaultMessage: 'numeral format',
             }) +
@@ -439,7 +439,7 @@ export function getUiSettings(): Record<string, UiSettingsParams<unknown>> {
           'data.advancedSettings.format.percentFormat.numeralFormatLinkText',
         values: {
           numeralFormatLink:
-            '<a href="http://numeraljs.com/" target="_blank" rel="noopener noreferrer">' +
+            '<a href="https://www.elastic.co/guide/en/kibana/current/numeral.html" target="_blank" rel="noopener">' +
             i18n.translate('data.advancedSettings.format.percentFormat.numeralFormatLinkText', {
               defaultMessage: 'numeral format',
             }) +
@@ -461,7 +461,7 @@ export function getUiSettings(): Record<string, UiSettingsParams<unknown>> {
           'data.advancedSettings.format.bytesFormat.numeralFormatLinkText',
         values: {
           numeralFormatLink:
-            '<a href="http://numeraljs.com/" target="_blank" rel="noopener noreferrer">' +
+            '<a href="https://www.elastic.co/guide/en/kibana/current/numeral.html" target="_blank" rel="noopener">' +
             i18n.translate('data.advancedSettings.format.bytesFormat.numeralFormatLinkText', {
               defaultMessage: 'numeral format',
             }) +
@@ -483,7 +483,7 @@ export function getUiSettings(): Record<string, UiSettingsParams<unknown>> {
           'data.advancedSettings.format.currencyFormat.numeralFormatLinkText',
         values: {
           numeralFormatLink:
-            '<a href="http://numeraljs.com/" target="_blank" rel="noopener noreferrer">' +
+            '<a href="https://www.elastic.co/guide/en/kibana/current/numeral.html" target="_blank" rel="noopener">' +
             i18n.translate('data.advancedSettings.format.currencyFormat.numeralFormatLinkText', {
               defaultMessage: 'numeral format',
             }) +
@@ -509,7 +509,7 @@ export function getUiSettings(): Record<string, UiSettingsParams<unknown>> {
           'data.advancedSettings.format.formattingLocaleText',
         values: {
           numeralLanguageLink:
-            '<a href="http://numeraljs.com/" target="_blank" rel="noopener noreferrer">' +
+            '<a href="https://www.elastic.co/guide/en/kibana/current/numeral.html" target="_blank" rel="noopener">' +
             i18n.translate(
               'data.advancedSettings.format.formattingLocale.numeralLanguageLinkText',
               {

diff --git a/...tor/public/components/field_format_editor/editors/bytes/__snapshots__/bytes.test.tsx.snap b/...tor/public/components/field_format_editor/editors/bytes/__snapshots__/bytes.test.tsx.snap
diff --git a/...x_pattern_field_editor/public/components/field_format_editor/editors/bytes/bytes.test.tsx b/...x_pattern_field_editor/public/components/field_format_editor/editors/bytes/bytes.test.tsx
@@ -8,9 +8,13 @@
 
 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 { BytesFormatEditor } from './bytes';
-import { FieldFormat } from 'src/plugins/data/public';
+
+type BytesFormatEditorProps = React.ComponentProps<typeof BytesFormatEditor>;
 
 const fieldType = 'number';
 const format = {
@@ -25,7 +29,20 @@ const formatParams = {
 const onChange = jest.fn();
 const onError = jest.fn();
 
+const KibanaReactContext = createKibanaReactContext(
+  coreMock.createStart({ basePath: 'my-base-path' })
+);
+
 describe('BytesFormatEditor', () => {
+  beforeAll(() => {
+    // Enzyme does not support the new Context API in shallow rendering.
+    // @see https://github.com/enzymejs/enzyme/issues/2189
+    (BytesFormatEditor as React.ComponentType<BytesFormatEditorProps>).contextTypes = {
+      services: () => null,
+    };
+    delete (BytesFormatEditor as Partial<typeof BytesFormatEditor>).contextType;
+  });
+
   it('should have a formatId', () => {
     expect(BytesFormatEditor.formatId).toEqual('bytes');
   });
@@ -38,7 +55,8 @@ describe('BytesFormatEditor', () => {
         formatParams={formatParams}
         onChange={onChange}
         onError={onError}
-      />
+      />,
+      { context: KibanaReactContext.value }
     );
     expect(component).toMatchSnapshot();
   });

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,20 @@ const formatParams = {
 const onChange = jest.fn();
 const onError = jest.fn();
 
+const KibanaReactContext = createKibanaReactContext(
+  coreMock.createStart({ basePath: 'my-base-path' })
+);
+
 describe('NumberFormatEditor', () => {
+  beforeAll(() => {
+    // Enzyme does not support the new Context API in shallow rendering.
+    // @see https://github.com/enzymejs/enzyme/issues/2189
+    (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 +55,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"

diff --git a/...public/components/field_format_editor/editors/percent/__snapshots__/percent.test.tsx.snap b/...public/components/field_format_editor/editors/percent/__snapshots__/percent.test.tsx.snap
diff --git a/...ttern_field_editor/public/components/field_format_editor/editors/percent/percent.test.tsx b/...ttern_field_editor/public/components/field_format_editor/editors/percent/percent.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 { PercentFormatEditor } from './percent';
 
+type PercentFormatEditorProps = React.ComponentProps<typeof PercentFormatEditor>;
+
 const fieldType = 'number';
 const format = {
   getConverterFor: jest.fn().mockImplementation(() => (input: number) => input * 2),
@@ -25,7 +29,20 @@ const formatParams = {
 const onChange = jest.fn();
 const onError = jest.fn();
 
+const KibanaReactContext = createKibanaReactContext(
+  coreMock.createStart({ basePath: 'my-base-path' })
+);
+
 describe('PercentFormatEditor', () => {
+  beforeAll(() => {
+    // Enzyme does not support the new Context API in shallow rendering.
+    // @see https://github.com/enzymejs/enzyme/issues/2189
+    (PercentFormatEditor as React.ComponentType<PercentFormatEditorProps>).contextTypes = {
+      services: () => null,
+    };
+    delete (PercentFormatEditor as Partial<typeof PercentFormatEditor>).contextType;
+  });
+
   it('should have a formatId', () => {
     expect(PercentFormatEditor.formatId).toEqual('percent');
   });
@@ -38,7 +55,8 @@ describe('PercentFormatEditor', () => {
         formatParams={formatParams}
         onChange={onChange}
         onError={onError}
-      />
+      />,
+      { context: KibanaReactContext.value }
     );
     expect(component).toMatchSnapshot();
   });