Consume new `tabs` shape in Discover & saved search embeddable by lukasolson · Pull Request #229897 · elastic/kibana

lukasolson · 2025-07-29T23:50:08Z

Summary

Part of #219268.
Follow-up to #228115.

Marks tabs as required inside SavedSearchAttributes. Moves consumers (content management APIs & embeddables) to use the new tabs field and treat the field as required. Preserves the code that syncs these two shapes of data. After this PR is merged, wait for the next serverless release before merging the next step.

This is just a temporary step in moving the discover session attributes (such as grid, columns) from the top level to the tabs array. As of this step, we are still duplicating the attributes & syncing them (for backwards compatibility). In a future step we will completely remove them from the top level & only read them from the tabs array.

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests 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
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 was used on any tests changed
The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines
Review the backport guidelines and apply applicable backport:* labels.

Identify risks

Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

See some risk examples
...

davismcphee · 2025-08-07T02:10:16Z

@lukasolson I didn't get to review the current changes thoroughly, but I took a quick look through and in general they seem good to me. We'll definitely have some conflicts with the save and load PR, but nothing that seems totally incompatible.

elasticmachine · 2025-08-11T05:30:38Z

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

elasticmachine · 2025-08-11T20:08:37Z

Pinging @elastic/fleet (Team:Fleet)

jughosta

I tested this branch and didn't notice any new issues 👏

Noticed an issue though which is also present on main: #231430
Now wonder if it has something to do with our recent changes to saved search (discover session) or with how Dashboard manages references.

TinaHeiligers

plugin manifest files LGTM

csr

Code review only, AppEx QA changes LGTM

peteharverson

Changes to the ML tests LGTM

achyutjhunjhunwala

Code review only for Logs, LGTM 👍🏼

x-pack/platform/plugins/shared/fleet/kibana.jsonc

elasticmachine · 2025-08-13T13:07:07Z

💚 Build Succeeded

Buildkite Build
Commit: b4a119b

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`savedSearch`	65	66	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`apm`	2.6MB	2.6MB	+70.0B
`discover`	1.1MB	1.1MB	+24.0B
`fleet`	2.1MB	2.1MB	+70.0B
`infra`	1.0MB	1.0MB	+69.0B
`logsShared`	203.1KB	203.2KB	+69.0B
total			+302.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`apm`	34.3KB	34.4KB	+141.0B
`fleet`	170.9KB	171.1KB	+141.0B
`infra`	50.0KB	50.1KB	+140.0B
`logsShared`	90.3KB	90.5KB	+140.0B
`savedSearch`	11.6KB	11.6KB	+36.0B
total			+598.0B

Unknown metric groups

API count

id	before	after	diff
`savedSearch`	68	69	+1

History

💛 Build #328762 was flaky a3563ee
💔 Build #328596 failed 3640d22
💔 Build #328539 failed 9c869a9
💛 Build #328145 was flaky 7a13356
💔 Build #328130 failed 67a4f14
💔 Build #328101 failed b8b3101

cc @lukasolson

…ic#229897) ## Summary Part of elastic#219268. Follow-up to elastic#228115. Marks `tabs` as required inside `SavedSearchAttributes`. Moves consumers (content management APIs & embeddables) to use the new `tabs` field and treat the field as required. Preserves the code that syncs these two shapes of data. After this PR is merged, wait for the next serverless release before merging the next step. This is just a temporary step in moving the discover session attributes (such as `grid`, `columns`) from the top level to the `tabs` array. As of this step, we are still duplicating the attributes & syncing them (for backwards compatibility). In a future step we will completely remove them from the top level & only read them from the `tabs` array. ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] 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 - [ ] [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 - [ ] 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) - [ ] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) - [ ] ... --------- Co-authored-by: Matthias Wilhelm <matthias.wilhelm@elastic.co>

## Summary While working on #232441 I realized that removing the top-level attributes from the discover session saved object is not actually currently bwc with main as of #229897 being merged. This PR introduces new types so that actually removing the attributes (which will be done in #232441) does not break backwards compatibility. ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] 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 - [ ] [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 - [ ] 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) - [ ] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) - [ ] ... --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

## Summary While working on elastic#232441 I realized that removing the top-level attributes from the discover session saved object is not actually currently bwc with main as of elastic#229897 being merged. This PR introduces new types so that actually removing the attributes (which will be done in elastic#232441) does not break backwards compatibility. ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] 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 - [ ] [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 - [ ] 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) - [ ] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) - [ ] ... --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

Consume new tabs shape in Discover & saved search embeddable

1e970fc

lukasolson self-assigned this Jul 29, 2025

lukasolson added Team:DataDiscovery Discover, search (data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. t// release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting labels Jul 29, 2025

lukasolson added 6 commits July 30, 2025 10:53

Fix types & tests

1e4bda9

Merge branch 'main' into discover_tabs_schema_consume

6ae5098

Fix functional tests

2c277d6

Re-add attributes to top level

7c23965

Merge branch 'main' into discover_tabs_schema_consume

8df5f62

Copy attributes back in top level

b3a830b

lukasolson added 7 commits August 6, 2025 22:01

Fix saved search json

ccdd806

Merge branch 'main' into discover_tabs_schema_consume

1bb2276

Fix incorrect copy/paste

6c71824

Merge branch 'main' into discover_tabs_schema_consume

6384802

Fix test data that was messed up

b8b3101

Fix saved search component

67a4f14

Add required plugins

7a13356

lukasolson marked this pull request as ready for review August 11, 2025 05:30

lukasolson requested review from a team as code owners August 11, 2025 05:30

kertal added the Feature:Discover Discover Application label Aug 11, 2025

Merge branch 'main' into discover_tabs_schema_consume

9c869a9

botelastic bot added the Team:Fleet Team label for Observability Data Collection Fleet team label Aug 11, 2025

Merge branch 'main' into discover_tabs_schema_consume

3640d22

jughosta approved these changes Aug 12, 2025

View reviewed changes

Merge branch 'main' into discover_tabs_schema_consume

a3563ee

TinaHeiligers approved these changes Aug 12, 2025

View reviewed changes

csr approved these changes Aug 13, 2025

View reviewed changes

peteharverson approved these changes Aug 13, 2025

View reviewed changes

achyutjhunjhunwala approved these changes Aug 13, 2025

View reviewed changes

Merge branch 'main' into discover_tabs_schema_consume

b4a119b

kertal reviewed Aug 13, 2025

View reviewed changes

x-pack/platform/plugins/shared/fleet/kibana.jsonc Show resolved Hide resolved

lukasolson merged commit c23ae35 into elastic:main Aug 13, 2025
12 checks passed

kibanamachine added the v9.2.0 label Aug 13, 2025

This was referenced Aug 21, 2025

Remove redundant tabs attributes from Discover Session saved object #232441

Closed

Make discover tabs schema changes bwc #232697

Merged

davismcphee mentioned this pull request Oct 6, 2025

[Discover] Discover session saved object schema with tabs breaks usages of deprecated saved objects API #237703

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Consume new `tabs` shape in Discover & saved search embeddable#229897

Consume new `tabs` shape in Discover & saved search embeddable#229897
lukasolson merged 18 commits intoelastic:mainfrom
lukasolson:discover_tabs_schema_consume

lukasolson commented Jul 29, 2025 •

edited

Loading

Uh oh!

davismcphee commented Aug 7, 2025

Uh oh!

elasticmachine commented Aug 11, 2025

Uh oh!

elasticmachine commented Aug 11, 2025

Uh oh!

jughosta left a comment

Uh oh!

TinaHeiligers left a comment

Uh oh!

csr left a comment •

edited

Loading

Uh oh!

peteharverson left a comment

Uh oh!

achyutjhunjhunwala left a comment •

edited

Loading

Uh oh!

Uh oh!

elasticmachine commented Aug 13, 2025

API count

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

Conversation

lukasolson commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Identify risks

Uh oh!

davismcphee commented Aug 7, 2025

Uh oh!

elasticmachine commented Aug 11, 2025

Uh oh!

elasticmachine commented Aug 11, 2025

Uh oh!

jughosta left a comment

Choose a reason for hiding this comment

Uh oh!

TinaHeiligers left a comment

Choose a reason for hiding this comment

Uh oh!

csr left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

peteharverson left a comment

Choose a reason for hiding this comment

Uh oh!

achyutjhunjhunwala left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

elasticmachine commented Aug 13, 2025

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

Page load bundle

API count

History

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

lukasolson commented Jul 29, 2025 •

edited

Loading

csr left a comment •

edited

Loading

achyutjhunjhunwala left a comment •

edited

Loading