Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fleet] Fix loading fields for transform destination index template #177608

Merged
merged 5 commits into from
Feb 23, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/
import { createAppContextStartContractMock } from '../../../../mocks';
import { appContextService } from '../../..';
import { loadFieldsFromYaml } from '../../fields/field';
import { loadDatastreamsFieldsFromYaml } from '../../fields/field';
import type { PackageInstallContext, RegistryDataStream } from '../../../../../common/types';

import { prepareTemplate, prepareToInstallTemplates } from './install';
Expand All @@ -16,8 +16,8 @@ jest.mock('../../fields/field', () => ({
loadFieldsFromYaml: jest.fn(),
}));

const mockedLoadFieldsFromYaml = loadFieldsFromYaml as jest.MockedFunction<
typeof loadFieldsFromYaml
const mockedLoadFieldsFromYaml = loadDatastreamsFieldsFromYaml as jest.MockedFunction<
typeof loadDatastreamsFieldsFromYaml
>;
const packageInstallContext = {
packageInfo: { name: 'package', version: '0.0.1' },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import type {
EsAssetReference,
ExperimentalDataStreamFeature,
} from '../../../../types';
import { loadFieldsFromYaml, processFields } from '../../fields/field';
import { loadDatastreamsFieldsFromYaml, processFields } from '../../fields/field';
import { getAssetFromAssetsMap, getPathParts } from '../../archive';
import {
FLEET_COMPONENT_TEMPLATES,
Expand Down Expand Up @@ -509,7 +509,7 @@ export function prepareTemplate({
experimentalDataStreamFeature?: ExperimentalDataStreamFeature;
}): { componentTemplates: TemplateMap; indexTemplate: IndexTemplateEntry } {
const { name: packageName, version: packageVersion } = packageInstallContext.packageInfo;
const fields = loadFieldsFromYaml(packageInstallContext, dataStream.path);
const fields = loadDatastreamsFieldsFromYaml(packageInstallContext, dataStream.path);

const isIndexModeTimeSeries =
dataStream.elasticsearch?.index_mode === 'time_series' ||
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ import {
buildComponentTemplates,
installComponentAndIndexTemplateForDataStream,
} from '../template/install';
import { isFields, processFields } from '../../fields/field';
import { generateMappings } from '../template/template';
import { isFields } from '../../fields/field';
import { getESAssetMetadata } from '../meta';
import { updateEsAssetReferences } from '../../packages/es_assets_reference';
import { getAssetFromAssetsMap, getPathParts } from '../../archive';
Expand All @@ -47,6 +46,7 @@ import { isUserSettingsTemplate } from '../template/utils';

import { deleteTransforms } from './remove';
import { getDestinationIndexAliases } from './transform_utils';
import { loadMappingForTransform } from './mappings';

const DEFAULT_TRANSFORM_TEMPLATES_PRIORITY = 250;
enum TRANSFORM_SPECS_TYPES {
Expand Down Expand Up @@ -183,8 +183,6 @@ const processTransformAssetsPerModule = (

// Handling fields.yml and all other files within 'fields' folder
if (fileName === TRANSFORM_SPECS_TYPES.FIELDS || isFields(path)) {
const validFields = processFields(content);
const mappings = generateMappings(validFields);
const templateName = getTransformAssetNameForInstallation(
installablePackage,
transformModuleId,
Expand All @@ -208,14 +206,6 @@ const processTransformAssetsPerModule = (
} else {
destinationIndexTemplates[indexToModify] = template;
}

// If there's already mappings set previously, append it to new
const previousMappings =
transformsSpecifications.get(transformModuleId)?.get('mappings') ?? {};

transformsSpecifications.get(transformModuleId)?.set('mappings', {
properties: { ...previousMappings.properties, ...mappings.properties },
});
}

if (fileName === TRANSFORM_SPECS_TYPES.TRANSFORM) {
Expand Down Expand Up @@ -394,6 +384,20 @@ const processTransformAssetsPerModule = (
version: t.transformVersion,
}));

// Load and generate mappings
for (const destinationIndexTemplate of destinationIndexTemplates) {
if (!destinationIndexTemplate.transformModuleId) {
continue;
}

transformsSpecifications
.get(destinationIndexTemplate.transformModuleId)
?.set(
'mappings',
loadMappingForTransform(packageInstallContext, destinationIndexTemplate.transformModuleId)
);
}

return {
indicesToAddRefs,
indexTemplatesRefs,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
/*
* 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; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import { loadMappingForTransform } from './mappings';

describe('loadMappingForTransform', () => {
it('should return a mappings without properties if there is no fields resource', () => {
const fields = loadMappingForTransform(
{
packageInfo: {} as any,
assetsMap: new Map(),
paths: [],
},
'test'
);

expect(fields).toEqual({ properties: {} });
});

it('should merge shallow mapping without properties if there is no fields resource', () => {
const fields = loadMappingForTransform(
{
packageInfo: {} as any,
assetsMap: new Map([
[
'/package/ti_opencti/2.1.0/elasticsearch/transform/latest_ioc/fields/ecs.yml',
Buffer.from(
`
- description: Description of the threat feed in a UI friendly format.
name: threat.feed.description
type: keyword
- description: The name of the threat feed in UI friendly format.
name: threat.feed.name
type: keyword`
),
],
[
'/package/ti_opencti/2.1.0/elasticsearch/transform/latest_ioc/fields/ecs-extra.yml',
Buffer.from(
`
- description: The display name indicator in an UI friendly format
level: extended
name: threat.indicator.name
type: keyword`
),
],
]),
paths: [
'/package/ti_opencti/2.1.0/elasticsearch/transform/latest_ioc/fields/ecs.yml',
'/package/ti_opencti/2.1.0/elasticsearch/transform/latest_ioc/fields/ecs-extra.yml',
],
},
'latest_ioc'
);

expect(fields).toMatchInlineSnapshot(`
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chrisberkhout Can you confirm it's the expected behaviour given the two fields files above

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's right.

Object {
"properties": Object {
"threat": Object {
"properties": Object {
"feed": Object {
"properties": Object {
"description": Object {
"ignore_above": 1024,
"type": "keyword",
},
"name": Object {
"ignore_above": 1024,
"type": "keyword",
},
},
},
"indicator": Object {
"properties": Object {
"name": Object {
"ignore_above": 1024,
"type": "keyword",
},
},
},
},
},
},
}
`);
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/*
* 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; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import { type PackageInstallContext } from '../../../../../common/types/models';
import { loadTransformFieldsFromYaml, processFields } from '../../fields/field';
import { generateMappings } from '../template/template';

export function loadMappingForTransform(
packageInstallContext: PackageInstallContext,
transformModuleId: string
) {
const fields = loadTransformFieldsFromYaml(packageInstallContext, transformModuleId);
const validFields = processFields(fields);
return generateMappings(validFields);
}
37 changes: 36 additions & 1 deletion x-pack/plugins/fleet/server/services/epm/fields/field.ts
Original file line number Diff line number Diff line change
Expand Up @@ -289,13 +289,25 @@ export const isFields = (path: string) => {
return path.includes('/fields/');
};

export const filterForTransformAssets = (transformName: string) => {
return function isTransformAssets(path: string) {
return path.includes(`/transform/${transformName}`);
};
};

function combineFilter(...filters: Array<(path: string) => boolean>) {
return function filterAsset(path: string) {
return filters.every((filter) => filter(path));
};
}

/**
* loadFieldsFromYaml
*
* Gets all field files, optionally filtered by dataset, extracts .yml files, merges them together
*/

export const loadFieldsFromYaml = (
export const loadDatastreamsFieldsFromYaml = (
packageInstallContext: PackageInstallContext,
datasetName?: string
): Field[] => {
Expand All @@ -318,3 +330,26 @@ export const loadFieldsFromYaml = (
return acc;
}, []);
};

export const loadTransformFieldsFromYaml = (
packageInstallContext: PackageInstallContext,
transformName: string
): Field[] => {
// Fetch all field definition files
const fieldDefinitionFiles = getAssetsDataFromAssetsMap(
packageInstallContext.packageInfo,
packageInstallContext.assetsMap,
combineFilter(isFields, filterForTransformAssets(transformName))
);
return fieldDefinitionFiles.reduce<Field[]>((acc, file) => {
// Make sure it is defined as it is optional. Should never happen.
if (file.buffer) {
const tmpFields = safeLoad(file.buffer.toString());
// safeLoad() returns undefined for empty files, we don't want that
if (tmpFields) {
acc = acc.concat(tmpFields);
}
}
return acc;
}, []);
};