[FieldFormats] fix register on start contract (#106828)

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.fieldformatsstart.md

@@ -8,7 +8,7 @@
 <b>Signature:</b>
 
 ```typescript
-export declare type FieldFormatsStart = Omit<FieldFormatsRegistry, 'init' & 'register'> & {
+export declare type FieldFormatsStart = Omit<FieldFormatsRegistry, 'init' | 'register'> & {
     deserialize: FormatFactory;
 };
 ```

src/plugins/data/common/field_formats/field_formats_registry.test.ts

@@ -76,6 +76,27 @@ describe('FieldFormatsRegistry', () => {
       expect(registeredFieldFormatters.get(StringFormat.id)).toBe(StringFormat);
       expect(registeredFieldFormatters.get(PercentFormat.id)).toBeUndefined();
     });
+
+    test('should throw if registering a formatter with existing id ', () => {
+      fieldFormatsRegistry.register([BoolFormat]);
+
+      expect(() => fieldFormatsRegistry.register([BoolFormat])).toThrowErrorMatchingInlineSnapshot(
+        `"Failed to register field format with id \\"boolean\\" as it already has been registered"`
+      );
+    });
+  });
+
+  describe('has', () => {
+    test('should provide an public "has" method', () => {
+      expect(fieldFormatsRegistry.has).toBeDefined();
+      expect(typeof fieldFormatsRegistry.has).toBe('function');
+    });
+
+    test('should check if field format registered', () => {
+      fieldFormatsRegistry.register([StringFormat]);
+      expect(fieldFormatsRegistry.has(StringFormat.id)).toBe(true);
+      expect(fieldFormatsRegistry.has(BoolFormat.id)).toBe(false);
+    });
   });
 
   describe('getType', () => {

src/plugins/data/common/field_formats/field_formats_registry.ts

@@ -253,7 +253,21 @@ export class FieldFormatsRegistry {
   }
 
   register(fieldFormats: FieldFormatInstanceType[]) {
-    fieldFormats.forEach((fieldFormat) => this.fieldFormats.set(fieldFormat.id, fieldFormat));
+    fieldFormats.forEach((fieldFormat) => {
+      if (this.fieldFormats.has(fieldFormat.id))
+        throw new Error(
+          `Failed to register field format with id "${fieldFormat.id}" as it already has been registered`
+        );
+      this.fieldFormats.set(fieldFormat.id, fieldFormat);
+    });
+  }
+
+  /**
+   * Checks if field format with id already registered
+   * @param id
+   */
+  has(id: string): boolean {
+    return this.fieldFormats.has(id);
   }
 
   /**

src/plugins/data/common/field_formats/mocks.ts

@@ -25,6 +25,7 @@ export const fieldFormatsMock: IFieldFormatsRegistry = {
   getTypeNameByEsTypes: jest.fn(),
   init: jest.fn(),
   register: jest.fn(),
+  has: jest.fn(),
   parseDefaultTypeMap: jest.fn(),
   deserialize: jest.fn().mockImplementation(() => {
     const DefaultFieldFormat = FieldFormat.from(identity);

src/plugins/data/common/field_formats/types.ts

@@ -94,4 +94,4 @@ export interface IFieldFormatMetaParams {
   };
 }
 
-export type FieldFormatsStartCommon = Omit<FieldFormatsRegistry, 'init' & 'register'>;
+export type FieldFormatsStartCommon = Omit<FieldFormatsRegistry, 'init' | 'register'>;

src/plugins/data/public/field_formats/field_formats_service.ts

@@ -49,9 +49,9 @@ export class FieldFormatsService {
 }
 
 /** @public */
-export type FieldFormatsSetup = Pick<FieldFormatsRegistry, 'register'>;
+export type FieldFormatsSetup = Pick<FieldFormatsRegistry, 'register' | 'has'>;
 
 /** @public */
-export type FieldFormatsStart = Omit<FieldFormatsRegistry, 'init' & 'register'> & {
+export type FieldFormatsStart = Omit<FieldFormatsRegistry, 'init' | 'register'> & {
   deserialize: FormatFactory;
 };

src/plugins/data/public/public.api.md

@@ -1077,7 +1077,7 @@ export type FieldFormatsContentType = 'html' | 'text';
 export type FieldFormatsGetConfigFn = GetConfigFn;
 
 // @public (undocumented)
-export type FieldFormatsStart = Omit<FieldFormatsRegistry, 'init' & 'register'> & {
+export type FieldFormatsStart = Omit<FieldFormatsRegistry, 'init' | 'register'> & {
     deserialize: FormatFactory;
 };
 

x-pack/plugins/lens/public/indexpattern_datasource/index.ts

@@ -35,7 +35,7 @@ export class IndexPatternDatasource {
 
   setup(
     core: CoreSetup<IndexPatternDatasourceStartPlugins>,
-    { expressions, editorFrame, charts }: IndexPatternDatasourceSetupPlugins
+    { expressions, editorFrame, charts, data: dataSetup }: IndexPatternDatasourceSetupPlugins
   ) {
     editorFrame.registerDatasource(async () => {
       const {
@@ -48,8 +48,11 @@ export class IndexPatternDatasource {
       } = await import('../async_services');
       return core
         .getStartServices()
-        .then(([coreStart, { data, indexPatternFieldEditor, uiActions }]) => {
-          data.fieldFormats.register([getSuffixFormatter(data.fieldFormats.deserialize)]);
+        .then(([coreStart, { indexPatternFieldEditor, uiActions, data }]) => {
+          const suffixFormatter = getSuffixFormatter(data.fieldFormats.deserialize);
+          if (!dataSetup.fieldFormats.has(suffixFormatter.id)) {
+            dataSetup.fieldFormats.register([suffixFormatter]);
+          }
           expressions.registerFunction(timeScale);
           expressions.registerFunction(counterRate);
           expressions.registerFunction(renameColumns);