[index patterns] [skip-ci] Index pattern “pattern list” support

src/plugins/data/common/index_patterns/index_pattern.stub.ts

@@ -9,17 +9,29 @@
 import { IIndexPattern } from '.';
 import { stubFields } from './field.stub';
 
+export const mockPatternLists = {
+  patternListActive: ['auditbeat-*', 'filebeat-*', 'packetbeat-*', 'winlogbeat-*'],
+  patternList: [
+    'apm-*-transaction*',
+    'auditbeat-*',
+    'endgame-*',
+    'filebeat-*',
+    'packetbeat-*',
+    'winlogbeat-*',
+  ],
+};
 export const stubIndexPattern: IIndexPattern = {
   id: 'logstash-*',
   fields: stubFields,
   title: 'logstash-*',
+  ...mockPatternLists,
   timeFieldName: '@timestamp',
   getTimeField: () => ({ name: '@timestamp', type: 'date' }),
 };
-
 export const stubIndexPatternWithFields: IIndexPattern = {
   id: '1234',
   title: 'logstash-*',
+  ...mockPatternLists,
   fields: [
     {
       name: 'response',

src/plugins/data/common/index_patterns/index_patterns/fixtures/stubbed_saved_object_index_pattern.ts

@@ -11,6 +11,18 @@ import stubbedLogstashFields from './logstash_fields';
 
 const mockLogstashFields = stubbedLogstashFields();
 
+export const mockPatternLists = {
+  patternListActive: ['auditbeat-*', 'filebeat-*', 'packetbeat-*', 'winlogbeat-*'],
+  patternList: [
+    'apm-*-transaction*',
+    'auditbeat-*',
+    'endgame-*',
+    'filebeat-*',
+    'packetbeat-*',
+    'winlogbeat-*',
+  ],
+};
+
 export function stubbedSavedObjectIndexPattern(id: string | null = null) {
   return {
     id,
@@ -20,6 +32,7 @@ export function stubbedSavedObjectIndexPattern(id: string | null = null) {
       customFormats: {},
       fields: mockLogstashFields,
       title: 'title',
+      patternList: mockPatternLists.patternList,
     },
     version: '2',
   };

src/plugins/data/common/index_patterns/index_patterns/index_pattern.test.ts

@@ -13,7 +13,10 @@ import { IndexPattern } from './index_pattern';
 import { DuplicateField } from '../../../../kibana_utils/common';
 // @ts-expect-error
 import mockLogStashFields from './fixtures/logstash_fields';
-import { stubbedSavedObjectIndexPattern } from './fixtures/stubbed_saved_object_index_pattern';
+import {
+  mockPatternLists,
+  stubbedSavedObjectIndexPattern,
+} from './fixtures/stubbed_saved_object_index_pattern';
 import { IndexPatternField } from '../fields';
 
 import { fieldFormatsMock } from '../../field_formats/mocks';
@@ -46,7 +49,7 @@ function create(id: string) {
   const {
     type,
     version,
-    attributes: { timeFieldName, fields, title },
+    attributes: { timeFieldName, fields, title, patternList },
   } = stubbedSavedObjectIndexPattern(id);
 
   return new IndexPattern({
@@ -58,6 +61,8 @@ function create(id: string) {
       fields: { ...fields, runtime_field: runtimeField },
       title,
       runtimeFieldMap,
+      patternList,
+      patternListActive: mockPatternLists.patternListActive,
     },
     fieldFormats: fieldFormatsMock,
     shortDotsEnable: false,

src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts

@@ -29,21 +29,25 @@ interface IndexPatternDeps {
 
 interface SavedObjectBody {
   fieldAttrs?: string;
-  title?: string;
-  timeFieldName?: string;
-  intervalName?: string;
+  fieldFormatMap?: string;
   fields?: string;
+  intervalName?: string;
+  patternList?: string[];
   sourceFilters?: string;
-  fieldFormatMap?: string;
-  typeMeta?: string;
+  timeFieldName?: string;
+  title?: string;
   type?: string;
+  typeMeta?: string;
 }
 
 type FormatFieldFn = (hit: Record<string, any>, fieldName: string) => any;
 
 export class IndexPattern implements IIndexPattern {
-  public id?: string;
+  public id: string = '';
   public title: string = '';
+
+  public patternList: string[];
+  public patternListActive: string[];
   public fieldFormatMap: Record<string, any>;
   /**
    * Only used by rollup indices, used by rollup specific endpoint to load field list
@@ -84,7 +88,12 @@ export class IndexPattern implements IIndexPattern {
   public readonly allowNoIndex: boolean = false;
 
   constructor({
-    spec = {},
+    spec = {
+      id: '',
+      title: '',
+      patternList: [],
+      patternListActive: [],
+    },
     fieldFormats,
     shortDotsEnable = false,
     metaFields = [],
@@ -120,6 +129,8 @@ export class IndexPattern implements IIndexPattern {
     this.intervalName = spec.intervalName;
     this.allowNoIndex = spec.allowNoIndex || false;
     this.runtimeFieldMap = spec.runtimeFieldMap || {};
+    this.patternListActive = spec.patternListActive;
+    this.patternList = spec.patternList;
   }
 
   /**
@@ -221,6 +232,8 @@ export class IndexPattern implements IIndexPattern {
       fieldAttrs: this.fieldAttrs,
       intervalName: this.intervalName,
       allowNoIndex: this.allowNoIndex,
+      patternListActive: this.patternListActive,
+      patternList: this.patternList,
     };
   }
 
@@ -316,19 +329,20 @@ export class IndexPattern implements IIndexPattern {
     const runtimeFieldMap = this.runtimeFieldMap;
 
     return {
+      allowNoIndex: this.allowNoIndex ? this.allowNoIndex : undefined,
       fieldAttrs: fieldAttrs ? JSON.stringify(fieldAttrs) : undefined,
-      title: this.title,
-      timeFieldName: this.timeFieldName,
-      intervalName: this.intervalName,
-      sourceFilters: this.sourceFilters ? JSON.stringify(this.sourceFilters) : undefined,
+      fieldFormatMap,
       fields: this.fields
         ? JSON.stringify(this.fields.filter((field) => field.scripted))
         : undefined,
-      fieldFormatMap,
+      intervalName: this.intervalName,
+      patternList: this.patternList,
+      runtimeFieldMap: runtimeFieldMap ? JSON.stringify(runtimeFieldMap) : undefined,
+      sourceFilters: this.sourceFilters ? JSON.stringify(this.sourceFilters) : undefined,
+      timeFieldName: this.timeFieldName,
+      title: this.title,
       type: this.type,
       typeMeta: this.typeMeta ? JSON.stringify(this.typeMeta) : undefined,
-      allowNoIndex: this.allowNoIndex ? this.allowNoIndex : undefined,
-      runtimeFieldMap: runtimeFieldMap ? JSON.stringify(runtimeFieldMap) : undefined,
     };
   }
 

src/plugins/data/common/index_patterns/index_patterns/index_patterns.test.ts

@@ -9,13 +9,19 @@
 import { defaults } from 'lodash';
 import { IndexPatternsService, IndexPattern } from '.';
 import { fieldFormatsMock } from '../../field_formats/mocks';
-import { stubbedSavedObjectIndexPattern } from './fixtures/stubbed_saved_object_index_pattern';
+import {
+  mockPatternLists,
+  stubbedSavedObjectIndexPattern,
+} from './fixtures/stubbed_saved_object_index_pattern';
 import { UiSettingsCommon, SavedObjectsClientCommon, SavedObject } from '../types';
 
 const createFieldsFetcher = jest.fn().mockImplementation(() => ({
   getFieldsForWildcard: jest.fn().mockImplementation(() => {
     return new Promise((resolve) => resolve([]));
   }),
+  validatePatternListActive: jest.fn().mockImplementation(() => {
+    return new Promise((resolve) => resolve(mockPatternLists.patternListActive));
+  }),
   every: jest.fn(),
 }));
 
@@ -32,7 +38,14 @@ describe('IndexPatterns', () => {
   let SOClientGetDelay = 0;
 
   beforeEach(() => {
-    const indexPatternObj = { id: 'id', version: 'a', attributes: { title: 'title' } };
+    const indexPatternObj = {
+      id: 'id',
+      version: 'a',
+      attributes: {
+        title: 'something',
+        patternList: mockPatternLists.patternList,
+      },
+    };
     savedObjectsClient = {} as SavedObjectsClientCommon;
     savedObjectsClient.find = jest.fn(
       () => Promise.resolve([indexPatternObj]) as Promise<Array<SavedObject<any>>>
@@ -87,6 +100,7 @@ describe('IndexPatterns', () => {
       version: 'foo',
       attributes: {
         title: 'something',
+        patternList: ['filebeat-*'],
       },
     });
 
@@ -122,7 +136,7 @@ describe('IndexPatterns', () => {
     expect(await indexPatterns.getIds()).toEqual(['id']);
     expect(savedObjectsClient.find).toHaveBeenCalledWith({
       type: 'index-pattern',
-      fields: ['title'],
+      fields: ['patternList', 'title'],
       perPage: 10000,
     });
   });
@@ -183,15 +197,16 @@ describe('IndexPatterns', () => {
   });
 
   test('create', async () => {
+    const id = '1234';
     const title = 'kibana-*';
     indexPatterns.refreshFields = jest.fn();
 
-    const indexPattern = await indexPatterns.create({ title }, true);
+    const indexPattern = await indexPatterns.create({ id, title, ...mockPatternLists }, true);
     expect(indexPattern).toBeInstanceOf(IndexPattern);
     expect(indexPattern.title).toBe(title);
     expect(indexPatterns.refreshFields).not.toBeCalled();
 
-    await indexPatterns.create({ title });
+    await indexPatterns.create({ id, title, ...mockPatternLists });
     expect(indexPatterns.refreshFields).toBeCalled();
   });
 
@@ -202,28 +217,30 @@ describe('IndexPatterns', () => {
 
     expect(savedObjectsClient.find).lastCalledWith({
       type: 'index-pattern',
-      fields: ['title'],
+      fields: ['patternList', 'title'],
       search,
       searchFields: ['title'],
       perPage: size,
     });
   });
 
   test('createAndSave', async () => {
+    const id = '1234';
     const title = 'kibana-*';
     indexPatterns.createSavedObject = jest.fn();
     indexPatterns.setDefault = jest.fn();
-    await indexPatterns.createAndSave({ title });
+    await indexPatterns.createAndSave({ id, title, patternList: mockPatternLists.patternList });
     expect(indexPatterns.createSavedObject).toBeCalled();
     expect(indexPatterns.setDefault).toBeCalled();
   });
 
-  test('savedObjectToSpec', () => {
+  test('savedObjectToSpec', async () => {
     const savedObject = {
       id: 'id',
       version: 'version',
       attributes: {
         title: 'kibana-*',
+        patternList: mockPatternLists.patternList,
         timeFieldName: '@timestamp',
         fields: '[]',
         sourceFilters: '[{"value":"item1"},{"value":"item2"}]',
@@ -234,8 +251,9 @@ describe('IndexPatterns', () => {
       type: 'index-pattern',
       references: [],
     };
+    const spec = await indexPatterns.savedObjectToSpec(savedObject);
 
-    expect(indexPatterns.savedObjectToSpec(savedObject)).toMatchSnapshot();
+    expect(spec).toMatchSnapshot();
   });
 
   test('failed requests are not cached', async () => {