[ML] Extend MlUrlGenerator to support other ML pages #75696

qn895 · 2020-08-21T19:11:25Z

Summary

This PR is part of #69265 to extend MlUrlGenerator for other apps within Kibana to access and to convert ML urls to non-hash paths.

Example usage:

  const mlUrlGenerator = useMlUrlGenerator();
  const {
    services: {
      application: { navigateToUrl },
    },
  } = useMlKibana();

  const redirectToAnalyticsManagementPage = async () => {
    const url = await mlUrlGenerator.createUrl({ page: ML_PAGES.DATA_FRAME_ANALYTICS });
    await navigateToUrl(url);
  };

Or preserve search within ml plugin

  const urlGenerator = useMlUrlGenerator();
  const navigateToPath = useNavigateToPath();

  const redirectToAnalyticsManagementPage = async () => {
    const path = await urlGenerator.createUrl({
      page: ML_TABS.DATA_FRAME_ANALYTICS',
      jobId,
      analysisType,
    });
    await navigateToPath(path, preserveSearch); // set preserve search to true
  };

Addition parameters that belong to globalApp _g and appState _a or custom to the page itself are also supported

        const url = await urlGenerator.createUrl({
          page: ML_PAGES.TIME_SERIES_EXPLORER,
          jobIds: ['logs_categorization_1'],
          detectorIndex: 0,
          entities: { mlcategory: '2' },
          refreshInterval: {
            display: 'Off',
            pause: false,
            value: 0,
          },
          timeRange: {
            from: '2020-07-12T00:39:02.912Z',
            to: '2020-07-22T15:52:18.613Z',
            mode: 'absolute',
          },
          zoom: {
            from: '2020-07-20T23:58:29.367Z',
            to: '2020-07-21T11:00:13.173Z',
          },
          query: {
            analyze_wildcard: true,
            query: '*',
          },
        });

Checklist

Unit or functional tests were updated or added to match the most common scenarios
This was checked for cross-browser compatibility

…refactor

elasticmachine · 2020-08-21T19:15:12Z

Pinging @elastic/ml-ui (:ml)

walterra · 2020-08-24T10:01:03Z

Could we expose ML_TABS as part of the url generator itself so we don't have to do a separate import for that? For example the code could the look something like this:

const mlUrlGenerator = useMlUrlGenerator();
  const {
    services: {
      application: { navigateToUrl },
    },
  } = useMlKibana();

  const redirectToAnalyticsManagementPage = async () => {
    const url = await mlUrlGenerator.createUrl({ page: mlUrlGenerator.ML_TABS.DATA_FRAME_ANALYTICS });
    await navigateToUrl(url);
  };

Naming nit: ML_TABS is what we make show up as tabs in the UI, but I wonder if it makes more sense to rename it to ML_PAGES as part of the url generator.

lukeelmers

app arch updates LGTM

qn895 · 2020-08-24T15:59:04Z

Naming nit: ML_TABS is what we make show up as tabs in the UI, but I wonder if it makes more sense to rename it to ML_PAGES as part of the url generator.

@walterra I agree - it's much more clear! Renamed it to ML_PAGES here: 7c9318e

qn895 · 2020-08-26T03:12:49Z

I noticed the links we add for the Kibana Sample data sets still use the old hash style URLs. Can these be edited to the non-hash version - defined in ml/server/lib/sample_data_sets/sample_data_sets.ts

Removed the hash here 64b936b
although I didn't use the url generator for this one. If we want to create a new `/modules/ slash page I can definitely do that.

@qn895 please take a look at #74555 (files), we should probably replace useLinkProps with ML Url Generator

Thanks for bringing it up. I will make the changes for these in a follow up PR as it involves reviews from another team.

lizozom · 2020-08-27T12:51:04Z

src/plugins/data/common/query/timefilter/types.ts

  pause: boolean;
  value: number;
 }

 export interface TimeRange {
  from: string;
  to: string;
-  mode?: 'absolute' | 'relative';
+  mode?: 'absolute' | 'relative' | 'quick';


@qn895 I'm slightly confused on how both these fields get used.

I don't even see any place in the code using them (nor here or in the data plugin), to the point I would consider removing mode 🤨

I'd love to sync on this.

@lizozom Thanks for the feedback. Our team decided it would be good to take those parameters out as they are outdated. I have reverted the additions to the data plugin here: 5eefb05

jgowdyelastic · 2020-08-27T13:32:42Z

x-pack/plugins/ml/public/url_generator.ts

+          mlUrlGeneratorState as DataFrameAnalyticsExplorationUrlState
+        );
+      case ML_PAGES.DATA_VISUALIZER:
+        return this.createDataVisualizerUrl(mlUrlGeneratorState as DataVisualizerUrlState);


these 3 are the same and so cold fall through to one case

Updated here 4d6a5a0

jgowdyelastic · 2020-08-27T13:34:54Z

