[Discover] Unify definition of field names and field descriptions (#134463) (#134637)

* [Discover] Address "Don't call Hooks" React error message

* [Discover] Unify definition of field names and field descriptions

* [Discover] Bring back source message

* [Discover] Update name function

* [Discover] Revert source logic

* [Discover] Update code style

Co-authored-by: Kibana Machine <[email protected]>
(cherry picked from commit c81da02)

Co-authored-by: Julia Rechkunova <[email protected]>

Author: kibanamachine

src/plugins/discover/common/field_types.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+export enum KNOWN_FIELD_TYPES {
+  BOOLEAN = 'boolean',
+  CONFLICT = 'conflict',
+  DATE = 'date',
+  DATE_RANGE = 'date_range',
+  GEO_POINT = 'geo_point',
+  GEO_SHAPE = 'geo_shape',
+  HISTOGRAM = 'histogram',
+  IP = 'ip',
+  IP_RANGE = 'ip_range',
+  KEYWORD = 'keyword',
+  MURMUR3 = 'murmur3',
+  NUMBER = 'number',
+  NESTED = 'nested',
+  STRING = 'string',
+  TEXT = 'text',
+  VERSION = 'version',
+}

src/plugins/discover/public/application/main/components/sidebar/discover_field_search.tsx

@@ -36,6 +36,7 @@ import {
 import { FormattedMessage } from '@kbn/i18n-react';
 import { FieldIcon } from '@kbn/react-field';
 import { getFieldTypeDescription } from './lib/get_field_type_description';
+import { KNOWN_FIELD_TYPES } from '../../../../../common/field_types';
 import { useDiscoverServices } from '../../../../utils/use_discover_services';
 
 export interface State {
@@ -107,7 +108,9 @@ export function DiscoverFieldSearch({ onChange, value, types, presentFieldTypes
   const { docLinks } = useDiscoverServices();
 
   const items: FieldTypeTableItem[] = useMemo(() => {
+    const knownTypes = Object.values(KNOWN_FIELD_TYPES) as string[];
     return presentFieldTypes
+      .filter((element) => knownTypes.includes(element))
       .sort((one, another) => one.localeCompare(another))
       .map((element, index) => ({
         id: index,
@@ -122,7 +125,9 @@ export function DiscoverFieldSearch({ onChange, value, types, presentFieldTypes
   const columnsSidebar: Array<EuiBasicTableColumn<FieldTypeTableItem>> = [
     {
       field: 'dataType',
-      name: 'Data type',
+      name: i18n.translate('discover.fieldTypesPopover.dataTypeColumnTitle', {
+        defaultMessage: 'Data type',
+      }),
       width: '110px',
       render: (name: string) => (
         <EuiFlexGroup alignItems="center" responsive={false} gutterSize="xs">
@@ -135,7 +140,9 @@ export function DiscoverFieldSearch({ onChange, value, types, presentFieldTypes
     },
     {
       field: 'description',
-      name: 'Description',
+      name: i18n.translate('discover.fieldTypesPopover.descriptionColumnTitle', {
+        defaultMessage: 'Description',
+      }),
       // eslint-disable-next-line react/no-danger
       render: (description: string) => <div dangerouslySetInnerHTML={{ __html: description }} />,
     },

src/plugins/discover/public/application/main/components/sidebar/lib/get_field_type_description.ts

@@ -8,22 +8,28 @@
 
 import type { DocLinksStart } from '@kbn/core/public';
 import { i18n } from '@kbn/i18n';
+import { KNOWN_FIELD_TYPES } from '../../../../../../common/field_types';
+
+const UNKNOWN_FIELD_TYPE_DESC = i18n.translate('discover.fieldNameDescription.unknownField', {
+  defaultMessage: 'Unknown field',
+});
 
 export function getFieldTypeDescription(type: string, docLinks: DocLinksStart) {
-  switch (type) {
-    case 'boolean':
+  const knownType: KNOWN_FIELD_TYPES = type as KNOWN_FIELD_TYPES;
+  switch (knownType) {
+    case KNOWN_FIELD_TYPES.BOOLEAN:
       return i18n.translate('discover.fieldNameDescription.booleanField', {
         defaultMessage: 'True and false values.',
       });
-    case 'conflict':
+    case KNOWN_FIELD_TYPES.CONFLICT:
       return i18n.translate('discover.fieldNameDescription.conflictField', {
         defaultMessage: 'Field has values of different types. Resolve in Management > Data Views.',
       });
-    case 'date':
+    case KNOWN_FIELD_TYPES.DATE:
       return i18n.translate('discover.fieldNameDescription.dateField', {
         defaultMessage: 'A date string or the number of seconds or milliseconds since 1/1/1970.',
       });
-    case 'date_range':
+    case KNOWN_FIELD_TYPES.DATE_RANGE:
       return i18n.translate('discover.fieldNameDescription.dateRangeField', {
         defaultMessage: 'Range of {dateFieldTypeLink} values. {viewSupportedDateFormatsLink}',
         values: {
@@ -43,49 +49,52 @@ export function getFieldTypeDescription(type: string, docLinks: DocLinksStart) {
             '</a>',
         },
       });
-    case 'geo_point':
+    case KNOWN_FIELD_TYPES.GEO_POINT:
       return i18n.translate('discover.fieldNameDescription.geoPointField', {
         defaultMessage: 'Latitude and longitude points.',
       });
-    case 'geo_shape':
+    case KNOWN_FIELD_TYPES.GEO_SHAPE:
       return i18n.translate('discover.fieldNameDescription.geoShapeField', {
         defaultMessage: 'Complex shapes, such as polygons.',
       });
-    case 'ip':
+    case KNOWN_FIELD_TYPES.HISTOGRAM:
+      return i18n.translate('discover.fieldNameDescription.histogramField', {
+        defaultMessage: 'Pre-aggregated numerical values in the form of a histogram.',
+      });
+    case KNOWN_FIELD_TYPES.IP:
       return i18n.translate('discover.fieldNameDescription.ipAddressField', {
         defaultMessage: 'IPv4 and IPv6 addresses.',
       });
-    case 'ip_range':
+    case KNOWN_FIELD_TYPES.IP_RANGE:
       return i18n.translate('discover.fieldNameDescription.ipAddressRangeField', {
         defaultMessage: 'Range of ip values supporting either IPv4 or IPv6 (or mixed) addresses.',
       });
-    case 'murmur3':
+    case KNOWN_FIELD_TYPES.MURMUR3:
       return i18n.translate('discover.fieldNameDescription.murmur3Field', {
         defaultMessage: 'Field that computes and stores hashes of values.',
       });
-    case 'number':
+    case KNOWN_FIELD_TYPES.NUMBER:
       return i18n.translate('discover.fieldNameDescription.numberField', {
         defaultMessage: 'Long, integer, short, byte, double, and float values.',
       });
-    case 'string':
+    case KNOWN_FIELD_TYPES.STRING:
       return i18n.translate('discover.fieldNameDescription.stringField', {
         defaultMessage: 'Full text such as the body of an email or a product description.',
       });
-    case 'text':
+    case KNOWN_FIELD_TYPES.TEXT:
       return i18n.translate('discover.fieldNameDescription.textField', {
         defaultMessage: 'Full text such as the body of an email or a product description.',
       });
-    case 'keyword':
+    case KNOWN_FIELD_TYPES.KEYWORD:
       return i18n.translate('discover.fieldNameDescription.keywordField', {
         defaultMessage:
           'Structured content such as an ID, email address, hostname, status code, or tag.',
       });
-
-    case 'nested':
+    case KNOWN_FIELD_TYPES.NESTED:
       return i18n.translate('discover.fieldNameDescription.nestedField', {
         defaultMessage: 'JSON object that preserves the relationship between its subfields.',
       });
-    case 'version':
+    case KNOWN_FIELD_TYPES.VERSION:
       return i18n.translate('discover.fieldNameDescription.versionField', {
         defaultMessage: 'Software versions. Supports {SemanticVersioningLink} precedence rules.',
         values: {
@@ -102,8 +111,8 @@ export function getFieldTypeDescription(type: string, docLinks: DocLinksStart) {
         },
       });
     default:
-      return i18n.translate('discover.fieldNameDescription.unknownField', {
-        defaultMessage: 'Unknown field',
-      });
+      // If you see a typescript error here, that's a sign that there are missing switch cases ^^
+      const _exhaustiveCheck: never = knownType;
+      return UNKNOWN_FIELD_TYPE_DESC || _exhaustiveCheck;
   }
 }

src/plugins/discover/public/utils/get_field_type_name.test.ts

@@ -6,11 +6,8 @@
  * Side Public License, v 1.
  */
 
-import {
-  getFieldTypeName,
-  KNOWN_FIELD_TYPES,
-  UNKNOWN_FIELD_TYPE_MESSAGE,
-} from './get_field_type_name';
+import { getFieldTypeName, UNKNOWN_FIELD_TYPE_MESSAGE } from './get_field_type_name';
+import { KNOWN_FIELD_TYPES } from '../../common/field_types';
 
 describe('getFieldTypeName', () => {
   describe('known field types should be recognized', () => {
@@ -28,7 +25,11 @@ describe('getFieldTypeName', () => {
     expect(getFieldTypeName(undefined)).toBe(UNKNOWN_FIELD_TYPE_MESSAGE);
   });
 
-  it(`should return '${UNKNOWN_FIELD_TYPE_MESSAGE}' when passed an unknown field type`, () => {
-    expect(getFieldTypeName('unknown_field_type')).toBe(UNKNOWN_FIELD_TYPE_MESSAGE);
+  it(`should return '${UNKNOWN_FIELD_TYPE_MESSAGE}' when passed 'unknown'`, () => {
+    expect(getFieldTypeName('unknown')).toBe(UNKNOWN_FIELD_TYPE_MESSAGE);
+  });
+
+  it('should return the original type string back when passed an unknown field type', () => {
+    expect(getFieldTypeName('unknown_field_type')).toBe('unknown_field_type');
   });
 });

src/plugins/discover/public/utils/get_field_type_name.ts

@@ -7,24 +7,8 @@
  */
 
 import { i18n } from '@kbn/i18n';
-import { KBN_FIELD_TYPES, ES_FIELD_TYPES } from '@kbn/data-plugin/public';
-
-export const KNOWN_FIELD_TYPES = {
-  BOOLEAN: KBN_FIELD_TYPES.BOOLEAN,
-  CONFLICT: KBN_FIELD_TYPES.CONFLICT,
-  DATE: KBN_FIELD_TYPES.DATE,
-  GEO_POINT: KBN_FIELD_TYPES.GEO_POINT,
-  GEO_SHAPE: KBN_FIELD_TYPES.GEO_SHAPE,
-  IP: KBN_FIELD_TYPES.IP,
-  KEYWORD: ES_FIELD_TYPES.KEYWORD,
-  MURMUR3: KBN_FIELD_TYPES.MURMUR3,
-  NUMBER: KBN_FIELD_TYPES.NUMBER,
-  NESTED: KBN_FIELD_TYPES.NESTED,
-  SOURCE: 'source',
-  STRING: KBN_FIELD_TYPES.STRING,
-  TEXT: ES_FIELD_TYPES.TEXT,
-  VERSION: ES_FIELD_TYPES.VERSION,
-};
+import { KBN_FIELD_TYPES } from '@kbn/data-plugin/public';
+import { KNOWN_FIELD_TYPES } from '../../common/field_types';
 
 export const UNKNOWN_FIELD_TYPE_MESSAGE = i18n.translate(
   'discover.fieldNameIcons.unknownFieldAriaLabel',
@@ -34,7 +18,21 @@ export const UNKNOWN_FIELD_TYPE_MESSAGE = i18n.translate(
 );
 
 export function getFieldTypeName(type?: string) {
-  switch (type) {
+  if (!type || type === KBN_FIELD_TYPES.UNKNOWN) {
+    return UNKNOWN_FIELD_TYPE_MESSAGE;
+  }
+
+  if (type === 'source') {
+    // TODO: check if we can remove this logic as outdated
+
+    // Note that this type is currently not provided, type for _source is undefined
+    return i18n.translate('discover.fieldNameIcons.sourceFieldAriaLabel', {
+      defaultMessage: 'Source field',
+    });
+  }
+
+  const knownType: KNOWN_FIELD_TYPES = type as KNOWN_FIELD_TYPES;
+  switch (knownType) {
     case KNOWN_FIELD_TYPES.BOOLEAN:
       return i18n.translate('discover.fieldNameIcons.booleanAriaLabel', {
         defaultMessage: 'Boolean field',
@@ -47,6 +45,10 @@ export function getFieldTypeName(type?: string) {
       return i18n.translate('discover.fieldNameIcons.dateFieldAriaLabel', {
         defaultMessage: 'Date field',
       });
+    case KNOWN_FIELD_TYPES.DATE_RANGE:
+      return i18n.translate('discover.fieldNameIcons.dateRangeFieldAriaLabel', {
+        defaultMessage: 'Date range field',
+      });
     case KNOWN_FIELD_TYPES.GEO_POINT:
       return i18n.translate('discover.fieldNameIcons.geoPointFieldAriaLabel', {
         defaultMessage: 'Geo point field',
@@ -55,10 +57,18 @@ export function getFieldTypeName(type?: string) {
       return i18n.translate('discover.fieldNameIcons.geoShapeFieldAriaLabel', {
         defaultMessage: 'Geo shape field',
       });
+    case KNOWN_FIELD_TYPES.HISTOGRAM:
+      return i18n.translate('discover.fieldNameIcons.histogramFieldAriaLabel', {
+        defaultMessage: 'Histogram field',
+      });
     case KNOWN_FIELD_TYPES.IP:
       return i18n.translate('discover.fieldNameIcons.ipAddressFieldAriaLabel', {
         defaultMessage: 'IP address field',
       });
+    case KNOWN_FIELD_TYPES.IP_RANGE:
+      return i18n.translate('discover.fieldNameIcons.ipRangeFieldAriaLabel', {
+        defaultMessage: 'IP range field',
+      });
     case KNOWN_FIELD_TYPES.MURMUR3:
       return i18n.translate('discover.fieldNameIcons.murmur3FieldAriaLabel', {
         defaultMessage: 'Murmur3 field',
@@ -67,11 +77,6 @@ export function getFieldTypeName(type?: string) {
       return i18n.translate('discover.fieldNameIcons.numberFieldAriaLabel', {
         defaultMessage: 'Number field',
       });
-    case KNOWN_FIELD_TYPES.SOURCE:
-      // Note that this type is currently not provided, type for _source is undefined
-      return i18n.translate('discover.fieldNameIcons.sourceFieldAriaLabel', {
-        defaultMessage: 'Source field',
-      });
     case KNOWN_FIELD_TYPES.STRING:
       return i18n.translate('discover.fieldNameIcons.stringFieldAriaLabel', {
         defaultMessage: 'String field',
@@ -93,6 +98,8 @@ export function getFieldTypeName(type?: string) {
         defaultMessage: 'Version field',
       });
     default:
-      return UNKNOWN_FIELD_TYPE_MESSAGE;
+      // If you see a typescript error here, that's a sign that there are missing switch cases ^^
+      const _exhaustiveCheck: never = knownType;
+      return knownType || _exhaustiveCheck;
   }
 }