1081664682

Committed 22 Nov 2023 02:11PM UTC coverage: 82.798% (-17.2%) from 99.964%

Build # 1081664682

Build Type

Pull #4214

gitlab-ci

Committed by

tranchitella

Commit Message

fix: Fixed the infinite page redirects when the back button is pressed

Remove the location and navigate from the useLocationParams.setValue callback
dependencies as they change the set function that is presented in other
useEffect dependencies. This happens when the back button is clicked, which
leads to the location changing infinitely.

Changelog: Title
Ticket: MEN-6847
Ticket: MEN-6796

Signed-off-by: Ihor Aleksandrychiev <ihor.aleksandrychiev@northern.tech>
Signed-off-by: Fabio Tranchitella <fabio.tranchitella@northern.tech>

Pull Request Pull Request #4214: fix: Fixed the infinite page redirects when the back button is pressed

Run Details

4319 of 6292 branches covered (0.0%)

8332 of 10063 relevant lines covered (82.8%)

191.0 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

91.43

/src/js/components/dashboard/deployments.js

// Copyright 2015 Northern.tech AS
//
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.
import React, { useCallback, useEffect, useRef, useState } from 'react';
import { useDispatch, useSelector } from 'react-redux';
import { Link } from 'react-router-dom';

import { setSnackbar } from '../../actions/appActions';
import { getDeploymentsByStatus } from '../../actions/deploymentActions';
import { DEPLOYMENT_ROUTES, DEPLOYMENT_STATES, deploymentDisplayStates } from '../../constants/deploymentConstants';
import { onboardingSteps } from '../../constants/onboardingConstants';
import { DEPLOYMENT_CUTOFF, getDevicesById, getIdAttribute, getOnboardingState, getRecentDeployments, getUserCapabilities } from '../../selectors';
import { getOnboardingComponentFor } from '../../utils/onboardingmanager';
import useWindowSize from '../../utils/resizehook';
import { clearAllRetryTimers, setRetryTimer } from '../../utils/retrytimer';
import Loader from '../common/loader';
import { BaseDeploymentsWidget, CompletedDeployments } from './widgets/deployments';
import RedirectionWidget from './widgets/redirectionwidget';

const refreshDeploymentsLength = 30000;

// we need to exclude the scheduled state here as the os version is not able to process these and would prevent the dashboard from loading
const stateMap = {
  [DEPLOYMENT_STATES.pending]: BaseDeploymentsWidget,
  [DEPLOYMENT_STATES.inprogress]: BaseDeploymentsWidget,
  [DEPLOYMENT_STATES.finished]: CompletedDeployments
};

