[SIEM] Client NP Cutover #64251

rylnd · 2020-04-22T21:24:24Z

Summary

This is meant to be the final PR for Siem's NP Migration (#45831). Similar to its companion (#63430), I've chunked this into two logical pieces:

Moving of files
Logical changes
- Declaration of client plugin dependencies in kibana.json
- Removal of references to legacy folder
- App registration (core.application.register)
  - this already existed, but I think the legacy app and links uiExports were overriding this behavior

TODO:

Fix our maps embeddable once [Maps] Migrate Maps embeddables to NP #63976 is merged
- ~~That PR has been merged to master (and here), but our map still isn't rendering. Currently investigating.~~ Fixed in [Maps] Include maps styles in embeddables factory so that they're bundled w/ consuming plugins #64460

Reviewer Notes:

I removed @types/js-yaml from our local package.json as it seemed like dead code (our types are working)
react-beautiful-dnd was removed from our package.json in Upgrade to EUI v22.3.0 #62963. I haven't seen any issues there, but it's worth mentioning again.
We need to perform an audit of our plugin dependencies (see 7564088). I previously created an issue for this: [SIEM] Audit our plugin dependencies and their availability #59250

Checklist

Unit or functional tests were updated or added to match the most common scenarios
This was checked for cross-browser compatibility, including a check against IE11

For maintainers

This was checked for breaking API changes and was labeled appropriately

This is solely renames; fixes come next.

These paths got a little shorter, so some lines could be collapsed.

I'm removing the @types/js-yaml for now because I'm not sure we need it; I'll add it back later if we do.

This previously had to be part of legacy bootstrapping due to an order of operations issue.

The index file should now be redundant with what's in the plugin: * app registration * feature registration

We can now use the NP API. Maps embeddable will not work here until their work is merged, but this should prevent us from importing legacy code and thus breaking the build.

These are all required for now, because that's how they're typed. If they _should_ be optional (and I think several should), we need to update the type and handle the null case within the app.

We're not using their contracts, but we are importing code from them.

* Replace build-breaking ui/new_platform mocks with equivalents in core proper * Remove unnecessary mocks of ui/new_platform

* I left the reference in CODEOWNERS in case someone tries to sneak something back * I left the .gitignore reference for the same reason

These were not caught by typescript and were causing test failures.

They're empty for now.

The new one dropped a param we weren't using.

Import them from core where we need them, instead

This is already imported, there's no benefit (and potential timing issues) with doing this inside the mount.

This doesn't change what's used, only how we're typing it. The types are now a little more truthful as: * our StartPlugins don't include setup contracts * our StartServices includes everything we use at Start time, including the one setup plugin.

These are shared, and should be consistent.

These were the legacy translations used... well, I don't know where they were used.

x-pack/legacy/plugins/siem/index.ts

rylnd · 2020-04-23T16:35:19Z

RE IE11 testing: I can't get kibana to load on this branch due to the following errors:

However, these are also present on master so I guess we'll punt for now.

We import our maps embeddable from maps, and we pass inspector to the embeddable. I just missed these in my audit. This was causing errors in the map embeddable.

This is an async call that we need to complete before we can render.

Conflicts: x-pack/index.js

rudolf · 2020-04-27T18:09:03Z

x-pack/plugins/siem/public/plugin.tsx

+import { SecurityPluginSetup } from '../../security/public';
+import { APP_ID, APP_NAME, APP_PATH, APP_ICON } from '../common/constants';
+import { initTelemetry } from './lib/telemetry';
+import { KibanaServices } from './lib/kibana';


Because we don't do tree-shaking this will inadvertently pull in the kibana_react plugin. It's currently an external module so this won't increase the bundle-size, but it would be better to have separate modules for KibanaServices used in the plugin.ts and the kibana_react and other dependencies used in app.tsx

@rudolf I addressed this one specifically in dd1bcd6, but the initTelemetry and serviceNowActionType imports correspond to ~500kB and ~70kB worth of code, respectively. Without those, the plugin bundle is about 10kB (!). I created #64589 as a followup to this PR.

When we load our initial plugin (before our app is loaded), were were implicitly importing all of kibana_react with this import. While a global module prevents this from affecting our bundle size currently, that could change in the future. Since we only need a reference to our class, we just import that instead.

XavierM

LGTM,

Tested Locally all the different pages and functionalities on chrome, everything is working as expected.
The code change makes sense and the Map is working <3.