x-pack/plugins/ml/public/url_generator.ts

  /**
   * Creates URL to the Anomaly Explorer page
   */
  private createExplorerUrl({
+    refreshInterval,


this file is now very large. would it be possible/convenient to break it into multiple files? one per page perhaps.
It might make it easier to manage in the future.

Refactor to separate files here 4d6a5a0

jgowdyelastic

LGTM

…i docs

darnautov

Latest changes LGTM! 👍 But please pay attention to the MLPageState suggestion

darnautov · 2020-09-02T08:07:18Z

x-pack/plugins/ml/common/types/ml_url_generator.ts

+  CLASSIFICATION: 'classification',
+} as const;
+
+type DATAFRAME_ANALYTICS_TYPE = typeof ANALYSIS_CONFIG_TYPE[keyof typeof ANALYSIS_CONFIG_TYPE];


I think we only use this notation for constants. For types, it's a camel case starting with capital.

Suggested change

type DATAFRAME_ANALYTICS_TYPE = typeof ANALYSIS_CONFIG_TYPE[keyof typeof ANALYSIS_CONFIG_TYPE];

type DataFrameAnalyticsType = typeof ANALYSIS_CONFIG_TYPE[keyof typeof ANALYSIS_CONFIG_TYPE];

Updated here 8248d7f

x-pack/plugins/ml/common/types/ml_url_generator.ts

walterra

Latest changes LGTM.

peteharverson

A few extra minor function / file renames for the data frame analytics pages are needed.

x-pack/plugins/ml/public/ml_url_generator/dataframe_analytics_urls_generator.ts

peteharverson

Latest edits LGTM!

kibanamachine · 2020-09-02T19:48:49Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 8489ded

Build metrics

@kbn/optimizer bundle module count

id	value	diff	baseline
ml	1385	+7	1378

async chunks size

id	value	diff	baseline
ml	8.2MB	+930.0B	8.2MB

page load bundle size

id	value	diff	baseline
ml	582.7KB	+6.1KB	576.6KB

distributable file count

id	value	diff	baseline
total	45539	+2	45537

History

💚 Build #71928 succeeded a6cb7da
💔 Build #71898 failed 67214cd
💚 Build #71626 succeeded 8148a6c
💔 Build #71462 failed 5eefb05
💚 Build #71434 succeeded 3751f4a

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

Co-authored-by: Dima Arnautov <[email protected]>

…76561) Co-authored-by: Dima Arnautov <[email protected]>

qn895 added 7 commits August 21, 2020 12:19

[ML] Extend MlUrlGenerator to support other pages

5efa8cd

[ML] Change destructuring & index based ml generator

9faedfd

[ML] Make createIndexBasedMlUrl check more explicit

7d8aba8

[ML] Remove commented code

40cc3c5

[ML] Update type for TimeRange

c1f8cde

[ML] Update redirect for dfa wizard to use constants

98dd2e5

Merge remote-tracking branch 'upstream/master' into ml-url-generator-…

0e4ddd6

…refactor

qn895 added the :ml label Aug 21, 2020

qn895 self-assigned this Aug 21, 2020

qn895 added release_note:skip Skip the PR/issue when compiling release notes v7.10.0 v8.0.0 Feature:Anomaly Detection ML anomaly detection Feature:Data Frame Analytics ML data frame analytics features Feature:File and Index Data Viz ML file and index data visualizer refactoring labels Aug 21, 2020

qn895 marked this pull request as ready for review August 21, 2020 19:15

qn895 requested review from a team as code owners August 21, 2020 19:15

lukeelmers approved these changes Aug 24, 2020

View reviewed changes

qn895 added 4 commits August 24, 2020 10:03

[ML] Rename ML_TABS to ML_PAGES

7c9318e

Merge remote-tracking branch 'upstream/master' into new-ml-url-generator

aa9398d

[ML] Update core API docs

7360f32

[ML] Fix perPartitionStopOnWarn typo

7ce5a5b

qn895 requested review from walterra, darnautov and peteharverson August 24, 2020 17:40

walterra mentioned this pull request Aug 26, 2020

[ML] Switch from HashRouter to platform-provided BrowserRouter #72013

Closed

9 tasks

lizozom reviewed Aug 27, 2020

View reviewed changes

jgowdyelastic reviewed Aug 27, 2020

View reviewed changes

qn895 added 4 commits August 27, 2020 11:38

Merge remote-tracking branch 'upstream/master' into new-ml-url-generator

689f0f6

[ML] Refactor to own folder

4d6a5a0

Merge remote-tracking branch 'upstream/master' into new-ml-url-generator

3751f4a

[ML] Revert changes to data/common/types

5eefb05

jgowdyelastic approved these changes Sep 1, 2020

View reviewed changes

qn895 added 3 commits September 1, 2020 10:41

[ML] Fix createAnomalyDetectionCreateJobSelectType name and update ap…

a1e9118

…i docs

