[Enterprise Search] Create HttpLogic Kea store, add http interceptors, and manage error connecting at top app-level #75790

cee-chen · 2020-08-24T16:38:23Z

Summary

I strongly recommend following along by commit! 🔍

This PR:

Changes all "Error connecting to Enteprise Search" response status codes from 404 to 502, which is a more accurate & distinct status code which we can use to granularly catch error connecting state (vs. our own 404s)
Set ups new a new HttpLogic Kea store, which allows us to
- connect() directly to HttpLogic in other Kea logic files that need to make http calls (instead of passing in http manually via args - cc @scottybollinger)
- Set http interceptors/listeners & remove the interceptors on unmount within Kea
- Share state derived from http (e.g. errorConnecting, readOnlyMode) between both AS & WS (but allow each app to handle that state differently if needed)
Moves the error connecting component to the top-level App instead of requiring every component to catch/manage its own state/return
Minor App Search cleanup - moves a lot of child components (LoadingState, EmptyState, EngineOverviewHeader) into subfolders of EngineOverview, instead of top-level components. This originally made sense for the MVP but no longer makes sense with more views coming in

QA

When Enterprise Search is unavailable on load

Start up Kibana on this branch but do NOT start (or STOP) Enterprise Search
Go to Workplace Search and confirm that the "Error connecting" prompt appears
Go to App Search and confirm that the "Error connecting" prompt appears
Also open your devtools and log XHR requests - on refresh, confirm that App Search polls /api/enterprise_search/config_data (which returns a 502 Bad Gateway)

When Enterprise Search becomes unavailable mid-session

Start up Kibana on this branch & Enterprise Search (any branch)
Go to App Search: http://localhost:5601/app/enterprise_search/app_search/engines
STOP Enterprise Search (ctrl+c)
Click the "App Search" breadcrumb
Confirm that the "Error connecting" state appears
START Enterprise Search
Go to Workplace Search: http://localhost:5601/app/enterprise_search/workplace_search/groups
STOP Enterprise Search
Click the "Overview" link in the side nav
Confirm that the "Error connecting" state appears

Regression testing

Confirm the Workplace Search overview page works before as normal and loads all data as normal
Confirm the App Search Engines loading state and empty state work as before

Checklist

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

cee-chen · 2020-08-24T16:45:24Z

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

