2f92ce1d4a
## Summary Dealing with circular dependencies between plugins has become a sharp pain point for anyone developing plugins in Kibana. ### Providing dependencies to a plugin First, a plugin defines its dependencies in its `kibana.jsonc` file as one of three types: - `required` - the dependency must be present and enabled -- will be guaranteed in the lifecycle - `optional` - the dependency can be missing or disabled -- will be `undefined` in the lifecycle - `requiredBundle` - the dependency is required as static code only -- will not be present in the lifecycle Missing or circular dependencies are detected by the Kibana platform when it starts. ### Providing dependencies in code Our plugins are written in and type-checked by Typescript. As such, each plugin needs to maintain Typescript types defining what the platform is providing. This is done manually, and there is no enforcement mechanism between that and the plugin Typescript types. If these dependency definitions are inconsistent or stale, it can lead to host of issues: - optional plugins typed as required that are disabled crash the plugin at runtime; - plugins that are no longer used still included in dependency checks; - plugins marked as required or optional that are actually required bundles. - etc. ### Dependencies with side-effects One of the interesting things that has come out of this has been identifying plugins that provide dependent logic through side-effects, rather than lifecycles. As an example, `licensing` provides a lifecycle contracts, but also a [route handler context](https://github.com/elastic/kibana/blob/main/x-pack/plugins/licensing/server/licensing_route_handler_context.ts) as middleware for a dependent plugin. Unfortunately, while this dependency can be stated as `required` in a dependent plugin's `kibana.jsonc`, the fact that this is a side-effect makes it incredible difficult to understand the dependency without searching the code. <img width="735" alt="Screenshot 2023-12-13 at 10 08 00 AM" src=" |
||
|---|---|---|
| .. | ||
| archive_migration_functions.sh | ||
| backport.js | ||
| build.js | ||
| build_api_docs.js | ||
| build_kibana_platform_plugins.js | ||
| build_plugin_list_docs.js | ||
| check_file_casing.js | ||
| check_ftr_code_owners.js | ||
| check_ftr_configs.js | ||
| check_jest_configs.js | ||
| check_licenses.js | ||
| check_mappings_update.js | ||
| chromium_version.js | ||
| classify_source.js | ||
| create_observability_rules.js | ||
| delete_kibana_indices.sh | ||
| dev_docs.sh | ||
| docs.js | ||
| download_pr_list.js | ||
| download_re2.sh | ||
| enabled_ftr_configs.js | ||
| es.js | ||
| es_archiver.js | ||
| eslint.js | ||
| eslint_with_types.js | ||
| extract_performance_testing_dataset.js | ||
| find_babel_runtime_helpers_in_use.js | ||
| find_node_libs_browser_polyfills_in_use.js | ||
| functional_test_runner.js | ||
| functional_tests.js | ||
| functional_tests_server.js | ||
| generate.js | ||
| generate_console_definitions.js | ||
| generate_openapi.js | ||
| generate_plugin.js | ||
| generate_team_assignments.js | ||
| i18n_check.js | ||
| i18n_extract.js | ||
| i18n_integrate.js | ||
| ingest_coverage.js | ||
| jest.js | ||
| jest_integration.js | ||
| kbn.js | ||
| kbn_archiver.js | ||
| kibana.js | ||
| kibana_encryption_keys.js | ||
| kibana_keystore.js | ||
| kibana_plugin.js | ||
| kibana_setup.js | ||
| kibana_verification_code.js | ||
| licenses_csv_report.js | ||
| lint_packages.js | ||
| lint_ts_projects.js | ||
| makelogs.js | ||
| notice.js | ||
| plugin_check.js | ||
| plugin_helpers.js | ||
| precommit_hook.js | ||
| read_jest_help.mjs | ||
| README.md | ||
| register_git_hook.js | ||
| report_failed_tests.js | ||
| report_performance_metrics.js | ||
| run_performance.js | ||
| run_scalability.js | ||
| saved_objs_info.js | ||
| ship_ci_stats.js | ||
| snapshot_plugin_types.js | ||
| spec_to_console.js | ||
| storybook.js | ||
| stylelint.js | ||
| synthtrace.js | ||
| telemetry_check.js | ||
| telemetry_extract.js | ||
| test_hardening.js | ||
| type_check.js | ||
| update_prs.js | ||
| update_vscode_config.js | ||
| validate_next_docs.js | ||
| whereis_pkg.js | ||
| yarn_deduplicate.js | ||
Kibana Dev Scripts
This directory contains scripts useful for interacting with Kibana tools in development. Use the node executable and --help flag to learn about how they work:
node scripts/{{script name}} --help
For Developers
This directory is excluded from the build and tools within it should help users discover their capabilities. Each script in this directory must:
- require
src/setup_node_envto bootstrap NodeJS environment - call out to source code in the
srcorpackagesdirectories - react to the
--helpflag - run everywhere OR check and fail fast when a required OS or toolchain is not available
Functional Test Scripts
node scripts/functional_tests [--config test/functional/config.base.js --config test/api_integration/config.js]
Runs all the functional tests: selenium tests and api integration tests. List configs with multiple --config arguments. Uses the @kbn/test library to run Elasticsearch and Kibana servers and tests against those servers, for multiple server+test setups. In particular, calls out to runTests(). Can be run on a single config.
node scripts/functional_tests_server [--config test/functional/config.base.js]
Starts just the Elasticsearch and Kibana servers given a single config, i.e. via --config test/functional/config.base.js or --config test/api_integration/config. Allows the user to start just the servers with this script, and keep them running while running tests against these servers. The idea is that the same config file configures both Elasticsearch and Kibana servers. Uses the startServers() method from @kbn/test library.
Example. Start servers and run tests, separately, but using the same config:
# Just the servers
node scripts/functional_tests_server --config path/to/config
In another terminal:
# Just the tests--against the running servers
node scripts/functional_test_runner --config path/to/config
For details on how the internal methods work, read this readme.
ES archiver
Loading data
If you wish to load up specific es archived data for your test, you can do so via:
node scripts/es_archiver.js load <archive> [--es-url=http://username:password@localhost:9200] [--kibana-url=http://username:password@localhost:5601/{basepath?}]
That will load the specified archive located in the archive directory specified by the default functional config file, located in test/functional/config.base.js. To load archives from other function config files you can pass --config path/to/config.js.
Note: The --es-url and --kibana-url options may or may not be neccessary depending on your current Kibana configuration settings, and their values
may also change based on those settings (for example if you are not running with security you will not need the username:password portion).
Saving data
You can save existing data into an archive by using the save command:
node scripts/es_archiver.js save <archive name for kibana data> [space separated list of index patterns to include]
You may want to store the .kibana index separate from data. Since adding a lot of data will bloat our repo size, we have many tests that reuse the same
data indices but use their own .kibana index.