ML locator #103652

streamich · 2021-06-29T12:32:26Z

Summary

Closes #98107

Removes ML URL generator.
Adds ML locator.
Switches all users of ML URL generator to use locator instead.

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

For maintainers

This was checked for breaking API changes and was labeled appropriately

Testing

ML URL generator that is now replaced by locator was used in many places throughout ML, APM, Logs, Security apps. For reviewers: please test the links that are generated by the locator still work in your app!

Below are a couple of example usages.

In logs anomaly detection:

x-pack/plugins/infra/public/pages/logs/log_entry_rate/sections/anomalies/log_entry_example.tsx

Link in ML setup flyout cards.

x-pack/plugins/infra/public/components/logging/log_analysis_setup/setup_flyout/module_list_card.tsx

elasticmachine · 2021-06-30T08:46:23Z

Pinging @elastic/kibana-app-services (Team:AppServices)

ppisljar

code LGTM

.../application/components/anomaly_results_view_selector/anomaly_results_view_selector.test.tsx

qn895 · 2021-06-30T18:54:15Z

Thanks for updating our url generator! Made some small changes, mainly to address a regression caused by the new locator already including the base path. Tested ML changes and can confirm the following work correctly after the latest changes:

Change the title of the pages (docTitle) whenever navigating to a new tab
- Only persist the refreshInterval in the _g parameter
Filters/Calendar pages should navigating back to previous page correctly
- Start trial link in data visualizer
- Select a different index link when creating indices that are not time based
Links for both Anomaly detection and DFA tables should work correctly for:
- Overview page
- Job list pages
- Kibana management page
Links to jobs when creating or viewing from Kibana's sample data
Calendars & Filters redirects (manage, create, cancel, new, save)
Link to calendars from the Job Details expanded panel
Link to SMV from the Job Details - Forecast panel
- Link added to recently accessed work correctly
Link to SMV from the Job Details - Annotations table
- Link added to recently accessed work correctly
Link to SMV from the Anomaly Explorer - Anomalies chart
- Link added to recently accessed work correctly
Switching between the SMV and Anomaly Explorer
Link to Create job in Explorer page when no job found
ML embeddables
- Add anomaly swimlane to dashboard
- Add anomaly chart embeddable to dashboard
- Link to SMV from the embedded anomaly charts
- Open in Anomaly Explorer opens up explorer page
Anomaly detection create job wizard
- Redirect to Single metric, multi-metric, population, advanced, categorization, and rare correctly
- Redirect to Data Visualizer
  - Link added to recently accessed work correctly
- Redirect to index pattern/saved search selection page when index not time based

banderror

Security Solution LGTM 👍
I left a small optional suggestion.

...ck/plugins/security_solution/public/common/components/ml/links/create_explorer_link.test.tsx

qn895 · 2021-07-06T14:43:36Z

Latest changes LGTM 🎉

FrankHassanabad

LGTM

weltenwort

infra plugin changes LGTM, thank you!

kibanamachine · 2021-07-08T14:23:18Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`ml`	1727	1729	+2

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`ml`	274	273	-1

Async chunks

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

id	before	after	diff
`infra`	1.7MB	1.7MB	-13.0B
`ml`	5.9MB	5.9MB	-805.0B
total			-818.0B

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`ml`	32	33	+1

Page load bundle

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

id	before	after	diff
`ml`	65.8KB	64.5KB	-1.3KB

Unknown metric groups

API count

id	before	after	diff
`ml`	278	277	-1

History

💔 Build #137183 failed 6d9e1b4
💔 Build #136818 failed f75149c
💔 Build #136547 failed 7017469
💚 Build #136365 succeeded 0e5b0c4
💔 Build #135755 failed 10e1486

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

kibanamachine · 2021-07-08T14:27:59Z

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.

* fix: 🐛 cast type * chore: 🤖 remove unused parameter * feat: 🎸 implement ML locator * test: 💍 add locator tests * feat: 🎸 expose ML locator form plugin contract * feat: 🎸 deprecate ml url generator * feat: 🎸 use locator in useMlHref() React hook * fix: 🐛 remove non-existing property * fix: 🐛 remove unused parameter * feat: 🎸 replace url generator by locator * refactor: 💡 remove ML url generator and replace by locator * fix: 🐛 correct type check error * test: 💍 add share plugin mock and use it * test: 💍 update mock * Remove usage of excludeBasePath * Fix recently accessed url for create job to data visualizer * refactor: 💡 rename interface * test: 💍 move locator mock into the share plugin * test: 💍 update Jest snapshot * test: 💍 use shared URL service mock * refactor: 💡 update usage after merging latest * refactor: 💡 use locator instead of generator * chore: 🤖 remove unused import Co-authored-by: Quynh Nguyen <quynh.nguyen@elastic.co>

* fix: 🐛 cast type * chore: 🤖 remove unused parameter * feat: 🎸 implement ML locator * test: 💍 add locator tests * feat: 🎸 expose ML locator form plugin contract * feat: 🎸 deprecate ml url generator * feat: 🎸 use locator in useMlHref() React hook * fix: 🐛 remove non-existing property * fix: 🐛 remove unused parameter * feat: 🎸 replace url generator by locator * refactor: 💡 remove ML url generator and replace by locator * fix: 🐛 correct type check error * test: 💍 add share plugin mock and use it * test: 💍 update mock * Remove usage of excludeBasePath * Fix recently accessed url for create job to data visualizer * refactor: 💡 rename interface * test: 💍 move locator mock into the share plugin * test: 💍 update Jest snapshot * test: 💍 use shared URL service mock * refactor: 💡 update usage after merging latest * refactor: 💡 use locator instead of generator * chore: 🤖 remove unused import Co-authored-by: Quynh Nguyen <quynh.nguyen@elastic.co> Co-authored-by: Vadim Dalecky <streamich@gmail.com> Co-authored-by: Quynh Nguyen <quynh.nguyen@elastic.co>