[ML] Change shape to use page and pageState

2abee97

[ML] Remove commented block code

8148a6c

darnautov approved these changes Sep 2, 2020

View reviewed changes

lizozom approved these changes Sep 2, 2020

View reviewed changes

walterra approved these changes Sep 2, 2020

View reviewed changes

peteharverson reviewed Sep 2, 2020

View reviewed changes

qn895 added 3 commits September 2, 2020 09:30

[ML] Rename dataframe -> data frame, update types for MLPagestype

9962c25

[ML] Rename DataFrameAnalyticsType

8248d7f

Merge remote-tracking branch 'upstream/master' into new-ml-url-generator

67214cd

peteharverson approved these changes Sep 2, 2020

View reviewed changes

qn895 and others added 2 commits September 2, 2020 10:25

[ML] Update typings

a6cb7da

[ML] fix base type

8489ded

qn895 merged commit aac8424 into elastic:master Sep 2, 2020

qn895 deleted the new-ml-url-generator branch September 2, 2020 19:52

qn895 mentioned this pull request Sep 2, 2020

[7.x] [ML] Extend MlUrlGenerator to support other ML pages (#75696) #76561

Merged

qn895 added a commit to qn895/kibana that referenced this pull request Sep 2, 2020

[ML] Extend MlUrlGenerator to support other ML pages (elastic#75696)

99544c6

Co-authored-by: Dima Arnautov <[email protected]>

qn895 added a commit that referenced this pull request Sep 3, 2020

[7.x] [ML] Extend MlUrlGenerator to support other ML pages (#75696) (#…

ef54fed

…76561) Co-authored-by: Dima Arnautov <[email protected]>

qn895 mentioned this pull request Sep 4, 2020

[ML] Migrate internal urls to non-hash paths #76735

Merged

30 tasks

peteharverson mentioned this pull request Sep 28, 2020

[ML] Url generator #69265

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ML] Extend MlUrlGenerator to support other ML pages #75696

[ML] Extend MlUrlGenerator to support other ML pages #75696

qn895 commented Aug 21, 2020 •

edited by peteharverson

Loading

elasticmachine commented Aug 21, 2020

walterra commented Aug 24, 2020 •

edited

Loading

lukeelmers left a comment

qn895 commented Aug 24, 2020

qn895 commented Aug 26, 2020

lizozom Aug 27, 2020 •

edited

Loading

qn895 Sep 1, 2020

jgowdyelastic Aug 27, 2020

qn895 Sep 1, 2020

jgowdyelastic Aug 27, 2020

qn895 Sep 1, 2020

jgowdyelastic left a comment

darnautov left a comment

darnautov Sep 2, 2020

qn895 Sep 2, 2020

walterra left a comment

peteharverson left a comment

peteharverson left a comment

kibanamachine commented Sep 2, 2020

	type DATAFRAME_ANALYTICS_TYPE = typeof ANALYSIS_CONFIG_TYPE[keyof typeof ANALYSIS_CONFIG_TYPE];
	type DataFrameAnalyticsType = typeof ANALYSIS_CONFIG_TYPE[keyof typeof ANALYSIS_CONFIG_TYPE];

[ML] Extend MlUrlGenerator to support other ML pages #75696

[ML] Extend MlUrlGenerator to support other ML pages #75696

Conversation

qn895 commented Aug 21, 2020 • edited by peteharverson Loading

Summary

Checklist

elasticmachine commented Aug 21, 2020

walterra commented Aug 24, 2020 • edited Loading

lukeelmers left a comment

Choose a reason for hiding this comment

qn895 commented Aug 24, 2020

qn895 commented Aug 26, 2020

lizozom Aug 27, 2020 • edited Loading

Choose a reason for hiding this comment

qn895 Sep 1, 2020

Choose a reason for hiding this comment

jgowdyelastic Aug 27, 2020

Choose a reason for hiding this comment

qn895 Sep 1, 2020

Choose a reason for hiding this comment

jgowdyelastic Aug 27, 2020

Choose a reason for hiding this comment

qn895 Sep 1, 2020

Choose a reason for hiding this comment

jgowdyelastic left a comment

Choose a reason for hiding this comment

darnautov left a comment

Choose a reason for hiding this comment

darnautov Sep 2, 2020

Choose a reason for hiding this comment

qn895 Sep 2, 2020

Choose a reason for hiding this comment

walterra left a comment

Choose a reason for hiding this comment

peteharverson left a comment

Choose a reason for hiding this comment

peteharverson left a comment

Choose a reason for hiding this comment

kibanamachine commented Sep 2, 2020

💚 Build Succeeded

Build metrics

@kbn/optimizer bundle module count

async chunks size

page load bundle size

distributable file count

History

qn895 commented Aug 21, 2020 •

edited by peteharverson

Loading

walterra commented Aug 24, 2020 •

edited

Loading

lizozom Aug 27, 2020 •

edited

Loading