12986fb8fc
* Move enzyme & misc test helpers out of __mocks__/ and into new test_helpers/
They're not technically mocks since nothing is being mocked, so we should move them into a test_helpers folder for specificity & organization
* Move React Router mocks into its own separate folder/import
This was part of the initial feedback, that it was unclear why importing something for Kea in __mocks__/index.ts was mocking react router along for the ride. Separating this out makes things clearer and imports more explicit
+ add some handy new mock useX jest.fn()s helpers, so we're not doing `useParams() as jest.Mock` errywhere
* Move Kea & logic mocks/helpers into kea_logic subfolder
- for organization
NOTE: It can't be a plain kea/ folder because then Jest automatically mocks the `kea` module itself kea 🤦
* Fix type failures
- Caused by switch from any to unknown (changed back to any + added a .test_helper suffix exclusion for any)
* Fix Enterprise Search tests/imports
- I checked all application folders but this one, whoops
* PR feedback: comment copy
* Update tests/files added since PR open with new import locations
* Fix misc react router typing
- null not being type-able as a boolean
- forgot to remove various useParam imports after adding mockUseParams
+ misc unused kea import, probably added while debugging kea mocks
|
||
|---|---|---|
| .. | ||
| 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 file or folder and only get coverage numbers for that file or 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
# When testing an individual file, remember to pass the path of the test file, not the source file.
sh jest.sh public/applications/shared/flash_messages/flash_messages_logic.test.ts