Add more detailed unmet deps logging #70098

nickofthyme · 2020-06-26T17:03:09Z

Summary

Adds log to existing log for unmet dependencies, to now include what unmet dependencies are missing.

[plugins-service] Plugin "securitySolution" has been disabled since the following direct or transitive dependencies are missing or disabled: ["ingestManager"]

config/kibana.yml

src/core/server/plugins/plugins_service.ts

afharo

I'll let @dover to review this. Since it's under his expertise :)

Thanks @nickofthyme for doing this so quickly! ❤️

nickofthyme · 2020-06-26T18:48:59Z

@joshdover I updated the existing tests for missing plugins. Let me know if you want any other tests to be added.

joshdover · 2020-06-26T20:08:50Z

src/core/server/plugins/plugins_service.test.ts

          ],
          Array [
-            "Plugin \\"plugin-with-disabled-transitive-dep\\" has been disabled since some of its direct or transitive dependencies are missing or disabled.",
+            "Plugin \\"plugin-with-disabled-transitive-dep\\" has been disabled since the following direct or transitive dependencies are missing or disabled: [\\"another-explicitly-disabled-plugin\\"]",


Can we add a plugin to this test that has missing optional dependencies to validate that this log does not disable or log optional dependencies

5d1b4e5

I also added some for nested/indirect dependencies.

joshdover · 2020-06-26T20:11:38Z

src/core/server/plugins/plugins_service.ts

@@ -257,17 +264,28 @@ export class PluginsService implements CoreService<PluginsServiceSetup, PluginsS
    pluginName: PluginName,
    pluginEnableStatuses: Map<PluginName, { plugin: PluginWrapper; isEnabled: boolean }>,
    parents: PluginName[] = []
-  ): boolean {
+  ): { enabled: boolean; missingDependencies: string[] } {


I prefer to change this return type to:

{ enabled: true } | { enabled: false; missingDependencies: string[] }

This helps us avoid bugs where we have a state that should be impossible, like:

{ enabled: true, missingDependencies: ['some-dep'] }

nickofthyme · 2020-07-01T14:00:51Z

@elasticmachine merge upstream

nickofthyme · 2020-07-01T14:01:25Z

@joshdover could you do one last pass on this, thanks!

joshdover · 2020-07-01T17:12:17Z

src/core/server/plugins/plugins_service.ts

+          `Plugin "${pluginName}" has been disabled since the following direct or transitive dependencies are missing or disabled: ${JSON.stringify(
+            pluginEnablement.missingDependencies
+          )}`


nit: we generally avoid using JSON.stringify and prefer using the .join method:

Suggested change

`Plugin "${pluginName}" has been disabled since the following direct or transitive dependencies are missing or disabled: ${JSON.stringify(

pluginEnablement.missingDependencies

)}`

`Plugin "${pluginName}" has been disabled since the following direct or transitive dependencies are missing or disabled: [${pluginEnablement.missingDependencies.join(', ')}]`

kibanamachine · 2020-07-01T18:57:54Z

💛 Build succeeded, but was flaky

continuous-integration/kibana-ci/pull-request
Commit: 8451e23
Flaky suites:
- kibana-ciGroup1

Test Failures

Kibana Pipeline / kibana-oss-agent / Plugin Functional Tests.test/plugin_functional/test_suites/core_plugins/logging·ts.core plugins plugin logging writes info_pattern context to custom pattern appender

Link to Jenkins

Standard Out

Failed Tests Reporter:
  - Test has failed 3 times on tracked branches: https://github.com/elastic/kibana/issues/70149

[00:00:00]       │
[00:01:18]         └-: core plugins
[00:01:18]           └-> "before all" hook
[00:03:51]           └-: plugin logging
[00:03:51]             └-> "before all" hook
[00:03:51]             └-> does not write to custom appenders when not configured
[00:03:51]               └-> "before each" hook: global before each
[00:03:51]               └-> "before each" hook
[00:03:51]               │ proc [kibana]   log   [17:56:56.517] [info][core_logging][debug_json][plugins] i go to the default appender!
[00:03:51]               └- ✓ pass  (48ms) "core plugins plugin logging does not write to custom appenders when not configured"
[00:03:51]             └-> writes debug_json context to custom JSON appender
[00:03:51]               └-> "before each" hook: global before each
[00:03:51]               └-> "before each" hook
[00:03:51]               └- ✓ pass  (40ms) "core plugins plugin logging writes debug_json context to custom JSON appender"
[00:03:51]             └-> writes info_json context to custom JSON appender
[00:03:51]               └-> "before each" hook: global before each
[00:03:51]               └-> "before each" hook
[00:03:51]               └- ✓ pass  (38ms) "core plugins plugin logging writes info_json context to custom JSON appender"
[00:03:51]             └-> writes debug_pattern context to custom pattern appender
[00:03:51]               └-> "before each" hook: global before each
[00:03:51]               └-> "before each" hook
[00:03:51]               └- ✓ pass  (34ms) "core plugins plugin logging writes debug_pattern context to custom pattern appender"
[00:03:51]             └-> writes info_pattern context to custom pattern appender
[00:03:51]               └-> "before each" hook: global before each
[00:03:51]               └-> "before each" hook
[00:03:51]               │ info Taking screenshot "/dev/shm/workspace/kibana/test/functional/screenshots/failure/core plugins plugin logging writes info_pattern context to custom pattern appender.png"
[00:03:52]               │ debg browser[WARNING] http://localhost:6121/9007199254740991/bundles/core_legacy_compat.bundle.js 2495:20 "App [dev_tools] is using deprecated mount context. Use core.getStartServices() instead."
[00:03:52]               │ debg browser[INFO] http://localhost:6121/9007199254740991/bundles/kbn-ui-shared-deps/kbn-ui-shared-deps.js 444:106112 "INFO: 2020-07-01T17:56:56Z
[00:03:52]               │        Adding connection to http://localhost:6121/elasticsearch
[00:03:52]               │
[00:03:52]               │      "
[00:03:52]               │ debg browser[WARNING] http://localhost:6121/9007199254740991/bundles/core_legacy_compat.bundle.js 2495:20 "App [management] is using deprecated mount context. Use core.getStartServices() instead."
[00:03:52]               │ debg browser[WARNING] http://localhost:6121/9007199254740991/bundles/core_legacy_compat.bundle.js 2495:20 "App [rendering] is using deprecated mount context. Use core.getStartServices() instead."
[00:03:52]               │ debg browser[WARNING] http://localhost:6121/9007199254740991/bundles/core_legacy_compat.bundle.js 2495:20 "App [custom-app-route] is using deprecated mount context. Use core.getStartServices() instead."
[00:03:52]               │ debg browser[WARNING] http://localhost:6121/9007199254740991/bundles/core_legacy_compat.bundle.js 2495:20 "App [chromeless] is using deprecated mount context. Use core.getStartServices() instead."
[00:03:52]               │ debg browser[WARNING] http://localhost:6121/9007199254740991/bundles/core_legacy_compat.bundle.js 2495:20 "App [appleave1] is using deprecated mount context. Use core.getStartServices() instead."
[00:03:52]               │ debg browser[WARNING] http://localhost:6121/9007199254740991/bundles/core_legacy_compat.bundle.js 2495:20 "App [appleave2] is using deprecated mount context. Use core.getStartServices() instead."
[00:03:52]               │ debg browser[WARNING] http://localhost:6121/9007199254740991/bundles/core_legacy_compat.bundle.js 2495:20 "App [foo] is using deprecated mount context. Use core.getStartServices() instead."
[00:03:52]               │ debg browser[WARNING] http://localhost:6121/9007199254740991/bundles/core_legacy_compat.bundle.js 2495:20 "App [bar] is using deprecated mount context. Use core.getStartServices() instead."
[00:03:52]               │ debg browser[DEBUG] http://localhost:6121/9007199254740991/bundles/plugin/usageCollection/usageCollection.plugin.js 950:16 "Reporting user-agent."
[00:03:52]               │ debg browser[DEBUG] http://localhost:6121/9007199254740991/bundles/plugin/usageCollection/usageCollection.plugin.js 950:16 "Reporting application changed to core_legacy_compat"
[00:03:52]               │ info Current URL is: http://localhost:6121/app/core_legacy_compat
[00:03:52]               │ info Saving page source to: /dev/shm/workspace/kibana/test/plugin_functional/failure_debug/html/core plugins plugin logging writes info_pattern context to custom pattern appender.html
[00:03:52]               └- ✖ fail: "core plugins plugin logging writes info_pattern context to custom pattern appender"
[00:03:52]               │

Stack Trace

{ Error: expected [ '' ] to sort of equal [ 'CUSTOM - PATTERN [plugins.core_logging.info_pattern][INFO ] log2' ]
    at Assertion.assert (packages/kbn-expect/expect.js:100:11)
    at Assertion.eql (packages/kbn-expect/expect.js:244:8)
    at Context.it (test/plugin_functional/test_suites/core_plugins/logging.ts:119:53)
  actual: '[\n  ""\n]',
  expected:
   '[\n  "CUSTOM - PATTERN [plugins.core_logging.info_pattern][INFO ] log2"\n]',
  showDiff: true }

Build metrics

✅ unchanged

History

💚 Build #57868 succeeded 7e0fdcb
💚 Build #56861 succeeded 5d1b4e5
💚 Build #56817 succeeded cf15a28
💔 Build #56774 failed f42e99d

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

build: add more detailed unmet deps logging

c0f06ff

nickofthyme requested review from joshdover and afharo June 26, 2020 17:03

nickofthyme requested a review from a team as a code owner June 26, 2020 17:03

joshdover reviewed Jun 26, 2020

View reviewed changes

config/kibana.yml Outdated Show resolved Hide resolved

nickofthyme added release_note:skip Skip the PR/issue when compiling release notes v7.9.0 v8.0.0 labels Jun 26, 2020

remove config changes

f42e99d

joshdover reviewed Jun 26, 2020

View reviewed changes

src/core/server/plugins/plugins_service.ts Outdated Show resolved Hide resolved

afharo reviewed Jun 26, 2020

View reviewed changes

nickofthyme marked this pull request as draft June 26, 2020 17:10

refactor logic into single function, update tests

cf15a28

nickofthyme requested a review from joshdover June 26, 2020 18:49

nickofthyme changed the title ~~build: add more detailed unmet deps logging~~ Add more detailed unmet deps logging Jun 26, 2020

nickofthyme marked this pull request as ready for review June 26, 2020 18:53

joshdover reviewed Jun 26, 2020

View reviewed changes

update return signature, add test more cases

5d1b4e5

nickofthyme requested a review from joshdover June 26, 2020 20:49

Merge branch 'master' into unmet-deps-log

7e0fdcb

joshdover approved these changes Jul 1, 2020

View reviewed changes

replace stringify with join

8451e23

nickofthyme merged commit b37b6ed into elastic:master Jul 1, 2020

nickofthyme deleted the unmet-deps-log branch July 1, 2020 19:01

nickofthyme added a commit to nickofthyme/kibana that referenced this pull request Jul 2, 2020

Add more detailed unmet deps logging (elastic#70098)

9fcd6f1

nickofthyme mentioned this pull request Jul 2, 2020

[7.x] Add more detailed unmet deps logging (#70098) #70599

Merged

nickofthyme added a commit that referenced this pull request Jul 2, 2020

Add more detailed unmet deps logging (#70098) (#70599)

3e81c7f

lukeelmers mentioned this pull request Nov 1, 2021

Provide details why plugin disabled #54001

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add more detailed unmet deps logging #70098

Add more detailed unmet deps logging #70098

nickofthyme commented Jun 26, 2020 •

edited

Loading

afharo left a comment •

edited

Loading

nickofthyme commented Jun 26, 2020

joshdover Jun 26, 2020

nickofthyme Jun 26, 2020

joshdover Jun 26, 2020

nickofthyme Jun 26, 2020

nickofthyme commented Jul 1, 2020

nickofthyme commented Jul 1, 2020

joshdover Jul 1, 2020

nickofthyme Jul 1, 2020

kibanamachine commented Jul 1, 2020

Standard Out

Stack Trace

Add more detailed unmet deps logging #70098

Add more detailed unmet deps logging #70098

Conversation

nickofthyme commented Jun 26, 2020 • edited Loading

Summary

afharo left a comment • edited Loading

Choose a reason for hiding this comment

nickofthyme commented Jun 26, 2020

joshdover Jun 26, 2020

Choose a reason for hiding this comment

nickofthyme Jun 26, 2020

Choose a reason for hiding this comment

joshdover Jun 26, 2020

Choose a reason for hiding this comment

nickofthyme Jun 26, 2020

Choose a reason for hiding this comment

nickofthyme commented Jul 1, 2020

nickofthyme commented Jul 1, 2020

joshdover Jul 1, 2020

Choose a reason for hiding this comment

nickofthyme Jul 1, 2020

Choose a reason for hiding this comment

kibanamachine commented Jul 1, 2020

💛 Build succeeded, but was flaky

Test Failures

Standard Out

Stack Trace

Build metrics

History

nickofthyme commented Jun 26, 2020 •

edited

Loading

afharo left a comment •

edited

Loading