Skip to content

Make discover tabs schema changes bwc (v2)#233807

Merged
lukasolson merged 2 commits intoelastic:mainfrom
lukasolson:discover_tabs_schema_bwc_fix_v2
Sep 3, 2025
Merged

Make discover tabs schema changes bwc (v2)#233807
lukasolson merged 2 commits intoelastic:mainfrom
lukasolson:discover_tabs_schema_bwc_fix_v2

Conversation

@lukasolson
Copy link
Copy Markdown
Contributor

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

@lukasolson lukasolson self-assigned this Sep 2, 2025
@lukasolson lukasolson added release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting Team:DataDiscovery Discover, search (data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. t// labels Sep 2, 2025
Copy link
Copy Markdown
Contributor

@davismcphee davismcphee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code-only review, LGTM 👍 Thanks for catching it! It looks like we do similar here, but afaict it seems to be done correctly in this case, right: src/platform/plugins/shared/saved_search/server/services/saved_searches/get_saved_searches.ts?

@lukasolson lukasolson changed the title Make discover tabs schema changes bwc (v2) in saved searches and add regression test Make discover tabs schema changes bwc (v2) Sep 3, 2025
@lukasolson lukasolson marked this pull request as ready for review September 3, 2025 16:26
@lukasolson lukasolson requested a review from a team as a code owner September 3, 2025 16:26
@elasticmachine
Copy link
Copy Markdown
Contributor

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

@elasticmachine
Copy link
Copy Markdown
Contributor

💚 Build Succeeded

Metrics [docs]

Page load bundle

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

id before after diff
savedSearch 11.6KB 11.6KB +21.0B

History

cc @lukasolson

@lukasolson lukasolson merged commit 8b633b1 into elastic:main Sep 3, 2025
12 checks passed
ymao1 pushed a commit to ymao1/kibana that referenced this pull request Sep 4, 2025
## 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)
- [ ] ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants