kibana/x-pack/plugins/enterprise_search
Scotty Bollinger 46d587a19f
[Workplace Search] Migrate SourcesLogic from ent-search (#83544)
* Copy and paste sources logic

This is simply a copy & paste of the sources_logic file from ent-search. The only changes were adding the comment at the top and changing how lodash imports, per linting requirements

* Add types

The “I” prefix has been removed, per agreed-upon standard

* Add type declaration to staticSourceData

Yay TypeScript  🙄

* Update route path

For all other routes, we use the account/org syntax. For this one, I missed it and forgot to add ‘account’ for the route path. This fixes it

* Update SourcesLogic to work with Kibana

- Remove routes/http in favor of HttpLogic
- Remove local flash messages in favor of global messages
- Update paths to imports
- Remove "I"s from interface names
- Varions type fixes
2020-11-17 10:28:44 -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 SourcesLogic from ent-search (#83544) 2020-11-17 10:28:44 -06:00
server [Workplace Search] Migrate SourcesLogic from ent-search (#83544) 2020-11-17 10:28:44 -06:00
kibana.json
README.md [Enterprise Search] Update CODEOWNERS and README (#78809) 2020-09-29 11:44:07 -07:00

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.