export const Deployments = ({ className = '', clickHandle }) => {
  const dispatch = useDispatch();
  const setSnackbarDispatched = useCallback(message => dispatch(setSnackbar(message)), [dispatch]);
  const { canDeploy } = useSelector(getUserCapabilities);
  const { total: deploymentsCount, ...deployments } = useSelector(getRecentDeployments);
  const onboardingState = useSelector(getOnboardingState);
  const devicesById = useSelector(getDevicesById);
  const idAttribute = useSelector(getIdAttribute);
  const [loading, setLoading] = useState(!deploymentsCount);
  // eslint-disable-next-line no-unused-vars
  const size = useWindowSize();
  const deploymentsRef = useRef();
  const timer = useRef();

  const getDeployments = useCallback(
    () =>
      Promise.all(Object.keys(stateMap).map(status => dispatch(getDeploymentsByStatus(status, 1, DEPLOYMENT_CUTOFF))))
        .catch(err => setRetryTimer(err, 'deployments', `Couldn't load deployments.`, refreshDeploymentsLength, setSnackbarDispatched))
        .finally(() => setLoading(false)),
    [dispatch, setSnackbarDispatched]
  );

  useEffect(() => {
    clearAllRetryTimers(setSnackbarDispatched);
    clearInterval(timer.current);
    timer.current = setInterval(getDeployments, refreshDeploymentsLength);
    getDeployments();
    return () => {
      clearInterval(timer.current);
      clearAllRetryTimers(setSnackbarDispatched);
    };
  }, [getDeployments, setSnackbarDispatched]);

  let onboardingComponent;
  if (deploymentsRef.current) {
    const anchor = {
      top: deploymentsRef.current.offsetTop + deploymentsRef.current.offsetHeight,
      left: deploymentsRef.current.offsetLeft + deploymentsRef.current.offsetWidth / 2
    };
    onboardingComponent = getOnboardingComponentFor(onboardingSteps.DEPLOYMENTS_PAST_COMPLETED, onboardingState, { anchor });
  }
  return (
    <div className={`${className} deployments`}>
      {loading ? (
        <Loader show={loading} fade={true} />
      ) : (
        <div className="dashboard flexbox column" ref={deploymentsRef} style={{ gridTemplateColumns: '1fr', rowGap: 10 }}>
          <h4 className={`${deploymentsCount ? 'margin-bottom-none' : 'margin-top-none'} margin-left-small`}>
            {deploymentsCount ? 'Recent deployments' : 'Deployments'}
          </h4>
          {deploymentsCount ? (
            <>
              {Object.entries(stateMap).reduce((accu, [key, Component]) => {
                if (!deployments[key]) {
                  return accu;
                }
                accu.push(
                  <React.Fragment key={key}>
                    <h5 className="margin-bottom-none">{deploymentDisplayStates[key]}</h5>
                    <Component deployments={deployments[key]} devicesById={devicesById} idAttribute={idAttribute} state={key} onClick={clickHandle} />
                  </React.Fragment>
                );
                return accu;
              }, [])}
              <Link className="margin-top" to="/deployments">
                See all deployments
              </Link>
            </>
          ) : (
            canDeploy && (
              <RedirectionWidget
                content="Create a new deployment to update a group of devices"
                onClick={() => clickHandle({ route: `${DEPLOYMENT_ROUTES.active.route}?open=true` })}
              />
            )
          )}
        </div>
      )}
      {onboardingComponent}
    </div>
  );
};

export default Deployments;

