[Discover] Support overriding solutionNavId used for root profile resolution in embeddable
#205986
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
…olution in embeddable
davismcphee
added
release_note:skip
|
Pinging @elastic/kibana-data-discovery (Team:DataDiscovery) |
|
Pinging @elastic/obs-ux-logs-team (Team:obs-ux-logs) |
botelastic
bot
added
the
Team:obs-ux-infra_services
|
Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services) |
rmyz
approved these changes
Jan 11, 2025
jughosta
approved these changes
Jan 13, 2025
| @@ -64,6 +64,7 @@ export type SearchEmbeddableSerializedAttributes = Omit< | |||
| // These are options that are not persisted in the saved object, but can be used by solutions | |||
| // when utilising the SavedSearchComponent package outside of dashboard contexts. | |||
| export interface NonPersistedDisplayOptions { | |||
| solutionNavIdOverride?: string; | |||
There was a problem hiding this comment.
Can we add the expected values to facilitate autocomplete? Like the following:
Suggested change
| solutionNavIdOverride?: string; | |
| solutionNavIdOverride?: 'oblt' | string; |
There was a problem hiding this comment.
Good idea and yes we can. Updated here: a6850d6.
💛 Build succeeded, but was flaky
Failed CI StepsTest Failures
Metrics [docs]Public APIs missing comments
Async chunks
History
cc @davismcphee |
|
Starting backport for target branches: 8.x https://github.com/elastic/kibana/actions/runs/12757656113 |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jan 13, 2025
…esolution in embeddable (elastic#205986) ## Summary This PR adds support for overriding the `solutionNavId` used for root profile resolution within the Discover embeddable, allowing consumers to force specific root profiles. Additionally the current usages of `LazySavedSearchComponent` within Observability apps have been updated to pass `solutionNavIdOverride: 'oblt'` to ensure their embedded logs components render in logs mode as expected. Resolves elastic#203121. ### 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) - [x] [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) - [ ] 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) (cherry picked from commit 13d4813)
💚 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
Jan 14, 2025
…r root profile resolution in embeddable (#205986) (#206525) # Backport This will backport the following commits from `main` to `8.x`: - [[Discover] Support overriding `solutionNavId` used for root profile resolution in embeddable (#205986)](#205986) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Davis McPhee","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-01-13T22:58:37Z","message":"[Discover] Support overriding `solutionNavId` used for root profile resolution in embeddable (#205986)\n\n## Summary\r\n\r\nThis PR adds support for overriding the `solutionNavId` used for root\r\nprofile resolution within the Discover embeddable, allowing consumers to\r\nforce specific root profiles. Additionally the current usages of\r\n`LazySavedSearchComponent` within Observability apps have been updated\r\nto pass `solutionNavIdOverride: 'oblt'` to ensure their embedded logs\r\ncomponents render in logs mode as expected.\r\n\r\nResolves #203121.\r\n\r\n### Checklist\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/src/platform/packages/shared/kbn-i18n/README.md)\r\n- [x]\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- [ ] 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 was checked for breaking HTTP API changes, and any breaking\r\nchanges have been approved by the breaking-change committee. The\r\n`release_note:breaking` label should be applied in these situations.\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- [x] The PR description includes the appropriate Release Notes section,\r\nand the correct `release_note:*` label is applied per the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"13d4813151ff0c7cb549cf0d22565a1f9d46fb68","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:DataDiscovery","backport:prev-minor","Team:obs-ux-logs","Team:obs-ux-infra_services","Project:OneDiscover"],"title":"[Discover] Support overriding `solutionNavId` used for root profile resolution in embeddable","number":205986,"url":"https://github.com/elastic/kibana/pull/205986","mergeCommit":{"message":"[Discover] Support overriding `solutionNavId` used for root profile resolution in embeddable (#205986)\n\n## Summary\r\n\r\nThis PR adds support for overriding the `solutionNavId` used for root\r\nprofile resolution within the Discover embeddable, allowing consumers to\r\nforce specific root profiles. Additionally the current usages of\r\n`LazySavedSearchComponent` within Observability apps have been updated\r\nto pass `solutionNavIdOverride: 'oblt'` to ensure their embedded logs\r\ncomponents render in logs mode as expected.\r\n\r\nResolves #203121.\r\n\r\n### Checklist\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/src/platform/packages/shared/kbn-i18n/README.md)\r\n- [x]\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- [ ] 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 was checked for breaking HTTP API changes, and any breaking\r\nchanges have been approved by the breaking-change committee. The\r\n`release_note:breaking` label should be applied in these situations.\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- [x] The PR description includes the appropriate Release Notes section,\r\nand the correct `release_note:*` label is applied per the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"13d4813151ff0c7cb549cf0d22565a1f9d46fb68"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/205986","number":205986,"mergeCommit":{"message":"[Discover] Support overriding `solutionNavId` used for root profile resolution in embeddable (#205986)\n\n## Summary\r\n\r\nThis PR adds support for overriding the `solutionNavId` used for root\r\nprofile resolution within the Discover embeddable, allowing consumers to\r\nforce specific root profiles. Additionally the current usages of\r\n`LazySavedSearchComponent` within Observability apps have been updated\r\nto pass `solutionNavIdOverride: 'oblt'` to ensure their embedded logs\r\ncomponents render in logs mode as expected.\r\n\r\nResolves #203121.\r\n\r\n### Checklist\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/src/platform/packages/shared/kbn-i18n/README.md)\r\n- [x]\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- [ ] 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 was checked for breaking HTTP API changes, and any breaking\r\nchanges have been approved by the breaking-change committee. The\r\n`release_note:breaking` label should be applied in these situations.\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- [x] The PR description includes the appropriate Release Notes section,\r\nand the correct `release_note:*` label is applied per the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"13d4813151ff0c7cb549cf0d22565a1f9d46fb68"}}]}] BACKPORT--> Co-authored-by: Davis McPhee <[email protected]>
viduni94
pushed a commit
to viduni94/kibana
that referenced
this pull request
Jan 23, 2025
…esolution in embeddable (elastic#205986) ## Summary This PR adds support for overriding the `solutionNavId` used for root profile resolution within the Discover embeddable, allowing consumers to force specific root profiles. Additionally the current usages of `LazySavedSearchComponent` within Observability apps have been updated to pass `solutionNavIdOverride: 'oblt'` to ensure their embedded logs components render in logs mode as expected. Resolves elastic#203121. ### 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) - [x] [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) - [ ] 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)
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
This PR adds support for overriding the
solutionNavIdused for root profile resolution within the Discover embeddable, allowing consumers to force specific root profiles. Additionally the current usages ofLazySavedSearchComponentwithin Observability apps have been updated to passsolutionNavIdOverride: 'oblt'to ensure their embedded logs components render in logs mode as expected.Resolves #203121.
Checklist
release_note:breakinglabel should be applied in these situations.release_note:*label is applied per the guidelines