[ML] Anomaly Detection: Migrate validation messages links to use docLinks. #94568

walterra · 2021-03-15T13:15:40Z

Summary

Fixes #94549

To make use of the docsLinks service which is only usable in client side code, Anomaly Detection's validation messages are not fully returned from the server anymore. Instead just the message ID and necessary metadata to parse the message template gets returned.
getMessages() no longer uses inline hard coded documentation links but picks links from the docsLinks service.
The code that rendered the messages originally on the server has been move to a function parseMessages() which can now be used on the client side and accepts the docsLinks services to get URLs to documentation from it.
This means we no longer need to get the current version/branch information for the server side code.
Tests have been updated to reflect the changes: API integration tests only check for the now reduced messages containing only message IDs and metadata. The expected results of the API integration tests are used as mocks for the client side function parseMessages(), this allows use to cover the same code and messages as previously.

Checklist

Unit or functional tests were updated or added to match the most common scenarios
This was checked for breaking API changes and was labeled appropriately

… tests and jest tests.

elasticmachine · 2021-03-15T13:15:43Z

Pinging @elastic/ml-ui (:ml)

src/core/public/doc_links/doc_links_service.ts

Co-authored-by: Lisa Cawley <lcawley@elastic.co>

….com:walterra/kibana into ml-move-validation-message-parsing-to-client

kibanamachine · 2021-03-15T19:26:45Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`ml`	1742	1743	+1

Async chunks

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

id	before	after	diff
`ml`	6.4MB	6.4MB	+23.5KB

Page load bundle

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

id	before	after	diff
`core`	432.1KB	433.1KB	+1.1KB
`ml`	70.1KB	70.2KB	+83.0B
total			+1.1KB

History

💔 Build #113129 failed ece2087
💚 Build #113068 succeeded 868af4e
💔 Build #113065 failed 4dc08c6

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

cc @walterra

peteharverson

Tested and LGTM

jgowdyelastic

Code LGTM

afharo

LGTM!

…inks. (elastic#94568) - To make use of the docsLinks service which is only usable in client side code, Anomaly Detection's validation messages are not fully returned from the server anymore. Instead just the message ID and necessary metadata to parse the message template gets returned. - getMessages() no longer uses inline hard coded documentation links but picks links from the docsLinks service. - The code that rendered the messages originally on the server has been move to a function parseMessages() which can now be used on the client side and accepts the docsLinks services to get URLs to documentation from it. - This means we no longer need to get the current version/branch information for the server side code. - Tests have been updated to reflect the changes: API integration tests only check for the now reduced messages containing only message IDs and metadata. The expected results of the API integration tests are used as mocks for the client side function parseMessages(), this allows use to cover the same code and messages as previously.

kibanamachine · 2021-03-17T06:56:42Z

💚 Backport successful

✅ 7.x / #94778

Successful backport PRs will be merged automatically after passing CI.

…inks. (#94568) (#94778) - To make use of the docsLinks service which is only usable in client side code, Anomaly Detection's validation messages are not fully returned from the server anymore. Instead just the message ID and necessary metadata to parse the message template gets returned. - getMessages() no longer uses inline hard coded documentation links but picks links from the docsLinks service. - The code that rendered the messages originally on the server has been move to a function parseMessages() which can now be used on the client side and accepts the docsLinks services to get URLs to documentation from it. - This means we no longer need to get the current version/branch information for the server side code. - Tests have been updated to reflect the changes: API integration tests only check for the now reduced messages containing only message IDs and metadata. The expected results of the API integration tests are used as mocks for the client side function parseMessages(), this allows use to cover the same code and messages as previously. Co-authored-by: Walter Rafelsberger <walter@elastic.co>

…-action * 'master' of github.com:elastic/kibana: (44 commits) Migrate the optimizer mixin to core (#94272) Replace EuiCodeBlock with JsonCodeEditor in DiscoverGrid (#92442) [ML] Anomaly Detection: Migrate validation messages links to use docLinks. (#94568) [Lists][Exceptions] - Adding basic linting, i18n and storybook support (#94772) [Fleet] Add test/fix for invalid/missing ids in bulk agent reassign (#94632) [Security Solution] [Cases] Move create page components and dependencies to Cases (#94444) [ML] Data Frame Analytics accessibility tests: fix flaky outlier creation test (#94735) [Security Solutions] Remove commented out old linter rules (#94753) [App Search] Role mappings migration part 2 (#94461) [CI] Update Backport action inputs to match updated ones (#94721) [chore] Remove the infra team from CODEOWNERS (#94740) [Connectors UI] Make UI use new connector APIs (#94180) [ML] Use indices options in anomaly detection job wizards (#91830) Remove `string` as a valid registry var type value (#94174) [Alerts] Replaces legacy es client with the ElasticsearchClient for alerts and triggers_actions_ui plugins. (#93364) [Reporting-CSV Export] Re-write CSV Export using SearchSource (#88303) chore(NA): upgrade bazel rules nodejs to v3.2.2 (#94726) [APM] Settings: Update layout and update/add descriptions (#94398) skip flaky suite (#94666) [XY axis] Integrates legend color picker with the eui palette (#90589) ... # Conflicts: # x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/cold_phase/cold_phase.tsx # x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/shared_fields/searchable_snapshot_field/searchable_snapshot_field.tsx # x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/constants.ts # x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/edit_policy.tsx # x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/form/configuration_context.tsx # x-pack/plugins/index_lifecycle_management/public/shared_imports.ts

walterra added 4 commits March 15, 2021 11:33

[ML] Move validation message parsing to client.

16b05c8

[ML] Migrate validation messages to use docLinks service.

fc6c1cb

[Ml] Update API integration tests.

e4adf5e

[ML] Jest tests for parseMessages(). Shared mocks for API integration…

4dc08c6

… tests and jest tests.

walterra added :ml Feature:Anomaly Detection ML anomaly detection refactoring v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.13.0 labels Mar 15, 2021

walterra requested review from peteharverson, jgowdyelastic and lcawl March 15, 2021 13:15

walterra self-assigned this Mar 15, 2021

walterra requested review from a team as code owners March 15, 2021 13:15

walterra changed the title ~~Ml move validation message parsing to client~~ [ML] Anomaly Detection: Migrate validation messages links to use docLinks. Mar 15, 2021

[ML] Remove no longer needed code from jest tests.

868af4e

lcawl mentioned this pull request Mar 15, 2021

Move from hard-coded links to documentation link service #88107

Closed

lcawl reviewed Mar 15, 2021

View reviewed changes

src/core/public/doc_links/doc_links_service.ts Outdated Show resolved Hide resolved

lcawl reviewed Mar 15, 2021

View reviewed changes

src/core/public/doc_links/doc_links_service.ts Outdated Show resolved Hide resolved

lcawl mentioned this pull request Mar 15, 2021

[ML] Fixes links in messages.ts #87763

Closed

8 tasks

walterra and others added 5 commits March 15, 2021 17:17

Update anomalyDetectionJobResource link.

aca29ae

Co-authored-by: Lisa Cawley <lcawley@elastic.co>

Update anomalyDetectionJobResourceAnalysisConfig link.

ece2087

Co-authored-by: Lisa Cawley <lcawley@elastic.co>

[ML] Fix jest test.

06bf6c5

Merge branch 'ml-move-validation-message-parsing-to-client' of github…

dcefb8e

….com:walterra/kibana into ml-move-validation-message-parsing-to-client

Merge branch 'master' into ml-move-validation-message-parsing-to-client

544525f

walterra mentioned this pull request Mar 16, 2021

[ML] Increase Test Coverage 7.13 #93205

Closed

15 tasks

peteharverson approved these changes Mar 16, 2021

View reviewed changes

jgowdyelastic approved these changes Mar 16, 2021

View reviewed changes

afharo approved these changes Mar 16, 2021

View reviewed changes

walterra added the auto-backport Deprecated: Automatically backport this PR after it's merged label Mar 17, 2021

walterra merged commit 83c6bcc into elastic:master Mar 17, 2021

walterra deleted the ml-move-validation-message-parsing-to-client branch March 17, 2021 06:53

kibanamachine mentioned this pull request Mar 17, 2021

[7.x] [ML] Anomaly Detection: Migrate validation messages links to use docLinks. (#94568) #94778

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ML] Anomaly Detection: Migrate validation messages links to use docLinks. #94568

[ML] Anomaly Detection: Migrate validation messages links to use docLinks. #94568

walterra commented Mar 15, 2021

elasticmachine commented Mar 15, 2021

kibanamachine commented Mar 15, 2021

peteharverson left a comment

jgowdyelastic left a comment

afharo left a comment

kibanamachine commented Mar 17, 2021

[ML] Anomaly Detection: Migrate validation messages links to use docLinks. #94568

[ML] Anomaly Detection: Migrate validation messages links to use docLinks. #94568

Conversation

walterra commented Mar 15, 2021

Summary

Checklist

elasticmachine commented Mar 15, 2021

kibanamachine commented Mar 15, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

peteharverson left a comment

Choose a reason for hiding this comment

jgowdyelastic left a comment

Choose a reason for hiding this comment

afharo left a comment

Choose a reason for hiding this comment

kibanamachine commented Mar 17, 2021

💚 Backport successful