301df28a66
* Create table pagination helpers * Update Curations table to use new pagination helpers * Update Credentials table to use new helpers + update to use DEFAULT_META and pass page[size] customization + update useEffect to manually call fetchCredentials on current page change + update table to pass empty prompt within table (rather than instead of), and add a loading indicator - update deleteApiKey to re-fetch credentials from API rather than modify the in-memory array (which more correctly handles pagination) * Update Engines table to use new helpers Server: + update server route to take page[current] (consistent w/ other routes) and page[size] - remove custom param translation (passing as-is) - remove ENGINES_PAGE_SIZE constant, basically stored within DEFAULT_META now and page size is passed from client-side - remove misc header cruft from engines table EnginesLogic: - Update http calls to send page[current] & page[size] (same as other files) - Change individual *Total/*Page vars to store the meta obj coming back from the API (same as other logic files) - Change on*Load actions to simply pass the API response (update typing to clarify) - Add new individual enginesLoading/metaEnginesLoading vars so that tables can show individual loading indicators between pagination - Change dataLoading to a selector (should only show on initial page load, and should use table loading indicators after) EnginesTable: - Update props to more closely match EuiBasicTable (items, onChange, add loading) so users can do a simple pass-through - Reorganize tests so that language block doesn't need its own custom wrapper vars - Remove empty data test (no longer really testing anything meaningful) and add loading test EnginesOverview: - Update to use new helpers, values, props, etc. - Add new test for onPaginate handlers |
||
|---|---|---|
| .. | ||
| 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.ymlwithenterpriseSearch.host: 'http://localhost:3002' - For faster QA/development, run Enterprise Search on elasticsearch-native auth and log in as the
elasticsuperuser 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
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