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

fix(ui): skip history.push on initial page load. Fixes #13940 #13995

Merged
merged 1 commit into from
Dec 13, 2024
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
29 changes: 16 additions & 13 deletions ui/src/cron-workflows/cron-workflow-details.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import {NotificationType} from 'argo-ui/src/components/notifications/notificatio
import {Page} from 'argo-ui/src/components/page/page';
import {SlidingPanel} from 'argo-ui/src/components/sliding-panel/sliding-panel';
import * as React from 'react';
import {useContext, useEffect, useState} from 'react';
import {useContext, useEffect, useRef, useState} from 'react';
import {RouteComponentProps} from 'react-router';

import {uiUrl} from '../shared/base';
Expand All @@ -29,6 +29,7 @@ export function CronWorkflowDetails({match, location, history}: RouteComponentPr
const {navigation, notifications, popup} = useContext(Context);
const queryParams = new URLSearchParams(location.search);

const isFirstRender = useRef(true);
const [namespace] = useState(match.params.namespace);
const [name] = useState(match.params.name);
const [sidePanel, setSidePanel] = useState(queryParams.get('sidePanel'));
Expand All @@ -47,18 +48,20 @@ export function CronWorkflowDetails({match, location, history}: RouteComponentPr
[history]
);

useEffect(
() =>
history.push(
historyUrl('cron-workflows/{namespace}/{name}', {
namespace,
name,
sidePanel,
tab
})
),
[namespace, name, sidePanel, tab]
);
useEffect(() => {
if (isFirstRender.current) {
isFirstRender.current = false;
return;
}
history.push(
historyUrl('cron-workflows/{namespace}/{name}', {
namespace,
name,
sidePanel,
tab
})
);
}, [namespace, name, sidePanel, tab]);

useEffect(() => {
services.cronWorkflows
Expand Down
25 changes: 14 additions & 11 deletions ui/src/cron-workflows/cron-workflow-list.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {Page} from 'argo-ui/src/components/page/page';
import {SlidingPanel} from 'argo-ui/src/components/sliding-panel/sliding-panel';
import * as React from 'react';
import {useContext, useEffect, useState} from 'react';
import {useContext, useEffect, useRef, useState} from 'react';
import {RouteComponentProps} from 'react-router-dom';

import {uiUrl} from '../shared/base';
Expand Down Expand Up @@ -33,6 +33,7 @@ export function CronWorkflowList({match, location, history}: RouteComponentProps
const {navigation} = useContext(Context);

// state for URL, query, and label parameters
const isFirstRender = useRef(true);
const [namespace, setNamespace] = useState<string>(nsUtils.getNamespace(match.params.namespace) || '');
const [sidePanel, setSidePanel] = useState(queryParams.get('sidePanel') === 'true');
const [labels, setLabels] = useState<string[]>([]);
Expand All @@ -49,16 +50,18 @@ export function CronWorkflowList({match, location, history}: RouteComponentProps
);

// save history
useEffect(
() =>
history.push(
historyUrl('cron-workflows' + (nsUtils.getManagedNamespace() ? '' : '/{namespace}'), {
namespace,
sidePanel
})
),
[namespace, sidePanel]
);
useEffect(() => {
if (isFirstRender.current) {
isFirstRender.current = false;
return;
}
history.push(
historyUrl('cron-workflows' + (nsUtils.getManagedNamespace() ? '' : '/{namespace}'), {
namespace,
sidePanel
})
);
}, [namespace, sidePanel]);

// internal state
const [error, setError] = useState<Error>();
Expand Down
33 changes: 18 additions & 15 deletions ui/src/event-flow/event-flow-page.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {Page} from 'argo-ui/src/components/page/page';
import {SlidingPanel} from 'argo-ui/src/components/sliding-panel/sliding-panel';
import {Tabs} from 'argo-ui/src/components/tabs/tabs';
import {useContext, useEffect, useState} from 'react';
import {useContext, useEffect, useRef, useState} from 'react';
import * as React from 'react';
import {RouteComponentProps} from 'react-router-dom';
import {Observable} from 'rxjs';
Expand Down Expand Up @@ -43,6 +43,7 @@ export function EventFlowPage({history, location, match}: RouteComponentProps<an
const queryParams = new URLSearchParams(location.search);

// state for URL and query parameters
const isFirstRender = useRef(true);
const [namespace, setNamespace] = useState(nsUtils.getNamespace(match.params.namespace) || '');
const [showFlow, setShowFlow] = useState(queryParams.get('showFlow') === 'true');
const [showWorkflows, setShowWorkflows] = useState(queryParams.get('showWorkflows') !== 'false');
Expand All @@ -61,20 +62,22 @@ export function EventFlowPage({history, location, match}: RouteComponentProps<an
[history]
);

useEffect(
() =>
history.push(
historyUrl('event-flow' + (nsUtils.getManagedNamespace() ? '' : '/{namespace}'), {
namespace,
showFlow,
showWorkflows,
expanded,
selectedNode,
tab
})
),
[namespace, showFlow, showWorkflows, expanded, expanded, tab]
);
useEffect(() => {
if (isFirstRender.current) {
isFirstRender.current = false;
return;
}
history.push(
historyUrl('event-flow' + (nsUtils.getManagedNamespace() ? '' : '/{namespace}'), {
namespace,
showFlow,
showWorkflows,
expanded,
selectedNode,
tab
})
);
}, [namespace, showFlow, showWorkflows, expanded, expanded, tab]);

// internal state
const [error, setError] = useState<Error>();
Expand Down
29 changes: 16 additions & 13 deletions ui/src/event-sources/event-source-details.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import {Page} from 'argo-ui/src/components/page/page';
import {SlidingPanel} from 'argo-ui/src/components/sliding-panel/sliding-panel';
import {Tabs} from 'argo-ui/src/components/tabs/tabs';
import * as React from 'react';
import {useContext, useEffect, useState} from 'react';
import {useContext, useEffect, useRef, useState} from 'react';
import {RouteComponentProps} from 'react-router';

import {ID} from '../event-flow/id';
Expand All @@ -27,6 +27,7 @@ export function EventSourceDetails({history, location, match}: RouteComponentPro
const queryParams = new URLSearchParams(location.search);

// state for URL and query parameters
const isFirstRender = useRef(true);
const namespace = match.params.namespace;
const name = match.params.name;
const [tab, setTab] = useState<string>(queryParams.get('tab'));
Expand All @@ -40,18 +41,20 @@ export function EventSourceDetails({history, location, match}: RouteComponentPro
[history]
);

useEffect(
() =>
history.push(
historyUrl('event-sources/{namespace}/{name}', {
namespace,
name,
tab,
selectedNode
})
),
[namespace, name, tab, selectedNode]
);
useEffect(() => {
if (isFirstRender.current) {
isFirstRender.current = false;
return;
}
history.push(
historyUrl('event-sources/{namespace}/{name}', {
namespace,
name,
tab,
selectedNode
})
);
}, [namespace, name, tab, selectedNode]);

const [error, setError] = useState<Error>();
const {object: eventSource, setObject: setEventSource, resetObject: resetEventSource, serialization, edited, lang, setLang} = useEditableObject<EventSource>();
Expand Down
29 changes: 16 additions & 13 deletions ui/src/event-sources/event-source-list.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import {SlidingPanel} from 'argo-ui/src/components/sliding-panel/sliding-panel';
import {Tabs} from 'argo-ui/src/components/tabs/tabs';
import classNames from 'classnames';
import * as React from 'react';
import {useContext, useEffect, useState} from 'react';
import {useContext, useEffect, useRef, useState} from 'react';
import {Link, RouteComponentProps} from 'react-router-dom';

import {ID} from '../event-flow/id';
Expand Down Expand Up @@ -36,6 +36,7 @@ export function EventSourceList({match, location, history}: RouteComponentProps<
const {navigation} = useContext(Context);

// state for URL and query parameters
const isFirstRender = useRef(true);
const [namespace, setNamespace] = useState(nsUtils.getNamespace(match.params.namespace) || '');
const [sidePanel, setSidePanel] = useState(queryParams.get('sidePanel') === 'true');
const [selectedNode, setSelectedNode] = useState<Node>(queryParams.get('selectedNode'));
Expand All @@ -50,18 +51,20 @@ export function EventSourceList({match, location, history}: RouteComponentProps<
[history]
);

useEffect(
() =>
history.push(
historyUrl('event-sources' + (nsUtils.getManagedNamespace() ? '' : '/{namespace}'), {
namespace,
sidePanel,
selectedNode,
tab
})
),
[namespace, sidePanel, selectedNode, tab]
);
useEffect(() => {
if (isFirstRender.current) {
isFirstRender.current = false;
return;
}
history.push(
historyUrl('event-sources' + (nsUtils.getManagedNamespace() ? '' : '/{namespace}'), {
namespace,
sidePanel,
selectedNode,
tab
})
);
}, [namespace, sidePanel, selectedNode, tab]);

// internal state
const [error, setError] = useState<Error>();
Expand Down
23 changes: 13 additions & 10 deletions ui/src/plugins/plugin-list.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {Page} from 'argo-ui/src/components/page/page';
import * as React from 'react';
import {useEffect, useState} from 'react';
import {useEffect, useRef, useState} from 'react';
import {RouteComponentProps} from 'react-router-dom';

import {uiUrl} from '../shared/base';
Expand All @@ -11,16 +11,19 @@ import {useCollectEvent} from '../shared/use-collect-event';

export function PluginList({match, history}: RouteComponentProps<any>) {
// state for URL and query parameters
const isFirstRender = useRef(true);
const [namespace] = useState(nsUtils.getNamespace(match.params.namespace) || '');
useEffect(
() =>
history.push(
historyUrl('plugins' + (nsUtils.getManagedNamespace() ? '' : '/{namespace}'), {
namespace
})
),
[namespace]
);
useEffect(() => {
if (isFirstRender.current) {
isFirstRender.current = false;
return;
}
history.push(
historyUrl('plugins' + (nsUtils.getManagedNamespace() ? '' : '/{namespace}'), {
namespace
})
);
}, [namespace]);
useCollectEvent('openedPlugins');

return (
Expand Down
7 changes: 6 additions & 1 deletion ui/src/reports/reports.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {ChartOptions} from 'chart.js';
import 'chartjs-plugin-annotation';

import * as React from 'react';
import {useContext, useEffect, useState} from 'react';
import {useContext, useEffect, useRef, useState} from 'react';
import {Bar, ChartData} from 'react-chartjs-2';
import {RouteComponentProps} from 'react-router-dom';

Expand Down Expand Up @@ -33,6 +33,7 @@ export function Reports({match, location, history}: RouteComponentProps<any>) {
const {navigation} = useContext(Context);

// state for URL, query, and label parameters
const isFirstRender = useRef(true);
const [namespace, setNamespace] = useState<string>(nsUtils.getNamespace(match.params.namespace) || '');
const [labels, setLabels] = useState((queryParams.get('labels') || '').split(',').filter(v => v !== ''));
// internal state
Expand All @@ -41,6 +42,10 @@ export function Reports({match, location, history}: RouteComponentProps<any>) {

// save history
useEffect(() => {
if (isFirstRender.current) {
isFirstRender.current = false;
return;
}
history.push(historyUrl('reports' + (nsUtils.getManagedNamespace() ? '' : '/{namespace}'), {namespace, labels: labels.join(',')}));
}, [namespace, labels]);

Expand Down
29 changes: 16 additions & 13 deletions ui/src/sensors/sensor-details.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {NotificationType} from 'argo-ui/src/components/notifications/notifications';
import {Page} from 'argo-ui/src/components/page/page';
import * as React from 'react';
import {useContext, useEffect, useState} from 'react';
import {useContext, useEffect, useRef, useState} from 'react';
import {RouteComponentProps} from 'react-router';

import {ID} from '../event-flow/id';
Expand All @@ -23,6 +23,7 @@ import '../workflows/components/workflow-details/workflow-details.scss';

export function SensorDetails({match, location, history}: RouteComponentProps<any>) {
// boiler-plate
const isFirstRender = useRef(true);
const {navigation, notifications, popup} = useContext(Context);
const queryParams = new URLSearchParams(location.search);

Expand All @@ -42,18 +43,20 @@ export function SensorDetails({match, location, history}: RouteComponentProps<an
[history]
);

useEffect(
() =>
history.push(
historyUrl('sensors/{namespace}/{name}', {
namespace,
name,
tab,
selectedLogNode
})
),
[namespace, name, tab, selectedLogNode]
);
useEffect(() => {
if (isFirstRender.current) {
isFirstRender.current = false;
return;
}
history.push(
historyUrl('sensors/{namespace}/{name}', {
namespace,
name,
tab,
selectedLogNode
})
);
}, [namespace, name, tab, selectedLogNode]);

useEffect(() => {
services.sensor
Expand Down
Loading