Skip to content

Commit

Permalink
[UII] Make constant keyword backfill optional (elastic#192921)
Browse files Browse the repository at this point in the history
## Summary

Follow up to elastic#188145. In some edge cases
(elastic/sdh-beats#5156), users could override
the index template used by integration data streams. It is possible to
create an index template without mappings, this causes
`fillConstantKeywordValues` to receive an undefined object when
upgrading the integration, and the upgrade then fails.

This PR makes the backfill operation here more fail-safe.
  • Loading branch information
jen-huang committed Sep 14, 2024
1 parent cabaf7a commit b5abc4e
Show file tree
Hide file tree
Showing 2 changed files with 114 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1867,6 +1867,110 @@ describe('EPM template', () => {
},
});
});

it('should fill constant keywords from previous mappings', async () => {
const esClient = elasticsearchServiceMock.createElasticsearchClient();
esClient.indices.getDataStream.mockResponse({
data_streams: [{ name: 'test-constant.keyword-default' }],
} as any);
esClient.indices.get.mockResponse({
'test-constant.keyword-default': {
mappings: {
properties: {
some_keyword_field: {
type: 'constant_keyword',
},
},
},
},
} as any);
esClient.indices.simulateTemplate.mockResponse({
template: {
settings: { index: {} },
mappings: {
properties: {
some_keyword_field: {
type: 'constant_keyword',
value: 'some_value',
},
},
},
},
} as any);
const logger = loggerMock.create();
await updateCurrentWriteIndices(esClient, logger, [
{
templateName: 'test',
indexTemplate: {
index_patterns: ['test-constant.keyword-*'],
template: {
template: {
settings: { index: {} },
mappings: { properties: {} },
},
},
} as any,
},
]);
const putMappingsCalls = esClient.indices.putMapping.mock.calls;
expect(putMappingsCalls).toHaveLength(1);
expect(putMappingsCalls[0][0]).toEqual({
index: 'test-constant.keyword-default',
body: {
properties: {
some_keyword_field: {
type: 'constant_keyword',
value: 'some_value',
},
},
},
write_index_only: true,
});
});

it('should not error when previous mappings are not found', async () => {
const esClient = elasticsearchServiceMock.createElasticsearchClient();
esClient.indices.getDataStream.mockResponse({
data_streams: [{ name: 'test-constant.keyword-default' }],
} as any);
esClient.indices.get.mockResponse({
'test-constant.keyword-default': {
mappings: {
properties: {
some_keyword_field: {
type: 'constant_keyword',
},
},
},
},
} as any);
esClient.indices.simulateTemplate.mockResponse({
template: {},
} as any);
const logger = loggerMock.create();
await updateCurrentWriteIndices(esClient, logger, [
{
templateName: 'test',
indexTemplate: {
index_patterns: ['test-constant.keyword-*'],
template: {
template: {
settings: { index: {} },
mappings: { properties: {} },
},
},
} as any,
},
]);
const putMappingsCalls = esClient.indices.putMapping.mock.calls;
expect(putMappingsCalls).toHaveLength(1);
expect(putMappingsCalls[0][0]).toEqual({
index: 'test-constant.keyword-default',
body: {},
write_index_only: true,
});
});

it('should rollover on expected error', async () => {
const esClient = elasticsearchServiceMock.createElasticsearchClient();
esClient.indices.getDataStream.mockResponse({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1027,10 +1027,16 @@ const updateExistingDataStream = async ({
);

settings = simulateResult.template.settings;
mappings = fillConstantKeywordValues(
currentBackingIndexConfig?.mappings || {},
simulateResult.template.mappings
);

try {
mappings = fillConstantKeywordValues(
currentBackingIndexConfig?.mappings || {},
simulateResult.template.mappings || {}
);
} catch (err) {
logger.error(`Error filling constant keyword values: ${err}`);
mappings = simulateResult.template.mappings;
}

lifecycle = simulateResult.template.lifecycle;

Expand Down

0 comments on commit b5abc4e

Please sign in to comment.