[SIEM] [Security] unified code structure phase 0 by XavierM · Pull Request #65965 · elastic/kibana

XavierM · 2020-05-11T03:39:27Z

Summary

This PR is to allow our family to get bigger and to have a better dev experience in our security code structure. Instead, to have as the upper-level components/containers/pages/store etc, we wanted to have the area on the top level like hosts/network/cases/timelines/alerts -> components/containers/pages/store etc...

We call this phase 0 because we just wanted to move the file around where it makes the most sense. The next phase will be to clean up more the dependencies between the sub-plugins. This PR was just tedious because of moving all the files and fixing the imports. Thanks To @patrykkopycinski and @cnasikas for the big help.

Reviewer instructions

Note: there are too many files changed in this branch for GitHub to present a nice diff. Instead, you'll have to review this locally:

# configure kibana repo to track renames across lots of files (this is what GitHub isn't doing)
git config diff.renamelimit 2600

# check out the branch locally
git fetch origin refs/pull/65965/head
git checkout -b XavierM/security-structure-2 FETCH_HEAD

# to view the full diff against master:
git diff $(git merge-base head master)

# to view a single file's history:
git log -p --follow -- <path-to-file>

rylnd · 2020-05-11T20:11:32Z

Just a quick comment: it does look like this inflates siem's initial bundle pretty significantly (2MB up from 200kB) :

I think we can fix it after this gets merged, but there's also a quick, naive fix for this branch if you want it:

diff --git a/x-pack/plugins/siem/public/plugin.tsx b/x-pack/plugins/siem/public/plugin.tsx
index 1a76e52c98..cc46025ddc 100644
--- a/x-pack/plugins/siem/public/plugin.tsx
+++ b/x-pack/plugins/siem/public/plugin.tsx
@@ -33,12 +33,6 @@ import { APP_ID, APP_NAME, APP_PATH, APP_ICON } from '../common/constants';
 import { initTelemetry } from './common/lib/telemetry';
 import { KibanaServices } from './common/lib/kibana/services';
 import { serviceNowActionType, jiraActionType } from './common/lib/connectors';