Conflicts: Jenkinsfile x-pack/plugins/siem/public/containers/case/configure/mock.ts x-pack/plugins/siem/public/pages/case/components/configure_cases/index.test.tsx x-pack/plugins/siem/public/pages/case/components/configure_cases/reducer.test.ts x-pack/plugins/siem/public/pages/case/components/configure_cases/reducer.ts

kibanamachine · 2020-04-27T22:45:16Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 94e3f3c

History

💚 Build #43445 succeeded 910c7c3
💚 Build #43412 succeeded 6dde8f8
💚 Build #43185 succeeded 924cb82
💚 Build #42925 succeeded 77b1a2e
💚 Build #42835 succeeded b72bee6

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

* Move SIEM public/ folder to NP plugin This is solely renames; fixes come next. * Update relative imports in our API tests * Fix linter errors following move to NP folder These paths got a little shorter, so some lines could be collapsed. * Move client dependencies to NP package.json I'm removing the @types/js-yaml for now because I'm not sure we need it; I'll add it back later if we do. * Fix relative imports to other plugins * Fix errant uses of ui/chrome * Remove legacy plugin shim * Move feature registration into plugin This previously had to be part of legacy bootstrapping due to an order of operations issue. * Disconnect legacy plugin The index file should now be redundant with what's in the plugin: * app registration * feature registration * Move public gitattributes * Remove references to legacy embeddables We can now use the NP API. Maps embeddable will not work here until their work is merged, but this should prevent us from importing legacy code and thus breaking the build. * Add our frontend dependencies to kibana.json These are all required for now, because that's how they're typed. If they _should_ be optional (and I think several should), we need to update the type and handle the null case within the app. * Replace use of ui/new_platform mocks in embeddable utils * Fix remaining jest tests * Replace build-breaking ui/new_platform mocks with equivalents in core proper * Remove unnecessary mocks of ui/new_platform * Remove references to legacy SIEM folder * I left the reference in CODEOWNERS in case someone tries to sneak something back * I left the .gitignore reference for the same reason * Fix mocks of relative paths These were not caught by typescript and were causing test failures. * Export our client plugin contracts They're empty for now. * Move from deprecated appmount API The new one dropped a param we weren't using. * Add missing mock causing test failures * Don't re-export core types from our plugin Import them from core where we need them, instead * Move Actions UI registry outside of mount This is already imported, there's no benefit (and potential timing issues) with doing this inside the mount. * Add security's setup contract to our StartServices This doesn't change what's used, only how we're typing it. The types are now a little more truthful as: * our StartPlugins don't include setup contracts * our StartServices includes everything we use at Start time, including the one setup plugin. * Add order and icon back to the sidebar link * Replace plugin class properties with constants These are shared, and should be consistent. * Enable our UI on NP * Add missed plugin dependencies We're not using their contracts, but we are importing code from them. * Revert use of constant in translation Can't do that, whoops * i18n our feature catalogue entry * Remove unnecessary array from single element * Remove unused keys These were the legacy translations used... well, I don't know where they were used. * Ignore circular dependencies in external plugins * Normalize exclusions * Add undeclared dependencies to kibana.json We import our maps embeddable from maps, and we pass inspector to the embeddable. I just missed these in my audit. This was causing errors in the map embeddable. * Await our call to setLayerList This is an async call that we need to complete before we can render. * Reduce siem plugin size When we load our initial plugin (before our app is loaded), were were implicitly importing all of kibana_react with this import. While a global module prevents this from affecting our bundle size currently, that could change in the future. Since we only need a reference to our class, we just import that instead.

elasticmachine · 2021-09-23T14:35:19Z

Pinging @elastic/security-solution (Team: SecuritySolution)

rylnd added 26 commits April 22, 2020 12:22

Move SIEM public/ folder to NP plugin

0a790b6

This is solely renames; fixes come next.

Update relative imports in our API tests

9c8a803

Fix linter errors following move to NP folder

abd851e

These paths got a little shorter, so some lines could be collapsed.

Move client dependencies to NP package.json

7dda611

I'm removing the @types/js-yaml for now because I'm not sure we need it; I'll add it back later if we do.

Fix relative imports to other plugins

f66d809

Fix errant uses of ui/chrome

4dd5cce

Remove legacy plugin shim

73c24de

Move feature registration into plugin

1743ad1

This previously had to be part of legacy bootstrapping due to an order of operations issue.

Disconnect legacy plugin

94ed640

The index file should now be redundant with what's in the plugin: * app registration * feature registration

Move public gitattributes

5d96af6

Remove references to legacy embeddables

aa0c279

We can now use the NP API. Maps embeddable will not work here until their work is merged, but this should prevent us from importing legacy code and thus breaking the build.

Add our frontend dependencies to kibana.json

7564088

These are all required for now, because that's how they're typed. If they _should_ be optional (and I think several should), we need to update the type and handle the null case within the app.

Add missed plugin dependencies

bd87328

We're not using their contracts, but we are importing code from them.

Replace use of ui/new_platform mocks in embeddable utils

9a79273

Fix remaining jest tests

aaac17d

* Replace build-breaking ui/new_platform mocks with equivalents in core proper * Remove unnecessary mocks of ui/new_platform

Remove references to legacy SIEM folder

4703723

* I left the reference in CODEOWNERS in case someone tries to sneak something back * I left the .gitignore reference for the same reason

Fix mocks of relative paths

5addd3a

These were not caught by typescript and were causing test failures.

Export our client plugin contracts

dffc3d1

They're empty for now.

Move from deprecated appmount API

449b848

The new one dropped a param we weren't using.

Add missing mock causing test failures

d1e355c

Don't re-export core types from our plugin

f380331

Import them from core where we need them, instead

Move Actions UI registry outside of mount

e16e90b

This is already imported, there's no benefit (and potential timing issues) with doing this inside the mount.

Add order and icon back to the sidebar link

4f3aa9c

Replace plugin class properties with constants

a1afb14

These are shared, and should be consistent.

Enable our UI on NP

09507e4

rylnd added Team:SIEM v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.8.0 labels Apr 22, 2020

rylnd added 3 commits April 22, 2020 18:01

i18n our feature catalogue entry

ed46115

Remove unnecessary array from single element

a65fd5b

Remove unused keys

7ee51c9

These were the legacy translations used... well, I don't know where they were used.

rylnd commented Apr 23, 2020

View reviewed changes

x-pack/legacy/plugins/siem/index.ts Show resolved Hide resolved

rylnd added 6 commits April 23, 2020 12:21

Ignore circular dependencies in external plugins

3fbe649

Normalize exclusions

b72bee6

Add undeclared dependencies to kibana.json

7eaec66

We import our maps embeddable from maps, and we pass inspector to the embeddable. I just missed these in my audit. This was causing errors in the map embeddable.

Merge branch 'master' into rh/siem_client_np

77b1a2e

Await our call to setLayerList

924cb82

This is an async call that we need to complete before we can render.

Merge branch 'master' into rh/siem_client_np

6dde8f8

Conflicts: x-pack/index.js

rylnd marked this pull request as ready for review April 27, 2020 15:38

rylnd requested a review from a team as a code owner April 27, 2020 15:38

rylnd requested a review from rudolf April 27, 2020 15:39

Merge branch 'master' into rh/siem_client_np

910c7c3

rudolf reviewed Apr 27, 2020

View reviewed changes

XavierM approved these changes Apr 27, 2020

View reviewed changes

rylnd mentioned this pull request Apr 27, 2020

[SIEM] Plugin bundle optimizations #64589

Closed

rylnd merged commit 4cc5b3a into elastic:master Apr 27, 2020

rylnd deleted the rh/siem_client_np branch April 27, 2020 22:59

This was referenced Apr 27, 2020

[7.x] [SIEM] Client NP Cutover (#64251) #64603

Merged

[SIEM] New Platform Cutover #59624

Closed

spong mentioned this pull request Apr 28, 2020

[SIEM] Migrate to new platform #45831

Closed

26 tasks

MindyRS added the Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. label Sep 23, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SIEM] Client NP Cutover #64251

[SIEM] Client NP Cutover #64251

rylnd commented Apr 22, 2020 •

edited

Loading

rylnd commented Apr 23, 2020

rudolf Apr 27, 2020

rylnd Apr 27, 2020

XavierM left a comment

kibanamachine commented Apr 27, 2020

elasticmachine commented Sep 23, 2021

[SIEM] Client NP Cutover #64251

[SIEM] Client NP Cutover #64251

Conversation

rylnd commented Apr 22, 2020 • edited Loading

Summary

Checklist

For maintainers

rylnd commented Apr 23, 2020

rudolf Apr 27, 2020

Choose a reason for hiding this comment

rylnd Apr 27, 2020

Choose a reason for hiding this comment

XavierM left a comment

Choose a reason for hiding this comment

kibanamachine commented Apr 27, 2020

💚 Build Succeeded

History

elasticmachine commented Sep 23, 2021

rylnd commented Apr 22, 2020 •

edited

Loading