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

81.48

/src/js/components/devices/widgets/attribute-autocomplete.js

// Copyright 2022 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';

// material ui
import { Autocomplete, TextField, createFilterOptions } from '@mui/material';

import { TIMEOUTS } from '../../../constants/appConstants';
import { emptyFilter } from '../../../constants/deviceConstants';
import { defaultHeaders } from '../base-devices';
import { getFilterLabelByKey } from './filters';

const textFieldStyle = { marginTop: 0, marginBottom: 15 };

export const getOptionLabel = option => {
  const header = Object.values(defaultHeaders).find(
    ({ attribute }) => attribute.scope === option.scope && (attribute.name === option.key || attribute.alternative === option.key)
  );
  return header?.title || option.title || option.value || option.key || option;
};

const FilterOption = (props, option) => {
  let content = getOptionLabel(option);
  if (option.category === 'recently used') {
    content = (
      <div className="flexbox center-aligned space-between" style={{ width: '100%' }}>
        <div>{content}</div>
        <div className="muted slightly-smaller">({option.scope})</div>
      </div>
    );
  }
  return <li {...props}>{content}</li>;
};

const optionsFilter = createFilterOptions();

const filterOptions = (options, params) => {
  const filtered = optionsFilter(options, params);
  if (filtered.length !== 1 && params.inputValue !== '') {
    filtered.push({
      inputValue: params.inputValue,
      key: 'custom',
      value: `Use "${params.inputValue}"`,
      category: 'custom',
      priority: 99
    });
  }
  return filtered;
};

export const AttributeAutoComplete = ({ attributes, disabled = false, filter = emptyFilter, label = 'Attribute', onRemove, onSelect, ...remainder }) => {
  const [key, setKey] = useState(filter.key); // this refers to the selected filter with key as the id
  const [options, setOptions] = useState([]);
  const [reset, setReset] = useState(true);
  const [scope, setScope] = useState(filter.scope);
  const timer = useRef();

  useEffect(() => {
    return () => {
      clearTimeout(timer.current);
    };
  }, []);

  useEffect(() => {
    setKey(emptyFilter.key);
    setScope(emptyFilter.scope);
    setOptions(attributes.sort((a, b) => a.priority - b.priority));
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [attributes.length, reset]);

  useEffect(() => {
    setKey(filter.key);
  }, [filter.key]);

  useEffect(() => {
    clearTimeout(timer.current);
    timer.current = setTimeout(() => onSelect({ key, scope }), TIMEOUTS.debounceDefault);
    return () => {
      clearTimeout(timer.current);
    };
  }, [key, onSelect, scope]);

  const updateFilterKey = (value, selectedScope) => {
    if (!value) {
      return removeFilter();
    }
    const { key = value, scope: fallbackScope } = attributes.find(filter => filter.key === value) ?? {};
    setKey(key);
    setScope(selectedScope || fallbackScope);
  };

  const removeFilter = useCallback(() => {
    if (key) {
      onRemove({ key, scope });
    }
    setReset(!reset);
  }, [key, onRemove, reset, setReset, scope]);

  return (
    <Autocomplete
      {...remainder}
      autoComplete
      autoHighlight
      autoSelect
      disabled={disabled}
      freeSolo
      filterSelectedOptions
      filterOptions={filterOptions}
      getOptionLabel={getOptionLabel}
      groupBy={option => option.category}
      renderOption={FilterOption}
      id="filter-selection"
      includeInputInList={true}
      onChange={(e, changedValue) => {
        const { inputValue, key = changedValue, scope } = changedValue || {};
        if (inputValue) {
          // only circumvent updateFilterKey if we deal with a custom attribute - those will be treated as inventory attributes
          setKey(inputValue);
          return setScope(emptyFilter.scope);
        }
        updateFilterKey(key, scope);
      }}
      options={options}
      renderInput={params => <TextField {...params} label={label} style={textFieldStyle} />}
      key={reset}
      value={getFilterLabelByKey(key, attributes)}
    />
  );
};

export default AttributeAutoComplete;

1	// Copyright 2022 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
16	// material ui
17	import { Autocomplete, TextField, createFilterOptions } from '@mui/material';
18
19	import { TIMEOUTS } from '../../../constants/appConstants';
20	import { emptyFilter } from '../../../constants/deviceConstants';
21	import { defaultHeaders } from '../base-devices';
22	import { getFilterLabelByKey } from './filters';
23
24	const textFieldStyle = { marginTop: 0, marginBottom: 15 };	183✔
25
26	export const getOptionLabel = option => {	183✔
27	const header = Object.values(defaultHeaders).find(	113✔
28	({ attribute }) => attribute.scope === option.scope && (attribute.name === option.key \|\| attribute.alternative === option.key)	552✔
29	);
30	return header?.title \|\| option.title \|\| option.value \|\| option.key \|\| option;	113✔
31	};
32
33	const FilterOption = (props, option) => {	183✔
34	let content = getOptionLabel(option);	20✔
35	if (option.category === 'recently used') {	20!
36	content = (	×
37	<div className="flexbox center-aligned space-between" style={{ width: '100%' }}>
38	<div>{content}</div>
39	<div className="muted slightly-smaller">({option.scope})</div>
40	</div>
41	);
42	}
43	return <li {...props}>{content}</li>;	20✔
44	};
45
46	const optionsFilter = createFilterOptions();	183✔
47
48	const filterOptions = (options, params) => {	183✔
49	const filtered = optionsFilter(options, params);	9✔
50	if (filtered.length !== 1 && params.inputValue !== '') {	9✔
51	filtered.push({	4✔
52	inputValue: params.inputValue,
53	key: 'custom',
54	value: `Use "${params.inputValue}"`,
55	category: 'custom',
56	priority: 99
57	});
58	}
59	return filtered;	9✔
60	};
61
62	export const AttributeAutoComplete = ({ attributes, disabled = false, filter = emptyFilter, label = 'Attribute', onRemove, onSelect, ...remainder }) => {	183!
63	const [key, setKey] = useState(filter.key); // this refers to the selected filter with key as the id	14✔
64	const [options, setOptions] = useState([]);	14✔
65	const [reset, setReset] = useState(true);	14✔
66	const [scope, setScope] = useState(filter.scope);	14✔
67	const timer = useRef();	14✔
68
69	useEffect(() => {	14✔
70	return () => {	4✔
71	clearTimeout(timer.current);	4✔
72	};
73	}, []);
74
75	useEffect(() => {	14✔
76	setKey(emptyFilter.key);	6✔
77	setScope(emptyFilter.scope);	6✔
78	setOptions(attributes.sort((a, b) => a.priority - b.priority));	12✔
79	// eslint-disable-next-line react-hooks/exhaustive-deps
80	}, [attributes.length, reset]);
81
82	useEffect(() => {	14✔
83	setKey(filter.key);	4✔
84	}, [filter.key]);
85
86	useEffect(() => {	14✔
87	clearTimeout(timer.current);	8✔
88	timer.current = setTimeout(() => onSelect({ key, scope }), TIMEOUTS.debounceDefault);	8✔
89	return () => {	8✔
90	clearTimeout(timer.current);	8✔
91	};
92	}, [key, onSelect, scope]);
93
94	const updateFilterKey = (value, selectedScope) => {	14✔
95	if (!value) {	×
96	return removeFilter();	×
97	}
98	const { key = value, scope: fallbackScope } = attributes.find(filter => filter.key === value) ?? {};	×
99	setKey(key);	×
100	setScope(selectedScope \|\| fallbackScope);	×
101	};
102
103	const removeFilter = useCallback(() => {	14✔
104	if (key) {	×
105	onRemove({ key, scope });	×
106	}
107	setReset(!reset);	×
108	}, [key, onRemove, reset, setReset, scope]);
109
110	return (	14✔
111	<Autocomplete
112	{...remainder}
113	autoComplete
114	autoHighlight
115	autoSelect
116	disabled={disabled}
117	freeSolo
118	filterSelectedOptions
119	filterOptions={filterOptions}
120	getOptionLabel={getOptionLabel}
121	groupBy={option => option.category}	20✔
122	renderOption={FilterOption}
123	id="filter-selection"
124	includeInputInList={true}
125	onChange={(e, changedValue) => {
126	const { inputValue, key = changedValue, scope } = changedValue \|\| {};	1!
127	if (inputValue) {	1!
128	// only circumvent updateFilterKey if we deal with a custom attribute - those will be treated as inventory attributes
129	setKey(inputValue);	1✔
130	return setScope(emptyFilter.scope);	1✔
131	}
132	updateFilterKey(key, scope);	×
133	}}
134	options={options}
135	renderInput={params => <TextField {...params} label={label} style={textFieldStyle} />}	25✔
136	key={reset}
137	value={getFilterLabelByKey(key, attributes)}
138	/>
139	);
140	};
141
142	export default AttributeAutoComplete;

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