[Enterprise Search] Expose core.chrome.setIsVisible for use in Workplace Search by scottybollinger · Pull Request #95984 · elastic/kibana

scottybollinger · 2021-03-31T20:22:22Z

Summary

In Workplace Search, the Private dashboard has a requirement to hide the Kibana chrome, as non-admin users should not have access to anything in Kibana but their personal dashboard. To achieve this, we need to remove the chrome for non-organization routes. This PR uses KibanaLogic to expose core.chrome.setIsVisible to the app.

Because the place where this is triggered––the index file with the routes––is instantiated after the app chrome, there is an unwanted flash of the top bars before hiding the UI. We hide the chrome when mounting the Workplace Search app and then unhide it when the routes necessitate the chrome.

Although not in this PR (follow-up immediately following this one), this is what we are trying to achieve:

Note: Astute observers might realize that this also hides the chrome for admin users who visit their Personal dashboard. This is an expected UX intended to keep the UXes separate for Kibana/admin management and Private source administration.

Best to review with whitespace changes hidden and/or commit-by-commit.

Checklist

Unit or functional tests were updated or added to match the most common scenarios

The Workplace Search Personal dashboard needs the chrome hidden. We hide it globally here first to prevent a flash of chrome on the Personal dashboard and unhide it for admin routes, which will be in a future commit

x-pack/plugins/enterprise_search/public/applications/workplace_search/index.tsx

cee-chen · 2021-03-31T23:49:51Z

x-pack/plugins/enterprise_search/public/plugin.ts

+        // The Workplace Search Personal dashboard needs the chrome hidden. We hide it globally
+        // here first to prevent a flash of chrome on the Personal dashboard and unhide it for admin routes.


💯 This comment is great/adds tons of context!

cee-chen

I have some minor suggestions for tests/performance but they're non-blocking and can be done in a follow-up PR if you prefer!

scottybollinger · 2021-04-01T19:32:06Z

@elasticmachine merge upstream

scottybollinger · 2021-04-05T13:23:23Z

@elasticmachine merge upstream

yakhinvadim

Looks great! Thanks for making this change, Scotty, and thanks for valuable suggestions, Constance!

kibanamachine · 2021-04-05T15:27:02Z

💚 Build Succeeded

Metrics [docs]

Async chunks

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

id	before	after	diff
`enterpriseSearch`	1.9MB	1.9MB	+268.0B

Page load bundle

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

id	before	after	diff
`enterpriseSearch`	14.3KB	14.3KB	+24.0B

History

💚 Build #116914 succeeded ed249eb
💔 Build #116897 failed 07465ae
💚 Build #116647 succeeded 2766aba

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

