[Dashboard] Transfer state when drilldown is opened in a new tab #124770

Heenawter · 2022-02-05T01:06:59Z

Summary

The current way of following through with a dashboard-to-dashboard drilldown is to exclusively use the Dashboard router - however, since this relies on in-memory storage, this fails when the user opens the drilldown in a new tab. To get around this, we have gone back to using URL state transfer only when the drilldown is opened in a new tab (i.e. when the getHref action is called; the onClick action remains unchanged) - this allows state to be fully transferred even when the session storage and/or in-memory storage is lost.

Video of Fix

2022-02-07_Dash2Dash-Drilldown-New-Tab.mp4

How I Tested

I tested multiple configurations of source/destination dashboards to ensure that all elements of state where transferred:

Use date range from origin dashboard
- Source has no filters
  ✅ Destination has no filters
  ✅ Destination has unique local filter
- Source has local filter
  ✅ Destination has no filters
  ✅ Destination has unique local filter
  ✅ Destination shares local filter with source
Don't use date range from origin dashboard
- Source has no filters
  ✅ Destination has no filters
  ✅ Destination has unique local filter
- Source has local filter
  ✅ Destination has no filters
  ✅ Destination has unique local filter
  ✅ Destination shares local filter with source

Note, however, that there is a bug where the unsaved changes badge won't go away for dashboard to dashboard drilldowns (fixed in #124278 which is currently not merged) - so, with all of the above tests, this bug was still present; I was simply verifying that the state was transferred as expected.

Checklist

Unit or functional tests were updated or added to match the most common scenarios
This was checked for cross-browser compatibility

…lldown_2022-02-04

…er/kibana into fix_new_tab_drilldown_2022-02-04

kibana-ci · 2022-02-11T21:23:52Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`dashboardEnhanced`	32	88	+56

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
`dashboard`	136	138	+2
`dashboardEnhanced`	50	51	+1
total			+3

Page load bundle

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

id	before	after	diff
`dashboard`	65.8KB	65.8KB	+83.0B
`dashboardEnhanced`	14.2KB	41.3KB	+27.1KB
total			+27.2KB

Unknown metric groups

API count

id	before	after	diff
`dashboard`	138	140	+2
`dashboardEnhanced`	51	52	+1
total			+3

References to deprecated APIs

id	before	after	diff
`dashboardEnhanced`	13	0	-13

Unreferenced deprecated APIs

id	before	after	diff
`data`	68	70	+2

History

💚 Build #23558 succeeded b1152fc
💚 Build #22825 succeeded 1559e9a
💚 Build #22650 succeeded 8b1c8fc
💚 Build #22238 succeeded 67f72fa
💚 Build #22177 succeeded 9f8bc2b864b3ea8a8c14337ea4f430cfd00a222a
💔 Build #21999 failed 877b816d4af34b279e1111725215c9f66ef9784a

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @Heenawter

kibanamachine · 2022-02-11T21:30:17Z

💔 All backports failed

Status	Branch	Result
❌	8.1	Backport failed because of merge conflicts
❌	7.16	Backport failed because of merge conflicts
❌	8.0	Backport failed because of merge conflicts
❌	7.17	Backport failed because of merge conflicts

How to fix

Re-run the backport manually:

node scripts/backport --pr 124770

Questions ?

Please refer to the Backport tool documentation

kibanamachine · 2022-02-15T21:36:18Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 124770 or prevent reminders by adding the backport:skip label.

…stic#124770) * Translate dashboard state to URL conditionally * Add functional tests * Fix typo in functional test descriptions * Remove deprecated references * Rename useUrl to be more specific (cherry picked from commit 17a997c) # Conflicts: # src/plugins/dashboard/public/index.ts

…4770) (#125726) * Translate dashboard state to URL conditionally * Add functional tests * Fix typo in functional test descriptions * Remove deprecated references * Rename useUrl to be more specific (cherry picked from commit 17a997c) # Conflicts: # src/plugins/dashboard/public/index.ts

…stic#124770) * Translate dashboard state to URL conditionally * Add functional tests * Fix typo in functional test descriptions * Remove deprecated references * Rename useUrl to be more specific (cherry picked from commit 17a997c) # Conflicts: # src/plugins/dashboard/public/index.ts

#124770) (#125740) * [Dashboard] Transfer state when drilldown is opened in a new tab (#124770) * Translate dashboard state to URL conditionally * Add functional tests * Fix typo in functional test descriptions * Remove deprecated references * Rename useUrl to be more specific (cherry picked from commit 17a997c) # Conflicts: # src/plugins/dashboard/public/index.ts * Fix lint

reuvenik · 2022-08-03T09:40:21Z

Hi.
We have version 7.16 of Kibana and have this issue.
I see it was fixed for version 8. when it will be fixed for 7.16?

ThomThomson · 2022-08-03T14:10:35Z

Hi @reuvenik! We aren't planning on releasing any more patches for 7.16. Additionally, this fix was only backported as far as 8.0.

reuvenik · 2022-08-07T07:38:06Z

7.17 is must as per your official documentation.
can this be done there so we be able to upgrade minor version and not major version to get this fix?

Heenawter · 2022-08-08T14:55:27Z

💚 All backports created successfully

Status	Branch	Result
✅	7.17

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…stic#124770) * Translate dashboard state to URL conditionally * Add functional tests * Fix typo in functional test descriptions * Remove deprecated references * Rename useUrl to be more specific (cherry picked from commit 17a997c) # Conflicts: # src/plugins/dashboard/public/index.ts

Heenawter · 2022-08-08T17:31:25Z

@reuvenik This has now been backported to 7.17 - hopefully that helps :)