streamich added 6 commits June 29, 2021 10:15

fix: 🐛 cast type

d1129fd

chore: 🤖 remove unused parameter

8796c8a

feat: 🎸 implement ML locator

09d6487

test: 💍 add locator tests

da33e69

feat: 🎸 expose ML locator form plugin contract

e83a843

feat: 🎸 deprecate ml url generator

0ab2ea2

streamich changed the title ~~Ml locator 2~~ ML locator Jun 29, 2021

streamich added 9 commits June 29, 2021 14:58

feat: 🎸 use locator in useMlHref() React hook

41c56aa

fix: 🐛 remove non-existing property

d4c9ac6

fix: 🐛 remove unused parameter

e4f5ac9

feat: 🎸 replace url generator by locator

302d91f

refactor: 💡 remove ML url generator and replace by locator

cf6f144

fix: 🐛 correct type check error

8259d22

test: 💍 add share plugin mock and use it

16c0b98

test: 💍 update mock

802f7a2

Merge branch 'master' into ml-locator-2

11ba91c

streamich marked this pull request as ready for review June 30, 2021 08:45

streamich requested review from a team as code owners June 30, 2021 08:45

streamich added release_note:breaking review Team:AppServices v7.15.0 v8.0.0 labels Jun 30, 2021

streamich mentioned this pull request Jun 30, 2021

Migrate URL generators to locators #98107

Closed

29 tasks

ppisljar approved these changes Jun 30, 2021

View reviewed changes

qn895 reviewed Jun 30, 2021

View reviewed changes

.../application/components/anomaly_results_view_selector/anomaly_results_view_selector.test.tsx Outdated Show resolved Hide resolved

qn895 added 2 commits June 30, 2021 12:50

Remove usage of excludeBasePath

2d7c96a

Fix recently accessed url for create job to data visualizer

10e1486

streamich added 4 commits July 5, 2021 16:21

Merge remote-tracking branch 'upstream/master' into ml-locator-2

0178051

refactor: 💡 rename interface

d356058

test: 💍 move locator mock into the share plugin

2efc999

test: 💍 update Jest snapshot

0e5b0c4

streamich requested a review from qn895 July 5, 2021 15:04

banderror approved these changes Jul 6, 2021

View reviewed changes

...ck/plugins/security_solution/public/common/components/ml/links/create_explorer_link.test.tsx Outdated Show resolved Hide resolved

streamich added 2 commits July 6, 2021 15:12

Merge remote-tracking branch 'upstream/master' into ml-locator-2

6cc007b

test: 💍 use shared URL service mock

7017469

qn895 approved these changes Jul 6, 2021

View reviewed changes

FrankHassanabad approved these changes Jul 6, 2021

View reviewed changes

streamich added 4 commits July 7, 2021 13:16

refactor: 💡 update usage after merging latest

d14e4f2

Merge remote-tracking branch 'upstream/master' into ml-locator-2

f75149c

Merge remote-tracking branch 'upstream/master' into ml-locator-2

8b9d73a

refactor: 💡 use locator instead of generator

6d9e1b4

weltenwort self-requested a review July 8, 2021 11:45

chore: 🤖 remove unused import

f6aee64

weltenwort approved these changes Jul 8, 2021

View reviewed changes

streamich added the auto-backport Deprecated - use backport:version if exact versions are needed label Jul 8, 2021

streamich merged commit 15d47ec into elastic:master Jul 8, 2021

kibanamachine mentioned this pull request Jul 8, 2021

[7.x] ML locator (#103652) #104883

Merged

peteharverson mentioned this pull request Aug 12, 2021

[ML] Fixes callout in rule editor when no filter lists created #108369

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ML locator #103652

ML locator #103652

streamich commented Jun 29, 2021 •

edited

Loading

elasticmachine commented Jun 30, 2021

ppisljar left a comment

qn895 commented Jun 30, 2021 •

edited

Loading

banderror left a comment

qn895 commented Jul 6, 2021

FrankHassanabad left a comment

weltenwort left a comment

kibanamachine commented Jul 8, 2021

API count

kibanamachine commented Jul 8, 2021

ML locator #103652

ML locator #103652

Conversation

streamich commented Jun 29, 2021 • edited Loading

Summary

Checklist

For maintainers

Testing

elasticmachine commented Jun 30, 2021

ppisljar left a comment

Choose a reason for hiding this comment

qn895 commented Jun 30, 2021 • edited Loading

banderror left a comment

Choose a reason for hiding this comment

qn895 commented Jul 6, 2021

FrankHassanabad left a comment

Choose a reason for hiding this comment

weltenwort left a comment

Choose a reason for hiding this comment

kibanamachine commented Jul 8, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

API count

History

kibanamachine commented Jul 8, 2021

💚 Backport successful

streamich commented Jun 29, 2021 •

edited

Loading

qn895 commented Jun 30, 2021 •

edited

Loading