…ace Search (elastic#95984) * Hide chrome for Workplace Search by default The Workplace Search Personal dashboard needs the chrome hidden. We hide it globally here first to prevent a flash of chrome on the Personal dashboard and unhide it for admin routes, which will be in a future commit * Add core.chrome.setIsVisible to KibanaLogic * Toggle chrome visibility for Workplace Search * Add test * Refactor to set context and chrome when pathname changes Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

kibanamachine · 2021-04-05T15:29:54Z

💚 Backport successful

✅ 7.x / #96221

This backport PR will be merged automatically after passing CI.

…ace Search (#95984) (#96221) * Hide chrome for Workplace Search by default The Workplace Search Personal dashboard needs the chrome hidden. We hide it globally here first to prevent a flash of chrome on the Personal dashboard and unhide it for admin routes, which will be in a future commit * Add core.chrome.setIsVisible to KibanaLogic * Toggle chrome visibility for Workplace Search * Add test * Refactor to set context and chrome when pathname changes Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Scotty Bollinger <scotty.bollinger@elastic.co>

…-nav * 'master' of github.com:elastic/kibana: (106 commits) [Lens] don't use eui variables for zindex (elastic#96117) Remove /src/legacy (elastic#95510) skip flaky suite (elastic#95899) [Dashboard] Fix Lens and TSVB chart tooltip positioning relative to global headers (elastic#94247) fixes a skipped management x-pack test (elastic#96178) [App Search] API logs: Add log detail flyout (elastic#96162) [tech-debt] Remove defunct opacity parameters from EUI shadow functions (elastic#96191) Add Input Controls project configuration (elastic#96238) [file upload] document file upload privileges and provide actionable UI when failures occur (elastic#95883) Revert "TS Incremental build exclude test files (elastic#95610)" (elastic#96223) [App Search] Added Sample Response section to Result Settings (elastic#95971) [Maps] Safe-erase text-field (elastic#94873) [RAC][Alert Triage][TGrid] Update the Alerts Table (TGrid) API to implement `renderCellValue` (elastic#96098) [Maps] Enable all zoom levels for all users (elastic#96093) Use plugin version in its publicPath (elastic#95945) [Enterprise Search] Expose core.chrome.setIsVisible for use in Workplace Search (elastic#95984) [Workplace Search] Add sub nav and fix rendering bugs in Personal dashboard (elastic#96100) [OBS]home page is showing incorrect value of APM throughput (tpm) (elastic#95991) [Observability] Exploratory View initial skeleton (elastic#94426) [KQL] Fixed styles of KQL textarea for the K8 theme (elastic#96190) ... # Conflicts: # x-pack/plugins/snapshot_restore/__jest__/client_integration/helpers/restore_snapshot.helpers.ts

scottybollinger added 3 commits March 31, 2021 15:14

Hide chrome for Workplace Search by default

5d7b780

The Workplace Search Personal dashboard needs the chrome hidden. We hide it globally here first to prevent a flash of chrome on the Personal dashboard and unhide it for admin routes, which will be in a future commit

Add core.chrome.setIsVisible to KibanaLogic

3de3bb8

Toggle chrome visibility for Workplace Search

2766aba

scottybollinger added Feature:Plugins release_note:skip Skip the PR/issue when compiling release notes v7.13.0 auto-backport Deprecated - use backport:version if exact versions are needed labels Mar 31, 2021

scottybollinger requested review from a team March 31, 2021 20:22

cee-chen reviewed Mar 31, 2021

View reviewed changes

x-pack/plugins/enterprise_search/public/applications/workplace_search/index.tsx Outdated Show resolved Hide resolved

cee-chen reviewed Mar 31, 2021

View reviewed changes

cee-chen approved these changes Mar 31, 2021

View reviewed changes

scottybollinger added 2 commits April 1, 2021 13:30

Add test

4310879

Refactor to set context and chrome when pathname changes

07465ae

Merge branch 'master' into scottybollinger/chrome-visibility

ed249eb

Merge branch 'master' into scottybollinger/chrome-visibility

d5ae48c

scottybollinger enabled auto-merge (squash) April 5, 2021 14:27

yakhinvadim approved these changes Apr 5, 2021

View reviewed changes

scottybollinger merged commit ea03eb1 into elastic:master Apr 5, 2021

kibanamachine mentioned this pull request Apr 5, 2021

[7.x] [Enterprise Search] Expose core.chrome.setIsVisible for use in Workplace Search (#95984) #96221

Merged

scottybollinger mentioned this pull request Apr 5, 2021

[Enterprise Search] Change order of WS plugin instantiation #96235

Closed

scottybollinger deleted the scottybollinger/chrome-visibility branch June 24, 2021 20:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Enterprise Search] Expose core.chrome.setIsVisible for use in Workplace Search#95984

[Enterprise Search] Expose core.chrome.setIsVisible for use in Workplace Search#95984
scottybollinger merged 7 commits intoelastic:masterfrom
scottybollinger:scottybollinger/chrome-visibility

scottybollinger commented Mar 31, 2021 •

edited

Loading

Uh oh!

Uh oh!

cee-chen Mar 31, 2021

Uh oh!

cee-chen left a comment

Uh oh!

scottybollinger commented Apr 1, 2021

Uh oh!

scottybollinger commented Apr 5, 2021

Uh oh!

yakhinvadim left a comment

Uh oh!

kibanamachine commented Apr 5, 2021

Uh oh!

kibanamachine commented Apr 5, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		// The Workplace Search Personal dashboard needs the chrome hidden. We hide it globally
		// here first to prevent a flash of chrome on the Personal dashboard and unhide it for admin routes.

Conversation

scottybollinger commented Mar 31, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

Uh oh!

cee-chen Mar 31, 2021

Choose a reason for hiding this comment

Uh oh!

cee-chen left a comment

Choose a reason for hiding this comment

Uh oh!

scottybollinger commented Apr 1, 2021

Uh oh!

scottybollinger commented Apr 5, 2021

Uh oh!

yakhinvadim left a comment

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented Apr 5, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

History

Uh oh!

kibanamachine commented Apr 5, 2021

💚 Backport successful

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

scottybollinger commented Mar 31, 2021 •

edited

Loading