kibana/x-pack/plugins/enterprise_search
Scotty Bollinger c45fe18fd5
[Workplace Search] Migrate Source containers and routers (#83954)
* Initial copy/paste of components

No changes other than linting and the removal of the underscore.toSentenceSerial method in favor of the following:

new Intl.ListFormat().format(groups)

which does the same thing

* Redo groups sentence with more accepted solution

Turns out the previos commit’s solution is not widely accepted:

https://caniuse.com/?search=ListFormat

* Add placeholders for future components

Schema and DisplaySettings are Custom Source components that will be added later. These are stubs so the containers will render.

* Update component paths

* Remove AppView, SidebarNavigation and FlashMessages

Sidebar copy and breadcrumbs will be recreated at the top level in a separate PR

* Use Kibana’s hasPlatinumLicense over minimumPlatinumLicense

Also renames fpAccount to account, as it’s called in Kibana

* Fix typings

* Move sidebar content temporarily to top of page

This is temporary as noted by comments

* Fix missing images

* Fix routes

Had the base route and not the status route in the fetchSourceStatuses method

* Clean up last Sidebar with temp copy placement

This is so that CI will pass and we can get this merged in and do the actual wiring up of everything in a separate PR.

* Remove unused links

For CI to pass. Will add back in future PR

* Minify SVG illustration

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2020-11-23 13:04:31 -06:00
..
common [bundle optimization] Update to semver 7.x to get tree-shaking (#83020) 2020-11-14 07:32:02 -05:00
public [Workplace Search] Migrate Source containers and routers (#83954) 2020-11-23 13:04:31 -06:00
server Removing circular dependency between spaces and security (#81891) 2020-11-19 13:41:13 -05:00
kibana.json Removing circular dependency between spaces and security (#81891) 2020-11-19 13:41:13 -05:00
README.md

Enterprise Search

Overview

This plugin's goal is to provide a Kibana user interface to the Enterprise Search solution's products (App Search and Workplace Search). In it's current MVP state, the plugin provides the following with the goal of gathering user feedback and raising product awareness:

  • App Search: A basic engines overview with links into the product.
  • Workplace Search: A simple app overview with basic statistics, links to the sources, users (if standard auth), and product settings.

Development

  1. When developing locally, Enterprise Search should be running locally alongside Kibana on localhost:3002.
  2. Update config/kibana.dev.yml with enterpriseSearch.host: 'http://localhost:3002'
  3. For faster QA/development, run Enterprise Search on elasticsearch-native auth and log in as the elastic superuser on Kibana.

Kea

Enterprise Search uses Kea.js to manage our React/Redux state for us. Kea state is handled in our *Logic files and exposes values and actions for our components to get and set state with.

Advanced Kea usage

For the most part, we stick to the functionality described in Kea's core concepts. However, in some files, we also take advantage of props and events, as well as manually mounting some shared logic files on plugin init outside of React.

Debugging Kea

To debug Kea state in-browser, Kea recommends Redux Devtools. To facilitate debugging, we use the path key with snake_cased paths. The path key should always end with the logic filename (e.g. ['enterprise_search', 'some_logic']) to make it easy for devs to quickly find/jump to files via IDE tooling.

Testing

Unit tests

From kibana-root-folder/x-pack, run:

yarn test:jest plugins/enterprise_search

E2E tests

See our functional test runner README.