[Cases] Fix plugin lifecycle inconsistencies #177132

cnasikas · 2024-02-17T09:27:13Z

Summary

The script from #171483 can identify inconsistencies and untyped dependencies in Kibana plugins. This PR fixes:

Move esUiShared, kibanaReact, kibanaUtils, and savedObjectsFinder to requiredBundles
Rename CasesUiSetup to CasesPublicSetup
Rename CasesUiStart to CasesPublicStart
Rename CasesSetup to CasesServerSetup
Rename CasesStart to CasesServerStart
Rename CasesPluginSetup (public) to CasesPublicSetupDependencies
Rename CasesPluginStart (public) to CasesPublicStartDependencies
Moved PluginsSetup from server/plugin.ts to server/types.ts and rename it to CasesServerSetupDependencies
Moved PluginsStart from server/plugin.ts to server/types.ts and rename it to CasesServerStartDependencies

I could not add the apm to optional plugins because I get an error due to circular dependencies. Observability and Secuirty solution have apm and cases as a dependency and probably this cause the following error.

Error

info Running model version mapping addition checks
   │ info Generating field lists from registry and file
   │ info Loading core with all plugins enabled so that we can get all savedObject mappings...
   │ERROR UNHANDLED ERROR: Error: Topological ordering of plugins did not complete, these plugins have cyclic or missing dependencies: ["aiAssistantManagementObservability","aiops","apm","assetManager","cases","cloudDefend","datasetQuality","elasticAssistant","enterpriseSearch","exploratoryView","infra","kubernetesSecurity","logsShared","logstash","metricsDataAccess","ml","monitoring","observability","observabilityAIAssistant","observabilityOnboarding","observabilityShared","observabilityLogsExplorer","osquery","profiling","securitySolution","securitySolutionEss","securitySolutionServerless","serverlessObservability","sessionView","synthetics","threatIntelligence","timelines","upgradeAssistant","uptime","ux"]
   │ERROR     at PluginsSystem.getTopologicallySortedPluginNames (plugins_system.ts:354:13)
   │ERROR     at PluginsSystem.uiPlugins (plugins_system.ts:274:36)
   │ERROR     at PluginsService.discover (plugins_service.ts:120:58)
   │ERROR     at Server.preboot (server.ts:172:30)
   │ERROR     at Root.preboot (index.ts:57:14)
   │ERROR     at extract_field_lists_from_plugins_worker.ts:51:3
ERROR UNHANDLED ERROR
ERROR Error: worker exited without sending mappings
          at extractFieldListsFromPlugins (extract_field_lists_from_plugins.ts:62:11)
          at processTicksAndRejections (node:internal/process/task_queues:95:5)
          at runModelVersionMappingAdditionsChecks (run_versions_mapping_additions_check.ts:28:66)
          at run_check_mappings_update_cli.ts:23:9
          at tooling_log.ts:84:18
          at description (run_check_mappings_update_cli.ts:22:7)
          at run.ts:73:10
          at withProcRunner (with_proc_runner.ts:29:5)
          at run (run.ts:71:5)

Also, the storage is passed by the cases plugin to the Kibana context and is not a dependency to another plugin. The script assumes that the storage is a plugin dependency and reports it. Neverthelss, this demonstrates that we should stop passing storage to the Kibana context and use hooks like useLocalStorage.

Lastly, ML uses cases but does not pass the licensing plugin to the KibanaContext. For that reason, I left it as optional in the Cases types. When #168178 is done we can change the type of the licensing service to required.

Results from the script

For maintainers

This was checked for breaking API changes and was labeled appropriately

cnasikas · 2024-02-17T09:37:38Z

/ci

cnasikas · 2024-02-18T12:37:07Z

/ci

cnasikas · 2024-02-18T13:35:19Z

/ci

elasticmachine · 2024-02-18T20:58:23Z

Pinging @elastic/response-ops (Team:ResponseOps)

elasticmachine · 2024-02-18T20:58:24Z

Pinging @elastic/response-ops-cases (Feature:Cases)

cnasikas · 2024-02-18T20:58:35Z

/ci

elasticmachine · 2024-02-18T21:51:56Z

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

elasticmachine · 2024-02-18T21:51:57Z

Pinging @elastic/obs-ux-management-team (Team:obs-ux-management)

adcoelho

What about the storage dependency? It shows up on the print screen but you don't mention it in the description. Is it maybe part of kibanaUtils?

cauemarcondes

LGTM

cnasikas · 2024-02-19T13:10:17Z

What about the storage dependency? It shows up on the print screen but you don't mention it in the description. Is it maybe part of kibanaUtils?

