* Add import rules - newlines between each group - mocks in test files before everything else - React before all other externals * Run --fix on public/applications/workplace_search * Manually fix errors still present in WS public files - these appear to be mostly due to jest.mock() or const mixed in with imports, which confuses the autofixer * Run --fix on public/applications/app_search + some manual fixes/tweaks along the way * Run --fix on public/applications/shared - some opinionated changes, particularly around IFlashMessages and grouping together types coming from Kibana (src->../../src) * Run --fix on public/applications/enterprise_search - mostly straightforward * Run --fix on public/applications/__mocks__ * Fix remaining top-level public files - Some opinionated changes (src/core -> ../../src/core) to keep types/mocks together * Run --fix on server/ files - same opinionated src->../src changes to keep deps grouped together - opinionated require->import fetch change in enterprise_esarch_config_api.test.ts - opinionated [] inclusion of builtins & external imports together (mostly for enterprise_search_request_handler.ts) |
||
---|---|---|
.. | ||
common | ||
public | ||
server | ||
jest.config.js | ||
jest.sh | ||
kibana.json | ||
README.md | ||
tsconfig.json |
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
- When developing locally, Enterprise Search should be running locally alongside Kibana on
localhost:3002
. - Update
config/kibana.dev.yml
withenterpriseSearch.host: 'http://localhost:3002'
- 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_case
d 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
Documentation: https://www.elastic.co/guide/en/kibana/current/development-tests.html#_unit_testing
Jest tests can be run directly from the x-pack/plugins/enterprise_search
folder. This also works for any subfolders or subcomponents.
yarn test:jest
yarn test:jest --watch
Unfortunately coverage collection does not work as automatically, and requires using our handy jest.sh script if you want to run tests on a specific folder and only get coverage numbers for that folder:
# Running the jest.sh script from the `x-pack/plugins/enterprise_search` folder (vs. kibana root)
# will save you time and allow you to Tab to complete folder dir names
sh jest.sh {YOUR_COMPONENT_DIR}
sh jest.sh public/applications/shared/kibana
sh jest.sh server/routes/app_search