[Fleet] Remove aliases from index_template when updating an existing template (#91142)

nchaulet · web-flow · commit c22366e69dee · 2021-02-11T13:55:45.000-05:00
diff --git a/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/install.test.ts b/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/install.test.ts
@@ -13,6 +13,12 @@ import { installTemplate } from './install';
 
 test('tests installPackage to use correct priority and index_patterns for data stream with dataset_is_prefix not set', async () => {
   const callCluster = elasticsearchServiceMock.createLegacyScopedClusterClient().callAsCurrentUser;
+  callCluster.mockImplementation((_, params) => {
+    if (params.method === 'GET' && params.path === '/_index_template/metrics-package.dataset') {
+      return { index_templates: [] };
+    }
+  });
+
   const fields: Field[] = [];
   const dataStreamDatasetIsPrefixUnset = {
     type: 'metrics',
@@ -37,14 +43,20 @@ test('tests installPackage to use correct priority and index_patterns for data s
     packageName: pkg.name,
   });
   // @ts-ignore
-  const sentTemplate = callCluster.mock.calls[0][1].body;
+  const sentTemplate = callCluster.mock.calls[1][1].body;
   expect(sentTemplate).toBeDefined();
   expect(sentTemplate.priority).toBe(templatePriorityDatasetIsPrefixUnset);
   expect(sentTemplate.index_patterns).toEqual([templateIndexPatternDatasetIsPrefixUnset]);
 });
 
 test('tests installPackage to use correct priority and index_patterns for data stream with dataset_is_prefix set to false', async () => {
   const callCluster = elasticsearchServiceMock.createLegacyScopedClusterClient().callAsCurrentUser;
+  callCluster.mockImplementation((_, params) => {
+    if (params.method === 'GET' && params.path === '/_index_template/metrics-package.dataset') {
+      return { index_templates: [] };
+    }
+  });
+
   const fields: Field[] = [];
   const dataStreamDatasetIsPrefixFalse = {
     type: 'metrics',
@@ -70,14 +82,20 @@ test('tests installPackage to use correct priority and index_patterns for data s
     packageName: pkg.name,
   });
   // @ts-ignore
-  const sentTemplate = callCluster.mock.calls[0][1].body;
+  const sentTemplate = callCluster.mock.calls[1][1].body;
   expect(sentTemplate).toBeDefined();
   expect(sentTemplate.priority).toBe(templatePriorityDatasetIsPrefixFalse);
   expect(sentTemplate.index_patterns).toEqual([templateIndexPatternDatasetIsPrefixFalse]);
 });
 
 test('tests installPackage to use correct priority and index_patterns for data stream with dataset_is_prefix set to true', async () => {
   const callCluster = elasticsearchServiceMock.createLegacyScopedClusterClient().callAsCurrentUser;
+  callCluster.mockImplementation((_, params) => {
+    if (params.method === 'GET' && params.path === '/_index_template/metrics-package.dataset') {
+      return { index_templates: [] };
+    }
+  });
+
   const fields: Field[] = [];
   const dataStreamDatasetIsPrefixTrue = {
     type: 'metrics',
@@ -103,8 +121,60 @@ test('tests installPackage to use correct priority and index_patterns for data s
     packageName: pkg.name,
   });
   // @ts-ignore
-  const sentTemplate = callCluster.mock.calls[0][1].body;
+  const sentTemplate = callCluster.mock.calls[1][1].body;
   expect(sentTemplate).toBeDefined();
   expect(sentTemplate.priority).toBe(templatePriorityDatasetIsPrefixTrue);
   expect(sentTemplate.index_patterns).toEqual([templateIndexPatternDatasetIsPrefixTrue]);
 });
+
+test('tests installPackage remove the aliases property if the property existed', async () => {
+  const callCluster = elasticsearchServiceMock.createLegacyScopedClusterClient().callAsCurrentUser;
+  callCluster.mockImplementation((_, params) => {
+    if (params.method === 'GET' && params.path === '/_index_template/metrics-package.dataset') {
+      return {
+        index_templates: [
+          {
+            name: 'metrics-package.dataset',
+            index_template: {
+              index_patterns: ['metrics-package.dataset-*'],
+              template: { aliases: {} },
+            },
+          },
+        ],
+      };
+    }
+  });
+
+  const fields: Field[] = [];
+  const dataStreamDatasetIsPrefixUnset = {
+    type: 'metrics',
+    dataset: 'package.dataset',
+    title: 'test data stream',
+    release: 'experimental',
+    package: 'package',
+    path: 'path',
+    ingest_pipeline: 'default',
+  } as RegistryDataStream;
+  const pkg = {
+    name: 'package',
+    version: '0.0.1',
+  };
+  const templateIndexPatternDatasetIsPrefixUnset = 'metrics-package.dataset-*';
+  const templatePriorityDatasetIsPrefixUnset = 200;
+  await installTemplate({
+    callCluster,
+    fields,
+    dataStream: dataStreamDatasetIsPrefixUnset,
+    packageVersion: pkg.version,
+    packageName: pkg.name,
+  });
+
+  // @ts-ignore
+  const removeAliases = callCluster.mock.calls[1][1].body;
+  expect(removeAliases.template.aliases).not.toBeDefined();
+  // @ts-ignore
+  const sentTemplate = callCluster.mock.calls[2][1].body;
+  expect(sentTemplate).toBeDefined();
+  expect(sentTemplate.priority).toBe(templatePriorityDatasetIsPrefixUnset);
+  expect(sentTemplate.index_patterns).toEqual([templateIndexPatternDatasetIsPrefixUnset]);
+});
diff --git a/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/install.ts b/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/install.ts
@@ -311,6 +311,45 @@ export async function installTemplate({
     });
   }
 
+  // Datastream now throw an error if the aliases field is present so ensure that we remove that field.
+  const getTemplateRes = await callCluster('transport.request', {
+    method: 'GET',
+    path: `/_index_template/${templateName}`,
+    ignore: [404],
+  });
+
+  const existingIndexTemplate = getTemplateRes?.index_templates?.[0];
+  if (
+    existingIndexTemplate &&
+    existingIndexTemplate.name === templateName &&
+    existingIndexTemplate?.index_template?.template?.aliases
+  ) {
+    const updateIndexTemplateParams: {
+      method: string;
+      path: string;
+      ignore: number[];
+      body: any;
+    } = {
+      method: 'PUT',
+      path: `/_index_template/${templateName}`,
+      ignore: [404],
+      body: {
+        ...existingIndexTemplate.index_template,
+        template: {
+          ...existingIndexTemplate.index_template.template,
+          // Remove the aliases field
+          aliases: undefined,
+        },
+      },
+    };
+    // This uses the catch-all endpoint 'transport.request' because there is no
+    // convenience endpoint using the new _index_template API yet.
+    // The existing convenience endpoint `indices.putTemplate` only sends to _template,
+    // which does not support v2 templates.
+    // See src/core/server/elasticsearch/api_types.ts for available endpoints.
+    await callCluster('transport.request', updateIndexTemplateParams);
+  }
+
   const composedOfTemplates = await installDataStreamComponentTemplates(
     templateName,
     dataStream.elasticsearch,
