[Enterprise Search] Remove all instances of KibanaContext to Kea store #78513

cee-chen · 2020-09-24T22:02:48Z

Summary

This is it, y'all!!! We've reached the endgame (well, there's still one more PR after this that handles sharing our store between our main app and our header app, but that won't require two teams to approve :)

Wow, such kea. much slim

Changelog

KibanaLogic now stores the following Kibana APIs:
- config (not an API and doesn't update dynamically, but it seemed to fall under the general "comes from Kibana" bucket)
- navigateToUrl
- setBreadcrumbs
- setDocTitle
- (future: setHeaderActionMenu - this will be in the next PR 🎉)

As always, I recommend following along by commit! There's a lot of files touched + test refactors in there.

QA/Regression testing

Nothing crashes
Breadcrumb navigation should work as before
Document titles should still be set

Checklist

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

…seeffect - The file is now no longer used to mock useContext, only unseEffect, hence the rename

- Remove mountWithKibanaContext completely - Change mountWithContext to mountWithIntl, since that's the only context remaining, and move it to its own file - Change mountWithAsyncContext to just mountAsync and move it to its own file + add an option to pair it w/ mountWithIntl for formatted date/number support

+ minor newline linting/grouping tweaks

cee-chen · 2020-09-24T22:08:24Z

x-pack/plugins/enterprise_search/public/applications/shared/kibana/kibana_logic.ts

+export const KibanaLogic = kea<MakeLogicType<IKibanaValues>>({
+  path: ['enterprise_search', 'kibana_logic'],
+  reducers: ({ props }) => ({
+    config: [props.config || {}, {}],
+    navigateToUrl: [props.navigateToUrl, {}],
+    setBreadcrumbs: [props.setBreadcrumbs, {}],
+    setDocTitle: [props.setDocTitle, {}],
+  }),
+});


Similar to the previous externalUrl PR, I also felt kinda weird that this store essentially just holds some variables that never update or require state, but in the end I decided to stay with a Kea logic file here because:

It's familiar

It's way easier to mock in tests since we already have the mocks/architecture set up

Admittedly those aren't like, super strong reasons heh, so if I'm definitely open to better paradigms if we think of them or if they come up down the road.

cee-chen · 2020-09-28T15:11:55Z

@elasticmachine merge upstream

cee-chen · 2020-09-28T16:06:47Z

@elasticmachine merge upstream

scottybollinger

This is so great! Thanks for doing it!

kibanamachine · 2020-09-28T17:39:01Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: f951152

Metrics [docs]

@kbn/optimizer bundle module count

id	value	diff	baseline
enterpriseSearch	249	+2	247

async chunks size

id	value	diff	baseline
enterpriseSearch	472.5KB	-16.8KB	489.2KB

page load bundle size

id	value	diff	baseline
enterpriseSearch	21.7KB	+3.0B	21.7KB

History

💔 Build #77470 failed aec8adf
💚 Build #77145 succeeded 1f6f4e4

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

JasonStoltz · 2020-09-28T18:05:48Z

x-pack/plugins/enterprise_search/public/applications/shared/kibana/kibana_logic.ts

+
+export const KibanaLogic = kea<MakeLogicType<IKibanaValues>>({
+  path: ['enterprise_search', 'kibana_logic'],
+  reducers: ({ props }) => ({


Nice. I didn't realize you could initialize logic with props like this.

Yeah! https://kea.js.org/docs/guide/additional/#props

Although as a warning (I think I mentioned this a few PRs back, but repeating it just as an fyi) if you set a value default to a passed prop without any fallbacks (e.g. someVar: [props.someVar, {}],), if you ever mount without passing a someVar prop the entire Kea/redux instance will error/crash. It's a good way of making sure you always have the data you need I guess? 😄

JasonStoltz

LGTM.

elastic#78513) * Add KibanaLogic store/mount * Update usage of setBreadcrumbs/setDocTitle to KibanaLogic * Update usage of Kibana config context to KibanaLogic * Update usage of navigateToUrl context to KibanaLogic * 🔥 Remove unused shallow_usecontext mocks, repurpose file to shallow_useeffect - The file is now no longer used to mock useContext, only unseEffect, hence the rename * 🔥 Delete/repurpose mount with context helpers - Remove mountWithKibanaContext completely - Change mountWithContext to mountWithIntl, since that's the only context remaining, and move it to its own file - Change mountWithAsyncContext to just mountAsync and move it to its own file + add an option to pair it w/ mountWithIntl for formatted date/number support * 🔥 Delete KibanaContext and mockKibanaContext + minor newline linting/grouping tweaks Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

#78513) (#78692) * Add KibanaLogic store/mount * Update usage of setBreadcrumbs/setDocTitle to KibanaLogic * Update usage of Kibana config context to KibanaLogic * Update usage of navigateToUrl context to KibanaLogic * 🔥 Remove unused shallow_usecontext mocks, repurpose file to shallow_useeffect - The file is now no longer used to mock useContext, only unseEffect, hence the rename * 🔥 Delete/repurpose mount with context helpers - Remove mountWithKibanaContext completely - Change mountWithContext to mountWithIntl, since that's the only context remaining, and move it to its own file - Change mountWithAsyncContext to just mountAsync and move it to its own file + add an option to pair it w/ mountWithIntl for formatted date/number support * 🔥 Delete KibanaContext and mockKibanaContext + minor newline linting/grouping tweaks Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

…a into add-anomalies-to-timeline * 'add-anomalies-to-timeline' of github.com:phillipb/kibana: (89 commits) Aligns several module versions across the repository (elastic#78327) Empty prompt and loading spinner for service map (elastic#78382) Change progress bar to spinner (elastic#78460) [QA][Code Coverage] Coverage teams lookup w/o Additional Config (elastic#77111) Slim down core bundle (elastic#75912) [Alerting] retry internal OCC calls within alertsClient (elastic#77838) [kbn/optimizer] only build xpack examples when building xpack plugins (elastic#78656) [Ingest Manager] Ingest setup upgrade (elastic#78081) [Ingest Manager] Surface saved object client 10,000 limitation to bulk actions UI (elastic#78520) fix name without a category or if field end with .text (elastic#78655) [Security Solution] [Detections] Log message enhancements (elastic#78429) [ML]DF Analytics exploration: default filter of results page by `defaultIsTraining` value in url (elastic#78303) [Enterprise Search] Remove all instances of KibanaContext to Kea store (elastic#78513) [ML] DF Analytics creation: ensure job did not fail to start before showing results link (elastic#78200) fix createAppNavigationHandler to use `navigateToUrl` (elastic#78583) Fixing a11y test failure on discover app (elastic#59975) (elastic#77614) [Security Solution] Initiate endpoint package upgrade from security app (elastic#77498) [kbn/es] use a basic build process (elastic#78090) [kbn/optimizer] fix .json extension handling (elastic#78524) Fix APM lodash imports (elastic#78438) ...

cee-chen added 7 commits September 24, 2020 14:39

Add KibanaLogic store/mount

dde8773

Update usage of setBreadcrumbs/setDocTitle to KibanaLogic

2cbb9a0

Update usage of Kibana config context to KibanaLogic

b29ccd9

Update usage of navigateToUrl context to KibanaLogic

742ecf9

🔥 Remove unused shallow_usecontext mocks, repurpose file to shallow_u…

167bf07

…seeffect - The file is now no longer used to mock useContext, only unseEffect, hence the rename

🔥 Delete KibanaContext and mockKibanaContext

1f6f4e4

+ minor newline linting/grouping tweaks

cee-chen added Feature:Plugins release_note:skip Skip the PR/issue when compiling release notes v7.10.0 labels Sep 24, 2020

cee-chen requested review from a team September 24, 2020 22:02

cee-chen commented Sep 24, 2020

View reviewed changes

Merge branch 'master' into context-to-kea

aec8adf

Merge branch 'master' into context-to-kea

f951152

scottybollinger approved these changes Sep 28, 2020

View reviewed changes

JasonStoltz reviewed Sep 28, 2020

View reviewed changes

JasonStoltz approved these changes Sep 28, 2020

View reviewed changes

cee-chen merged commit 3e426a0 into elastic:master Sep 28, 2020

cee-chen deleted the context-to-kea branch September 28, 2020 19:04

cee-chen mentioned this pull request Sep 28, 2020

[7.x] [Enterprise Search] Remove all instances of KibanaContext to Kea store (#78513) #78692

Merged

cee-chen mentioned this pull request Sep 29, 2020

[Enterprise Search] DRY out createHref helper for navigateToUrl calls #78717

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Enterprise Search] Remove all instances of KibanaContext to Kea store #78513

[Enterprise Search] Remove all instances of KibanaContext to Kea store #78513

cee-chen commented Sep 24, 2020 •

edited

Loading

cee-chen Sep 24, 2020 •

edited

Loading

cee-chen commented Sep 28, 2020

cee-chen commented Sep 28, 2020

scottybollinger left a comment

kibanamachine commented Sep 28, 2020

JasonStoltz Sep 28, 2020

cee-chen Sep 28, 2020

JasonStoltz left a comment

[Enterprise Search] Remove all instances of KibanaContext to Kea store #78513

[Enterprise Search] Remove all instances of KibanaContext to Kea store #78513

Conversation

cee-chen commented Sep 24, 2020 • edited Loading

Summary

Wow, such kea. much slim

Changelog

QA/Regression testing

Checklist

cee-chen Sep 24, 2020 • edited Loading

Choose a reason for hiding this comment

cee-chen commented Sep 28, 2020

cee-chen commented Sep 28, 2020

scottybollinger left a comment

Choose a reason for hiding this comment

kibanamachine commented Sep 28, 2020

💚 Build Succeeded

Metrics [docs]

@kbn/optimizer bundle module count

async chunks size

page load bundle size

History

JasonStoltz Sep 28, 2020

Choose a reason for hiding this comment

cee-chen Sep 28, 2020

Choose a reason for hiding this comment

JasonStoltz left a comment

Choose a reason for hiding this comment

cee-chen commented Sep 24, 2020 •

edited

Loading

cee-chen Sep 24, 2020 •

edited

Loading