Good observation. I forgot about it. I added a paragraph about it.

cnasikas · 2024-02-19T13:14:26Z

@elasticmachine merge upstream

cnasikas · 2024-02-20T14:45:14Z

@elasticmachine merge upstream

darnautov

ML changes LGTM

…to fix_case_dependencies

kibana-ci · 2024-03-03T14:47:05Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 4af36df

Failed CI Steps

Test Failures

[job] [logs] Serverless Osquery Cypress Tests #3 / ALL - Saved queries Saved queries Complex Test should create a new query and verify:

hidden columns, full screen and sorting
pagination
query can viewed (status), edited and deleted should create a new query and verify:
hidden columns, full screen and sorting
pagination
query can viewed (status), edited and deleted

[job] [logs] Detection Engine - Exceptions - Security Solution Cypress Tests #3 / Exception list detail page Should edit list details Should edit list details

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @cnasikas

## Summary The script from elastic#171483 can identify inconsistencies and untyped dependencies in Kibana plugins. This PR fixes: - Move `esUiShared`, `kibanaReact`, `kibanaUtils`, and `savedObjectsFinder` to `requiredBundles` - Rename `CasesUiSetup` to `CasesPublicSetup` - Rename `CasesUiStart` to `CasesPublicStart` - Rename `CasesSetup` to `CasesServerSetup` - Rename `CasesStart` to `CasesServerStart` - Rename `CasesPluginSetup` (public) to `CasesPublicSetupDependencies` - Rename `CasesPluginStart` (public) to `CasesPublicStartDependencies` - Moved `PluginsSetup` from `server/plugin.ts` to `server/types.ts` and rename it to `CasesServerSetupDependencies` - Moved `PluginsStart` from `server/plugin.ts` to `server/types.ts` and rename it to `CasesServerStartDependencies` I could not add the `apm` to optional plugins because I get an error due to circular dependencies. Observability and Secuirty solution have `apm` and `cases` as a dependency and probably this cause the following error. <details> <summary>Error</summary> ``` info Running model version mapping addition checks │ info Generating field lists from registry and file │ info Loading core with all plugins enabled so that we can get all savedObject mappings... │ERROR UNHANDLED ERROR: Error: Topological ordering of plugins did not complete, these plugins have cyclic or missing dependencies: ["aiAssistantManagementObservability","aiops","apm","assetManager","cases","cloudDefend","datasetQuality","elasticAssistant","enterpriseSearch","exploratoryView","infra","kubernetesSecurity","logsShared","logstash","metricsDataAccess","ml","monitoring","observability","observabilityAIAssistant","observabilityOnboarding","observabilityShared","observabilityLogsExplorer","osquery","profiling","securitySolution","securitySolutionEss","securitySolutionServerless","serverlessObservability","sessionView","synthetics","threatIntelligence","timelines","upgradeAssistant","uptime","ux"] │ERROR at PluginsSystem.getTopologicallySortedPluginNames (plugins_system.ts:354:13) │ERROR at PluginsSystem.uiPlugins (plugins_system.ts:274:36) │ERROR at PluginsService.discover (plugins_service.ts:120:58) │ERROR at Server.preboot (server.ts:172:30) │ERROR at Root.preboot (index.ts:57:14) │ERROR at extract_field_lists_from_plugins_worker.ts:51:3 ERROR UNHANDLED ERROR ERROR Error: worker exited without sending mappings at extractFieldListsFromPlugins (extract_field_lists_from_plugins.ts:62:11) at processTicksAndRejections (node:internal/process/task_queues:95:5) at runModelVersionMappingAdditionsChecks (run_versions_mapping_additions_check.ts:28:66) at run_check_mappings_update_cli.ts:23:9 at tooling_log.ts:84:18 at description (run_check_mappings_update_cli.ts:22:7) at run.ts:73:10 at withProcRunner (with_proc_runner.ts:29:5) at run (run.ts:71:5) ``` </details> Also, the `storage` is passed by the `cases` plugin to the Kibana context and is not a dependency to another plugin. The script assumes that the `storage` is a plugin dependency and reports it. Neverthelss, this demonstrates that we should stop passing `storage` to the Kibana context and use hooks like `useLocalStorage`. ## Results from the script <img width="727" alt="Screenshot 2024-02-17 at 8 54 32 AM" src="https://github.com/elastic/kibana/assets/7871006/1c86f501-72c5-473c-92f5-7a4935da914b"> ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: Kibana Machine <[email protected]>

cnasikas added chore release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Cases Cases feature v8.14.0 labels Feb 17, 2024

