[Fleet] IngestManager Plugin interface for registering UI extensions #82783

paul-tavares · 2020-11-05T21:08:15Z

Summary

Introduces a new Plugins#start interface for registering Fleet UI extensions (removes prior single-purpose method)
Introduces 3 extension points that can be registered:
- Integration (Package) detail custom view (note: use of this extension point is not yet implemented)
- Integration Policy Edit view and
- Integration Policy Create view.
Refactors the existing Endpoint (Security Solution) ui extension to use this new approach

closes #82478

Checklist

Delete any items that are not applicable to this PR.

Unit or functional tests were updated or added to match the most common scenarios

…ension approach

…has configuration options)

…gest-ui-extension-registration # Conflicts: # x-pack/plugins/ingest_manager/public/applications/ingest_manager/sections/agent_policy/create_package_policy_page/step_configure_package.tsx

…gest-ui-extension-registration # Conflicts: # x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/components/custom_package_policy.tsx # x-pack/plugins/fleet/public/index.ts # x-pack/plugins/fleet/public/plugin.ts # x-pack/plugins/security_solution/public/common/mock/endpoint/dependencies_start_mock.ts # x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/endpoint_policy_edit_extension.tsx

…gest-ui-extension-registration

jen-huang

The overall architecture looks good and makes sense. I left comments on some areas of concern that I spotted, happy to have discussions for any of them!

x-pack/plugins/fleet/public/applications/fleet/hooks/use_ui_extension.ts

...s/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/index.tsx

...ins/fleet/public/applications/fleet/sections/agent_policy/edit_package_policy_page/index.tsx

x-pack/plugins/fleet/common/types/ui_extensions.ts

jfsiii · 2020-11-11T01:03:18Z

...plications/fleet/sections/agent_policy/create_package_policy_page/step_configure_package.tsx

