[Discover] Add support for restorable state for doc viewer flyout tabs by akowalska622 · Pull Request #249030 · elastic/kibana

akowalska622 · 2026-01-14T14:45:23Z

Summary

This pull request introduces state persistence and restoration capabilities for the DocViewer in Discover. It enables each doc viewer tab to save and restore its own state, and wires this state handling through the Redux store and all relevant components. This improves user experience by maintaining tab-specific state across navigation and document changes.

It's also prepared to save and restore any other state, apart from doc viewer tab state and gives profiles possibility to register components with restorable state.

It prepares us to specifically save Table and JSON tabs as per:
[Discover] [Unified Doc Viewer] Support restorable state in the Table doc viewer tab #248567
[Discover] [Unified Doc Viewer] Support restorable state in the JSON doc viewer tab #248568

Here you can find an example how to use it as a consumer.

Video of an example usage:

Screen.Recording.2026-01-16.at.13.12.12.mov

Acceptance criteria

Doc viewer tab state is stored within Discover's state management, scoped per tab.
Doc viewer tab state is restored when switching between Discover tabs with open flyouts.
Doc viewer tab state is cleared when the flyout is closed or the expanded document changes.
Discover profiles are able to register doc viewer tabs with restorable state.
(Optional) Discover profiles can pass initialTabState to their doc viewer tabs when calling the setExpandedDoc extension point action

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

Changes are looking good! Left some initial feedback.

src/platform/packages/shared/kbn-unified-doc-viewer/src/services/types.ts

...platform/plugins/shared/discover/public/application/main/state_management/redux/constants.ts

davismcphee

Thanks for the updates, looks great! Once we fix the conflicts from #248203 and add some tests, this looks ready to ship to me 🚀

…ewer

…thub.com:akowalska622/kibana into discover-support-restorable-state-for-doc-viewer

…ewer

elasticmachine · 2026-01-17T13:12:52Z

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

davismcphee

Latest changes look great!

Just one final ask: could you please update an example profile to use the restorable state functionality and add FTR tests for it here?

It would also probably be helpful to add some inline documentation about how consumers can use the restorable functionality to the type definition (or add it to the Unified Doc Viewer readme and link from here):

kibana/src/platform/plugins/shared/discover/public/context_awareness/types.ts

Lines 536 to 542 in 56a2f10

    
             /** 
        
              * Supports customizing the behaviour of the Discover document 
        
              * viewer flyout, such as the flyout title and available tabs 
        
              * @param params The doc viewer extension parameters 
        
              * @returns The doc viewer extension 
        
              */ 
        
             getDocViewer: (params: DocViewerExtensionParams) => DocViewerExtension;

...platform/packages/shared/kbn-unified-doc-viewer/src/components/doc_viewer/doc_viewer_tab.tsx

akowalska622 · 2026-01-19T10:06:52Z

could you please update an example profile to use the restorable state functionality

Ah this sounds like much better solution than my dedicated branch for example 😅 On it!

…thub.com:akowalska622/kibana into discover-support-restorable-state-for-doc-viewer

…ewer

akowalska622 · 2026-01-19T13:00:09Z

Thanks @davismcphee! All asks addressed. I've created a new dedicated component for a doc viewer tab with restorable state in example profile, so the original custom tab is kept leaner. When I initially added it there, I felt that too much is going on there and maybe it's worth keeping it separated, but I'm open for changes!

akowalska622 · 2026-01-19T13:02:03Z

src/platform/plugins/shared/unified_doc_viewer/README.md

-* The trace waterfall does not show in components since it's an Embeddable and we're not mocking everything out.
-* The "(X% of trace)" component is never rendered because we are not fetching parent span data.


This gets auto adjusted on save in VSC

VSC knew it was wrong 🙂

davismcphee

Excellent work on this, you're now officially our resident doc viewer expert! I'm gonna trigger a flaky test run against the new tests to be sure, but assuming that passes, this LGTM 🚀

...ofile_providers/example/example_data_source_profile/components/restorable_state_doc_view.tsx

davismcphee · 2026-01-19T19:36:48Z

src/platform/plugins/shared/unified_doc_viewer/README.md

Wonderful documentation, thank you!

davismcphee · 2026-01-19T19:36:50Z

src/platform/plugins/shared/unified_doc_viewer/README.md

-* The trace waterfall does not show in components since it's an Embeddable and we're not mocking everything out.
-* The "(X% of trace)" component is never rendered because we are not fetching parent span data.


VSC knew it was wrong 🙂

kibanamachine · 2026-01-19T21:13:04Z

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#10541

[✅] src/platform/test/functional/apps/discover/context_awareness/config.ts: 50/50 tests passed.

see run history

Co-authored-by: Davis McPhee <davismcphee@hotmail.com>

…ewer

elasticmachine · 2026-01-20T10:38:45Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 862e454

Failed CI Steps

FTR Configs #36

Test Failures

[job] [logs] FTR Configs #36 / Data Views Verify data view is created once user reach the findings page - default space

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`discover`	1982	1983	+1

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
`@kbn/unified-doc-viewer`	24	28	+4

Async chunks

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

id	before	after	diff
`discover`	1.4MB	1.4MB	-2.5KB
`unifiedDocViewer`	372.0KB	372.6KB	+548.0B
total			-2.0KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`@kbn/unified-doc-viewer`	3	4	+1

Page load bundle

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

id	before	after	diff
`discover`	25.4KB	25.4KB	+36.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/unified-doc-viewer`	26	31	+5

async chunk count

id	before	after	diff
`discover`	41	42	+1

History

💚 Build #383201 succeeded 777096b
💛 Build #382856 was flaky e47346b
💔 Build #382616 failed 7c631a7
💔 Build #382579 failed 1a6bda8
💔 Build #382345 failed 9d5c344
💔 Build #382209 failed e7534ce

cc @akowalska622

elastic#249030) ## Summary Resolves: elastic#248564 This pull request introduces state persistence and restoration capabilities for the DocViewer in Discover. It enables each doc viewer tab to save and restore its own state, and wires this state handling through the Redux store and all relevant components. This improves user experience by maintaining tab-specific state across navigation and document changes. It's also prepared to save and restore any other state, apart from doc viewer tab state and gives profiles possibility to register components with restorable state. It prepares us to specifically save `Table` and `JSON` tabs as per: [[Discover] [Unified Doc Viewer] Support restorable state in the Table doc viewer tab elastic#248567](elastic#248567) [[Discover] [Unified Doc Viewer] Support restorable state in the JSON doc viewer tab elastic#248568](elastic#248568) [Here](akowalska622@a82b54f) you can find an example how to use it as a consumer. Video of an example usage: https://github.com/user-attachments/assets/2caaaaa9-cbc0-48bb-9fe0-d9723efb3b57 ### Acceptance criteria - [x] Doc viewer tab state is stored within Discover's state management, scoped per tab. - [x] Doc viewer tab state is restored when switching between Discover tabs with open flyouts. - [x] Doc viewer tab state is cleared when the flyout is closed or the expanded document changes. - [x] Discover profiles are able to register doc viewer tabs with restorable state. - [x] (Optional) Discover profiles can pass `initialTabState` to their doc viewer tabs when calling the `setExpandedDoc` extension point action ### 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) - [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) - [ ] 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> Co-authored-by: Davis McPhee <davismcphee@hotmail.com>

akowalska622 added 2 commits January 14, 2026 15:14

clean initialDocViewerTabId when changing expanded doc

4935b75

add docViewer state to the TabState.uiState

057db78

akowalska622 self-assigned this Jan 14, 2026

akowalska622 added 2 commits January 14, 2026 15:58

clean state when necessary

68f021b

implement restorable state for doc viewer

fa48a09

davismcphee reviewed Jan 15, 2026

View reviewed changes

akowalska622 and others added 4 commits January 15, 2026 17:11

clean up default tab state

77c425e

adjust types

e7534ce

Changes from node scripts/lint_ts_projects --fix

23257fd

Changes from node scripts/regenerate_moon_projects.js --update

9d5c344

davismcphee reviewed Jan 15, 2026

View reviewed changes

akowalska622 added 3 commits January 16, 2026 11:48

Merge branch 'main' into discover-support-restorable-state-for-doc-vi…

480da1b

…ewer

Merge branch 'discover-support-restorable-state-for-doc-viewer' of gi…

9526f37

…thub.com:akowalska622/kibana into discover-support-restorable-state-for-doc-viewer

add initialTabState to setExpandedDoc extension point action

a8b9e22

akowalska622 mentioned this pull request Jan 16, 2026

[Discover] [PoC] Add initialTabState to doc viewer setExpandedDoc action akowalska622/kibana#4

Closed

10 tasks

akowalska622 and others added 5 commits January 16, 2026 13:33

revert DocViewerComponent type

ac9b3c7

Merge branch 'main' into discover-support-restorable-state-for-doc-vi…

eefdff6

…ewer

add unit tests

6c1b8fe

Merge branch 'main' into discover-support-restorable-state-for-doc-vi…

1a6bda8

…ewer

Merge branch 'main' into discover-support-restorable-state-for-doc-vi…

7c631a7

…ewer

akowalska622 requested a review from davismcphee January 16, 2026 15:44

Merge branch 'main' into discover-support-restorable-state-for-doc-vi…

e47346b

…ewer

akowalska622 marked this pull request as ready for review January 17, 2026 13:12

akowalska622 requested a review from a team as a code owner January 17, 2026 13:12

davismcphee reviewed Jan 19, 2026

View reviewed changes

...platform/packages/shared/kbn-unified-doc-viewer/src/components/doc_viewer/doc_viewer_tab.tsx Outdated Show resolved Hide resolved

akowalska622 and others added 6 commits January 19, 2026 11:30

remove redundant useMemo

776b0ba

add restorable state example to example profile

4360b58

add FTR for example of restorable state doc view

0f8de49

add documentation for restorable doc viewer state

abfa484

Merge branch 'discover-support-restorable-state-for-doc-viewer' of gi…

f623ce5

…thub.com:akowalska622/kibana into discover-support-restorable-state-for-doc-viewer

Merge branch 'main' into discover-support-restorable-state-for-doc-vi…

777096b

…ewer

akowalska622 requested a review from davismcphee January 19, 2026 12:58

akowalska622 commented Jan 19, 2026

View reviewed changes

davismcphee approved these changes Jan 19, 2026

View reviewed changes

akowalska622 and others added 2 commits January 20, 2026 09:56

fix wrong naming for restorable doc viewer example

1fb2bfc

Co-authored-by: Davis McPhee <davismcphee@hotmail.com>

Merge branch 'main' into discover-support-restorable-state-for-doc-vi…

862e454

…ewer

akowalska622 merged commit 817a1b3 into elastic:main Jan 20, 2026
16 checks passed

kibanamachine added the v9.4.0 label Jan 20, 2026

iblancof mentioned this pull request Jan 30, 2026

[Discover][Traces] Keep waterfall flyout when switching tabs #251107

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Discover] Add support for restorable state for doc viewer flyout tabs#249030

[Discover] Add support for restorable state for doc viewer flyout tabs#249030
akowalska622 merged 25 commits intoelastic:mainfrom
akowalska622:discover-support-restorable-state-for-doc-viewer

akowalska622 commented Jan 14, 2026 •

edited

Loading

davismcphee left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

davismcphee left a comment

elasticmachine commented Jan 17, 2026

davismcphee left a comment

Uh oh!

akowalska622 commented Jan 19, 2026

akowalska622 commented Jan 19, 2026

akowalska622 Jan 19, 2026

davismcphee Jan 19, 2026

davismcphee left a comment

Uh oh!

davismcphee Jan 19, 2026

davismcphee Jan 19, 2026

kibanamachine commented Jan 19, 2026

elasticmachine commented Jan 20, 2026

API count

async chunk count

Uh oh!

Labels

4 participants

	/**
	* Supports customizing the behaviour of the Discover document
	* viewer flyout, such as the flyout title and available tabs
	* @param params The doc viewer extension parameters
	* @returns The doc viewer extension
	*/
	getDocViewer: (params: DocViewerExtensionParams) => DocViewerExtension;

		* The trace waterfall does not show in components since it's an Embeddable and we're not mocking everything out.
		* The "(X% of trace)" component is never rendered because we are not fetching parent span data.

Conversation

akowalska622 commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Acceptance criteria

Checklist

Identify risks

davismcphee left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

davismcphee left a comment

Choose a reason for hiding this comment

elasticmachine commented Jan 17, 2026

davismcphee left a comment

Choose a reason for hiding this comment

Uh oh!

akowalska622 commented Jan 19, 2026

akowalska622 commented Jan 19, 2026

akowalska622 Jan 19, 2026

Choose a reason for hiding this comment

davismcphee Jan 19, 2026

Choose a reason for hiding this comment

davismcphee left a comment

Choose a reason for hiding this comment

Uh oh!

davismcphee Jan 19, 2026

Choose a reason for hiding this comment

davismcphee Jan 19, 2026

Choose a reason for hiding this comment

kibanamachine commented Jan 19, 2026

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#10541

elasticmachine commented Jan 20, 2026

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

API count

async chunk count

History

Uh oh!

Labels

4 participants

akowalska622 commented Jan 14, 2026 •

edited

Loading