-import { Cases } from './cases';
-import { Alerts } from './alerts';
-import { Hosts } from './hosts';
-import { Network } from './network';
-import { Overview } from './overview';
-import { Timelines } from './timelines';
 
 export interface SetupPlugins {
   home: HomePublicPluginSetup;
@@ -68,12 +62,6 @@ export interface PluginStart {}
 
 export class Plugin implements IPlugin<PluginSetup, PluginStart, SetupPlugins, StartPlugins> {
   private kibanaVersion: string;
-  private readonly alertsSubPlugin = new Alerts();
-  private readonly casesSubPlugin = new Cases();
-  private readonly hostsSubPlugin = new Hosts();
-  private readonly networkSubPlugin = new Network();
-  private readonly overviewSubPlugin = new Overview();
-  private readonly timelinesSubPlugin = new Timelines();
 
   constructor(initializerContext: PluginInitializerContext) {
     this.kibanaVersion = initializerContext.env.packageInfo.version;
@@ -108,12 +96,19 @@ export class Plugin implements IPlugin<PluginSetup, PluginStart, SetupPlugins, S
         security: plugins.security,
       } as StartServices;
 
-      const alertsStart = this.alertsSubPlugin.start();
-      const casesStart = this.casesSubPlugin.start();
-      const hostsStart = this.hostsSubPlugin.start();
-      const networkStart = this.networkSubPlugin.start();
-      const overviewStart = this.overviewSubPlugin.start();
-      const timelinesStart = this.timelinesSubPlugin.start();
+      const alertsSubPlugin = new (await import('./alerts')).Alerts();
+      const casesSubPlugin = new (await import('./cases')).Cases();
+      const hostsSubPlugin = new (await import('./hosts')).Hosts();
+      const networkSubPlugin = new (await import('./network')).Network();
+      const overviewSubPlugin = new (await import('./overview')).Overview();
+      const timelinesSubPlugin = new (await import('./timelines')).Timelines();
+
+      const alertsStart = alertsSubPlugin.start();
+      const casesStart = casesSubPlugin.start();
+      const hostsStart = hostsSubPlugin.start();
+      const networkStart = networkSubPlugin.start();
+      const overviewStart = overviewSubPlugin.start();
+      const timelinesStart = timelinesSubPlugin.start();
 
       return renderApp(services, params, {
         routes: [

…cture-2

rylnd · 2020-05-11T23:17:20Z

@elasticmachine merge upstream

rylnd

Checked it out locally, ran through some standard desk tests. Did not check every single line of code, but I did page through the entirety of it with git diff $(git merge-base master head) -w --word-diff=color to see if there were any large logical changes: besides the top-level restructuring, things looked pretty mechanical/straightforward.

I was not able to find any issues with my desk testing, and once CI is green I think that'll give us enough confidence to merge this now and fix any outstanding issues between now and release.

This new structure is going to be really nice moving forward; thank you for taking the time to do this @XavierM 🥇

rylnd · 2020-05-11T23:21:26Z

@elasticmachine merge upstream

… security-structure-2

kibanamachine · 2020-05-12T02:51:46Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 08a5ab8

History

💔 Build #47150 failed 0765937
💔 Build #47117 failed d784e05
💔 Build #47136 failed c2b9e1e
💔 Build #46971 failed 39bed1b
💔 Build #46808 failed 39bed1b

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

* master: (46 commits) [Drilldowns][chore] Remove some any's from components. Remove `PlaceContext` from components (elastic#65854) [functional/services] import By/until from module (elastic#66015) [Drilldowns][IE] fix welcome bar layout in IE (elastic#65676) Inspect action shows on dashboard for every chart (elastic#65998) Fix heigt calc in calc issue for ie11 (elastic#66010) [Flights] Delay Bucket - Error notification on opening sample visualization (elastic#66028) [SIEM] [Security] unified code structure phase 0 (elastic#65965) [Maps] Organize layers into subfolders (elastic#65513) skip flaky suite (elastic#59849) Cleanup prefill and edit flow. (elastic#66105) Fix major severity service map ring colors (elastic#66124) [DOCS] Improves formatting in action types (elastic#65932) [DOCS] APM Agent config: Setting values must be string (elastic#65875) Change default cert age limit value. (elastic#65918) [DOCS] Removed saved object options (elastic#66072) [SIEM] [Cases] Case API tests (elastic#65777) Add example of of local plugin installation (elastic#65986) skip flaky suite (elastic#65741) [SIEM][Detections] Restrict ML rule modification to ML Admins (elastic#65583) [Reporting/Test] Add Functional test for download CSV (elastic#65401) ...

…ine-editor * 'master' of github.com:elastic/kibana: (37 commits) [APM] Correct relative paths in scripts (#66159) [Uptime] Enable deselection of stale filters (#65523) [Drilldowns][chore] Remove some any's from components. Remove `PlaceContext` from components (#65854) [functional/services] import By/until from module (#66015) [Drilldowns][IE] fix welcome bar layout in IE (#65676) Inspect action shows on dashboard for every chart (#65998) Fix heigt calc in calc issue for ie11 (#66010) [Flights] Delay Bucket - Error notification on opening sample visualization (#66028) [SIEM] [Security] unified code structure phase 0 (#65965) [Maps] Organize layers into subfolders (#65513) skip flaky suite (#59849) Cleanup prefill and edit flow. (#66105) Fix major severity service map ring colors (#66124) [DOCS] Improves formatting in action types (#65932) [DOCS] APM Agent config: Setting values must be string (#65875) Change default cert age limit value. (#65918) [DOCS] Removed saved object options (#66072) [SIEM] [Cases] Case API tests (#65777) Add example of of local plugin installation (#65986) skip flaky suite (#65741) ...

* apply new structure for teh security solutions * fix few imports + store * fix types * update path in test * miss path in api_integration Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> # Conflicts: # x-pack/plugins/siem/public/components/paginated_table/index.tsx # x-pack/plugins/siem/public/containers/hosts/index.tsx # x-pack/plugins/siem/public/pages/detection_engine/components/activity_monitor/columns.tsx # x-pack/plugins/siem/public/pages/detection_engine/components/activity_monitor/index.tsx # x-pack/plugins/siem/public/pages/detection_engine/rules/all/columns.tsx # x-pack/plugins/siem/public/pages/network/ip_details/index.test.tsx

oatkiller

Thank you! Pumped to work together more.

kibanamachine · 2020-05-14T02:58:44Z

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.

tonymeehan · 2020-05-14T15:10:08Z

kibanamachine · 2020-05-15T03:08:44Z

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.

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

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

XavierM added 2 commits May 10, 2020 23:11

apply new structure for teh security solutions

812a131

fix few imports + store

39bed1b

XavierM added Team:SIEM v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.9.0 labels May 11, 2020

XavierM requested a review from rylnd May 11, 2020 03:39

XavierM requested review from a team as code owners May 11, 2020 03:39

XavierM closed this May 11, 2020

XavierM reopened this May 11, 2020

XavierM closed this May 11, 2020

XavierM reopened this May 11, 2020

XavierM requested review from oatkiller and spong May 11, 2020 14:56

XavierM added 2 commits May 11, 2020 17:01

fix types

d784e05

Merge branch 'master' of github.com:elastic/kibana into security-stru…

c2b9e1e

…cture-2

rylnd approved these changes May 11, 2020

View reviewed changes

elasticmachine and others added 4 commits May 11, 2020 16:21

Merge branch 'master' into security-structure-2

0765937

update path in test

f4fc8dc

Merge branch 'security-structure-2' of github.com:XavierM/kibana into…

ae83810

… security-structure-2

miss path in api_integration

08a5ab8

XavierM merged commit 3bb51bb into elastic:master May 12, 2020

XavierM mentioned this pull request May 12, 2020

[7.x] [SIEM] [Security] unified code structure phase 0 (#65965) #66221

Merged

oatkiller reviewed May 12, 2020

View reviewed changes

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label May 14, 2020

cnasikas pushed a commit that referenced this pull request May 15, 2020

[7.x] [SIEM] [Security] unified code structure phase 0 (#65965) (#66221)

38f469b

kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label May 15, 2020

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] [Security] unified code structure phase 0#65965

[SIEM] [Security] unified code structure phase 0#65965
XavierM merged 8 commits intoelastic:masterfrom
XavierM:security-structure-2

XavierM commented May 11, 2020 •

edited

Loading

Uh oh!

rylnd commented May 11, 2020

Uh oh!

rylnd commented May 11, 2020

Uh oh!

rylnd left a comment

Uh oh!

rylnd commented May 11, 2020

Uh oh!

kibanamachine commented May 12, 2020

Uh oh!

oatkiller left a comment

Uh oh!

kibanamachine commented May 14, 2020

Uh oh!

tonymeehan commented May 14, 2020

Uh oh!

kibanamachine commented May 15, 2020

Uh oh!

elasticmachine commented Sep 23, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Conversation

XavierM commented May 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Reviewer instructions

Uh oh!

rylnd commented May 11, 2020

Uh oh!

rylnd commented May 11, 2020

Uh oh!

rylnd left a comment

Choose a reason for hiding this comment

Uh oh!

rylnd commented May 11, 2020

Uh oh!

kibanamachine commented May 12, 2020

💚 Build Succeeded

History

Uh oh!

oatkiller left a comment

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented May 14, 2020

Uh oh!

tonymeehan commented May 14, 2020

Uh oh!

kibanamachine commented May 15, 2020

Uh oh!

elasticmachine commented Sep 23, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

XavierM commented May 11, 2020 •

edited

Loading