Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ML] Fix the browser's history navigation #80902

Merged
merged 5 commits into from
Oct 19, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ class AnnotationsTableUI extends Component {
timeRange,
refreshInterval: {
display: 'Off',
pause: false,
pause: true,
value: 0,
},
jobIds: [job.job_id],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ class LinksMenuUI extends Component {
jobIds: [record.job_id],
refreshInterval: {
display: 'Off',
pause: false,
pause: true,
value: 0,
},
timeRange: {
Expand Down Expand Up @@ -307,7 +307,7 @@ class LinksMenuUI extends Component {
const _g = rison.encode({
refreshInterval: {
display: 'Off',
pause: false,
pause: true,
value: 0,
},
time: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* you may not use this file except in compliance with the Elastic License.
*/

import React, { FC, Fragment, useState, useEffect } from 'react';
import React, { FC, Fragment, useState, useEffect, useCallback } from 'react';
import { Subscription } from 'rxjs';
import { EuiSuperDatePicker, OnRefreshProps } from '@elastic/eui';
import { TimeRange, TimeHistoryContract } from 'src/plugins/data/public';
Expand Down Expand Up @@ -48,13 +48,15 @@ export const DatePickerWrapper: FC = () => {
const [globalState, setGlobalState] = useUrlState('_g');
const getRecentlyUsedRanges = getRecentlyUsedRangesFactory(history);

const [refreshInterval, setRefreshInterval] = useState<RefreshInterval>(
globalState?.refreshInterval ?? timefilter.getRefreshInterval()
const refreshInterval: RefreshInterval =
globalState?.refreshInterval ?? timefilter.getRefreshInterval();

const setRefreshInterval = useCallback(
(refreshIntervalUpdate: RefreshInterval) => {
setGlobalState('refreshInterval', refreshIntervalUpdate);
},
[setGlobalState]
);
useEffect(() => {
setGlobalState({ refreshInterval });
timefilter.setRefreshInterval(refreshInterval);
}, [refreshInterval?.pause, refreshInterval?.value, setGlobalState]);

const [time, setTime] = useState(timefilter.getTime());
const [recentlyUsedRanges, setRecentlyUsedRanges] = useState(getRecentlyUsedRanges());
Expand All @@ -71,34 +73,35 @@ export const DatePickerWrapper: FC = () => {
const subscriptions = new Subscription();
const refreshIntervalUpdate$ = timefilter.getRefreshIntervalUpdate$();
if (refreshIntervalUpdate$ !== undefined) {
subscriptions.add(refreshIntervalUpdate$.subscribe(timefilterUpdateListener));
subscriptions.add(
refreshIntervalUpdate$.subscribe((r) => {
setRefreshInterval(timefilter.getRefreshInterval());
})
);
}
const timeUpdate$ = timefilter.getTimeUpdate$();
if (timeUpdate$ !== undefined) {
subscriptions.add(timeUpdate$.subscribe(timefilterUpdateListener));
subscriptions.add(
timeUpdate$.subscribe((v) => {
setTime(timefilter.getTime());
})
);
}
const enabledUpdated$ = timefilter.getEnabledUpdated$();
if (enabledUpdated$ !== undefined) {
subscriptions.add(enabledUpdated$.subscribe(timefilterUpdateListener));
subscriptions.add(
enabledUpdated$.subscribe((w) => {
setIsAutoRefreshSelectorEnabled(timefilter.isAutoRefreshSelectorEnabled());
setIsTimeRangeSelectorEnabled(timefilter.isTimeRangeSelectorEnabled());
})
);
}

return function cleanup() {
subscriptions.unsubscribe();
};
}, []);

useEffect(() => {
// Force re-render with up-to-date values when isTimeRangeSelectorEnabled/isAutoRefreshSelectorEnabled are changed.
timefilterUpdateListener();
}, [isTimeRangeSelectorEnabled, isAutoRefreshSelectorEnabled]);

function timefilterUpdateListener() {
setTime(timefilter.getTime());
setRefreshInterval(timefilter.getRefreshInterval());
setIsAutoRefreshSelectorEnabled(timefilter.isAutoRefreshSelectorEnabled());
setIsTimeRangeSelectorEnabled(timefilter.isTimeRangeSelectorEnabled());
}

function updateFilter({ start, end }: Duration) {
const newTime = { from: start, to: end };
// Update timefilter for controllers listening for changes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ export class ForecastsTableUI extends Component {
},
refreshInterval: {
display: 'Off',
pause: false,
pause: true,
value: 0,
},
jobIds: [this.props.job.job_id],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ export const TimeSeriesExplorerUrlStateManager: FC<TimeSeriesExplorerUrlStateMan

const refresh = useRefresh();
useEffect(() => {
if (refresh !== undefined) {
if (refresh !== undefined && refresh.lastRefresh !== lastRefresh) {
setLastRefresh(refresh?.lastRefresh);

if (refresh.timeRange !== undefined) {
Expand All @@ -109,7 +109,7 @@ export const TimeSeriesExplorerUrlStateManager: FC<TimeSeriesExplorerUrlStateMan
});
}
}
}, [refresh?.lastRefresh]);
}, [refresh?.lastRefresh, lastRefresh, setGlobalState]);

// We cannot simply infer bounds from the globalState's `time` attribute
// with `moment` since it can contain custom strings such as `now-15m`.
Expand Down Expand Up @@ -147,18 +147,6 @@ export const TimeSeriesExplorerUrlStateManager: FC<TimeSeriesExplorerUrlStateMan
const previousSelectedJobIds = usePrevious(selectedJobIds);
const isJobChange = !isEqual(previousSelectedJobIds, selectedJobIds);

// Use a side effect to clear appState when changing jobs.
useEffect(() => {
if (selectedJobIds !== undefined && previousSelectedJobIds !== undefined) {
setLastRefresh(Date.now());
appStateHandler(APP_STATE_ACTION.CLEAR);
}
const validatedJobId = validateJobSelection(jobsWithTimeRange, selectedJobIds, setGlobalState);
if (typeof validatedJobId === 'string') {
setSelectedJobId(validatedJobId);
}
}, [JSON.stringify(selectedJobIds)]);

// Next we get globalState and appState information to pass it on as props later.
// If a job change is going on, we fall back to defaults (as if appState was already cleared),
// otherwise the page could break.
Expand Down Expand Up @@ -216,9 +204,21 @@ export const TimeSeriesExplorerUrlStateManager: FC<TimeSeriesExplorerUrlStateMan

setAppState('mlTimeSeriesExplorer', mlTimeSeriesExplorer);
},
[JSON.stringify([appState, globalState])]
[JSON.stringify(appState?.mlTimeSeriesExplorer), setAppState]
);

// Use a side effect to clear appState when changing jobs.
useEffect(() => {
if (selectedJobIds !== undefined && previousSelectedJobIds !== undefined) {
setLastRefresh(Date.now());
appStateHandler(APP_STATE_ACTION.CLEAR);
}
const validatedJobId = validateJobSelection(jobsWithTimeRange, selectedJobIds, setGlobalState);
if (typeof validatedJobId === 'string') {
setSelectedJobId(validatedJobId);
}
}, [JSON.stringify(selectedJobIds)]);

const boundsMinMs = bounds?.min?.valueOf();
const boundsMaxMs = bounds?.max?.valueOf();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -805,7 +805,7 @@ function createResultsUrl(jobIds, start, end, resultsPage, mode = 'absolute') {
}

path += `?_g=(ml:(jobIds:!(${idString}))`;
path += `,refreshInterval:(display:Off,pause:!f,value:0),time:(from:'${from}'`;
path += `,refreshInterval:(display:Off,pause:!t,value:0),time:(from:'${from}'`;
path += `,to:'${to}'`;
if (mode === 'invalid') {
path += `,mode:invalid`;
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/ml/public/application/util/chart_utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ export async function getExploreSeriesLink(mlUrlGenerator, series) {
jobIds: [series.jobId],
refreshInterval: {
display: 'Off',
pause: false,
pause: true,
value: 0,
},
timeRange: {
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/ml/public/application/util/url_state.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ describe('getUrlState', () => {
test('properly decode url with _g and _a', () => {
expect(
parseUrlState(
"?_a=(mlExplorerFilter:(),mlExplorerSwimlane:(viewByFieldName:action),query:(query_string:(analyze_wildcard:!t,query:'*')))&_g=(ml:(jobIds:!(dec-2)),refreshInterval:(display:Off,pause:!f,value:0),time:(from:'2019-01-01T00:03:40.000Z',mode:absolute,to:'2019-08-30T11:55:07.000Z'))&savedSearchId=571aaf70-4c88-11e8-b3d7-01146121b73d"
"?_a=(mlExplorerFilter:(),mlExplorerSwimlane:(viewByFieldName:action),query:(query_string:(analyze_wildcard:!t,query:'*')))&_g=(ml:(jobIds:!(dec-2)),refreshInterval:(display:Off,pause:!t,value:0),time:(from:'2019-01-01T00:03:40.000Z',mode:absolute,to:'2019-08-30T11:55:07.000Z'))&savedSearchId=571aaf70-4c88-11e8-b3d7-01146121b73d"
)
).toEqual({
_a: {
Expand All @@ -45,7 +45,7 @@ describe('getUrlState', () => {
},
refreshInterval: {
display: 'Off',
pause: false,
pause: true,
value: 0,
},
time: {
Expand Down