reuvenik · 2022-08-08T17:51:37Z

Very helpful.
Thanks!

…ab (elastic#124770) (elastic#138278) * [Dashboard] Transfer state when drilldown is opened in a new tab (elastic#124770) * Translate dashboard state to URL conditionally * Add functional tests * Fix typo in functional test descriptions * Remove deprecated references * Rename useUrl to be more specific (cherry picked from commit 17a997c) # Conflicts: # src/plugins/dashboard/public/index.ts * Fix conflicts Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Heenawter self-assigned this Feb 5, 2022

Heenawter added the v7.17.1 label Feb 5, 2022

Heenawter force-pushed the fix_new_tab_drilldown_2022-02-04 branch 3 times, most recently from 9f8bc2b to 3d2f192 Compare February 7, 2022 18:46

Translate dashboard state to URL conditionally

550ce12

Heenawter force-pushed the fix_new_tab_drilldown_2022-02-04 branch from 3d2f192 to 550ce12 Compare February 7, 2022 18:53

Merge branch 'main' of github.com:elastic/kibana into fix_new_tab_dri…

67f72fa

…lldown_2022-02-04

qn895 mentioned this pull request Feb 7, 2022

[Dashboard] Remove URL Generator #121832

Merged

Heenawter added bug Fixes for quality problems that affect the customer experience release_note:skip Skip the PR/issue when compiling release notes v8.2.0 v7.17.0 labels Feb 7, 2022

Heenawter and others added 3 commits February 8, 2022 14:56

Add functional tests

180b6f9

Merge branch 'main' of github.com:elastic/kibana into fix_new_tab_dri…

930438a

…lldown_2022-02-04

Merge branch 'main' into fix_new_tab_drilldown_2022-02-04

8b1c8fc

Heenawter removed release_note:skip Skip the PR/issue when compiling release notes v7.16.0 v7.17.0 v7.16.1 labels Feb 9, 2022

Heenawter added 2 commits February 11, 2022 12:50

Rename useUrl to be more specific

d946669

Merge branch 'fix_new_tab_drilldown_2022-02-04' of github.com:heenawt…

cffe71c

…er/kibana into fix_new_tab_drilldown_2022-02-04

Heenawter merged commit 17a997c into elastic:main Feb 11, 2022

Heenawter deleted the fix_new_tab_drilldown_2022-02-04 branch February 11, 2022 21:27

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Feb 15, 2022

Heenawter mentioned this pull request Feb 15, 2022

[8.1] [Dashboard] Transfer state when drilldown is opened in a new tab (#124770) #125726

Merged

kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Feb 15, 2022

Heenawter mentioned this pull request Feb 15, 2022

[8.0] [Dashboard] Transfer state when drilldown is opened in a new tab (#124770) #125740

Merged

ThomThomson mentioned this pull request Feb 16, 2022

option to open dashboard drilldown in new tab/window #122233

Closed

Heenawter added v7.16.4 and removed v7.16.3 v7.17.1 v7.16.4 labels Feb 16, 2022

Heenawter mentioned this pull request Aug 8, 2022

[7.17] [Dashboard] Transfer state when drilldown is opened in a new tab (#124770) #138278

Merged

kibanamachine added the v7.17.6 label Aug 8, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Dashboard] Transfer state when drilldown is opened in a new tab #124770

[Dashboard] Transfer state when drilldown is opened in a new tab #124770

Heenawter commented Feb 5, 2022 •

edited

Loading

kibana-ci commented Feb 11, 2022

API count

References to deprecated APIs

Unreferenced deprecated APIs

kibanamachine commented Feb 11, 2022

kibanamachine commented Feb 15, 2022

reuvenik commented Aug 3, 2022

ThomThomson commented Aug 3, 2022

reuvenik commented Aug 7, 2022

Heenawter commented Aug 8, 2022

Heenawter commented Aug 8, 2022

reuvenik commented Aug 8, 2022

[Dashboard] Transfer state when drilldown is opened in a new tab #124770

[Dashboard] Transfer state when drilldown is opened in a new tab #124770

Conversation

Heenawter commented Feb 5, 2022 • edited Loading

Summary

Video of Fix

How I Tested

Checklist

kibana-ci commented Feb 11, 2022

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Page load bundle

API count

References to deprecated APIs

Unreferenced deprecated APIs

History

kibanamachine commented Feb 11, 2022

💔 All backports failed

How to fix

Questions ?

kibanamachine commented Feb 15, 2022

reuvenik commented Aug 3, 2022

ThomThomson commented Aug 3, 2022

reuvenik commented Aug 7, 2022

Heenawter commented Aug 8, 2022

💚 All backports created successfully

Questions ?

Heenawter commented Aug 8, 2022

reuvenik commented Aug 8, 2022

Heenawter commented Feb 5, 2022 •

edited

Loading