cnasikas self-assigned this Feb 17, 2024

cnasikas added 2 commits February 17, 2024 09:28

Fix plugin interfaces

67f52e7

Fix dependencies

3c07cc0

cnasikas force-pushed the fix_case_dependencies branch from bdb91e2 to 3c07cc0 Compare February 17, 2024 09:28

cnasikas added 2 commits February 17, 2024 10:56

Remove cases from apm kibana.jsonc

2708180

Remove apm due to circular dependecies

037f01c

cnasikas marked this pull request as ready for review February 18, 2024 20:58

cnasikas requested review from a team as code owners February 18, 2024 20:58

cnasikas added 2 commits February 18, 2024 21:45

Merge branch 'main' into fix_case_dependencies

2ecb392

Fix solution types

2338dd2

cnasikas requested review from a team as code owners February 18, 2024 21:51

kqualters-elastic approved these changes Feb 19, 2024

View reviewed changes

adcoelho approved these changes Feb 19, 2024

View reviewed changes

shahzad31 approved these changes Feb 19, 2024

View reviewed changes

cauemarcondes approved these changes Feb 19, 2024

View reviewed changes

js-jankisalvi approved these changes Feb 19, 2024

View reviewed changes

pgayvallet approved these changes Feb 19, 2024

View reviewed changes

Merge branch 'main' into fix_case_dependencies

b7531ee

Merge branch 'main' into fix_case_dependencies

fa84dbd

cnasikas enabled auto-merge (squash) February 20, 2024 14:45

patrykkopycinski approved these changes Feb 20, 2024

View reviewed changes

darnautov approved these changes Feb 20, 2024

View reviewed changes

tonyghiani approved these changes Feb 20, 2024

View reviewed changes

cnasikas disabled auto-merge February 20, 2024 15:43

cnasikas added 3 commits March 3, 2024 12:51

Merge branch 'main' into fix_case_dependencies

13ea7fa

Fix error with licensing

99b95b8

Merge branch 'fix_case_dependencies' of github.com:cnasikas/kibana in…

4af36df

…to fix_case_dependencies

cnasikas mentioned this pull request Mar 3, 2024

[Cases] Use the CasesContext to pass the Kibana services #168178

Open

cnasikas enabled auto-merge (squash) March 3, 2024 12:34

cnasikas merged commit c7f2a6e into elastic:main Mar 3, 2024
41 checks passed

cnasikas deleted the fix_case_dependencies branch March 3, 2024 14:47

kibanamachine added the backport:skip This commit does not require backporting label Mar 3, 2024

benakansara mentioned this pull request Mar 11, 2024

[APM] [Alerts] Fix error rendering alerts table in APM app #178371

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cases] Fix plugin lifecycle inconsistencies #177132

[Cases] Fix plugin lifecycle inconsistencies #177132

cnasikas commented Feb 17, 2024 •

edited

Loading

cnasikas commented Feb 17, 2024

cnasikas commented Feb 18, 2024

cnasikas commented Feb 18, 2024

elasticmachine commented Feb 18, 2024

elasticmachine commented Feb 18, 2024

cnasikas commented Feb 18, 2024

elasticmachine commented Feb 18, 2024

elasticmachine commented Feb 18, 2024

adcoelho left a comment

cauemarcondes left a comment

cnasikas commented Feb 19, 2024 •

edited

Loading

cnasikas commented Feb 19, 2024

cnasikas commented Feb 20, 2024

darnautov left a comment

kibana-ci commented Mar 3, 2024

[Cases] Fix plugin lifecycle inconsistencies #177132

[Cases] Fix plugin lifecycle inconsistencies #177132

Conversation

cnasikas commented Feb 17, 2024 • edited Loading

Summary

Results from the script

For maintainers

cnasikas commented Feb 17, 2024

cnasikas commented Feb 18, 2024

cnasikas commented Feb 18, 2024

elasticmachine commented Feb 18, 2024

elasticmachine commented Feb 18, 2024

cnasikas commented Feb 18, 2024

elasticmachine commented Feb 18, 2024

elasticmachine commented Feb 18, 2024

adcoelho left a comment

Choose a reason for hiding this comment

cauemarcondes left a comment

Choose a reason for hiding this comment

cnasikas commented Feb 19, 2024 • edited Loading

cnasikas commented Feb 19, 2024

cnasikas commented Feb 20, 2024

darnautov left a comment

Choose a reason for hiding this comment

kibana-ci commented Mar 3, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

History

cnasikas commented Feb 17, 2024 •

edited

Loading

cnasikas commented Feb 19, 2024 •

edited

Loading