@@ -55,6 +63,10 @@ export const StepConfigurePackagePolicy: React.FunctionComponent<{
  validationResults,
  submitAttempted,
 }) => {
+  const hasUiExtension =
+    useUIExtension(packageInfo.name, 'integration-policy', from === 'edit' ? 'edit' : 'create') !==
+    undefined;


I believe it will be a boolean. It's the result of something !== undefined, which should be a boolean.

doh 🤦🏻‍♀️ I read it as a nested ternary

good case for replacing the shorthand, if it's initially hard to parse scrolling through

...c/management/pages/policy/view/ingest_manager_integration/endpoint_policy_edit_extension.tsx

jen-huang · 2020-11-10T22:01:41Z

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

+      const { registerExtension } = plugins.ingestManager;
+
+      registerExtension({
+        integration: 'endpoint',
+        type: 'integration-policy',
+        view: 'edit',
+        component: LazyEndpointPolicyEditExtension,
+      });
+
+      registerExtension({
+        integration: 'endpoint',
+        type: 'integration-policy',
+        view: 'create',
+        component: LazyEndpointPolicyCreateExtension,
+      });


nice 👍🏻

...ins/fleet/public/applications/fleet/sections/agent_policy/edit_package_policy_page/index.tsx

...plications/fleet/sections/agent_policy/create_package_policy_page/step_configure_package.tsx

nchaulet

Tested locally works as expected, looks good to me 🚀

…gest-ui-extension-registration

jen-huang

One minor comment but otherwise LGTM. Thanks for making the review changes; this is a great foundation for all the extensions to come. Nice work!

x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts

…gest-ui-extension-registration

kibanamachine · 2020-11-12T15:47:14Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 51675cd

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`ingestManager`	407	410	+3
`securitySolution`	2068	2071	+3
total			+6

Async chunks

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

id	before	after	diff
`ingestManager`	1.1MB	1.1MB	+4.2KB
`securitySolution`	7.8MB	7.9MB	+87.3KB
total			+91.5KB

Distributable file count

id	before	after	diff
`default`	42775	42784	+9

Page load bundle

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

id	before	after	diff
`ingestManager`	386.2KB	384.6KB	-1.6KB
`securitySolution`	243.6KB	163.5KB	-80.0KB
total			-81.6KB

Unknown metric groups

async chunk count

id	before	after	diff
`securitySolution`	8	11	+3

History

💔 Build #87457 failed 9a2c882
💚 Build #87076 succeeded 77250da
💔 Build #86928 failed a3380c78711ccbbc608ca41b30c5d279c3cd5067
💔 Build #86848 failed b2f1a52
💔 Build #86550 failed 80fa113

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

pzl

looks good, nothing left to say but nits

…lastic#82783) * Expose `registerExtension()` interface on `Plugin#start` * Refactor use of `CustomConfigurePackagePolicy` to the new registerExtension approach * Refactor to always show registered ui extension (even if Integration has configuration options)

* master: [ML] Update apidoc config with the Trained models endpoints (elastic#83274) [Fleet] IngestManager Plugin interface for registering UI extensions (elastic#82783) [Alerting] Moves the Index & Geo Threshold UIs into the Stack Alerts Public Plugin (elastic#82951)

…82783) (#83307) * Expose `registerExtension()` interface on `Plugin#start` * Refactor use of `CustomConfigurePackagePolicy` to the new registerExtension approach * Refactor to always show registered ui extension (even if Integration has configuration options)

paul-tavares added 7 commits November 4, 2020 15:07

Types for UI Extensions

1460657

Expose registerExtension() interface on Plugin#start

ab5c1fa

Added registration of endpoint integration edit component

4b8244f

Added new UIExtensionContext provider to the Fleet application

6d6ab03

Refactor use of CustomConfigurePackagePolicy to the new registerExt…

98f3d8b

…ension approach

Remove old package policy custom component code

c6e9a43

Some more cleanup of older register approach

e0bc26f

paul-tavares added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Feature:Endpoint Elastic Endpoint feature Team:Fleet Team label for Observability Data Collection Fleet team v7.11.0 Team:Defend Workflows “EDR Workflows” sub-team of Security Solution labels Nov 5, 2020

paul-tavares self-assigned this Nov 5, 2020

paul-tavares added 15 commits November 6, 2020 09:56

Refactor to always show registered ui extension (even if Integration …

4c42831

…has configuration options)

remove old component + pass correct policy data structures to extensions

1b70c0e

Edit Package Policy page handles UI Extension onChange events

e6ad71c

Create Package Policy page handling of Extension View change events

4381e1c

fix type

eeef2eb

Better typings for useUIExtension

80fa113

Fix unit tests after refactor of Extension Storage

dbfa432

Merge remote-tracking branch 'upstream/master' into task/olm-82478-in…

1df188a

…gest-ui-extension-registration # Conflicts: # x-pack/plugins/ingest_manager/public/applications/ingest_manager/sections/agent_policy/create_package_policy_page/step_configure_package.tsx

Fix type

39e8aff

a (maybe) better way to type second argument of useUIExtension()

b2f1a52

Fix paths after merge of master

17ae980

Remove delete import

cf634a1

change the way ui extension plugin service is imported

ed9f07d

Merge remote-tracking branch 'upstream/master' into task/olm-82478-in…

77250da

…gest-ui-extension-registration

paul-tavares force-pushed the task/olm-82478-ingest-ui-extension-registration branch from a3380c7 to 77250da Compare November 10, 2020 14:00

jen-huang reviewed Nov 10, 2020

View reviewed changes

jfsiii reviewed Nov 11, 2020

View reviewed changes

...plications/fleet/sections/agent_policy/create_package_policy_page/step_configure_package.tsx Outdated Show resolved Hide resolved

paul-tavares added 5 commits November 11, 2020 14:10

Move UI extension types to /public

3b630e9

rename ui extension types

4920368

Rename some properties of ui extension types

d179373

change useUIExtension to throw if associated context is missing

41f7644

Adjust conditional to now use negation check

7831acf

nchaulet approved these changes Nov 11, 2020

View reviewed changes

paul-tavares added 2 commits November 11, 2020 16:14

Simplify Extension Point definition type

6d87b28

Merge remote-tracking branch 'upstream/master' into task/olm-82478-in…

9a2c882

…gest-ui-extension-registration

paul-tavares requested review from jfsiii, jen-huang and nchaulet November 11, 2020 21:16

jen-huang approved these changes Nov 11, 2020

View reviewed changes

x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts Outdated Show resolved Hide resolved

nchaulet approved these changes Nov 11, 2020

View reviewed changes

paul-tavares added 3 commits November 12, 2020 08:03

Fix tests

912d585

Shorten the import path for package policy model types

c2842a3

Merge remote-tracking branch 'upstream/master' into task/olm-82478-in…

51675cd

…gest-ui-extension-registration

paul-tavares removed the request for review from jfsiii November 12, 2020 16:03

kevinlog approved these changes Nov 12, 2020

View reviewed changes

pzl approved these changes Nov 12, 2020

View reviewed changes

paul-tavares merged commit 1babb5f into elastic:master Nov 12, 2020

paul-tavares deleted the task/olm-82478-ingest-ui-extension-registration branch November 12, 2020 16:44

paul-tavares mentioned this pull request Nov 12, 2020

[7.x] [Fleet] IngestManager Plugin interface for registering UI extensions (#82783) #83307

Merged

sorenlouv mentioned this pull request Feb 2, 2021

[APM] POC for Fleet integration (new getting started guide) #89987

Closed

jamiehynds mentioned this pull request Mar 2, 2021

[Windows] Custom Event Channel support elastic/integrations#317

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fleet] IngestManager Plugin interface for registering UI extensions #82783

[Fleet] IngestManager Plugin interface for registering UI extensions #82783

paul-tavares commented Nov 5, 2020 •

edited

Loading

jen-huang left a comment

This comment was marked as resolved.

jfsiii Nov 11, 2020

jen-huang Nov 11, 2020

pzl Nov 11, 2020

jen-huang Nov 10, 2020

nchaulet left a comment

jen-huang left a comment

kibanamachine commented Nov 12, 2020

async chunk count

pzl left a comment •

edited

Loading

[Fleet] IngestManager Plugin interface for registering UI extensions #82783

[Fleet] IngestManager Plugin interface for registering UI extensions #82783

Conversation

paul-tavares commented Nov 5, 2020 • edited Loading

Summary

Checklist

jen-huang left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

jfsiii Nov 11, 2020

Choose a reason for hiding this comment

jen-huang Nov 11, 2020

Choose a reason for hiding this comment

pzl Nov 11, 2020

Choose a reason for hiding this comment

jen-huang Nov 10, 2020

Choose a reason for hiding this comment

nchaulet left a comment

Choose a reason for hiding this comment

jen-huang left a comment

Choose a reason for hiding this comment

kibanamachine commented Nov 12, 2020

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Distributable file count

Page load bundle

async chunk count

History

pzl left a comment • edited Loading

Choose a reason for hiding this comment

paul-tavares commented Nov 5, 2020 •

edited

Loading

pzl left a comment •

edited

Loading