1	// Copyright 2015 Northern.tech AS
2	//
3	// Licensed under the Apache License, Version 2.0 (the "License");
4	// you may not use this file except in compliance with the License.
5	// You may obtain a copy of the License at
6	//
7	// http://www.apache.org/licenses/LICENSE-2.0
8	//
9	// Unless required by applicable law or agreed to in writing, software
10	// distributed under the License is distributed on an "AS IS" BASIS,
11	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12	// See the License for the specific language governing permissions and
13	// limitations under the License.
14	import React, { useCallback, useEffect, useRef, useState } from 'react';
15	import { useDispatch, useSelector } from 'react-redux';
16	import { Link } from 'react-router-dom';
17
18	import { setSnackbar } from '../../actions/appActions';
19	import { getDeploymentsByStatus } from '../../actions/deploymentActions';
20	import { DEPLOYMENT_ROUTES, DEPLOYMENT_STATES, deploymentDisplayStates } from '../../constants/deploymentConstants';
21	import { onboardingSteps } from '../../constants/onboardingConstants';
22	import { DEPLOYMENT_CUTOFF, getDevicesById, getIdAttribute, getOnboardingState, getRecentDeployments, getUserCapabilities } from '../../selectors';
23	import { getOnboardingComponentFor } from '../../utils/onboardingmanager';
24	import useWindowSize from '../../utils/resizehook';
25	import { clearAllRetryTimers, setRetryTimer } from '../../utils/retrytimer';
26	import Loader from '../common/loader';
27	import { BaseDeploymentsWidget, CompletedDeployments } from './widgets/deployments';
28	import RedirectionWidget from './widgets/redirectionwidget';
29
30	const refreshDeploymentsLength = 30000;	4✔
31
32	// we need to exclude the scheduled state here as the os version is not able to process these and would prevent the dashboard from loading
33	const stateMap = {	4✔
34	[DEPLOYMENT_STATES.pending]: BaseDeploymentsWidget,
35	[DEPLOYMENT_STATES.inprogress]: BaseDeploymentsWidget,
36	[DEPLOYMENT_STATES.finished]: CompletedDeployments
37	};
38
39	export const Deployments = ({ className = '', clickHandle }) => {	4✔
40	const dispatch = useDispatch();	418✔
41	const setSnackbarDispatched = useCallback(message => dispatch(setSnackbar(message)), [dispatch]);	418✔
42	const { canDeploy } = useSelector(getUserCapabilities);	418✔
43	const { total: deploymentsCount, ...deployments } = useSelector(getRecentDeployments);	418✔
44	const onboardingState = useSelector(getOnboardingState);	418✔
45	const devicesById = useSelector(getDevicesById);	418✔
46	const idAttribute = useSelector(getIdAttribute);	418✔
47	const [loading, setLoading] = useState(!deploymentsCount);	418✔
48	// eslint-disable-next-line no-unused-vars
49	const size = useWindowSize();	418✔
50	const deploymentsRef = useRef();	418✔
51	const timer = useRef();	418✔
52
53	const getDeployments = useCallback(	418✔
54	() =>
55	Promise.all(Object.keys(stateMap).map(status => dispatch(getDeploymentsByStatus(status, 1, DEPLOYMENT_CUTOFF))))	207✔
56	.catch(err => setRetryTimer(err, 'deployments', `Couldn't load deployments.`, refreshDeploymentsLength, setSnackbarDispatched))	×
57	.finally(() => setLoading(false)),	68✔
58	[dispatch, setSnackbarDispatched]
59	);
60
61	useEffect(() => {	418✔
62	clearAllRetryTimers(setSnackbarDispatched);	7✔
63	clearInterval(timer.current);	7✔
64	timer.current = setInterval(getDeployments, refreshDeploymentsLength);	7✔
65	getDeployments();	7✔
66	return () => {	7✔
67	clearInterval(timer.current);	7✔
68	clearAllRetryTimers(setSnackbarDispatched);	7✔
69	};
70	}, [getDeployments, setSnackbarDispatched]);
71
72	let onboardingComponent;
73	if (deploymentsRef.current) {	418✔
74	const anchor = {	411✔
75	top: deploymentsRef.current.offsetTop + deploymentsRef.current.offsetHeight,
76	left: deploymentsRef.current.offsetLeft + deploymentsRef.current.offsetWidth / 2
77	};
78	onboardingComponent = getOnboardingComponentFor(onboardingSteps.DEPLOYMENTS_PAST_COMPLETED, onboardingState, { anchor });	411✔
79	}
80	return (	418✔
81	<div className={`${className} deployments`}>
82	{loading ? (	418!
83	<Loader show={loading} fade={true} />
84	) : (
85	<div className="dashboard flexbox column" ref={deploymentsRef} style={{ gridTemplateColumns: '1fr', rowGap: 10 }}>
86	<h4 className={`${deploymentsCount ? 'margin-bottom-none' : 'margin-top-none'} margin-left-small`}>	418!
87	{deploymentsCount ? 'Recent deployments' : 'Deployments'}	418!
88	</h4>
89	{deploymentsCount ? (	418!
90	<>
91	{Object.entries(stateMap).reduce((accu, [key, Component]) => {
92	if (!deployments[key]) {	1,254!
93	return accu;	×
94	}
95	accu.push(	1,254✔
96	<React.Fragment key={key}>
97	<h5 className="margin-bottom-none">{deploymentDisplayStates[key]}</h5>
98	<Component deployments={deployments[key]} devicesById={devicesById} idAttribute={idAttribute} state={key} onClick={clickHandle} />
99	</React.Fragment>
100	);
101	return accu;	1,254✔
102	}, [])}
103	<Link className="margin-top" to="/deployments">
104	See all deployments
105	</Link>
106	</>
107	) : (
108	canDeploy && (	×
109	<RedirectionWidget
110	content="Create a new deployment to update a group of devices"
111	onClick={() => clickHandle({ route: `${DEPLOYMENT_ROUTES.active.route}?open=true` })}	×
112	/>
113	)
114	)}
115	</div>
116	)}
117	{onboardingComponent}
118	</div>
119	);
120	};
121
122	export default Deployments;

mendersoftware / gui / 1081664682

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous