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

74.07

/src/js/components/common/docslink.js

// Copyright 2023 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, { forwardRef, useState } from 'react';
import { useSelector } from 'react-redux';

import { Description as DescriptionIcon } from '@mui/icons-material';
import { Chip, Collapse, chipClasses } from '@mui/material';
import { makeStyles } from 'tss-react/mui';

import { TIMEOUTS } from '../../constants/appConstants';
import { getDocsVersion, getFeatures } from '../../selectors';
import { useDebounce } from '../../utils/debouncehook';
import { MenderTooltipClickable } from './mendertooltip';

const useStyles = makeStyles()(theme => ({
  iconAura: {
    position: 'absolute',
    top: -6,
    bottom: -4,
    left: -7,
    right: -6.5,
    border: `1px dashed ${theme.palette.text.disabled}`,
    borderRadius: '50%',
    '&.hovering': {
      borderColor: 'transparent'
    }
  },
  chip: {
    borderStyle: 'dashed',
    [`.${chipClasses.deleteIcon}`]: {
      fontSize: 'smaller'
    },
    '&.not-hovering': {
      borderColor: 'transparent',
      color: theme.palette.text.disabled,
      [`.${chipClasses.deleteIcon}`]: {
        color: theme.palette.text.disabled
      },
      [`.${chipClasses.label}`]: {
        paddingLeft: 0,
        visibility: 'collapse'
      }
    }
  }
}));

export const DOCSTIPS = {
  deviceConfig: { id: 'deviceConfig', path: 'add-ons/configure' },
  dynamicGroups: { id: 'dynamicGroups', path: 'overview/device-group#dynamic-group' },
  phasedDeployments: { id: 'phasedDeployments', path: 'overview/customize-the-update-process' },
  pausedDeployments: { id: 'pausedDeployments', path: 'overview/customize-the-update-process#synchronized-updates' },
  retryDeployments: { id: 'retryDeployments', path: 'overview/deployment' },
  releases: { id: 'releases', path: 'overview/artifact' }
};

export const DocsTooltip = ({ anchor = {}, id = '', ...props }) => {
  const [isHovering, setIsHovering] = useState(false);
  const debouncedHovering = useDebounce(isHovering, TIMEOUTS.debounceDefault);
  const docsVersion = useSelector(getDocsVersion);
  const { isHosted } = useSelector(getFeatures);
  const { classes } = useStyles();
  const { content, path } = DOCSTIPS[id] || {};
  const target = `https://docs.mender.io/${docsVersion}${path}`;

  const onClick = () => {
    const docsParams = { headers: { 'x-mender-docs': docsVersion } };
    fetch(target, isHosted ? {} : docsParams);
    window.open(target, '_blank');
  };

  const hoverClass = debouncedHovering ? 'hovering' : 'not-hovering';
  return (
    <MenderTooltipClickable
      placement="bottom-start"
      disableFocusListener={false}
      disableHoverListener={false}
      disableTouchListener={false}
      style={anchor}
      title={content}
      {...props}
    >
      <Chip
        color="primary"
        className={`${classes.chip} ${hoverClass}`}
        label={
          <Collapse in={debouncedHovering} orientation="horizontal">
            Learn more
          </Collapse>
        }
        deleteIcon={
          <div className="relative">
            <DescriptionIcon fontSize="small" />
            <div className={`${classes.iconAura} ${hoverClass}`} />
          </div>
        }
        onClick={onClick}
        onDelete={onClick}
        onMouseOver={() => setIsHovering(true)}
        onMouseOut={() => setIsHovering(false)}
        variant="outlined"
      />
    </MenderTooltipClickable>
  );
};

export const DocsLink = forwardRef(({ children, className = '', path, title = '', ...remainder }, ref) => {
  const docsVersion = useSelector(getDocsVersion);
  const { isHosted } = useSelector(getFeatures);
  const target = `https://docs.mender.io/${docsVersion}${path}`;

  const onClickHandler = () => {
    const docsParams = { headers: { 'x-mender-docs': docsVersion } };
    fetch(target, isHosted ? {} : docsParams);
  };

  return (
    // eslint-disable-next-line react/jsx-no-target-blank
    <a className={className} {...remainder} href={target} onClick={onClickHandler} ref={ref} target="_blank" rel={isHosted ? 'noopener noreferrer' : ''}>
      {children ? children : title}
    </a>
  );
});

DocsLink.displayName = 'DocsLink';

export default DocsLink;

1	// Copyright 2023 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, { forwardRef, useState } from 'react';
15	import { useSelector } from 'react-redux';
16
17	import { Description as DescriptionIcon } from '@mui/icons-material';
18	import { Chip, Collapse, chipClasses } from '@mui/material';
19	import { makeStyles } from 'tss-react/mui';
20
21	import { TIMEOUTS } from '../../constants/appConstants';
22	import { getDocsVersion, getFeatures } from '../../selectors';
23	import { useDebounce } from '../../utils/debouncehook';
24	import { MenderTooltipClickable } from './mendertooltip';
25
26	const useStyles = makeStyles()(theme => ({	183✔
27	iconAura: {
28	position: 'absolute',
29	top: -6,
30	bottom: -4,
31	left: -7,
32	right: -6.5,
33	border: `1px dashed ${theme.palette.text.disabled}`,
34	borderRadius: '50%',
35	'&.hovering': {
36	borderColor: 'transparent'
37	}
38	},
39	chip: {
40	borderStyle: 'dashed',
41	[`.${chipClasses.deleteIcon}`]: {
42	fontSize: 'smaller'
43	},
44	'&.not-hovering': {
45	borderColor: 'transparent',
46	color: theme.palette.text.disabled,
47	[`.${chipClasses.deleteIcon}`]: {
48	color: theme.palette.text.disabled
49	},
50	[`.${chipClasses.label}`]: {
51	paddingLeft: 0,
52	visibility: 'collapse'
53	}
54	}
55	}
56	}));
57
58	export const DOCSTIPS = {	183✔
59	deviceConfig: { id: 'deviceConfig', path: 'add-ons/configure' },
60	dynamicGroups: { id: 'dynamicGroups', path: 'overview/device-group#dynamic-group' },
61	phasedDeployments: { id: 'phasedDeployments', path: 'overview/customize-the-update-process' },
62	pausedDeployments: { id: 'pausedDeployments', path: 'overview/customize-the-update-process#synchronized-updates' },
63	retryDeployments: { id: 'retryDeployments', path: 'overview/deployment' },
64	releases: { id: 'releases', path: 'overview/artifact' }
65	};
66
67	export const DocsTooltip = ({ anchor = {}, id = '', ...props }) => {	183✔
68	const [isHovering, setIsHovering] = useState(false);	866✔
69	const debouncedHovering = useDebounce(isHovering, TIMEOUTS.debounceDefault);	866✔
70	const docsVersion = useSelector(getDocsVersion);	866✔
71	const { isHosted } = useSelector(getFeatures);	866✔
72	const { classes } = useStyles();	866✔
73	const { content, path } = DOCSTIPS[id] \|\| {};	866✔
74	const target = `https://docs.mender.io/${docsVersion}${path}`;	866✔
75
76	const onClick = () => {	866✔
77	const docsParams = { headers: { 'x-mender-docs': docsVersion } };	×
78	fetch(target, isHosted ? {} : docsParams);	×
79	window.open(target, '_blank');	×
80	};
81
82	const hoverClass = debouncedHovering ? 'hovering' : 'not-hovering';	866!
83	return (	866✔
84	<MenderTooltipClickable
85	placement="bottom-start"
86	disableFocusListener={false}
87	disableHoverListener={false}
88	disableTouchListener={false}
89	style={anchor}
90	title={content}
91	{...props}
92	>
93	<Chip
94	color="primary"
95	className={`${classes.chip} ${hoverClass}`}
96	label={
97	<Collapse in={debouncedHovering} orientation="horizontal">
98	Learn more
99	</Collapse>
100	}
101	deleteIcon={
102	<div className="relative">
103	<DescriptionIcon fontSize="small" />
104	<div className={`${classes.iconAura} ${hoverClass}`} />
105	</div>
106	}
107	onClick={onClick}
108	onDelete={onClick}
109	onMouseOver={() => setIsHovering(true)}	×
110	onMouseOut={() => setIsHovering(false)}	×
111	variant="outlined"
112	/>
113	</MenderTooltipClickable>
114	);
115	};
116
117	export const DocsLink = forwardRef(({ children, className = '', path, title = '', ...remainder }, ref) => {	183✔
118	const docsVersion = useSelector(getDocsVersion);	218✔
119	const { isHosted } = useSelector(getFeatures);	218✔
120	const target = `https://docs.mender.io/${docsVersion}${path}`;	218✔
121
122	const onClickHandler = () => {	218✔
123	const docsParams = { headers: { 'x-mender-docs': docsVersion } };	×
124	fetch(target, isHosted ? {} : docsParams);	×
125	};
126
127	return (	218✔
128	// eslint-disable-next-line react/jsx-no-target-blank
129	<a className={className} {...remainder} href={target} onClick={onClickHandler} ref={ref} target="_blank" rel={isHosted ? 'noopener noreferrer' : ''}>	218✔
130	{children ? children : title}	218✔
131	</a>
132	);
133	});
134
135	DocsLink.displayName = 'DocsLink';	183✔
136
137	export default DocsLink;

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