mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
# Backport This will backport the following commits from `main` to `8.10`: - [[Fleet] Fix transforms not updating aliases for unsupported format (#165857)](https://github.com/elastic/kibana/pull/165857) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Quynh Nguyen (Quinn)","email":"43350163+qn895@users.noreply.github.com"},"sourceCommit":{"committedDate":"2023-09-08T03:20:04Z","message":"[Fleet] Fix transforms not updating aliases for unsupported format (#165857)\n\n## Summary\r\n\r\nA [recent update in the\r\npackage-spec](https://github.com/elastic/package-spec/pull/574) for\r\npackages containing transforms allows official support for aliases in\r\ntransforms' config. However, the format that went in\r\nhttps://github.com/elastic/package-spec/pull/574 was different from when\r\nthe aliases support was initially added in Fleet, so the shape of the\r\nJSON parsed in Fleet ends up being an array of object. This PR updates\r\nthe `getDestinationIndexAliases` util to support the newly added format\r\n(which is array of object).\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- [x] [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- [ ] 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—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—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)\r\n\r\nCo-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>","sha":"973f9505e1b76b359b1381c1e1d7371a6805af1a","branchLabelMapping":{"^v8.11.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":[":ml","release_note:skip","Feature:Transforms","Team:Fleet","v8.10.0","v8.11.0","v8.9.3"],"number":165857,"url":"https://github.com/elastic/kibana/pull/165857","mergeCommit":{"message":"[Fleet] Fix transforms not updating aliases for unsupported format (#165857)\n\n## Summary\r\n\r\nA [recent update in the\r\npackage-spec](https://github.com/elastic/package-spec/pull/574) for\r\npackages containing transforms allows official support for aliases in\r\ntransforms' config. However, the format that went in\r\nhttps://github.com/elastic/package-spec/pull/574 was different from when\r\nthe aliases support was initially added in Fleet, so the shape of the\r\nJSON parsed in Fleet ends up being an array of object. This PR updates\r\nthe `getDestinationIndexAliases` util to support the newly added format\r\n(which is array of object).\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- [x] [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- [ ] 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—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—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)\r\n\r\nCo-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>","sha":"973f9505e1b76b359b1381c1e1d7371a6805af1a"}},"sourceBranch":"main","suggestedTargetBranches":["8.10","8.9"],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.11.0","labelRegex":"^v8.11.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/165857","number":165857,"mergeCommit":{"message":"[Fleet] Fix transforms not updating aliases for unsupported format (#165857)\n\n## Summary\r\n\r\nA [recent update in the\r\npackage-spec](https://github.com/elastic/package-spec/pull/574) for\r\npackages containing transforms allows official support for aliases in\r\ntransforms' config. However, the format that went in\r\nhttps://github.com/elastic/package-spec/pull/574 was different from when\r\nthe aliases support was initially added in Fleet, so the shape of the\r\nJSON parsed in Fleet ends up being an array of object. This PR updates\r\nthe `getDestinationIndexAliases` util to support the newly added format\r\n(which is array of object).\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- [x] [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- [ ] 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—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—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)\r\n\r\nCo-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>","sha":"973f9505e1b76b359b1381c1e1d7371a6805af1a"}},{"branch":"8.9","label":"v8.9.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Quynh Nguyen (Quinn) <43350163+qn895@users.noreply.github.com>
This commit is contained in:
Kibana Machine
GitHub
parent
552cb18318
commit
e473ff65b5
2 changed files with 37 additions and 4 deletions
|
|
@ -47,6 +47,35 @@ describe('test transform_utils', () => {
|
|||
]);
|
||||
});
|
||||
|
||||
test('return transform alias settings when input is an array of object', () => {
|
||||
const aliasSettings = [
|
||||
{ alias: 'alias1', move_on_creation: true },
|
||||
{ alias: 'alias2' },
|
||||
{ alias: 'alias3', move_on_creation: false },
|
||||
];
|
||||
expect(getDestinationIndexAliases(aliasSettings)).toStrictEqual([
|
||||
{ alias: 'alias1', move_on_creation: true },
|
||||
{ alias: 'alias2', move_on_creation: false },
|
||||
{ alias: 'alias3', move_on_creation: false },
|
||||
]);
|
||||
|
||||
expect(
|
||||
getDestinationIndexAliases([
|
||||
...aliasSettings,
|
||||
undefined,
|
||||
{},
|
||||
{ invalid_object: true },
|
||||
null,
|
||||
'alias3.all',
|
||||
])
|
||||
).toStrictEqual([
|
||||
{ alias: 'alias1', move_on_creation: true },
|
||||
{ alias: 'alias2', move_on_creation: false },
|
||||
{ alias: 'alias3', move_on_creation: false },
|
||||
{ alias: 'alias3.all', move_on_creation: false },
|
||||
]);
|
||||
});
|
||||
|
||||
test('return transform alias settings when input is a string', () => {
|
||||
expect(getDestinationIndexAliases('alias1.latest')).toStrictEqual([
|
||||
{ alias: 'alias1.latest', move_on_creation: true },
|
||||
|
|
|
|||
|
|
@ -13,16 +13,15 @@ interface TransformAliasSetting {
|
|||
// ensuring that the alias points at only one index (i.e.: the destination index of the current transform).
|
||||
move_on_creation?: boolean;
|
||||
}
|
||||
function isTransformAliasSetting(arg: unknown): arg is TransformAliasSetting {
|
||||
return isPopulatedObject(arg, ['alias']) && typeof arg.alias === 'string';
|
||||
}
|
||||
|
||||
export const getDestinationIndexAliases = (aliasSettings: unknown): TransformAliasSetting[] => {
|
||||
let aliases: TransformAliasSetting[] = [];
|
||||
|
||||
if (!aliasSettings) return aliases;
|
||||
|
||||
// Can be in form of {
|
||||
// 'alias1': null,
|
||||
// 'alias2': { move_on_creation: false }
|
||||
// }
|
||||
if (isPopulatedObject<string, { move_on_creation?: boolean }>(aliasSettings)) {
|
||||
Object.keys(aliasSettings).forEach((alias) => {
|
||||
if (aliasSettings.hasOwnProperty(alias) && typeof alias === 'string') {
|
||||
|
|
@ -31,11 +30,16 @@ export const getDestinationIndexAliases = (aliasSettings: unknown): TransformAli
|
|||
}
|
||||
});
|
||||
}
|
||||
|
||||
if (Array.isArray(aliasSettings)) {
|
||||
aliases = aliasSettings.reduce<TransformAliasSetting[]>((acc, alias) => {
|
||||
if (typeof alias === 'string') {
|
||||
acc.push({ alias, move_on_creation: alias.endsWith('.latest') ? true : false });
|
||||
}
|
||||
|
||||
if (isTransformAliasSetting(alias)) {
|
||||
acc.push({ alias: alias.alias, move_on_creation: alias.move_on_creation ?? false });
|
||||
}
|
||||
return acc;
|
||||
}, []);
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue