Skip to content

[SIEM] Migrating frontend services to NP#53669

Merged
rylnd merged 7 commits intoelastic:masterfrom
rylnd:siem_ui_settings
Dec 20, 2019
Merged

[SIEM] Migrating frontend services to NP#53669
rylnd merged 7 commits intoelastic:masterfrom
rylnd:siem_ui_settings

Conversation

@rylnd
Copy link
Copy Markdown
Contributor

@rylnd rylnd commented Dec 20, 2019

Resubmits #52783 updated with the latest changes on master.

rylnd and others added 2 commits December 19, 2019 20:31
* Remove legacy index_patterns import

We'd already brought in the new interface in a previous commit; this was
just used as an unnecessary type assertion.

* Update snapshots following new docLink mocks

* Remove unused manual mocks

These are not picked up by jest; calling
jest.mock('lib/compose/kibana_core') has the same effect whether or not
these files exist.

* WIP: Use kibana core mock everywhere we're doing it manually

The timeline tests are the last place we're explicitly mocking
useKibanaCore; removing the mocks cause tests to hang. I think  hey're
relying on the side effects of importing the mock/ui_settings file, but
I'll figure that out next.

* Replace ui/documentation_links with core NP service

In most instances, this meant using the useContext hook with our NP core
context.

This also updates our mocks to leverage the factory so graciously
provided by platform.

There are a few failing tests, mostly due to links being previously
undefined in tests.

* Use new mocks on timeline test that doesn't hang

The rest of these do, though.

* Remove remaining uses of mockUiSettings in useKibanaCore mocks

These have to be evaluated immediately so that we always return the
same core object. Otherwise we get stuck in a loop between
render/useEffect/setState due to the savedObjects client being different
on each invocation.

* Invoke platform's mock factory at mock time

Previously, we were invoking it any time someone called `useKibanaCore`,
getting a new object back each time. This both caused some bugs (looping
with useEffect) and was not representative of how the actual hook
worked.

This also moves that invokation into the mock function, along with
shaping the mocked module so that we don't have to do it in every call
to jest.mock.

* WIP: migrating to use kibana_react's provider and helpers

We're re-exporting these locally to have more control around mocking
them (until platform implements that).

This breaks everything that was using the old mocks. Will fix.

* WIP: Migrating to use kibana_react

Instead of our homegrown hooks we can use these utilities instead.

Unfortunately kibana_react doesn't yet have mocks, so we had to implement
that ourselves. Luckily, we already had local mocks for the settings
service. This migrates to a the new format. For clarity and consistency,
we also re-export new platform's mocks here and use them to populate our
kibana_react mocks.

We started by migrating the UiSettings service to new platform, and let
that drive the rest. With the mocks in place for kibana_react, removing
the usage of useKibanaCore was a natural step as well.

The next step is removing the usage of chrome.getUiSettingsClient with
our useUiSetting$ hook, and with that (and maybe some config setup; I'm
seeing errors at runtime), we should be ready to start migrating other
services.

* Bind a copy of kibana at mock creation

We were previously returning a new copy any time e.g. useKibana was
called, which is not the contract that consumers are expecting. and in
fact caused looping with components employing useEffect etc.

* Remove internal context providers and last usage

We're now using kibana_react fully.

* Fix tests failing due to wrong mocks

Remaining failures are either due to a date format issue, or something
being rendered differently. Those are up next.

Still haven't touched use of chrome.getUiSettingsClient, that's after.

* Fix test failures related to date formatting

* mocks missing UI Setting (DEFAULT_TIMEZONE_BROWSER) which is required
by our formatted_date utilities
* mock timepicker ranges in the one test that uses it (SuperDatePicker)

* Remove unnecessary and/or redundant mocks

Since our TestProvider now mocks new platform, the only tests that
should need to mock uiSettings related stuff (e.g. timezone preferences)
would be the tests that (directly or no) use kibana_react to get it.

* Refactor kibana_react mocks

* adds a mock for the non-observable useUiSetting
* removes the unmockable HOC withKibana

* Replace usage of chrome.getUiSettingsClient with useUiSetting

