[TSVB] Disable runtime fields showing up in TSVB (#90163)

* [TSVB] Disable runtime fields showing up in TSVB * add tests Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
elastic · Feb 4, 2021 · b413d9d · b413d9d
1 parent df4eb0f
commit b413d9d
Show file tree

Hide file tree

Showing 2 changed files with 79 additions and 10 deletions.
diff --git a/..._type_timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts b/..._type_timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.test.ts
@@ -7,9 +7,14 @@
  */
 
 import { from } from 'rxjs';
-import { AbstractSearchStrategy, ReqFacade } from './abstract_search_strategy';
+import {
+  AbstractSearchStrategy,
+  ReqFacade,
+  toSanitizedFieldType,
+} from './abstract_search_strategy';
 import type { VisPayload } from '../../../../common/types';
 import type { IFieldType } from '../../../../../data/common';
+import type { FieldSpec, RuntimeField } from '../../../../../data/common';
 
 class FooSearchStrategy extends AbstractSearchStrategy {}
 
@@ -91,4 +96,66 @@ describe('AbstractSearchStrategy', () => {
       }
     );
   });
+
+  describe('toSanitizedFieldType', () => {
+    const mockedField = {
+      lang: 'lang',
+      conflictDescriptions: {},
+      aggregatable: true,
+      name: 'name',
+      type: 'type',
+      esTypes: ['long', 'geo'],
+    } as FieldSpec;
+
+    test('should sanitize fields ', async () => {
+      const fields = [mockedField] as FieldSpec[];
+
+      expect(toSanitizedFieldType(fields)).toMatchInlineSnapshot(`
+        Array [
+          Object {
+            "label": "name",
+            "name": "name",
+            "type": "type",
+          },
+        ]
+      `);
+    });
+
+    test('should filter runtime fields', async () => {
+      const fields: FieldSpec[] = [
+        {
+          ...mockedField,
+          runtimeField: {} as RuntimeField,
+        },
+      ];
+
+      expect(toSanitizedFieldType(fields)).toMatchInlineSnapshot(`Array []`);
+    });
+
+    test('should filter non-aggregatable fields', async () => {
+      const fields: FieldSpec[] = [
+        {
+          ...mockedField,
+          aggregatable: false,
+        },
+      ];
+
+      expect(toSanitizedFieldType(fields)).toMatchInlineSnapshot(`Array []`);
+    });
+
+    test('should filter nested fields', async () => {
+      const fields: FieldSpec[] = [
+        {
+          ...mockedField,
+          subType: {
+            nested: {
+              path: 'path',
+            },
+          },
+        },
+      ];
+
+      expect(toSanitizedFieldType(fields)).toMatchInlineSnapshot(`Array []`);
+    });
+  });
 });
diff --git a/...s/vis_type_timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts b/...s/vis_type_timeseries/server/lib/search_strategies/strategies/abstract_search_strategy.ts
@@ -8,13 +8,11 @@
 
 import type { FakeRequest, IUiSettingsClient, SavedObjectsClientContract } from 'kibana/server';
 
-import { indexPatterns } from '../../../../../data/server';
+import { indexPatterns, IndexPatternsFetcher } from '../../../../../data/server';
 
 import type { Framework } from '../../../plugin';
-import type { IndexPatternsFetcher, IFieldType } from '../../../../../data/server';
-import type { VisPayload } from '../../../../common/types';
-import type { IndexPatternsService } from '../../../../../data/common';
-import type { SanitizedFieldType } from '../../../../common/types';
+import type { FieldSpec, IndexPatternsService } from '../../../../../data/common';
+import type { VisPayload, SanitizedFieldType } from '../../../../common/types';
 import type { VisTypeTimeseriesRequestHandlerContext } from '../../../types';
 
 /**
@@ -36,11 +34,15 @@ export interface ReqFacade<T = unknown> extends FakeRequest {
   getIndexPatternsService: () => Promise<IndexPatternsService>;
 }
 
-const toSanitizedFieldType = (fields: IFieldType[]) => {
+export const toSanitizedFieldType = (fields: FieldSpec[]) => {
   return fields
-    .filter((field) => field.aggregatable && !indexPatterns.isNestedField(field))
+    .filter(
+      (field) =>
+        // Make sure to only include mapped fields, e.g. no index pattern runtime fields
+        !field.runtimeField && field.aggregatable && !indexPatterns.isNestedField(field)
+    )
     .map(
-      (field: IFieldType) =>
+      (field) =>
         ({
           name: field.name,
           label: field.customLabel ?? field.name,
@@ -95,7 +97,7 @@ export abstract class AbstractSearchStrategy {
 
     return toSanitizedFieldType(
       kibanaIndexPattern
-        ? kibanaIndexPattern.fields.getAll()
+        ? kibanaIndexPattern.getNonScriptedFields()
         : await indexPatternsFetcher!.getFieldsForWildcard({
             pattern: indexPattern,
             fieldCapsOptions: { allow_no_indices: true },