[Enterprise Search] Refactor product server route registrations to their own files/folders #82663

cee-chen · 2020-11-04T21:36:18Z

Summary

I was adding a new Engine server route to App Search and noticed our server/plugin.ts was getting a little bloated/unwieldy. I decided to refactor/move all App Search and Workplace Search server route registrations to their own individual files (e.g. server/routes/index.ts) rather than being at the top level of server/plugin.ts.

Benefits:

Our import list at the top of plugin.ts doesn't grow larger and larger, making the actual file/logic harder to read
Products can scale to any size without affecting one another
No need to namespace route registrations internally within the product folders (48019ca)

Checklist

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

- super basic, leaves out assertions to avoid brittleness

cee-chen · 2020-11-04T21:37:43Z

x-pack/plugins/enterprise_search/server/routes/workplace_search/groups.ts

+export function registerGroupRoutes(dependencies: IRouteDependencies) {
  registerGroupsRoute(dependencies);
  registerSearchGroupsRoute(dependencies);
  registerGroupRoute(dependencies);


@scottybollinger I wasn't sure if you wanted to move all these registrations to the new index.ts or keep them grouped in this file for simplicity - let me know if you have a preference and I can make that change in this PR

Moving it is fine. Thanks! Will definitely have an effect on #82669 but I can make changes after we merge this or vice versa.

Sweet, thanks Scotty! I'll move them here shortly.

Moved in ac5ddaa - hope I got it right, feel free to tweak further in #82669 if I didn't

cee-chen · 2020-11-04T21:43:22Z

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

+import { registerAppSearchRoutes } from './';
+
+describe('registerAppSearchRoutes', () => {
+  it('runs without errors', () => {


I def know these aren't great tests - it basically just confirms that the parent fn runs w/o assertions, which is not my favorite but in this case I'm not sure it's worth the LOE to expand them further since:

we weren't testing route registration calls originally anyway in plugin.ts

In theory each individual registerXRoute should have its own fleshed out unit testing in any case

I ran into this same issue with #82669 and just replaced the first test in that file with the registerWSGroupRoutes and coverage passed but good to know we can do this for coverage purposes.

scottybollinger

LGTM! Thanks for doing this!

kibanamachine · 2020-11-05T01:42:07Z

💚 Build Succeeded

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

Metrics [docs]

distributable file count

id	before	after	diff
`default`	42717	42719	+2

History

💚 Build #85958 succeeded 66425c8

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

…eir own files/folders (elastic#82663) * Refactor all AS & WS route registrations to their own file/folders * Remove WS in route registrations since the main fn is already specific * Cover index.ts files - super basic, leaves out assertions to avoid brittleness * Move WS group routes to index.ts

…eir own files/folders (#82663) (#82680) * Refactor all AS & WS route registrations to their own file/folders * Remove WS in route registrations since the main fn is already specific * Cover index.ts files - super basic, leaves out assertions to avoid brittleness * Move WS group routes to index.ts

* master: (127 commits) [ILM] Fix breadcrumbs (elastic#82594) [UX]Swap env filter with percentile (elastic#82246) Add platform's missing READMEs (elastic#82268) [Discover] Adding uiMetric to track Visualize link click (elastic#82344) [Search] Add used index pattern name to the search agg error field (elastic#82604) improve client-side SO client get pooling (elastic#82603) [Security Solution] Unskips Overview tests (elastic#82459) Embeddables/migrations (elastic#82296) [Enterprise Search] Refactor product server route registrations to their own files/folders (elastic#82663) Moving reinstall function outside of promise.all (elastic#82672) Load choropleth layer correctly (elastic#82628) Master backport elastic#81233 (elastic#82642) [Fleet] Allow snake cased Kibana assets (elastic#77515) Reduce saved objects authorization checks (elastic#82204) [data.search] Add request handler context and asScoped pattern (elastic#80775) [ML] Fixes formatting of fields in index data visualizer (elastic#82593) Usage collector readme (elastic#82548) [Lens] Visualization validation and better error messages (elastic#81439) [ML] Add annotation markers to time series brush area to indicate annotations exist outside of selected range (elastic#81490) chore(NA): install microdnf in UBI docker build only (elastic#82611) ...

cee-chen added 3 commits November 4, 2020 12:53

Refactor all AS & WS route registrations to their own file/folders

68ffa68

Remove WS in route registrations since the main fn is already specific

48019ca

Cover index.ts files

66425c8

- super basic, leaves out assertions to avoid brittleness

cee-chen added Feature:Plugins backport:skip This commit does not require backporting v7.11.0 labels Nov 4, 2020

cee-chen requested review from JasonStoltz, scottybollinger and a team November 4, 2020 21:36

cee-chen commented Nov 4, 2020

View reviewed changes

cee-chen added release_note:skip Skip the PR/issue when compiling release notes and removed backport:skip This commit does not require backporting labels Nov 4, 2020

cee-chen commented Nov 4, 2020

View reviewed changes

scottybollinger approved these changes Nov 4, 2020

View reviewed changes

Move WS group routes to index.ts

ac5ddaa

cee-chen merged commit b264498 into elastic:master Nov 5, 2020

cee-chen deleted the server-routes branch November 5, 2020 01:43

cee-chen mentioned this pull request Nov 5, 2020

[7.x] [Enterprise Search] Refactor product server route registrations to their own files/folders (#82663) #82680

Merged

scottybollinger mentioned this pull request Nov 9, 2020

[Workplace Search] Consolidate groups routes #83015

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Enterprise Search] Refactor product server route registrations to their own files/folders #82663

[Enterprise Search] Refactor product server route registrations to their own files/folders #82663

cee-chen commented Nov 4, 2020 •

edited

Loading

cee-chen Nov 4, 2020

scottybollinger Nov 4, 2020

cee-chen Nov 4, 2020

cee-chen Nov 4, 2020

cee-chen Nov 4, 2020 •

edited

Loading

scottybollinger Nov 4, 2020 •

edited

Loading

scottybollinger left a comment

kibanamachine commented Nov 5, 2020

[Enterprise Search] Refactor product server route registrations to their own files/folders #82663

[Enterprise Search] Refactor product server route registrations to their own files/folders #82663

Conversation

cee-chen commented Nov 4, 2020 • edited Loading

Summary

Checklist

cee-chen Nov 4, 2020

Choose a reason for hiding this comment

scottybollinger Nov 4, 2020

Choose a reason for hiding this comment

cee-chen Nov 4, 2020

Choose a reason for hiding this comment

cee-chen Nov 4, 2020

Choose a reason for hiding this comment

cee-chen Nov 4, 2020 • edited Loading

Choose a reason for hiding this comment

scottybollinger Nov 4, 2020 • edited Loading

Choose a reason for hiding this comment

scottybollinger left a comment

Choose a reason for hiding this comment

kibanamachine commented Nov 5, 2020

💚 Build Succeeded

Metrics [docs]

distributable file count

History

cee-chen commented Nov 4, 2020 •

edited

Loading

cee-chen Nov 4, 2020 •

edited

Loading

scottybollinger Nov 4, 2020 •

edited

Loading