We're opting for the non-observable behavior here because I believe
that's more analagous.

There are a few remaining usages in non-react code.

Tests are still using the mocks, those'll be removed next.

* Remove ui_settings mocks

Now that we're not using this hook there's no need for the mocks. Tests
are green.

* Remove siem's UI settings hook

We're now using the ones provided by kibana_react.

* Use withKibana HOC on our component classes

React was kind enough to remind me that I can't put hooks in classes.
Whoops.

* Set defaults for some unknown UI settings

The service claims not to know about these settings we're retrieving.
Until I can figure out where they should come from, we're going to
initialize them with what seem to be the defaults at plugin
initialization.

* Remove old hooks

These have now been replaced with kibana_react's equivalents.

* Fix type error on usage of useKibana hook

This is one of the few places where we're using another plugin, which
are not present in the default typings due to their opt-in nature.

* Fix type error on ML call

The indexPattern we get back is actually an array. The endpoint seems to
handle this just fine (at least, it doesn't blow up), but once we
started retrieving a typed value this error surfaced.

* Export a 'bound' version of the useKibana function

Rather than having to type this on each invocation. This requires us to
define which plugins we depend on, which is a good thing.

* Instantiate our mock function

We aren't using these right now I didn't notice, but that wasn't the
right reference.

* Fix test that relies on unmocked service

Our QueryBar component relies very (very, very) indirectly on a storage
service that does not exist in New Platform, nor its corresponding
mocks. To get it passing for now, we're just gonna pretend like it's
there.

* Remove use of ui/chrome in our charts

Replaces with hooks that accomplish the same.

* Remove last use of chrome.getUiSettingsClient

This function is itself a hook, so we should be good here.

* Remove unnecessary non-null assertions

Now that we're using our typed version of the useKibana hook, typescript
knows that these services will be available (once we actually enforce
that in our kibana.json, of course).

* Fix chart tests

These rely on a kibana hook now, so we need to mock it out for these
renders lest we blow up when the context isn't there.

* Replace missing mock

I deleted this in a previous commit, thinking it unneeded.
However, getHostDetailsBreadcrumbs ultimately asks for some
default date parameters for the timerange boundaries.

* Add back tests for our theming hook

* Style: cleanup

* Remove unneeded default UI Settings values

We were previously getting errors due to these values not being known to
the client, but it looks like that was either fixed upstream, or a
temporary issue caused by some improper context setup.

* Simplify kibana_react mocks

Let's leave JSX out of it.

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
These hooks were deleted on a recent branch, but new usages were merged
to master in the meantime.
@rylnd rylnd added release_note:skip Skip the PR/issue when compiling release notes v7.6.0 Team:SIEM labels Dec 20, 2019
@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/siem (Team:SIEM)

@rylnd rylnd requested a review from spalger December 20, 2019 02:56
 Conflicts:
	x-pack/legacy/plugins/siem/public/pages/detection_engine/components/signals/index.tsx
	x-pack/legacy/plugins/siem/public/pages/detection_engine/rules/components/import_rule_modal/index.tsx
	x-pack/legacy/plugins/siem/public/pages/detection_engine/rules/components/step_define_rule/index.tsx
@elasticmachine
Copy link
Copy Markdown
Contributor

💚 Build Succeeded

History

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

Copy link
Copy Markdown
Contributor

@XavierM XavierM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rylnd rylnd merged commit 8d6cfa5 into elastic:master Dec 20, 2019
@rylnd rylnd deleted the siem_ui_settings branch December 20, 2019 20:24
rylnd added a commit that referenced this pull request Dec 20, 2019
* [SIEM] Migrating frontend services to NP (#52783)

* Remove legacy index_patterns import

We'd already brought in the new interface in a previous commit; this was
just used as an unnecessary type assertion.

* Update snapshots following new docLink mocks

* Remove unused manual mocks

These are not picked up by jest; calling
jest.mock('lib/compose/kibana_core') has the same effect whether or not
these files exist.

* WIP: Use kibana core mock everywhere we're doing it manually

The timeline tests are the last place we're explicitly mocking
useKibanaCore; removing the mocks cause tests to hang. I think  hey're
relying on the side effects of importing the mock/ui_settings file, but
I'll figure that out next.

* Replace ui/documentation_links with core NP service

In most instances, this meant using the useContext hook with our NP core
context.

This also updates our mocks to leverage the factory so graciously
provided by platform.

There are a few failing tests, mostly due to links being previously
undefined in tests.

* Use new mocks on timeline test that doesn't hang

The rest of these do, though.

* Remove remaining uses of mockUiSettings in useKibanaCore mocks

These have to be evaluated immediately so that we always return the
same core object. Otherwise we get stuck in a loop between
render/useEffect/setState due to the savedObjects client being different
on each invocation.

* Invoke platform's mock factory at mock time

Previously, we were invoking it any time someone called `useKibanaCore`,
getting a new object back each time. This both caused some bugs (looping
with useEffect) and was not representative of how the actual hook
worked.

This also moves that invokation into the mock function, along with
shaping the mocked module so that we don't have to do it in every call
to jest.mock.

* WIP: migrating to use kibana_react's provider and helpers

We're re-exporting these locally to have more control around mocking
them (until platform implements that).

This breaks everything that was using the old mocks. Will fix.

* WIP: Migrating to use kibana_react

Instead of our homegrown hooks we can use these utilities instead.

Unfortunately kibana_react doesn't yet have mocks, so we had to implement
that ourselves. Luckily, we already had local mocks for the settings
service. This migrates to a the new format. For clarity and consistency,
we also re-export new platform's mocks here and use them to populate our
kibana_react mocks.

We started by migrating the UiSettings service to new platform, and let
that drive the rest. With the mocks in place for kibana_react, removing
the usage of useKibanaCore was a natural step as well.

The next step is removing the usage of chrome.getUiSettingsClient with
our useUiSetting$ hook, and with that (and maybe some config setup; I'm
seeing errors at runtime), we should be ready to start migrating other
services.

* Bind a copy of kibana at mock creation

We were previously returning a new copy any time e.g. useKibana was
called, which is not the contract that consumers are expecting. and in
fact caused looping with components employing useEffect etc.

* Remove internal context providers and last usage

We're now using kibana_react fully.

* Fix tests failing due to wrong mocks

Remaining failures are either due to a date format issue, or something
being rendered differently. Those are up next.

Still haven't touched use of chrome.getUiSettingsClient, that's after.

* Fix test failures related to date formatting

* mocks missing UI Setting (DEFAULT_TIMEZONE_BROWSER) which is required
by our formatted_date utilities
* mock timepicker ranges in the one test that uses it (SuperDatePicker)

* Remove unnecessary and/or redundant mocks

Since our TestProvider now mocks new platform, the only tests that
should need to mock uiSettings related stuff (e.g. timezone preferences)
would be the tests that (directly or no) use kibana_react to get it.

* Refactor kibana_react mocks

* adds a mock for the non-observable useUiSetting
* removes the unmockable HOC withKibana

* Replace usage of chrome.getUiSettingsClient with useUiSetting

We're opting for the non-observable behavior here because I believe
that's more analagous.

There are a few remaining usages in non-react code.

Tests are still using the mocks, those'll be removed next.

* Remove ui_settings mocks

Now that we're not using this hook there's no need for the mocks. Tests
are green.

* Remove siem's UI settings hook

We're now using the ones provided by kibana_react.

* Use withKibana HOC on our component classes

React was kind enough to remind me that I can't put hooks in classes.
Whoops.

* Set defaults for some unknown UI settings

The service claims not to know about these settings we're retrieving.
Until I can figure out where they should come from, we're going to
initialize them with what seem to be the defaults at plugin
initialization.

* Remove old hooks

These have now been replaced with kibana_react's equivalents.

* Fix type error on usage of useKibana hook

This is one of the few places where we're using another plugin, which
are not present in the default typings due to their opt-in nature.

* Fix type error on ML call

The indexPattern we get back is actually an array. The endpoint seems to
handle this just fine (at least, it doesn't blow up), but once we
started retrieving a typed value this error surfaced.

* Export a 'bound' version of the useKibana function

Rather than having to type this on each invocation. This requires us to
define which plugins we depend on, which is a good thing.

* Instantiate our mock function

We aren't using these right now I didn't notice, but that wasn't the
right reference.

* Fix test that relies on unmocked service

Our QueryBar component relies very (very, very) indirectly on a storage
service that does not exist in New Platform, nor its corresponding
mocks. To get it passing for now, we're just gonna pretend like it's
there.

* Remove use of ui/chrome in our charts

Replaces with hooks that accomplish the same.

* Remove last use of chrome.getUiSettingsClient

This function is itself a hook, so we should be good here.

* Remove unnecessary non-null assertions

Now that we're using our typed version of the useKibana hook, typescript
knows that these services will be available (once we actually enforce
that in our kibana.json, of course).

* Fix chart tests

These rely on a kibana hook now, so we need to mock it out for these
renders lest we blow up when the context isn't there.

* Replace missing mock

I deleted this in a previous commit, thinking it unneeded.
However, getHostDetailsBreadcrumbs ultimately asks for some
default date parameters for the timerange boundaries.

* Add back tests for our theming hook

* Style: cleanup

* Remove unneeded default UI Settings values

We were previously getting errors due to these values not being known to
the client, but it looks like that was either fixed upstream, or a
temporary issue caused by some improper context setup.

* Simplify kibana_react mocks

Let's leave JSX out of it.

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

* Update references to now-deleted hooks

These hooks were deleted on a recent branch, but new usages were merged
to master in the meantime.

* Fix remaining uses of hooks/chrome that were not merge conflicts

* Use HOC on class component

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
jkelastic pushed a commit to jkelastic/kibana that referenced this pull request Jan 8, 2020
* [SIEM] Migrating frontend services to NP (elastic#52783)

* Remove legacy index_patterns import

We'd already brought in the new interface in a previous commit; this was
just used as an unnecessary type assertion.

* Update snapshots following new docLink mocks

* Remove unused manual mocks

These are not picked up by jest; calling
jest.mock('lib/compose/kibana_core') has the same effect whether or not
these files exist.

* WIP: Use kibana core mock everywhere we're doing it manually

The timeline tests are the last place we're explicitly mocking
useKibanaCore; removing the mocks cause tests to hang. I think  hey're
relying on the side effects of importing the mock/ui_settings file, but
I'll figure that out next.

* Replace ui/documentation_links with core NP service

In most instances, this meant using the useContext hook with our NP core
context.

This also updates our mocks to leverage the factory so graciously
provided by platform.

There are a few failing tests, mostly due to links being previously
undefined in tests.

* Use new mocks on timeline test that doesn't hang

The rest of these do, though.

* Remove remaining uses of mockUiSettings in useKibanaCore mocks

These have to be evaluated immediately so that we always return the
same core object. Otherwise we get stuck in a loop between
render/useEffect/setState due to the savedObjects client being different
on each invocation.

* Invoke platform's mock factory at mock time

Previously, we were invoking it any time someone called `useKibanaCore`,
getting a new object back each time. This both caused some bugs (looping
with useEffect) and was not representative of how the actual hook
worked.

This also moves that invokation into the mock function, along with
shaping the mocked module so that we don't have to do it in every call
to jest.mock.

* WIP: migrating to use kibana_react's provider and helpers

We're re-exporting these locally to have more control around mocking
them (until platform implements that).

This breaks everything that was using the old mocks. Will fix.

* WIP: Migrating to use kibana_react

Instead of our homegrown hooks we can use these utilities instead.

Unfortunately kibana_react doesn't yet have mocks, so we had to implement
that ourselves. Luckily, we already had local mocks for the settings
service. This migrates to a the new format. For clarity and consistency,
we also re-export new platform's mocks here and use them to populate our
kibana_react mocks.

We started by migrating the UiSettings service to new platform, and let
that drive the rest. With the mocks in place for kibana_react, removing
the usage of useKibanaCore was a natural step as well.

The next step is removing the usage of chrome.getUiSettingsClient with
our useUiSetting$ hook, and with that (and maybe some config setup; I'm
seeing errors at runtime), we should be ready to start migrating other
services.

* Bind a copy of kibana at mock creation

We were previously returning a new copy any time e.g. useKibana was
called, which is not the contract that consumers are expecting. and in
fact caused looping with components employing useEffect etc.

* Remove internal context providers and last usage

We're now using kibana_react fully.

* Fix tests failing due to wrong mocks

Remaining failures are either due to a date format issue, or something
being rendered differently. Those are up next.

Still haven't touched use of chrome.getUiSettingsClient, that's after.

* Fix test failures related to date formatting

* mocks missing UI Setting (DEFAULT_TIMEZONE_BROWSER) which is required
by our formatted_date utilities
* mock timepicker ranges in the one test that uses it (SuperDatePicker)

* Remove unnecessary and/or redundant mocks

Since our TestProvider now mocks new platform, the only tests that
should need to mock uiSettings related stuff (e.g. timezone preferences)
would be the tests that (directly or no) use kibana_react to get it.

* Refactor kibana_react mocks

* adds a mock for the non-observable useUiSetting
* removes the unmockable HOC withKibana

* Replace usage of chrome.getUiSettingsClient with useUiSetting

We're opting for the non-observable behavior here because I believe
that's more analagous.

There are a few remaining usages in non-react code.

Tests are still using the mocks, those'll be removed next.

* Remove ui_settings mocks

Now that we're not using this hook there's no need for the mocks. Tests
are green.

* Remove siem's UI settings hook

We're now using the ones provided by kibana_react.

* Use withKibana HOC on our component classes

React was kind enough to remind me that I can't put hooks in classes.
Whoops.

* Set defaults for some unknown UI settings

The service claims not to know about these settings we're retrieving.
Until I can figure out where they should come from, we're going to
initialize them with what seem to be the defaults at plugin
initialization.

* Remove old hooks

These have now been replaced with kibana_react's equivalents.

* Fix type error on usage of useKibana hook

This is one of the few places where we're using another plugin, which
are not present in the default typings due to their opt-in nature.

* Fix type error on ML call

The indexPattern we get back is actually an array. The endpoint seems to
handle this just fine (at least, it doesn't blow up), but once we
started retrieving a typed value this error surfaced.

* Export a 'bound' version of the useKibana function

Rather than having to type this on each invocation. This requires us to
define which plugins we depend on, which is a good thing.

* Instantiate our mock function

We aren't using these right now I didn't notice, but that wasn't the
right reference.

* Fix test that relies on unmocked service

Our QueryBar component relies very (very, very) indirectly on a storage
service that does not exist in New Platform, nor its corresponding
mocks. To get it passing for now, we're just gonna pretend like it's
there.

* Remove use of ui/chrome in our charts

Replaces with hooks that accomplish the same.

* Remove last use of chrome.getUiSettingsClient

This function is itself a hook, so we should be good here.

* Remove unnecessary non-null assertions

Now that we're using our typed version of the useKibana hook, typescript
knows that these services will be available (once we actually enforce
that in our kibana.json, of course).

* Fix chart tests

These rely on a kibana hook now, so we need to mock it out for these
renders lest we blow up when the context isn't there.

* Replace missing mock

I deleted this in a previous commit, thinking it unneeded.
However, getHostDetailsBreadcrumbs ultimately asks for some
default date parameters for the timerange boundaries.

* Add back tests for our theming hook

* Style: cleanup

* Remove unneeded default UI Settings values

We were previously getting errors due to these values not being known to
the client, but it looks like that was either fixed upstream, or a
temporary issue caused by some improper context setup.

* Simplify kibana_react mocks

Let's leave JSX out of it.

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

* Update references to now-deleted hooks

These hooks were deleted on a recent branch, but new usages were merged
to master in the meantime.

* Fix remaining uses of hooks/chrome that were not merge conflicts

* Use HOC on class component

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release_note:skip Skip the PR/issue when compiling release notes Team:SIEM v7.6.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants