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

87.88

/src/js/components/deployments/deployment-report/rolloutschedule.js

// Copyright 2021 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 from 'react';

import { ArrowForward } from '@mui/icons-material';
import { Chip } from '@mui/material';
import { makeStyles } from 'tss-react/mui';

import moment from 'moment';
import momentDurationFormatSetup from 'moment-duration-format';
import pluralize from 'pluralize';

import { DEPLOYMENT_STATES } from '../../../constants/deploymentConstants';
import { formatTime, getPhaseDeviceCount, getRemainderPercent } from '../../../helpers';
import { TwoColumnData } from '../../common/configurationobject';
import LinedHeader from '../../common/lined-header';
import Time from '../../common/time';
import { getPhaseStartTime } from '../createdeployment';
import { ProgressChartComponent, getDeploymentPhasesInfo, getDisplayablePhases } from '../progressChart';
import { defaultColumnDataProps } from '../report';
import PhaseProgress from './phaseprogress';

const useStyles = makeStyles()(theme => ({
  currentPhaseInfo: { backgroundColor: theme.palette.grey[400] },
  phaseInfo: { maxWidth: maxPhaseWidth, borderRadius: 5, paddingTop: theme.spacing(), paddingBottom: theme.spacing(3) },
  phaseIndex: { alignSelf: 'flex-start', margin: theme.spacing(2), marginLeft: theme.spacing(2.5) },
  phasesOverviewArrow: { marginLeft: theme.spacing(4), marginRight: theme.spacing(4) }
}));

momentDurationFormatSetup(moment);

const maxPhaseWidth = 270;

const PhaseLabel = ({ index }) => <div className="capitalized progress-step-number muted">Phase {index + 1}</div>;

export const RolloutSchedule = ({ deployment, headerClass, innerRef, onAbort, onUpdateControlChange }) => {
  const { classes } = useStyles();
  const now = moment();
  const { created: creationTime = now.toISOString(), filter, finished, status, update_control_map } = deployment;

  const { phases, reversedPhases, totalDeviceCount, ...remainder } = getDeploymentPhasesInfo(deployment);

  const start_time = phases[0].start_ts || creationTime;
  const currentPhase = reversedPhases.find(phase => now.isAfter(phase.start_ts)) || phases[0];
  const currentPhaseIndex = phases.findIndex(phase => phase.id === currentPhase.id);
  const currentPhaseStartTime = getPhaseStartTime(phases, currentPhaseIndex, start_time);
  let currentPhaseTime = 'N/A';
  if (now.isSameOrAfter(currentPhaseStartTime)) {
    currentPhaseTime = currentPhaseIndex + 1;
  }
  const endTime = finished ? <Time value={formatTime(finished)} /> : filter ? 'N/A' : '-';

  const displayablePhases = getDisplayablePhases({ currentPhase, phases, totalDeviceCount, ...remainder });
  return (
    <>
      <LinedHeader className={`margin-top-large ${headerClass}`} heading="Schedule details" innerRef={innerRef} />
      {phases.length > 1 || !update_control_map ? (
        <>
          <div className="flexbox">
            <TwoColumnData
              {...defaultColumnDataProps}
              config={{
                'Start time': <Time value={formatTime(start_time)} />,
                'Current phase': currentPhaseTime
              }}
            />
            <ArrowForward className={classes.phasesOverviewArrow} />
            <TwoColumnData {...defaultColumnDataProps} config={{ 'End time': endTime }} />
          </div>
          <ProgressChartComponent className="margin-top no-background" phases={displayablePhases} PhaseLabel={PhaseLabel} />
        </>
      ) : (
        <PhaseProgress deployment={deployment} onAbort={onAbort} onUpdateControlChange={onUpdateControlChange} />
      )}
      <div className="deployment-phases-report margin-top margin-bottom" style={{ gridTemplateColumns: `repeat(auto-fit, ${maxPhaseWidth}px)` }}>
        {phases.map((phase, index) => {
          phase.batch_size = phase.batch_size || getRemainderPercent(phases);
          const deviceCount = getPhaseDeviceCount(totalDeviceCount, phase.batch_size, phase.batch_size, index === phases.length - 1);
          const deviceCountText = !filter ? ` (${deviceCount} ${pluralize('device', deviceCount)})` : '';
          const startTime = phase.start_ts ?? getPhaseStartTime(phases, index, start_time);
          const phaseObject = {
            'Phase start time': <Time value={startTime} />,
            'Batch size': <div className="muted">{`${phase.batch_size}%${deviceCountText}`}</div>
          };
          let phaseTitle = status !== DEPLOYMENT_STATES.scheduled ? <div className="muted">Complete</div> : null;
          let isCurrentPhase = false;
          if (now.isBefore(startTime)) {
            const duration = moment.duration(moment(startTime).diff(now));
            phaseTitle = <div>{`Begins in ${duration.format('d [days] hh [h] mm [m]')}`}</div>;
          } else if (status === DEPLOYMENT_STATES.inprogress && phase.id === currentPhase.id) {
            phaseTitle = <div className="muted">Current phase</div>;
            isCurrentPhase = true;
          }
          return (
            <div className={`flexbox column centered ${classes.phaseInfo} ${isCurrentPhase ? classes.currentPhaseInfo : ''}`} key={startTime}>
              {phaseTitle}
              <Chip className={classes.phaseIndex} size="small" label={`Phase ${index + 1}`} />
              <TwoColumnData {...defaultColumnDataProps} style={{ ...defaultColumnDataProps.style, alignSelf: 'initial' }} config={phaseObject} />
            </div>
          );
        })}
      </div>
    </>
  );
};

export default RolloutSchedule;

1	// Copyright 2021 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 from 'react';
15
16	import { ArrowForward } from '@mui/icons-material';
17	import { Chip } from '@mui/material';
18	import { makeStyles } from 'tss-react/mui';
19
20	import moment from 'moment';
21	import momentDurationFormatSetup from 'moment-duration-format';
22	import pluralize from 'pluralize';
23
24	import { DEPLOYMENT_STATES } from '../../../constants/deploymentConstants';
25	import { formatTime, getPhaseDeviceCount, getRemainderPercent } from '../../../helpers';
26	import { TwoColumnData } from '../../common/configurationobject';
27	import LinedHeader from '../../common/lined-header';
28	import Time from '../../common/time';
29	import { getPhaseStartTime } from '../createdeployment';
30	import { ProgressChartComponent, getDeploymentPhasesInfo, getDisplayablePhases } from '../progressChart';
31	import { defaultColumnDataProps } from '../report';
32	import PhaseProgress from './phaseprogress';
33
34	const useStyles = makeStyles()(theme => ({	10✔
35	currentPhaseInfo: { backgroundColor: theme.palette.grey[400] },
36	phaseInfo: { maxWidth: maxPhaseWidth, borderRadius: 5, paddingTop: theme.spacing(), paddingBottom: theme.spacing(3) },
37	phaseIndex: { alignSelf: 'flex-start', margin: theme.spacing(2), marginLeft: theme.spacing(2.5) },
38	phasesOverviewArrow: { marginLeft: theme.spacing(4), marginRight: theme.spacing(4) }
39	}));
40
41	momentDurationFormatSetup(moment);	10✔
42
43	const maxPhaseWidth = 270;	10✔
44
45	const PhaseLabel = ({ index }) => <div className="capitalized progress-step-number muted">Phase {index + 1}</div>;	10✔
46
47	export const RolloutSchedule = ({ deployment, headerClass, innerRef, onAbort, onUpdateControlChange }) => {	10✔
48	const { classes } = useStyles();	8✔
49	const now = moment();	8✔
50	const { created: creationTime = now.toISOString(), filter, finished, status, update_control_map } = deployment;	8!
51
52	const { phases, reversedPhases, totalDeviceCount, ...remainder } = getDeploymentPhasesInfo(deployment);	8✔
53
54	const start_time = phases[0].start_ts \|\| creationTime;	8!
55	const currentPhase = reversedPhases.find(phase => now.isAfter(phase.start_ts)) \|\| phases[0];	8!
56	const currentPhaseIndex = phases.findIndex(phase => phase.id === currentPhase.id);	8✔
57	const currentPhaseStartTime = getPhaseStartTime(phases, currentPhaseIndex, start_time);	8✔
58	let currentPhaseTime = 'N/A';	8✔
59	if (now.isSameOrAfter(currentPhaseStartTime)) {	8!
60	currentPhaseTime = currentPhaseIndex + 1;	8✔
61	}
62	const endTime = finished ? <Time value={formatTime(finished)} /> : filter ? 'N/A' : '-';	8!
63
64	const displayablePhases = getDisplayablePhases({ currentPhase, phases, totalDeviceCount, ...remainder });	8✔
65	return (	8✔
66	<>
67	<LinedHeader className={`margin-top-large ${headerClass}`} heading="Schedule details" innerRef={innerRef} />
68	{phases.length > 1 \|\| !update_control_map ? (	24!
69	<>
70	<div className="flexbox">
71	<TwoColumnData
72	{...defaultColumnDataProps}
73	config={{
74	'Start time': <Time value={formatTime(start_time)} />,
75	'Current phase': currentPhaseTime
76	}}
77	/>
78	<ArrowForward className={classes.phasesOverviewArrow} />
79	<TwoColumnData {...defaultColumnDataProps} config={{ 'End time': endTime }} />
80	</div>
81	<ProgressChartComponent className="margin-top no-background" phases={displayablePhases} PhaseLabel={PhaseLabel} />
82	</>
83	) : (
84	<PhaseProgress deployment={deployment} onAbort={onAbort} onUpdateControlChange={onUpdateControlChange} />
85	)}
86	<div className="deployment-phases-report margin-top margin-bottom" style={{ gridTemplateColumns: `repeat(auto-fit, ${maxPhaseWidth}px)` }}>
87	{phases.map((phase, index) => {
88	phase.batch_size = phase.batch_size \|\| getRemainderPercent(phases);	8!
89	const deviceCount = getPhaseDeviceCount(totalDeviceCount, phase.batch_size, phase.batch_size, index === phases.length - 1);	8✔
90	const deviceCountText = !filter ? ` (${deviceCount} ${pluralize('device', deviceCount)})` : '';	8!
91	const startTime = phase.start_ts ?? getPhaseStartTime(phases, index, start_time);	8!
92	const phaseObject = {	8✔
93	'Phase start time': <Time value={startTime} />,
94	'Batch size': <div className="muted">{`${phase.batch_size}%${deviceCountText}`}</div>
95	};
96	let phaseTitle = status !== DEPLOYMENT_STATES.scheduled ? <div className="muted">Complete</div> : null;	8!
97	let isCurrentPhase = false;	8✔
98	if (now.isBefore(startTime)) {	8!
99	const duration = moment.duration(moment(startTime).diff(now));	×
100	phaseTitle = <div>{`Begins in ${duration.format('d [days] hh [h] mm [m]')}`}</div>;	×
101	} else if (status === DEPLOYMENT_STATES.inprogress && phase.id === currentPhase.id) {	8!
102	phaseTitle = <div className="muted">Current phase</div>;	×
103	isCurrentPhase = true;	×
104	}
105	return (	8✔
106	<div className={`flexbox column centered ${classes.phaseInfo} ${isCurrentPhase ? classes.currentPhaseInfo : ''}`} key={startTime}>	8!
107	{phaseTitle}
108	<Chip className={classes.phaseIndex} size="small" label={`Phase ${index + 1}`} />
109	<TwoColumnData {...defaultColumnDataProps} style={{ ...defaultColumnDataProps.style, alignSelf: 'initial' }} config={phaseObject} />
110	</div>
111	);
112	})}
113	</div>
114	</>
115	);
116	};
117
118	export default RolloutSchedule;

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