Skip to content

Commit

Permalink
[Semantic Text] Fix semantic text when selecting multi-fields (#189118)
Browse files Browse the repository at this point in the history
## Summary

This fixes a semantic text bug where selecting a multi-fields would
break the mappings. Instead we now filter out multi-fields from
reference fields, and recursively add any child fields to make sure we
don't break the denormalization anyway.


### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces—unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes—Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
  • Loading branch information
sphilipse authored Jul 25, 2024
1 parent efb2866 commit bfb24ef
Show file tree
Hide file tree
Showing 4 changed files with 188 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export const ReferenceFieldSelects = () => {
};

const referenceFieldOptions: SuperSelectOption[] = Object.values(allFields.byId)
.filter((field) => field.source.type === 'text')
.filter((field) => field.source.type === 'text' && !field.isMultiField)
.map((field) => ({
value: field.path.join('.'),
inputDisplay: field.path.join('.'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export function useSemanticText(props: UseSemanticTextProps) {
const defaultName = getFieldByPathName(allFields, 'semantic_text') ? '' : 'semantic_text';
const referenceField =
Object.values(allFields.byId)
.find((field) => field.source.type === 'text')
.find((field) => field.source.type === 'text' && !field.isMultiField)
?.path.join('.') || '';
if (!form.getFormData().name) {
form.setFieldValue('name', defaultName);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -641,6 +641,173 @@ describe('utils', () => {
} as any;
expect(getStateWithCopyToFields(state)).toEqual(expectedState);
});
test('adds nested text field with copy to to state for multi-fields correctly', () => {
const state = {
fields: {
byId: {
'88ebcfdb-19b7-4458-9ea2-9488df54453d': {
id: '88ebcfdb-19b7-4458-9ea2-9488df54453d',
isMultiField: false,
path: ['title'],
source: {
name: 'title',
type: 'semantic_text',
inference_id: 'id',
reference_field: 'existing.new',
},
},
},
rootLevelFields: ['88ebcfdb-19b7-4458-9ea2-9488df54453d'],
},
mappingViewFields: {
byId: {
existing: {
id: 'existing',
isMultiField: false,
path: ['existing'],
source: {
name: 'existing',
type: 'object',
},
},
'new-field': {
childFields: ['child-1', 'child-2'],
id: 'new-field',
parentId: 'existing',
isMultiField: true,
path: ['existing', 'new'],
source: {
name: 'new',
type: 'text',
},
},
'child-1': {
id: 'child-1',
parentId: 'new-field',
isMultiField: false,
path: ['existing', 'new', 'child-1'],
source: {
name: 'child-1',
type: 'text',
},
},
'child-2': {
id: 'child-2',
parentId: 'new-field',
isMultiField: true,
path: ['existing', 'new', 'child-2'],
source: {
name: 'child-2',
type: 'text',
},
},
},
},
} as any;
const expectedState = {
fields: {
byId: {
'88ebcfdb-19b7-4458-9ea2-9488df54453d': {
id: '88ebcfdb-19b7-4458-9ea2-9488df54453d',
isMultiField: false,
path: ['title'],
source: {
name: 'title',
type: 'semantic_text',
inference_id: 'id',
},
},
existing: {
id: 'existing',
isMultiField: false,
path: ['existing'],
source: {
name: 'existing',
type: 'object',
},
},
'new-field': {
childFields: ['child-1', 'child-2'],
id: 'new-field',
isMultiField: true,
parentId: 'existing',
path: ['existing', 'new'],
source: {
name: 'new',
type: 'text',
copy_to: ['title'],
},
},
'child-1': {
id: 'child-1',
parentId: 'new-field',
isMultiField: false,
path: ['existing', 'new', 'child-1'],
source: {
name: 'child-1',
type: 'text',
},
},
'child-2': {
id: 'child-2',
parentId: 'new-field',
isMultiField: true,
path: ['existing', 'new', 'child-2'],
source: {
name: 'child-2',
type: 'text',
},
},
},
rootLevelFields: ['88ebcfdb-19b7-4458-9ea2-9488df54453d', 'existing'],
},
mappingViewFields: {
byId: {
existing: {
id: 'existing',
isMultiField: false,
path: ['existing'],
source: {
name: 'existing',
type: 'object',
},
},
'new-field': {
childFields: ['child-1', 'child-2'],
id: 'new-field',
parentId: 'existing',
isMultiField: true,
path: ['existing', 'new'],
source: {
name: 'new',
type: 'text',
},
},
'child-1': {
id: 'child-1',
parentId: 'new-field',
isMultiField: false,
path: ['existing', 'new', 'child-1'],
source: {
name: 'child-1',
type: 'text',
},
},
'child-2': {
id: 'child-2',
parentId: 'new-field',
isMultiField: true,
path: ['existing', 'new', 'child-2'],
source: {
name: 'child-2',
type: 'text',
},
},
},
},
} as any;
expect(getStateWithCopyToFields(state)).toEqual(expectedState);
});
});
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -732,27 +732,18 @@ export function getStateWithCopyToFields(state: State): State {
: [field.path.join('.')],
},
};
// add existing text field and children to byId list
const children = existingTextField.childFields
? existingTextField.childFields.reduce<Record<string, NormalizedField>>(
(acc, childFieldId) => {
acc[childFieldId] = state.mappingViewFields.byId[childFieldId];
return acc;
},
{}
)
: {};

updatedState = {
...updatedState,
fields: {
...updatedState.fields,
byId: {
...updatedState.fields.byId,
[existingTextField.id]: updatedTextField,
...children,
},
},
};
addChildFieldsToState(updatedTextField, updatedState);
if (existingTextField.parentId) {
let currentField = existingTextField;
let hasParent = true;
Expand All @@ -768,6 +759,10 @@ export function getStateWithCopyToFields(state: State): State {
// parent is not in state yet
updatedState.fields.byId[currentField.parentId] =
updatedState.mappingViewFields.byId[currentField.parentId];
addChildFieldsToState(
updatedState.mappingViewFields.byId[currentField.parentId],
updatedState
);
currentField = updatedState.fields.byId[currentField.parentId];
}
}
Expand All @@ -782,6 +777,19 @@ export function getStateWithCopyToFields(state: State): State {
return updatedState;
}

function addChildFieldsToState(field: NormalizedField, state: State): State {
if (!field.childFields || field.childFields.length === 0) {
return state;
}
for (const childFieldId of field.childFields) {
if (!state.fields.byId[childFieldId]) {
state.fields.byId[childFieldId] = state.mappingViewFields.byId[childFieldId];
state = addChildFieldsToState(state.fields.byId[childFieldId], state);
}
}
return state;
}

export const getFieldByPathName = (fields: NormalizedFields, name: string) => {
return Object.values(fields.byId).find((field) => field.path.join('.') === name);
};
Expand Down

0 comments on commit bfb24ef

Please sign in to comment.