@@ -67,6 +68,7 @@ export const renderApp = (
 >
 <LicenseProvider license$={plugins.licensing.license$}>
 <Provider store={store}>
+ <HttpProvider http={core.http} errorConnecting={errorConnecting} />


Just wanted to make a quick note here: I left http in KibanaContext for now:

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

Lines 59 to 63 in 94b5da6

<KibanaContext.Provider

value={{

config,

externalUrl,

http: core.http,

although I'm 50/50 on whether to remove it and have the only way for us to access http be from const { http } = useValues(HttpLogic) (vs also being able to do const { http } = useContext(KibanaContext)).

They both reference the same global Kibana http instance so it's not a question of accidentally using the wrong var or anything, it's just 2 different ways of calling http which may end up being confusing.

I will say that IMO useContext(KibanaContext) is significantly easier to mock and spy on in Jest tests (you just listen for mockKibanaContext.http changes) - whereas I ran into a super huge headache trying to pass a mockContext into a HttpLogic mock for some baffling reason.

Either way we decide, I definitely don't plan on removing all instances of const { http } = useContext(KibanaContext) in this PR, to try to keep it smaller for now. @scottybollinger / @JasonStoltz would definitely appreciate your thoughts if we should eventually remove them or if it's not a huge deal to have 2 ways of accessing http.

I personally don't mind leaving both instance types since they reference the same thing and especially if it makes testing easier

Yeah I'm 👍 for just leaving it as is for now and seeing how it goes. We could always change it later.

- For clearer error handling

- This allows us to: - connect() directly to HttpLogic in other Kea logic files that need to make http calls, instead of passing in http manually via args - Set http interceptors & remove them interceptors on unmount within Kea - Share state derived from http (e.g. errorConnecting, readOnlyMode) between both AS & WS (but allow each app to handle that state differently if needed) + Refactors necessary for these changes: - Kea types - add events key, clarify that mount returns an unmount function, fix reducer state type - ReactDOM unmount - remove resetContext({}), was preventing logic from unmounting properly

- Since main app is now handling errorConnecting - http can now be connected directly from HttpLogic Kea store, so no need to pass it + minor cleanup in logic_overview.test.ts - remove unneeded unmount(), act(), switch to HttpLogic mock

…m EngineOverview

- delete old ErrorState component - move LoadingState, EmptyState, and EngineOverviewHeader into subfolders in engine_overview

richkuz

Nice! 💯

richkuz · 2020-08-24T18:02:58Z

x-pack/plugins/enterprise_search/server/routes/app_search/engines.ts

@@ -52,7 +52,7 @@ export function registerEnginesRoute({ router, config, log }: IRouteDependencies
 log.error(`Cannot connect to App Search: ${e.toString()}`);
 if (e instanceof Error) log.debug(e.stack as string);

- return response.notFound({ body: 'cannot-connect' });
+ return response.customError({ statusCode: 502, body: 'cannot-connect' });


Should we distinguish authentication errors separately?

Ahhh hm, great call. I can definitely try in a separate PR - I think I'd probably build off what Jason is doing in #75487 and check for the /login redirect there (since eventually all API endpoints should be using that helper).

We have to be careful about what statusCode we use for authentication though. If we try 401 or 403 I believe Kibana automatically responds to that by logging the Kibana user out (which is not what we want lmao). I'm tempted to keep the status code the same (502) and simply modify the body to specify a "Cannot authenticate this user" error vs a generic "Cannot connect to Enterprise Search" fallback.

What do you think?

Definitely, separate PR. Was just thinking out loud.

If we try 401 or 403 I believe Kibana automatically responds to that by logging the Kibana user out (which is not what we want lmao).

Oy, definitely not. Does Kibana install some invasive, global hook to catch all 401/403's? I am not close enough to the code, but returning a 401/403 wrapped inside a 502 feels broken. Anyway, we can discuss separately. I don't intend to hold up progress on this PR on a tangential issue. Incremental progress FTW.

I haven't dug through their code super deeply but yeah I believe every http request/response gets run through their global http lib (both on the client-side and server-side). I definitely see why and we get plenty of advantages of doing so, it's just in this one scenario that we don't particularly want that side-effect. I remember spending a real confused half hour trying to figure out why I was getting logged out during my initial MVP work though haha.

Also there's some nuance to the status codes here - while it's true that the user is unauthorized in Enterprise Search, they're not necessarily unauthorized in Kibana (which is generating the status code), and as such it's not necessarily a client error / a 4xx doesn't necessarily apply.

I do think the 502 status code is the most generic while still applying to our use case:

This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response

In this case, a /login redirect (unauthenticated in Enterprise Search) qualifies as an "invalid response" just IMO.

I agree with you there Constance 👍

x-pack/plugins/enterprise_search/server/routes/app_search/engines.test.ts

scottybollinger

LGTM! Left a comment about a test suite name but feel free to merge if that's as intended

cee-chen

I'm being lazy and making these changes via GitHub since my current local is all mangled w/ flash messages shenanigans

x-pack/plugins/enterprise_search/server/routes/workplace_search/overview.test.ts

x-pack/plugins/enterprise_search/server/routes/app_search/engines.test.ts

kibanamachine · 2020-08-24T22:06:41Z

💚 Build Succeeded

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

Build metrics

@kbn/optimizer bundle module count

id	value	diff	baseline
enterpriseSearch	200	+3	197

async chunks size

id	value	diff	baseline
enterpriseSearch	349.0KB	+6.6KB	342.5KB

page load bundle size

id	value	diff	baseline
enterpriseSearch	21.8KB	+31.0B	21.8KB

History

💛 Build #70070 was flaky ed83457

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

JasonStoltz · 2020-08-25T12:46:54Z

Great changes Constance, thank you.

…, and manage error connecting at top app-level (#75790) (#75821) * [Setup] Change error connecting status code to 502 - For clearer error handling * Set up new HttpProvider/Logic Kea store & listeners - This allows us to: - connect() directly to HttpLogic in other Kea logic files that need to make http calls, instead of passing in http manually via args - Set http interceptors & remove them interceptors on unmount within Kea - Share state derived from http (e.g. errorConnecting, readOnlyMode) between both AS & WS (but allow each app to handle that state differently if needed) + Refactors necessary for these changes: - Kea types - add events key, clarify that mount returns an unmount function, fix reducer state type - ReactDOM unmount - remove resetContext({}), was preventing logic from unmounting properly * Update AS & WS to show error connecting component at app level * [WS] Remove errorConnecting logic & http arg from Overview - Since main app is now handling errorConnecting - http can now be connected directly from HttpLogic Kea store, so no need to pass it + minor cleanup in logic_overview.test.ts - remove unneeded unmount(), act(), switch to HttpLogic mock * [AS] Add top-level ErrorConnecting component & remove error logic from EngineOverview * [AS] Clean up/move EngineOverview child components into subfolder - delete old ErrorState component - move LoadingState, EmptyState, and EngineOverviewHeader into subfolders in engine_overview * PR feedback: Update test assertions 404 copy

…, and manage error connecting at top app-level (elastic#75790) * [Setup] Change error connecting status code to 502 - For clearer error handling * Set up new HttpProvider/Logic Kea store & listeners - This allows us to: - connect() directly to HttpLogic in other Kea logic files that need to make http calls, instead of passing in http manually via args - Set http interceptors & remove them interceptors on unmount within Kea - Share state derived from http (e.g. errorConnecting, readOnlyMode) between both AS & WS (but allow each app to handle that state differently if needed) + Refactors necessary for these changes: - Kea types - add events key, clarify that mount returns an unmount function, fix reducer state type - ReactDOM unmount - remove resetContext({}), was preventing logic from unmounting properly * Update AS & WS to show error connecting component at app level * [WS] Remove errorConnecting logic & http arg from Overview - Since main app is now handling errorConnecting - http can now be connected directly from HttpLogic Kea store, so no need to pass it + minor cleanup in logic_overview.test.ts - remove unneeded unmount(), act(), switch to HttpLogic mock * [AS] Add top-level ErrorConnecting component & remove error logic from EngineOverview * [AS] Clean up/move EngineOverview child components into subfolder - delete old ErrorState component - move LoadingState, EmptyState, and EngineOverviewHeader into subfolders in engine_overview * PR feedback: Update test assertions 404 copy

cee-chen requested review from JasonStoltz and scottybollinger August 24, 2020 16:38

cee-chen commented Aug 24, 2020

View reviewed changes

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

cee-chen added 6 commits August 24, 2020 09:48

[Setup] Change error connecting status code to 502

c8dd2e8

- For clearer error handling

Update AS & WS to show error connecting component at app level

e25ccc2

[AS] Add top-level ErrorConnecting component & remove error logic fro…

0874cb3

…m EngineOverview

[AS] Clean up/move EngineOverview child components into subfolder

ed83457

- delete old ErrorState component - move LoadingState, EmptyState, and EngineOverviewHeader into subfolders in engine_overview

cee-chen force-pushed the http-logic branch from 94b5da6 to ed83457 Compare August 24, 2020 16:48

richkuz reviewed Aug 24, 2020

View reviewed changes

richkuz approved these changes Aug 24, 2020

View reviewed changes

cee-chen changed the title ~~Http logic~~ [Enterprise Search] Create HttpLogic Kea store, add http interceptors, and manage error connecting at top app-level Aug 24, 2020

scottybollinger reviewed Aug 24, 2020

View reviewed changes

x-pack/plugins/enterprise_search/server/routes/app_search/engines.test.ts Show resolved Hide resolved

scottybollinger approved these changes Aug 24, 2020

View reviewed changes

cee-chen commented Aug 24, 2020

View reviewed changes

PR feedback: Update test assertions 404 copy

d6263cb

cee-chen merged commit 90bd654 into elastic:master Aug 24, 2020

cee-chen deleted the http-logic branch August 24, 2020 22:07

cee-chen mentioned this pull request Aug 24, 2020

[7.x] [Enterprise Search] Create HttpLogic Kea store, add http interceptors, and manage error connecting at top app-level (#75790) #75821

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Enterprise Search] Create HttpLogic Kea store, add http interceptors, and manage error connecting at top app-level #75790

[Enterprise Search] Create HttpLogic Kea store, add http interceptors, and manage error connecting at top app-level #75790

cee-chen commented Aug 24, 2020 •

edited

Loading

cee-chen Aug 24, 2020

scottybollinger Aug 24, 2020

JasonStoltz Aug 25, 2020

richkuz left a comment

richkuz Aug 24, 2020

cee-chen Aug 24, 2020 •

edited

Loading

richkuz Aug 24, 2020

cee-chen Aug 24, 2020

cee-chen Aug 24, 2020 •

edited

Loading

JasonStoltz Aug 25, 2020

scottybollinger left a comment

cee-chen left a comment •

edited

Loading

kibanamachine commented Aug 24, 2020

JasonStoltz commented Aug 25, 2020

	<KibanaContext.Provider
	value={{
	config,
	externalUrl,
	http: core.http,

[Enterprise Search] Create HttpLogic Kea store, add http interceptors, and manage error connecting at top app-level #75790

[Enterprise Search] Create HttpLogic Kea store, add http interceptors, and manage error connecting at top app-level #75790

Conversation

cee-chen commented Aug 24, 2020 • edited Loading

Summary

QA

When Enterprise Search is unavailable on load

When Enterprise Search becomes unavailable mid-session

Regression testing

Checklist

cee-chen Aug 24, 2020

Choose a reason for hiding this comment

scottybollinger Aug 24, 2020

Choose a reason for hiding this comment

JasonStoltz Aug 25, 2020

Choose a reason for hiding this comment

richkuz left a comment

Choose a reason for hiding this comment

richkuz Aug 24, 2020

Choose a reason for hiding this comment

cee-chen Aug 24, 2020 • edited Loading

Choose a reason for hiding this comment

richkuz Aug 24, 2020

Choose a reason for hiding this comment

cee-chen Aug 24, 2020

Choose a reason for hiding this comment

cee-chen Aug 24, 2020 • edited Loading

Choose a reason for hiding this comment

JasonStoltz Aug 25, 2020

Choose a reason for hiding this comment

scottybollinger left a comment

Choose a reason for hiding this comment

cee-chen left a comment • edited Loading

Choose a reason for hiding this comment

kibanamachine commented Aug 24, 2020

💚 Build Succeeded

Build metrics

@kbn/optimizer bundle module count

async chunks size

page load bundle size

History

JasonStoltz commented Aug 25, 2020

cee-chen commented Aug 24, 2020 •

edited

Loading

cee-chen Aug 24, 2020 •

edited

Loading

cee-chen Aug 24, 2020 •

edited

Loading

cee-chen left a comment •

edited

Loading