[Security Solution] Put Artifacts by Policy feature behind a feature flag #95284

dasansol92 · 2021-03-24T10:57:33Z

Summary

This pr includes code from this branch that allows users assign artifacts by policy.

It also includes feature flag management on Ui with a new custom hook that checks if the desired feature is enabled or not.
This hook uses a new key on redux state inside the app namespace making it available for all security plugins.
In order to use this hook under security app you have to import it and call it on this way:

import { useIsExperimentalFeatureEnabled } from '*/common/hooks/use_experimental_features';
const isSomeFeatureFlagYouWantToCheckEnabled: boolean = useIsExperimentalFeatureEnabled(
      'someFeatureFlagYouWantToCheck'
    );

To enable this feature flag in dev env just write this into your kibana.dev.yml:

xpack.securitySolution.enableExperimental:
- trustedAppsByPolicyEnabled

Behind the scenes it uses enableExperimental plugin configuration
On the BE, it forces the default value for effectScope when feature flag is not enabled.

Feature Flag:

Edit action:

It also includes unit tests.

Checklist

Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

For maintainers

This was checked for breaking API changes and was labeled appropriately

… into feature branch

* Initial version of API for trusted apps per policy. * Fixed compilation errors because of missing new property. * Mapping from tags to policies and back. (No testing) * Fixed compilation error after pulling in main. * Fixed failing tests. * Separated out the prefix in tag for policy reference into constant. Co-authored-by: Kibana Machine <[email protected]>

…er Global or Policy Specific (elastic#88707) * Create form supports selecting policies or making Trusted app global * New component `EffectedPolicySelect` - for selecting policies * Enhanced `waitForAction()` test utility to provide a `validate()` option

elastic#89479) * Add Edit button to TA card UI * Support additional url params (`show`, `id`) * Refactor TrustedAppForm to support Editing of an existing entry

…lastic#90333) * New API route for Update (`PUT`) * Connect UI to Update (PUT) API * Add `version` to TrustedApp type and return it on the API responses * Refactor - moved some public/server shared modules to top-level `common/*`

…rusted App item (elastic#90842) * Get One Trusted App API - route, service, handler * Adjust UI to call GET api to retrieve trusted app for edit * Deleted ununsed trusted app types file * Add UI handling of non-existing TA for edit or when id is missing in url

…rusted Apps (elastic#91656) * correct trusted app schema to ensure `version` is not exposed on TS type for POST * Added updated_by, updated_on properties to TrustedApp * Refactored TA List view to fix bug where card was not updated on a successful edit * Test cases for card interaction from the TA List view * Change title of policy selection to `Assignment` * Selectable Policy CSS adjustments based on UX feedback

…port (elastic#92611) * Fix bad merge from master * Fix trusted apps generator * Add `kuery` to the GET (list) Trusted Apps api

…te/update trusted app schema

…feature flag value from state

elasticmachine · 2021-03-24T10:57:35Z

Pinging @elastic/security-onboarding-and-lifecycle-mgt (Team:Onboarding and Lifecycle Mgt)

kevinlog · 2021-03-24T12:11:46Z

I checked it out and did a test run. Find a summary of what I did below. Based on this quick run, things look like they're working as expected!

with feature flag turned OFF:

Add some new trusted apps
Ensure policies are updated
Edit a trusted app
Delete a trusted app
Ensure policies update

with feature flag turned ON:

Add a new trusted app for a single policy
Add a new trusted app for a different single policy
Ensure policies update correctly (i.e. one updates for a per Policy change)
Edit trusted apps
Delete trusted apps
Ensure policies update accordingly

Some screenshots:
Feature Flag OFF

Feature Flag ON

kevinlog · 2021-03-24T12:13:53Z

Functionally, things look like they're working from my perspective, so it's a 👍 from me. @paul-tavares should give the code a closer look - I know a lot of this code was previously reviewed when we were working on the feature branch.

paul-tavares

Looks awesome.
I did not run it locally, but did review all code. Left just a few comments that I would like to hear back from you on.

thanks for taking this on :)

x-pack/plugins/security_solution/public/common/hooks/use_experimental_features.ts

...ugins/security_solution/public/management/pages/trusted_apps/view/trusted_apps_page.test.tsx

paul-tavares · 2021-03-24T17:44:10Z

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

@@ -65,14 +65,19 @@ import {
 import { SecurityAppStore } from './common/store/store';
 import { getCaseConnectorUI } from './cases/components/connectors';
 import { licenseService } from './common/hooks/use_license';
+import { SecuritySolutionConfigType } from './common/types';


(optional) consider renaming so that its clear this is only a subset of the security soluton configuration (the properties exposed to the UI). Maybe SecuritySolutionUiConfigType?

paul-tavares · 2021-03-24T17:48:51Z

x-pack/plugins/security_solution/server/endpoint/routes/trusted_apps/handlers.ts

+  endpointAppContext: EndpointAppContext
+): Promise<PutTrustedAppUpdateRequest | PostTrustedAppCreateRequest> => {
+  const config = await endpointAppContext.config();
+  const isTrustedAppsByPolicyEnabled = parseExperimentalConfigValue(config.enableExperimental)


Wondering if we should avoid the constant parsing and instead do it once in the EndpointAppContext and expose it there. Doing the parsing there would hepefully avoid having this function here be async as well, since we would not have to retrieve the .config() again.

Thoughts?

You mean move this into x-pack/plugins/security_solution/server/plugin.ts and add the parsed enableExperimental on the EndpointAppContext type?
Make sense for me since it will be available everywhere with the context,

yes, thats what I mean. I think that might be ok because we're not using the Observable approach to sync up with the config.

dasansol92 · 2021-03-25T13:45:08Z

@elasticmachine merge upstream

…eature_flag-930

FrankHassanabad

LGTM

kibanamachine · 2021-03-25T15:54:26Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`securitySolution`	2209	2214	+5

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`securitySolution`	7.2MB	7.2MB	+6.1KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`securitySolution`	211.3KB	212.5KB	+1.3KB

Unknown metric groups

async chunk count

id	before	after	diff
`securitySolution`	25	26	+1

History

💔 Build #115140 failed 5dadf5e
💔 Build #115122 failed 647e7af
💚 Build #114841 succeeded a2c8e63

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

paul-tavares

🚢 🚀

…flag (elastic#95284) * Added sync_master file for tracking/triggering PRs for merging master into feature branch * removed unnecessary (temporary) markdown file * Trusted apps by policy api (elastic#88025) * Initial version of API for trusted apps per policy. * Fixed compilation errors because of missing new property. * Mapping from tags to policies and back. (No testing) * Fixed compilation error after pulling in main. * Fixed failing tests. * Separated out the prefix in tag for policy reference into constant. Co-authored-by: Kibana Machine <[email protected]> * [SECURITY_SOLUTION][ENDPOINT] Ability to create a Trusted App as either Global or Policy Specific (elastic#88707) * Create form supports selecting policies or making Trusted app global * New component `EffectedPolicySelect` - for selecting policies * Enhanced `waitForAction()` test utility to provide a `validate()` option * [SECURITY SOLUTION][ENDPOINT] UI for editing Trusted Application items (elastic#89479) * Add Edit button to TA card UI * Support additional url params (`show`, `id`) * Refactor TrustedAppForm to support Editing of an existing entry * [SECURITY SOLUTION][ENDPOINT] API (`PUT`) for Trusted Apps Edit flow (elastic#90333) * New API route for Update (`PUT`) * Connect UI to Update (PUT) API * Add `version` to TrustedApp type and return it on the API responses * Refactor - moved some public/server shared modules to top-level `common/*` * [SECURITY SOLUTION][ENDPOINT] Trusted Apps API to retrieve a single Trusted App item (elastic#90842) * Get One Trusted App API - route, service, handler * Adjust UI to call GET api to retrieve trusted app for edit * Deleted ununsed trusted app types file * Add UI handling of non-existing TA for edit or when id is missing in url * [Security Solution][Endpoint] Multiple misc. updates/fixes for Edit Trusted Apps (elastic#91656) * correct trusted app schema to ensure `version` is not exposed on TS type for POST * Added updated_by, updated_on properties to TrustedApp * Refactored TA List view to fix bug where card was not updated on a successful edit * Test cases for card interaction from the TA List view * Change title of policy selection to `Assignment` * Selectable Policy CSS adjustments based on UX feedback * Fix failing server tests * [Security Solution][Endpoint] Trusted Apps list API KQL filtering support (elastic#92611) * Fix bad merge from master * Fix trusted apps generator * Add `kuery` to the GET (list) Trusted Apps api * Refactor schema with Put method after merging changes with master * WIP: allow effectScope only when feature flag is enabled * Fixes errors with non declared logger * Uses experimental features module to allow or not effectScope on create/update trusted app schema * Set default value for effectScope when feature flag is disabled * Adds experimentals into redux store. Also creates hook to retrieve a feature flag value from state * Hides effectPolicy when feature flag is not enabled * Fixes unit test mocking hook and adds new test case * Changes file extension for custom hook * Adds new unit test for custom hook * Hides horizontal bar with feature flag * Compress text area depending on feature flag * Fixes failing test because feature flag * Fixes wrong import and unit test * Thwrows error if invalid feature flag check * Adds snapshoot checks with feature flag enabled/disabled * Test snapshots * Changes type name * Add experimentalFeatures in app context * Fixes type checks due AppContext changes * Fixes test due changes on custom hook Co-authored-by: Paul Tavares <[email protected]> Co-authored-by: Bohdan Tsymbala <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Paul Tavares <[email protected]>

…flag (#95284) (#95497) * Added sync_master file for tracking/triggering PRs for merging master into feature branch * removed unnecessary (temporary) markdown file * Trusted apps by policy api (#88025) * Initial version of API for trusted apps per policy. * Fixed compilation errors because of missing new property. * Mapping from tags to policies and back. (No testing) * Fixed compilation error after pulling in main. * Fixed failing tests. * Separated out the prefix in tag for policy reference into constant. Co-authored-by: Kibana Machine <[email protected]> * [SECURITY_SOLUTION][ENDPOINT] Ability to create a Trusted App as either Global or Policy Specific (#88707) * Create form supports selecting policies or making Trusted app global * New component `EffectedPolicySelect` - for selecting policies * Enhanced `waitForAction()` test utility to provide a `validate()` option * [SECURITY SOLUTION][ENDPOINT] UI for editing Trusted Application items (#89479) * Add Edit button to TA card UI * Support additional url params (`show`, `id`) * Refactor TrustedAppForm to support Editing of an existing entry * [SECURITY SOLUTION][ENDPOINT] API (`PUT`) for Trusted Apps Edit flow (#90333) * New API route for Update (`PUT`) * Connect UI to Update (PUT) API * Add `version` to TrustedApp type and return it on the API responses * Refactor - moved some public/server shared modules to top-level `common/*` * [SECURITY SOLUTION][ENDPOINT] Trusted Apps API to retrieve a single Trusted App item (#90842) * Get One Trusted App API - route, service, handler * Adjust UI to call GET api to retrieve trusted app for edit * Deleted ununsed trusted app types file * Add UI handling of non-existing TA for edit or when id is missing in url * [Security Solution][Endpoint] Multiple misc. updates/fixes for Edit Trusted Apps (#91656) * correct trusted app schema to ensure `version` is not exposed on TS type for POST * Added updated_by, updated_on properties to TrustedApp * Refactored TA List view to fix bug where card was not updated on a successful edit * Test cases for card interaction from the TA List view * Change title of policy selection to `Assignment` * Selectable Policy CSS adjustments based on UX feedback * Fix failing server tests * [Security Solution][Endpoint] Trusted Apps list API KQL filtering support (#92611) * Fix bad merge from master * Fix trusted apps generator * Add `kuery` to the GET (list) Trusted Apps api * Refactor schema with Put method after merging changes with master * WIP: allow effectScope only when feature flag is enabled * Fixes errors with non declared logger * Uses experimental features module to allow or not effectScope on create/update trusted app schema * Set default value for effectScope when feature flag is disabled * Adds experimentals into redux store. Also creates hook to retrieve a feature flag value from state * Hides effectPolicy when feature flag is not enabled * Fixes unit test mocking hook and adds new test case * Changes file extension for custom hook * Adds new unit test for custom hook * Hides horizontal bar with feature flag * Compress text area depending on feature flag * Fixes failing test because feature flag * Fixes wrong import and unit test * Thwrows error if invalid feature flag check * Adds snapshoot checks with feature flag enabled/disabled * Test snapshots * Changes type name * Add experimentalFeatures in app context * Fixes type checks due AppContext changes * Fixes test due changes on custom hook Co-authored-by: Paul Tavares <[email protected]> Co-authored-by: Bohdan Tsymbala <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Paul Tavares <[email protected]> Co-authored-by: Paul Tavares <[email protected]> Co-authored-by: Bohdan Tsymbala <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Paul Tavares <[email protected]>

paul-tavares and others added 24 commits March 24, 2021 11:14

Added sync_master file for tracking/triggering PRs for merging master…

2330c33

… into feature branch

removed unnecessary (temporary) markdown file

d3e1952

[SECURITY SOLUTION][ENDPOINT] UI for editing Trusted Application items (

00932d4

elastic#89479) * Add Edit button to TA card UI * Support additional url params (`show`, `id`) * Refactor TrustedAppForm to support Editing of an existing entry

Fix failing server tests

8b3bbf1

[Security Solution][Endpoint] Trusted Apps list API KQL filtering sup…

1d23186

…port (elastic#92611) * Fix bad merge from master * Fix trusted apps generator * Add `kuery` to the GET (list) Trusted Apps api

Refactor schema with Put method after merging changes with master

c6d59e1

WIP: allow effectScope only when feature flag is enabled

a3aba39

Fixes errors with non declared logger

f4f3c89

Uses experimental features module to allow or not effectScope on crea…

f5305af

…te/update trusted app schema

Set default value for effectScope when feature flag is disabled

e9f0bd4

Adds experimentals into redux store. Also creates hook to retrieve a …

cf74b2b

…feature flag value from state

Hides effectPolicy when feature flag is not enabled

0e86279

Fixes unit test mocking hook and adds new test case

530db6d

Changes file extension for custom hook

99565d8

Adds new unit test for custom hook

4a4cafc

Hides horizontal bar with feature flag

de7c045

Compress text area depending on feature flag

9599891

Fixes failing test because feature flag

722da21

Fixes wrong import and unit test

a2c8e63

dasansol92 added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Team:Defend Workflows “EDR Workflows” sub-team of Security Solution v7.13.0 labels Mar 24, 2021

dasansol92 requested review from a team as code owners March 24, 2021 10:57

paul-tavares reviewed Mar 24, 2021

View reviewed changes

dasansol92 added 7 commits March 25, 2021 09:47

Thwrows error if invalid feature flag check

d0d92d2

Adds snapshoot checks with feature flag enabled/disabled

78e8a44

Test snapshots

f6b1f41

Changes type name

7f6381a

Add experimentalFeatures in app context

a8817fe

Fixes type checks due AppContext changes

647e7af

Fixes test due changes on custom hook

5dadf5e

Merge branch 'master' into feature/olm-endpoint_artifacts_by_policy_f…

a640dfc

…eature_flag-930

FrankHassanabad approved these changes Mar 25, 2021

View reviewed changes

paul-tavares approved these changes Mar 25, 2021

View reviewed changes

dasansol92 merged commit 2af094a into elastic:master Mar 26, 2021

dasansol92 mentioned this pull request Mar 26, 2021

[7.x] [Security Solution] Put Artifacts by Policy feature behind a feature flag (#95284) #95497

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Security Solution] Put Artifacts by Policy feature behind a feature flag #95284

[Security Solution] Put Artifacts by Policy feature behind a feature flag #95284

dasansol92 commented Mar 24, 2021 •

edited

Loading

elasticmachine commented Mar 24, 2021

kevinlog commented Mar 24, 2021

kevinlog commented Mar 24, 2021

paul-tavares left a comment

paul-tavares Mar 24, 2021

paul-tavares Mar 24, 2021

dasansol92 Mar 25, 2021

paul-tavares Mar 25, 2021

dasansol92 commented Mar 25, 2021

FrankHassanabad left a comment

kibanamachine commented Mar 25, 2021

async chunk count

paul-tavares left a comment

[Security Solution] Put Artifacts by Policy feature behind a feature flag #95284

[Security Solution] Put Artifacts by Policy feature behind a feature flag #95284

Conversation

dasansol92 commented Mar 24, 2021 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented Mar 24, 2021

kevinlog commented Mar 24, 2021

kevinlog commented Mar 24, 2021

paul-tavares left a comment

Choose a reason for hiding this comment

paul-tavares Mar 24, 2021

Choose a reason for hiding this comment

paul-tavares Mar 24, 2021

Choose a reason for hiding this comment

dasansol92 Mar 25, 2021

Choose a reason for hiding this comment

paul-tavares Mar 25, 2021

Choose a reason for hiding this comment

dasansol92 commented Mar 25, 2021

FrankHassanabad left a comment

Choose a reason for hiding this comment

kibanamachine commented Mar 25, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

async chunk count

History

paul-tavares left a comment

Choose a reason for hiding this comment

dasansol92 commented Mar 24, 2021 •

edited

Loading