Make discover tabs schema changes bwc by lukasolson · Pull Request #232697 · elastic/kibana

lukasolson · 2025-08-22T19:14:56Z

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, 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
...

lukasolson · 2025-08-22T19:44:18Z

src/platform/plugins/shared/saved_search/server/saved_objects/schema.ts

+
+// Mark top-level attributes (except title and description) optional, and mark tabs as required
+export const SCHEMA_SEARCH_MODEL_VERSION_7 = SCHEMA_SEARCH_MODEL_VERSION_6.extends({
+  columns: schema.maybe(columns),


This only includes the properties that were not already marked as optional (schema.maybe).

… src/core/server/integration_tests/ci_checks'

elasticmachine · 2025-08-24T14:13:59Z

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

elasticmachine · 2025-08-25T17:35:53Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: c694565

Failed CI Steps

FTR Configs #97

Test Failures

[job] [logs] FTR Configs #97 / serverless search UI - feature flags Search Playground - Saved Playgrounds Create a Saved Playground should allow saving playground

Metrics [docs]

✅ unchanged

History

💚 Build #331957 succeeded 70f532b
💔 Build #331923 failed a69945d

cc @lukasolson

… src/core/server/integration_tests/ci_checks'

davismcphee

Tested locally:

Saving a new session.
Loading and updating an existing session.
Importing a session from an older version, loading and updating.
Importing a dashboard containing both a by ref and by value session from an older version, unlinking and linking session panels to the library, and updating the dashboard.

Worked as expected in all scenarios, LGTM 👍

## 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>

## Summary This PR ensures backward compatibility for saved searches where `kibanaSavedObjectMeta` exists only inside a tab and not at the top-level attributes. Prior to this change, the updates in #232441 would not have been fully BWC, potentially causing issues when loading older saved objects. This PR verifies that the search source JSON is properly initialized in such cases and is not an empty object. This is a follow-up to #232697, further strengthening BWC guarantees for Discover saved searches with tabs. ### 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) - [ ] ...

## Summary This PR ensures backward compatibility for saved searches where `kibanaSavedObjectMeta` exists only inside a tab and not at the top-level attributes. Prior to this change, the updates in elastic#232441 would not have been fully BWC, potentially causing issues when loading older saved objects. This PR verifies that the search source JSON is properly initialized in such cases and is not an empty object. This is a follow-up to elastic#232697, further strengthening BWC guarantees for Discover saved searches with tabs. ### 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) - [ ] ...

Make discover tabs schema changes bwc

f7fb611

lukasolson self-assigned this Aug 22, 2025

lukasolson added the Team:DataDiscovery Discover, search (data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. t// label Aug 22, 2025

Include previous saved object schema

a69945d

lukasolson commented Aug 22, 2025

View reviewed changes

[CI] Auto-commit changed files from 'node scripts/jest_integration -u…

70f532b

… src/core/server/integration_tests/ci_checks'

lukasolson marked this pull request as ready for review August 24, 2025 14:13

lukasolson requested review from a team as code owners August 24, 2025 14:13

Merge branch 'main' into discover_tabs_schema_bwc_fix

c694565

lukasolson added release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting labels Aug 25, 2025

lukasolson and others added 3 commits August 25, 2025 12:17

Merge branch 'main' into discover_tabs_schema_bwc_fix

5109de5

Add entry for saved search object schema

7da48be

[CI] Auto-commit changed files from 'node scripts/jest_integration -u…

e70b8fc

… src/core/server/integration_tests/ci_checks'

davismcphee approved these changes Aug 25, 2025

View reviewed changes

lukasolson mentioned this pull request Aug 25, 2025

Remove redundant tabs attributes from Discover Session saved object #232441

Closed

10 tasks

afharo approved these changes Aug 26, 2025

View reviewed changes

lukasolson merged commit 789b51d into elastic:main Aug 27, 2025
12 checks passed

kibanamachine added the v9.2.0 label Aug 27, 2025

lukasolson mentioned this pull request Sep 2, 2025

Make discover tabs schema changes bwc (v2) #233807

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make discover tabs schema changes bwc#232697

Make discover tabs schema changes bwc#232697
lukasolson merged 7 commits intoelastic:mainfrom
lukasolson:discover_tabs_schema_bwc_fix

lukasolson commented Aug 22, 2025

Uh oh!

lukasolson Aug 22, 2025 •

edited

Loading

Uh oh!

elasticmachine commented Aug 24, 2025

Uh oh!

elasticmachine commented Aug 25, 2025

Uh oh!

davismcphee left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

lukasolson commented Aug 22, 2025

Summary

Checklist

Identify risks

Uh oh!

lukasolson Aug 22, 2025 • 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!

elasticmachine commented Aug 24, 2025

Uh oh!

elasticmachine commented Aug 25, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

History

Uh oh!

davismcphee left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

lukasolson Aug 22, 2025 •

edited

Loading