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

qn895 · 2020-09-04T01:57:45Z

Summary

This is WIP to migrate ML internal URLs to non-hash paths. Follow up of #75696 and part of meta issue to switch from HashRouter to BrowserRouter #75696.

Potential Follow-up PRs

Persist the refreshInterval setting even after creating a new AD job (currently it's being reset-ed to { pause: true, value: 0 }

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
This was checked for cross-browser compatibility

- Overview page create job/create dfa - AE configure rules: filter link

- Update link to jobs page when no SMV jobs found

…ate in tab nav

…und DFA types

…nvalid

…meSeriesExplorerUrlStateManager

…eload

walterra

Had a first look, overall the refactor and use of utils looks good. I added some smaller questions/suggestions.

One thing i noticed I'm not sure why this is necessary: I see the use of async/await with navigateToUrl or await mlUrlGenerator.createUrl but I'm not sure this is required?

walterra · 2020-09-08T12:45:48Z

x-pack/plugins/ml/common/constants/data_frame_analytics.ts

+export const ANALYSIS_CONFIG_TYPE = {
+  OUTLIER_DETECTION: 'outlier_detection',
+  REGRESSION: 'regression',
+  CLASSIFICATION: 'classification',
+} as const;


We have the same as an enum already in plugins/ml/public/application/data_frame_analytics/common/analytics.ts. This one using the const approach as well as the location here LGTM so suggest to try to get rid of the on mentioned in this comment.

Went through and updated the usage of enum ANALYSIS_CONFIG_TYPE to const ANALYSIS_CONFIG_TYPE here dd3517b

walterra · 2020-09-08T12:46:39Z

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

@@ -79,3 +80,5 @@ export interface DataFrameAnalyticsConfig {
  version: string;
  allow_lazy_start?: boolean;
 }
+
+export type DataFrameAnalyticsType = typeof ANALYSIS_CONFIG_TYPE[keyof typeof ANALYSIS_CONFIG_TYPE];


I don't think we use the Type postfix in other places so suggest to just name this DataFrameAnalytics.

Renamed here d3edff7

walterra · 2020-09-08T12:49:11Z

x-pack/plugins/ml/public/application/components/navigation_menu/main_tabs.tsx

+  };
+
+  useEffect(() => {
+    document.title = `ML - ${TAB_DATA[selectedTabId].name} - Kibana`;


I wonder if Kibana offers a way to do this more "officially" without directly manipulating document.title?

That's a good point! I do see coreStart.docTitle.change('My Title') that the Kibana team has exposed out ... Gonna take a look to see if we an implement this using that instead 👍

Changed to using Kibana's chrome.docTitle.change() here c62a924

walterra · 2020-09-08T12:50:06Z

x-pack/plugins/ml/public/application/components/navigation_menu/main_tabs.tsx

        // globalState (e.g. selected jobs and time range) should be retained when changing pages.
        // appState will not be considered.
-        const fullGlobalStateString = globalState !== undefined ? `?_g=${encode(globalState)}` : '';


Why is the global state no longer necessary?

I'm still retaining the globalState here, just within redirectToTab instead of the encoded string.

…al-urls # Conflicts: # x-pack/plugins/ml/public/application/settings/filter_lists/list/table.js

[ML] Update useMlLink

walterra · 2020-09-15T15:15:34Z

...data_frame_analytics/pages/analytics_management/components/models_management/models_list.tsx

+            analysisType: Object.keys(
+              item.metadata?.analytics_config.analysis
+            )[0] as DataFrameAnalyticsType,


We have getAnalysisType() available in plugins/ml/public/application/data_frame_analytics/common/analytics.ts.

Updated here cc8f5dd

walterra · 2020-09-15T15:16:17Z

...ion/data_frame_analytics/pages/analytics_management/hooks/use_create_analytics_form/state.ts

@@ -290,7 +291,7 @@ export function getFormStateFromJobConfig(
  analyticsJobConfig: Readonly<CloneDataFrameAnalyticsConfig>,
  isClone: boolean = true
 ): Partial<State['form']> {
-  const jobType = Object.keys(analyticsJobConfig.analysis)[0] as ANALYSIS_CONFIG_TYPE;
+  const jobType = Object.keys(analyticsJobConfig.analysis)[0] as DataFrameAnalyticsType;


We have getAnalysisType() available in plugins/ml/public/application/data_frame_analytics/common/analytics.ts.

Updated here cc8f5dd

walterra · 2020-09-15T15:17:02Z

.../data_frame_analytics/pages/analytics_management/services/analytics_service/get_analytics.ts

@@ -143,7 +140,7 @@ export const getAnalyticsFactory = (
              checkpointing: {},
              config,
              id: config.id,
-              job_type: Object.keys(config.analysis)[0] as ANALYSIS_CONFIG_TYPE,
+              job_type: Object.keys(config.analysis)[0] as DataFrameAnalyticsType,


We have getAnalysisType() available in plugins/ml/public/application/data_frame_analytics/common/analytics.ts.

Updated here cc8f5dd

walterra · 2020-09-15T15:17:40Z

...s/ml/public/application/datavisualizer/file_based/components/results_links/results_links.tsx

+  } = useMlKibana();
+
+  useEffect(() => {
+    let unamounted = false;


should this be unmounted?

Updated here cc8f5dd

walterra · 2020-09-15T15:19:19Z

...s/ml/public/application/explorer/components/explorer_no_jobs_found/explorer_no_jobs_found.js

-  />
-);
+import { ML_PAGES } from '../../../../../common/constants/ml_url_generator';
+import { Link } from 'react-router-dom';


Nit: This import could be at the top of the file.

Updated here cc8f5dd

walterra · 2020-09-15T15:30:48Z

x-pack/plugins/ml/public/application/jobs/jobs_list/components/jobs_list/jobs_list.js

@@ -71,7 +71,7 @@ export class JobsList extends Component {
      return id;
    }

-    return <ADJobIdLink id={id} />;
+    return <ADJobIdLink key={id} id={id} />;


Nit: Besides Ml as a prefix we hardly use any abbreviations in component names so I was wondering if we should make this the full written <AnomalyDetectionJobIdLink ... />.

Updated here cc8f5dd

peteharverson · 2020-09-15T16:40:10Z

Gave latest edits a test, and all looks good. Only issue I have found is when coming into the Anomaly Detection jobs list from the Management app jobs list, and deleting the search query, the address bar URL ends up as e.g.

http://localhost:5601/zvl/app/ml/ml#/jobs?_g=(refreshInterval:(pause:!f,value:30000))

The page loads fine, but you get the extra ml# in the URL.

pheyos

Functional test fix LGTM

…, update addItemToRecentlyAccessed

…al-urls

qn895 · 2020-09-16T20:48:54Z

Gave latest edits a test, and all looks good. Only issue I have found is when coming into the Anomaly Detection jobs list from the Management app jobs list, and deleting the search query, the address bar URL ends up as e.g.
http://localhost:5601/zvl/app/ml/ml#/jobs?_g=(refreshInterval:(pause:!f,value:30000))
The page loads fine, but you get the extra ml# in the URL.

Thanks for catching that. This issue should now be fixed in 92dad64.

I also realized I missed a few spots in the process of working on this issue and have made updates to those:

Link to calendars from the Job Details expanded panel
Link to SMV from the Job Details - Forecast panel
Link to SMV from the Job Details - Annotations table
Link to SMV from the Anomaly Explorer - Anomalies chart
Switching between the SMV and Anomaly Explorer

walterra

Latest changes LGTM

peteharverson

Tested latest edits and LGTM

qn895 · 2020-09-17T15:25:14Z

@elasticmachine merge upstream

kibanamachine · 2020-09-17T17:01:07Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: a39face

Build metrics

async chunks size

id	value	diff	baseline
ml	8.1MB	+54.9KB	8.0MB

page load bundle size

id	value	diff	baseline
ml	872.3KB	+27.0KB	845.3KB

History

💚 Build #75018 succeeded ee507b4
💔 Build #74978 failed 0a0436b
💚 Build #74514 succeeded 0d83eac
💚 Build #74479 succeeded d3edff7
💚 Build #74320 succeeded 1efaed2

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

Co-authored-by: Elastic Machine <[email protected]>

Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

qn895 added 15 commits September 3, 2020 09:45

[ML] Update internal links

5ff3100

- Overview page create job/create dfa - AE configure rules: filter link

[ML] Update internal links

df33079

- Update link to jobs page when no SMV jobs found

[ML] Update links to datavisualizer results page

8c3adc1

[ML] Update links to datavisualizer results page

0333310

[ML] Update links to filter list

65de961

[ML] Update browser doc title whenever tab changes

4ec96fd

[ML] Update manageCalendarsHref

49d0e7d

[ML] Update jobList and data frame list

6827517

[ML] Remove get_selected_ids_url

6f86f70

[ML] Update globalState to appropriate url states & retain only _g st…

7f8decf

…ate in tab nav

[ML] Update link for register feature

ce2f3ec

[ML] Add i18n to main tabs

6fbb599

[ML] Add link to DFA list, remove commented preserve search, move aro…

195929f

…und DFA types

[ML] Update import for const ANALYSIS_CONFIG_TYPE

f175d27

[ML] Revert change to APM

8ffd123

qn895 added Feature:Anomaly Detection ML anomaly detection v8.0.0 Feature:File and Index Data Viz ML file and index data visualizer Feature:Data Frame Analytics ML data frame analytics features v7.10.0 labels Sep 4, 2020

qn895 self-assigned this Sep 4, 2020

qn895 added 6 commits September 4, 2020 12:12

[ML] Fix broken Start trial link in data visualizer

a30ec90

[ML] Redirect to main job page if _g for global for dfa exploration i…

0e9915b

…nvalid

[ML] Inject basepath to preConfiguredJobRedirect

5b8c82e

[ML] Inject basepath to preConfiguredJobRedirect + update mock for Ti…

7742303

…meSeriesExplorerUrlStateManager

[ML] Change to useNavigateToPath instead of href to avoid full page r…

f56525c

…eload

[ML] Update links within settings

25272ca

peteharverson added the :ml label Sep 8, 2020

walterra reviewed Sep 8, 2020

View reviewed changes

Merge remote-tracking branch 'upstream/master' into ml-replace-intern…

adc1047

…al-urls # Conflicts: # x-pack/plugins/ml/public/application/settings/filter_lists/list/table.js

qn895 added 4 commits September 15, 2020 10:35

[ML] Update useMlLink

42313ae

[ML] Update useMlLink

[ML] Change redirectToMlAccessDeniedPage to using deps

f762277

[ML] Fix recently_accessed not working from non-ml pages

ba56a81

[ML] Add message

0d83eac

walterra reviewed Sep 15, 2020

View reviewed changes

pheyos approved these changes Sep 16, 2020

View reviewed changes

qn895 added 8 commits September 16, 2020 09:54

[ML] Use getAnalysisType, reorder import Link, rename AdJobLink

cc8f5dd

[ML] Update clearSelectedJobIdFromUrl, update forecast tables linking…

92dad64

…, update addItemToRecentlyAccessed

[ML] Update links inside annotations_table

0a4a559

[ML] Update links in ExplorerChartContainerUI

efe49ea

[ML] Rename single metric viewer links

abe0ce6

[ML] Update switch link btw SMV and AE

b7f9be7

[ML] Update tests

5dd7373

Merge remote-tracking branch 'upstream/master' into ml-replace-intern…

0a0436b

…al-urls

qn895 added 2 commits September 16, 2020 17:40

[ML] Fix model list linking

75352f9

[ML] Update linking in AE Anomalies table

ee507b4

walterra approved these changes Sep 17, 2020

View reviewed changes

peteharverson approved these changes Sep 17, 2020

View reviewed changes

Merge branch 'master' into ml-replace-internal-urls

a39face

qn895 merged commit d88b3a6 into elastic:master Sep 17, 2020

qn895 deleted the ml-replace-internal-urls branch September 17, 2020 17:09

qn895 mentioned this pull request Sep 17, 2020

[7.x] [ML] Migrate internal urls to non-hash paths (#76735) #77792

Merged

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

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

5e08831

Co-authored-by: Elastic Machine <[email protected]>

qn895 mentioned this pull request Sep 18, 2020

[ML] Fix registerUrlGenerator broken on basic licensing #77832

Merged

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

[7.x] [ML] Migrate internal urls to non-hash paths (#76735) (#77792)

7fb9d4d

Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

qn895 mentioned this pull request Oct 15, 2020

[ML] Fix regression with some links not opening in new tab #80785

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

qn895 commented Sep 4, 2020 •

edited

Loading

walterra left a comment

walterra Sep 8, 2020

qn895 Sep 9, 2020 •

edited

Loading

walterra Sep 8, 2020

qn895 Sep 15, 2020

walterra Sep 8, 2020

qn895 Sep 8, 2020

qn895 Sep 15, 2020 •

edited

Loading

walterra Sep 8, 2020

qn895 Sep 8, 2020

walterra Sep 15, 2020

qn895 Sep 16, 2020

walterra Sep 15, 2020

qn895 Sep 16, 2020

walterra Sep 15, 2020

qn895 Sep 16, 2020

walterra Sep 15, 2020

qn895 Sep 16, 2020

walterra Sep 15, 2020

qn895 Sep 16, 2020

walterra Sep 15, 2020

qn895 Sep 16, 2020

peteharverson commented Sep 15, 2020

pheyos left a comment

qn895 commented Sep 16, 2020

walterra left a comment

peteharverson left a comment

qn895 commented Sep 17, 2020

kibanamachine commented Sep 17, 2020

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

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

Conversation

qn895 commented Sep 4, 2020 • edited Loading

Summary

Potential Follow-up PRs

Checklist

walterra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qn895 Sep 9, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qn895 Sep 15, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

peteharverson commented Sep 15, 2020

pheyos left a comment

Choose a reason for hiding this comment

qn895 commented Sep 16, 2020

walterra left a comment

Choose a reason for hiding this comment

peteharverson left a comment

Choose a reason for hiding this comment

qn895 commented Sep 17, 2020

kibanamachine commented Sep 17, 2020

💚 Build Succeeded

Build metrics

async chunks size

page load bundle size

History

qn895 commented Sep 4, 2020 •

edited

Loading

qn895 Sep 9, 2020 •

edited

Loading

qn895 Sep 15, 2020 •

edited

Loading