Expose NP FieldFormats service to server side (#55419)

* Expose NP FieldFormats service to server side * fix CI * fix PR comments * fix PR comments * fix CI * getFieldFormatsRegistry -> getFieldFormatRegistry * fix CI * memoize - add resolve cache function * fix Jest * move IFieldFormatMetaParams to types.ts * FieldFormatRegistry -> FieldFormatsRegistry * update src/core/MIGRATION.md * update public contract Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
elastic · Jan 27, 2020 · 5d6dbf0 · 5d6dbf0
1 parent 9301531
commit 5d6dbf0
Show file tree

Hide file tree

Showing 70 changed files with 525 additions and 741 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -244,15 +244,15 @@ module.exports = {
               {
                 target: [
                   '(src|x-pack)/plugins/**/*',
-                  '!(src|x-pack)/plugins/*/server/**/*',
+                  '!(src|x-pack)/plugins/**/server/**/*',
 
                   'src/legacy/core_plugins/**/*',
-                  '!src/legacy/core_plugins/*/server/**/*',
-                  '!src/legacy/core_plugins/*/index.{js,ts,tsx}',
+                  '!src/legacy/core_plugins/**/server/**/*',
+                  '!src/legacy/core_plugins/**/index.{js,ts,tsx}',
 
                   'x-pack/legacy/plugins/**/*',
-                  '!x-pack/legacy/plugins/*/server/**/*',
-                  '!x-pack/legacy/plugins/*/index.{js,ts,tsx}',
+                  '!x-pack/legacy/plugins/**/server/**/*',
+                  '!x-pack/legacy/plugins/**/index.{js,ts,tsx}',
 
                   'examples/**/*',
                   '!examples/**/server/**/*',

diff --git a/src/core/MIGRATION.md b/src/core/MIGRATION.md
@@ -1231,8 +1231,8 @@ This table shows where these uiExports have moved to in the New Platform. In mos
 | `docViews`                   |                                                                                                                           |                                                                                                                                       |
 | `embeddableActions`          |                                                                                                                           | Should be an API on the embeddables plugin.                                                                                           |
 | `embeddableFactories`        |                                                                                                                           | Should be an API on the embeddables plugin.                                                                                           |
-| `fieldFormatEditors`         |                                                                                                                           |                                                                                                                                       |
-| `fieldFormats`               |                                                                                                                           |                                                                                                                                       |
+| `fieldFormatEditors`         |                                                                                                                          |                                                                                                                                       |
+| `fieldFormats`               | [`plugins.data.fieldFormats`](./src/plugins/data/public/field_formats)                                                                                                                          |                                                                                                                                       |
 | `hacks`                      | n/a                                                                                                                       | Just run the code in your plugin's `start` method.                                                                                    |
 | `home`                       | [`plugins.home.featureCatalogue.register`](./src/plugins/home/public/feature_catalogue)                                   | Must add `home` as a dependency in your kibana.json.                                                                                  |
 | `indexManagement`            |                                                                                                                           | Should be an API on the indexManagement plugin.                                                                                       |

diff --git a/src/legacy/core_plugins/kibana/index.js b/src/legacy/core_plugins/kibana/index.js
@@ -25,7 +25,6 @@ import { migrations } from './migrations';
 import { importApi } from './server/routes/api/import';
 import { exportApi } from './server/routes/api/export';
 import { managementApi } from './server/routes/api/management';
-import { registerFieldFormats } from './server/field_formats/register';
 import * as systemApi from './server/lib/system_api';
 import mappings from './mappings.json';
 import { getUiSettingDefaults } from './ui_setting_defaults';
@@ -331,7 +330,6 @@ export default function(kibana) {
       importApi(server);
       exportApi(server);
       managementApi(server);
-      registerFieldFormats(server);
       registerCspCollector(usageCollection, server);
       server.expose('systemApi', systemApi);
       server.injectUiAppVars('kibana', () => injectVars(server));

diff --git a/src/legacy/core_plugins/vis_type_metric/public/components/metric_vis_component.tsx b/src/legacy/core_plugins/vis_type_metric/public/components/metric_vis_component.tsx
@@ -24,7 +24,7 @@ import { isColorDark } from '@elastic/eui';
 
 import { getHeatmapColors, getFormat, Vis } from '../legacy_imports';
 import { MetricVisValue } from './metric_vis_value';
-import { FieldFormat, ContentType } from '../../../../../plugins/data/public';
+import { fieldFormats } from '../../../../../plugins/data/public';
 import { Context } from '../metric_vis_fn';
 import { KibanaDatatable } from '../../../../../plugins/expressions/public';
 import { VisParams, MetricVisMetric } from '../types';
@@ -100,9 +100,9 @@ export class MetricVisComponent extends Component<MetricVisComponentProps> {
   }
 
   private getFormattedValue = (
-    fieldFormatter: FieldFormat,
+    fieldFormatter: fieldFormats.FieldFormat,
     value: any,
-    format: ContentType = 'text'
+    format: fieldFormats.ContentType = 'text'
   ) => {
     if (isNaN(value)) return '-';
     return fieldFormatter.convert(value, format);
@@ -119,7 +119,7 @@ export class MetricVisComponent extends Component<MetricVisComponentProps> {
     const metrics: MetricVisMetric[] = [];
 
     let bucketColumnId: string;
-    let bucketFormatter: FieldFormat;
+    let bucketFormatter: fieldFormats.FieldFormat;
 
     if (dimensions.bucket) {
       bucketColumnId = table.columns[dimensions.bucket.accessor].id;

diff --git a/src/legacy/core_plugins/vis_type_metric/public/metric_vis_type.test.ts b/src/legacy/core_plugins/vis_type_metric/public/metric_vis_type.test.ts
@@ -24,7 +24,7 @@ import { npStart } from 'ui/new_platform';
 import getStubIndexPattern from 'fixtures/stubbed_logstash_index_pattern';
 
 import { Vis } from '../../visualizations/public';
-import { UrlFormat } from '../../../../plugins/data/public';
+import { fieldFormats } from '../../../../plugins/data/public';
 import {
   setup as visualizationsSetup,
   start as visualizationsStart,
@@ -39,7 +39,7 @@ describe('metric_vis - createMetricVisTypeDefinition', () => {
   beforeAll(() => {
     visualizationsSetup.types.createReactVisualization(metricVisTypeDefinition);
     (npStart.plugins.data.fieldFormats.getType as jest.Mock).mockImplementation(() => {
-      return UrlFormat;
+      return fieldFormats.UrlFormat;
     });
   });
 

diff --git a/src/legacy/core_plugins/vis_type_timeseries/public/components/vis_types/table/vis.js b/src/legacy/core_plugins/vis_type_timeseries/public/components/vis_types/table/vis.js
@@ -26,7 +26,7 @@ import { calculateLabel } from '../../../../common/calculate_label';
 import { isSortable } from './is_sortable';
 import { EuiToolTip, EuiIcon } from '@elastic/eui';
 import { replaceVars } from '../../lib/replace_vars';
-import { FIELD_FORMAT_IDS } from '../../../../../../../plugins/data/public';
+import { fieldFormats } from '../../../../../../../plugins/data/public';
 import { FormattedMessage } from '@kbn/i18n/react';
 
 import { METRIC_TYPES } from '../../../../common/metric_types';
@@ -49,8 +49,8 @@ export class TableVis extends Component {
   constructor(props) {
     super(props);
 
-    const fieldFormats = npStart.plugins.data.fieldFormats;
-    const DateFormat = fieldFormats.getType(FIELD_FORMAT_IDS.DATE);
+    const fieldFormatsService = npStart.plugins.data.fieldFormats;
+    const DateFormat = fieldFormatsService.getType(fieldFormats.FIELD_FORMAT_IDS.DATE);
 
     this.dateFormatter = new DateFormat({}, this.props.getConfig);
   }

diff --git a/src/legacy/ui/field_formats/index.ts b/src/legacy/ui/field_formats/index.ts
diff --git a/src/legacy/ui/field_formats/mixin/field_formats_mixin.ts b/src/legacy/ui/field_formats/mixin/field_formats_mixin.ts
diff --git a/src/legacy/ui/field_formats/mixin/field_formats_service.test.ts b/src/legacy/ui/field_formats/mixin/field_formats_service.test.ts
diff --git a/src/legacy/ui/field_formats/mixin/field_formats_service.ts b/src/legacy/ui/field_formats/mixin/field_formats_service.ts
diff --git a/src/legacy/ui/public/agg_types/agg_config.ts b/src/legacy/ui/public/agg_types/agg_config.ts
@@ -34,9 +34,9 @@ import { AggConfigs } from './agg_configs';
 import { Schema } from '../vis/editors/default/schemas';
 import {
   ISearchSource,
-  ContentType,
-  KBN_FIELD_TYPES,
   FetchOptions,
+  fieldFormats,
+  KBN_FIELD_TYPES,
 } from '../../../../plugins/data/public';
 
 export interface AggConfigOptions {
@@ -375,7 +375,7 @@ export class AggConfig {
     return this.aggConfigs.timeRange;
   }
 
-  fieldFormatter(contentType?: ContentType, defaultFormat?: any) {
+  fieldFormatter(contentType?: fieldFormats.ContentType, defaultFormat?: any) {
     const format = this.type && this.type.getFormat(this);
 
     if (format) {
@@ -385,12 +385,12 @@ export class AggConfig {
     return this.fieldOwnFormatter(contentType, defaultFormat);
   }
 
-  fieldOwnFormatter(contentType?: ContentType, defaultFormat?: any) {
-    const fieldFormats = npStart.plugins.data.fieldFormats;
+  fieldOwnFormatter(contentType?: fieldFormats.ContentType, defaultFormat?: any) {
+    const fieldFormatsService = npStart.plugins.data.fieldFormats;
     const field = this.getField();
     let format = field && field.format;
     if (!format) format = defaultFormat;
-    if (!format) format = fieldFormats.getDefaultInstance(KBN_FIELD_TYPES.STRING);
+    if (!format) format = fieldFormatsService.getDefaultInstance(KBN_FIELD_TYPES.STRING);
     return format.getConverterFor(contentType);
   }
 

diff --git a/src/legacy/ui/public/agg_types/agg_type.ts b/src/legacy/ui/public/agg_types/agg_type.ts
@@ -27,7 +27,7 @@ import { AggConfigs } from './agg_configs';
 import { Adapters } from '../inspector';
 import { BaseParamType } from './param_types/base';
 import { AggParamType } from '../agg_types/param_types/agg';
-import { KBN_FIELD_TYPES, FieldFormat, ISearchSource } from '../../../../plugins/data/public';
+import { KBN_FIELD_TYPES, fieldFormats, ISearchSource } from '../../../../plugins/data/public';
 
 export interface AggTypeConfig<
   TAggConfig extends AggConfig = AggConfig,
@@ -54,16 +54,16 @@ export interface AggTypeConfig<
     inspectorAdapters: Adapters,
     abortSignal?: AbortSignal
   ) => Promise<any>;
-  getFormat?: (agg: TAggConfig) => FieldFormat;
+  getFormat?: (agg: TAggConfig) => fieldFormats.FieldFormat;
   getValue?: (agg: TAggConfig, bucket: any) => any;
   getKey?: (bucket: any, key: any, agg: TAggConfig) => any;
 }
 
 const getFormat = (agg: AggConfig) => {
   const field = agg.getField();
-  const fieldFormats = npStart.plugins.data.fieldFormats;
+  const fieldFormatsService = npStart.plugins.data.fieldFormats;
 
-  return field ? field.format : fieldFormats.getDefaultInstance(KBN_FIELD_TYPES.STRING);
+  return field ? field.format : fieldFormatsService.getDefaultInstance(KBN_FIELD_TYPES.STRING);
 };
 
 export class AggType<
@@ -191,7 +191,7 @@ export class AggType<
    * @param  {agg} agg - the agg to pick a format for
    * @return {FieldFormat}
    */
-  getFormat: (agg: TAggConfig) => FieldFormat;
+  getFormat: (agg: TAggConfig) => fieldFormats.FieldFormat;
 
   getValue: (agg: TAggConfig, bucket: any) => any;