Skip to content

Commit

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

# Backport

This will backport the following commits from `main` to `8.15`:
- [[Semantic Text] Fix semantic text when selecting multi-fields
(#189118)](#189118)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Sander
Philipse","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-07-25T12:28:41Z","message":"[Semantic
Text] Fix semantic text when selecting multi-fields (#189118)\n\n##
Summary\r\n\r\nThis fixes a semantic text bug where selecting a
multi-fields would\r\nbreak the mappings. Instead we now filter out
multi-fields from\r\nreference fields, and recursively add any child
fields to make sure we\r\ndon't break the denormalization
anyway.\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that are not
applicable to this PR.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [ ] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n- [ ] Any UI touched in this PR is
usable by keyboard only (learn more\r\nabout [keyboard
accessibility](https://webaim.org/techniques/keyboard/))\r\n- [ ] Any UI
touched in this PR does not create any new axe failures\r\n(run axe in
browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n-
[ ] If a plugin configuration key changed, check if it needs to
be\r\nallowlisted in the cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[ ] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[ ] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n\r\n###
Risk Matrix\r\n\r\nDelete this section if it is not applicable to this
PR.\r\n\r\nBefore closing this PR, invite QA, stakeholders, and other
developers to\r\nidentify risks that should be tested prior to the
change/feature\r\nrelease.\r\n\r\nWhen forming the risk matrix, consider
some of the following examples\r\nand how they may potentially impact
the change:\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes
|\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n|
Multiple Spaces&mdash;unexpected behavior in non-default Kibana
Space.\r\n| Low | High | Integration tests will verify that all features
are still\r\nsupported in non-default Kibana Space and when user
switches between\r\nspaces. |\r\n| Multiple nodes&mdash;Elasticsearch
polling might have race conditions\r\nwhen multiple Kibana nodes are
polling for the same tasks. | High | Low\r\n| Tasks are idempotent, so
executing them multiple times will not result\r\nin logical error, but
will degrade performance. To test for this case we\r\nadd plenty of unit
tests around this logic and document manual testing\r\nprocedure. |\r\n|
Code should gracefully handle cases when feature X or plugin Y
are\r\ndisabled. | Medium | High | Unit tests will verify that any
feature flag\r\nor plugin combination still results in our service
operational. |\r\n| [See more potential
risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
|\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for
breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"bfb24efe628ccdee12fb6fea97ca338060fd4838","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Search","v8.15.0","v8.16.0"],"title":"[Semantic
Text] Fix semantic text when selecting
multi-fields","number":189118,"url":"https://github.com/elastic/kibana/pull/189118","mergeCommit":{"message":"[Semantic
Text] Fix semantic text when selecting multi-fields (#189118)\n\n##
Summary\r\n\r\nThis fixes a semantic text bug where selecting a
multi-fields would\r\nbreak the mappings. Instead we now filter out
multi-fields from\r\nreference fields, and recursively add any child
fields to make sure we\r\ndon't break the denormalization
anyway.\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that are not
applicable to this PR.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [ ] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n- [ ] Any UI touched in this PR is
usable by keyboard only (learn more\r\nabout [keyboard
accessibility](https://webaim.org/techniques/keyboard/))\r\n- [ ] Any UI
touched in this PR does not create any new axe failures\r\n(run axe in
browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n-
[ ] If a plugin configuration key changed, check if it needs to
be\r\nallowlisted in the cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[ ] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[ ] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n\r\n###
Risk Matrix\r\n\r\nDelete this section if it is not applicable to this
PR.\r\n\r\nBefore closing this PR, invite QA, stakeholders, and other
developers to\r\nidentify risks that should be tested prior to the
change/feature\r\nrelease.\r\n\r\nWhen forming the risk matrix, consider
some of the following examples\r\nand how they may potentially impact
the change:\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes
|\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n|
Multiple Spaces&mdash;unexpected behavior in non-default Kibana
Space.\r\n| Low | High | Integration tests will verify that all features
are still\r\nsupported in non-default Kibana Space and when user
switches between\r\nspaces. |\r\n| Multiple nodes&mdash;Elasticsearch
polling might have race conditions\r\nwhen multiple Kibana nodes are
polling for the same tasks. | High | Low\r\n| Tasks are idempotent, so
executing them multiple times will not result\r\nin logical error, but
will degrade performance. To test for this case we\r\nadd plenty of unit
tests around this logic and document manual testing\r\nprocedure. |\r\n|
Code should gracefully handle cases when feature X or plugin Y
are\r\ndisabled. | Medium | High | Unit tests will verify that any
feature flag\r\nor plugin combination still results in our service
operational. |\r\n| [See more potential
risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
|\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for
breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"bfb24efe628ccdee12fb6fea97ca338060fd4838"}},"sourceBranch":"main","suggestedTargetBranches":["8.15"],"targetPullRequestStates":[{"branch":"8.15","label":"v8.15.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/189118","number":189118,"mergeCommit":{"message":"[Semantic
Text] Fix semantic text when selecting multi-fields (#189118)\n\n##
Summary\r\n\r\nThis fixes a semantic text bug where selecting a
multi-fields would\r\nbreak the mappings. Instead we now filter out
multi-fields from\r\nreference fields, and recursively add any child
fields to make sure we\r\ndon't break the denormalization
anyway.\r\n\r\n\r\n### Checklist\r\n\r\nDelete any items that are not
applicable to this PR.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [ ] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n- [ ] Any UI touched in this PR is
usable by keyboard only (learn more\r\nabout [keyboard
accessibility](https://webaim.org/techniques/keyboard/))\r\n- [ ] Any UI
touched in this PR does not create any new axe failures\r\n(run axe in
browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n-
[ ] If a plugin configuration key changed, check if it needs to
be\r\nallowlisted in the cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[ ] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[ ] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n\r\n###
Risk Matrix\r\n\r\nDelete this section if it is not applicable to this
PR.\r\n\r\nBefore closing this PR, invite QA, stakeholders, and other
developers to\r\nidentify risks that should be tested prior to the
change/feature\r\nrelease.\r\n\r\nWhen forming the risk matrix, consider
some of the following examples\r\nand how they may potentially impact
the change:\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes
|\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n|
Multiple Spaces&mdash;unexpected behavior in non-default Kibana
Space.\r\n| Low | High | Integration tests will verify that all features
are still\r\nsupported in non-default Kibana Space and when user
switches between\r\nspaces. |\r\n| Multiple nodes&mdash;Elasticsearch
polling might have race conditions\r\nwhen multiple Kibana nodes are
polling for the same tasks. | High | Low\r\n| Tasks are idempotent, so
executing them multiple times will not result\r\nin logical error, but
will degrade performance. To test for this case we\r\nadd plenty of unit
tests around this logic and document manual testing\r\nprocedure. |\r\n|
Code should gracefully handle cases when feature X or plugin Y
are\r\ndisabled. | Medium | High | Unit tests will verify that any
feature flag\r\nor plugin combination still results in our service
operational. |\r\n| [See more potential
risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
|\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for
breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"bfb24efe628ccdee12fb6fea97ca338060fd4838"}}]}]
BACKPORT-->

Co-authored-by: Sander Philipse <[email protected]>
  • Loading branch information
kibanamachine and sphilipse authored Jul 25, 2024
1 parent bc26589 commit bd51600
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 bd51600

Please sign in to comment.