[SIEM] Adds ability to infer the newsfeed.enabled setting #56236

rylnd · 2020-01-28T21:23:16Z

Summary

In order to determine whether to show the new Security news feed within the SIEM app, we first need to know whether the newsfeed is disabled globally.

Since we are no longer able to access the newsfeed.enabled setting directly from the kibana config, we needed to make some changes to the newsfeed plugin in order to infer that setting's value. With these changes, dependent plugins can predicate upon the presence/absence of the newsfeed plugin in the same way as the newsfeed.enabled boolean.

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

~~[ ] This was checked for cross-browser compatibility, including a check against IE11~~
-~~ [ ] Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support~~
~~[ ] Documentation was added for features that require explanation or tutorials~~
~~[ ] Unit or functional tests were updated or added to match the most common scenarios~~
~~[ ] This was checked for keyboard-only and screenreader accessibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately
This includes a feature addition or change that requires a release note and was labeled appropriately

Without a contract, dependent plugins have no way of knowing whether the plugin is enabled or not as the contract will always be undefined.

So that dependent plugins can use them.

We're going to use the availability of the newsfeed plugin as part of our determination for whether or not to show the security newsfeed. If users set `newsfeed.enabled: false`, the plugin will be unavailable and the security feed will not be shown.

elasticmachine · 2020-01-28T21:25:57Z

Pinging @elastic/siem (Team:SIEM)

src/plugins/newsfeed/public/plugin.tsx

tsullivan

See if my suggested change can be made and let you avoid the eslint-disable

The presence of the newsfeed plugin means that newsfeed.enabled is true. If both that and our local setting are true, we will show the Security feed.

tsullivan

LGTM

reviewed the code only

andrew-goldstein

Thank you @rylnd for implementing this request from @MikePaquette! 🙏

When the newsfeed.enabled setting in config/kibana.yml is changed from it's default value to false, the Security news widget in the SIEM Overview will not make a network request for news, and the Security news widget will not be displayed in the Overview.

Setting newsfeed.enabled to false in config/kibana.yml overrides the setting shown in the screenshot below:

I desk tested this with @rylnd over a zoom.

LGTM 🚀 📰

rylnd · 2020-01-28T22:58:09Z

@elasticmachine merge upstream

kibanamachine · 2020-01-29T00:14:52Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 91b05db

History

💔 Build #23164 failed ea9bbc9

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

XavierM · 2020-01-29T00:47:40Z

@rylnd @tsullivan
~~Am I wondering if we need to add newsfeed as require here now since it is a dependency https://github.com/elastic/kibana/blob/master/x-pack/legacy/plugins/siem/index.ts#L43~~

After discussing with Ryland, we are loading newsfeed through ui/new-platform so we should be fine since we are doing the same with map embeddable.

) * Always return a contract from the newsfeed plugin Without a contract, dependent plugins have no way of knowing whether the plugin is enabled or not as the contract will always be undefined. * Export newsfeed contract types from public index So that dependent plugins can use them. * Declare newsfeed as an optional dependency of SIEM We're going to use the availability of the newsfeed plugin as part of our determination for whether or not to show the security newsfeed. If users set `newsfeed.enabled: false`, the plugin will be unavailable and the security feed will not be shown. * Respect global newsfeed.enabled config in Security newsfeed The presence of the newsfeed plugin means that newsfeed.enabled is true. If both that and our local setting are true, we will show the Security feed. * Prefer object type over empty interface Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

…56265) * Always return a contract from the newsfeed plugin Without a contract, dependent plugins have no way of knowing whether the plugin is enabled or not as the contract will always be undefined. * Export newsfeed contract types from public index So that dependent plugins can use them. * Declare newsfeed as an optional dependency of SIEM We're going to use the availability of the newsfeed plugin as part of our determination for whether or not to show the security newsfeed. If users set `newsfeed.enabled: false`, the plugin will be unavailable and the security feed will not be shown. * Respect global newsfeed.enabled config in Security newsfeed The presence of the newsfeed plugin means that newsfeed.enabled is true. If both that and our local setting are true, we will show the Security feed. * Prefer object type over empty interface Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

…56266) * Always return a contract from the newsfeed plugin Without a contract, dependent plugins have no way of knowing whether the plugin is enabled or not as the contract will always be undefined. * Export newsfeed contract types from public index So that dependent plugins can use them. * Declare newsfeed as an optional dependency of SIEM We're going to use the availability of the newsfeed plugin as part of our determination for whether or not to show the security newsfeed. If users set `newsfeed.enabled: false`, the plugin will be unavailable and the security feed will not be shown. * Respect global newsfeed.enabled config in Security newsfeed The presence of the newsfeed plugin means that newsfeed.enabled is true. If both that and our local setting are true, we will show the Security feed. * Prefer object type over empty interface Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

* master: (31 commits) [SIEM] Overview page feedback (elastic#56261) refactor (elastic#56131) [NP Cleanup] Remove ui/public/inspector (elastic#55677) [SIEM] [TIMELINE] Only add endpoint logo when on event.module === endgame (elastic#56263) Basic Functionality Alert List (elastic#55800) [SIEM] Fix filters on Hosts and Network page (elastic#56234) [SIEM] Adds ability to infer the newsfeed.enabled setting (elastic#56236) [SIEM][Detection Engine] critical blocker for updated rules [SIEM][Detection Engine] critical blocker, fixes ordering issue that causes rules to not run the first time [SIEM] Add link to endpoint app through reference.url (elastic#56211) [Metrics UI] Fixing title truncation in Metrics Explorer (elastic#55917) [SIEM] Put the notice for rules in comment block (elastic#56123) [SIEM][Detection Engine] critical blocker with the UI crashing Consistent timeouts for the Space onPostAuth interceptor tests (elastic#56158) Skip tests that depend on other skipped test [SIEM] [Detection Engine] Timestamps for rules (elastic#56197) Sort server-side in SavedObject export (elastic#55128) [Reporting] Document the 8.0 breaking changes (elastic#56187) Revert "[Monitoring] Change all configs to `monitoring.*`" (elastic#56214) add owners for es_archiver (elastic#56184) ...

…55831 * '7.x' of github.com:elastic/kibana: (78 commits) Re-enable watcher FireFox functional test (elastic#56112) (elastic#56294) [Metrics UI] Fixing title truncation in Metrics Explorer (elastic#55917) (elastic#56248) [APM] x-axis labels on Error occurrences chart are incorrect based on Kibana timezone (elastic#55686) (elastic#56288) Migrate saved_object_save_as_checkbox directive to timelion (elastic#56114) (elastic#56286) [APM] Treat error.exception.stacktrace.line as optional (elastic#55733) (elastic#55840) Remove alerts and actions from feature catalogue (elastic#56140) (elastic#56208) Migrate UI capabilities to use new platform APIs (elastic#56070) (elastic#56207) [ML] Add functional tests for analytics UI: creation addition and regression/outlier results (elastic#56059) (elastic#56191) [SIEM] Overview page feedback (elastic#56261) (elastic#56276) [NP Cleanup] Remove ui/public/inspector (elastic#55677) (elastic#56271) [Index template] Fix editor should support mappings types (elastic#55804) fixes map index message (elastic#56104) (elastic#56194) [SIEM] [TIMELINE] Only add endpoint logo when on event.module === endgame (elastic#56263) (elastic#56269) [SIEM] Fix filters on Hosts and Network page (elastic#56234) (elastic#56267) [SIEM] Adds ability to infer the newsfeed.enabled setting (elastic#56236) (elastic#56265) [SIEM][Detection Engine] critical blocker for updated rules (elastic#56259) [SIEM] Put the notice for rules in comment block (elastic#56123) (elastic#56246) [SIEM][Detection Engine] critical blocker, fixes ordering issue that causes rules to not run the first time (elastic#56256) [Reporting/NP] Migration of Reporting Security dependency (elastic#56046) (elastic#56198) [SIEM] Add link to endpoint app through reference.url (elastic#56211) (elastic#56250) ... # Conflicts: # x-pack/plugins/watcher/public/plugin.ts

rylnd added 3 commits January 28, 2020 15:06

Always return a contract from the newsfeed plugin

fc49036

Without a contract, dependent plugins have no way of knowing whether the plugin is enabled or not as the contract will always be undefined.

Export newsfeed contract types from public index

ecbd481

So that dependent plugins can use them.

rylnd requested a review from andrew-goldstein January 28, 2020 21:23

rylnd self-assigned this Jan 28, 2020

rylnd added v7.6.0 v7.7.0 v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Team:SIEM labels Jan 28, 2020

patrykkopycinski approved these changes Jan 28, 2020

View reviewed changes

tsullivan reviewed Jan 28, 2020

View reviewed changes

src/plugins/newsfeed/public/plugin.tsx Outdated Show resolved Hide resolved

tsullivan requested changes Jan 28, 2020

View reviewed changes

rylnd added 2 commits January 28, 2020 15:59

Respect global newsfeed.enabled config in Security newsfeed

5b6af2b

The presence of the newsfeed plugin means that newsfeed.enabled is true. If both that and our local setting are true, we will show the Security feed.

Prefer object type over empty interface

9749dc0

rylnd requested a review from tsullivan January 28, 2020 22:02

tsullivan approved these changes Jan 28, 2020

View reviewed changes

andrew-goldstein approved these changes Jan 28, 2020

View reviewed changes

Merge branch 'master' into siem_newsfeed_setting

91b05db

rylnd merged commit 02befde into elastic:master Jan 29, 2020

This was referenced Jan 29, 2020

[7.x] [SIEM] Adds ability to infer the newsfeed.enabled setting (#56236) #56265

Merged

[7.6] [SIEM] Adds ability to infer the newsfeed.enabled setting (#56236) #56266

Merged

rylnd deleted the siem_newsfeed_setting branch January 29, 2020 04:44

rylnd mentioned this pull request Apr 30, 2020

[SIEM] NP Plugin dependency cleanup #64842

Merged

3 tasks

alexfrancoeur mentioned this pull request Sep 24, 2020

[Core UI] Kibana Overview Page #75827

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SIEM] Adds ability to infer the newsfeed.enabled setting #56236

[SIEM] Adds ability to infer the newsfeed.enabled setting #56236

rylnd commented Jan 28, 2020

elasticmachine commented Jan 28, 2020

tsullivan left a comment

tsullivan left a comment

andrew-goldstein left a comment

rylnd commented Jan 28, 2020

kibanamachine commented Jan 29, 2020

XavierM commented Jan 29, 2020 •

edited

Loading

[SIEM] Adds ability to infer the newsfeed.enabled setting #56236

[SIEM] Adds ability to infer the newsfeed.enabled setting #56236

Conversation

rylnd commented Jan 28, 2020

Summary

Checklist

For maintainers

elasticmachine commented Jan 28, 2020

tsullivan left a comment

Choose a reason for hiding this comment

tsullivan left a comment

Choose a reason for hiding this comment

andrew-goldstein left a comment

Choose a reason for hiding this comment

rylnd commented Jan 28, 2020

kibanamachine commented Jan 29, 2020

💚 Build Succeeded

History

XavierM commented Jan 29, 2020 • edited Loading

XavierM commented Jan 29, 2020 •

edited

Loading