Set from & to as optional args in @kbn/grouping #213212
Merged
+33
−20
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
albertoblaz
added
release_note:skip
|
Pinging @elastic/kibana-cloud-security-posture (Team:Cloud Security) |
14 tasks
💛 Build succeeded, but was flaky
Failed CI Steps
Metrics [docs]Async chunks
Historycc @albertoblaz |
albertoblaz
changed the title
from & to as optional args in @kbn/grouping
umbopepato
approved these changes
Mar 5, 2025
seanrathier
approved these changes
Mar 5, 2025
|
Starting backport for target branches: 9.0 |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Mar 5, 2025
## Summary Set `from` and `to` as optional args in `getGroupingQuery`, a function exposed by `@kbn/grouping`. It will unblock this PR: - elastic#212955 ### Motivation `getGroupingQuery` returns an ES aggregation for grouping documents. This function assumes data will be queried in a certain interval of time. However, Asset Inventory needs to query data from the beginning of time because the UI will not provide any time-range filter. So in order to reuse this logic, we need to set both args as optional. Reason for wrapping both fields in an optional `timeRange` record is to have either both present or both undefined, not only one of them present. ### Checklist - [ ] 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/src/platform/packages/shared/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 - [x] [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 - [ ] 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) - [x] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Risks No risk at all. It would be a breaking change otherwise, if we had to require args that were optional before. (cherry picked from commit af147b5)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Mar 5, 2025
) # Backport This will backport the following commits from `main` to `9.0`: - [Set from & to as optional args in @kbn/grouping (#213212)](#213212) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Alberto Blázquez","email":"albertoblaz@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-03-05T16:21:54Z","message":"Set from & to as optional args in @kbn/grouping (#213212)\n\n## Summary\n\nSet `from` and `to` as optional args in `getGroupingQuery`, a function\nexposed by `@kbn/grouping`.\n\nIt will unblock this PR:\n- https://github.com/elastic/kibana/pull/212955\n\n### Motivation \n\n`getGroupingQuery` returns an ES aggregation for grouping documents.\nThis function assumes data will be queried in a certain interval of\ntime. However, Asset Inventory needs to query data from the beginning of\ntime because the UI will not provide any time-range filter. So in order\nto reuse this logic, we need to set both args as optional.\n\nReason for wrapping both fields in an optional `timeRange` record is to\nhave either both present or both undefined, not only one of them\npresent.\n\n### Checklist\n\n- [ ] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [ ]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [ ] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [x] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [ ] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [x] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n### Risks\n\nNo risk at all. It would be a breaking change otherwise, if we had to\nrequire args that were optional before.","sha":"af147b5cc6612bc9e5632c2004f868f8c2b2a7f9","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Cloud Security","backport:prev-minor","v9.1.0"],"title":"Set from & to as optional args in @kbn/grouping","number":213212,"url":"https://github.com/elastic/kibana/pull/213212","mergeCommit":{"message":"Set from & to as optional args in @kbn/grouping (#213212)\n\n## Summary\n\nSet `from` and `to` as optional args in `getGroupingQuery`, a function\nexposed by `@kbn/grouping`.\n\nIt will unblock this PR:\n- https://github.com/elastic/kibana/pull/212955\n\n### Motivation \n\n`getGroupingQuery` returns an ES aggregation for grouping documents.\nThis function assumes data will be queried in a certain interval of\ntime. However, Asset Inventory needs to query data from the beginning of\ntime because the UI will not provide any time-range filter. So in order\nto reuse this logic, we need to set both args as optional.\n\nReason for wrapping both fields in an optional `timeRange` record is to\nhave either both present or both undefined, not only one of them\npresent.\n\n### Checklist\n\n- [ ] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [ ]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [ ] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [x] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [ ] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [x] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n### Risks\n\nNo risk at all. It would be a breaking change otherwise, if we had to\nrequire args that were optional before.","sha":"af147b5cc6612bc9e5632c2004f868f8c2b2a7f9"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/213212","number":213212,"mergeCommit":{"message":"Set from & to as optional args in @kbn/grouping (#213212)\n\n## Summary\n\nSet `from` and `to` as optional args in `getGroupingQuery`, a function\nexposed by `@kbn/grouping`.\n\nIt will unblock this PR:\n- https://github.com/elastic/kibana/pull/212955\n\n### Motivation \n\n`getGroupingQuery` returns an ES aggregation for grouping documents.\nThis function assumes data will be queried in a certain interval of\ntime. However, Asset Inventory needs to query data from the beginning of\ntime because the UI will not provide any time-range filter. So in order\nto reuse this logic, we need to set both args as optional.\n\nReason for wrapping both fields in an optional `timeRange` record is to\nhave either both present or both undefined, not only one of them\npresent.\n\n### Checklist\n\n- [ ] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [ ]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [ ] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [x] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [ ] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [x] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n### Risks\n\nNo risk at all. It would be a breaking change otherwise, if we had to\nrequire args that were optional before.","sha":"af147b5cc6612bc9e5632c2004f868f8c2b2a7f9"}}]}] BACKPORT--> Co-authored-by: Alberto Blázquez <albertoblaz@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Set
fromandtoas optional args ingetGroupingQuery, a function exposed by@kbn/grouping.It will unblock this PR:
Motivation
getGroupingQueryreturns an ES aggregation for grouping documents. This function assumes data will be queried in a certain interval of time. However, Asset Inventory needs to query data from the beginning of time because the UI will not provide any time-range filter. So in order to reuse this logic, we need to set both args as optional.Reason for wrapping both fields in an optional
timeRangerecord is to have either both present or both undefined, not only one of them present.Checklist
release_note:breakinglabel should be applied in these situations.release_note:*label is applied per the guidelinesRisks
No risk at all. It would be a breaking change otherwise, if we had to require args that were optional before.