963124858

pending completion

Build # 963124858

Build Type

Pull #3870

gitlab-ci

Committed by

mzedel

Commit Message

chore: cleaned up left over onboarding tooltips & aligned with updated design

Signed-off-by: Manuel Zedel <manuel.zedel@northern.tech>

Pull Request Pull Request #3870: MEN-5413

Run Details

4368 of 6355 branches covered (68.73%)

91 of 118 new or added lines in 22 files covered. (77.12%)

1753 existing lines in 162 files now uncovered.

8246 of 10042 relevant lines covered (82.12%)

193.52 hits per line

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

72.09

/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 { getFilterLabelByKey } from './filters';
import { defaultHeaders } from '../base-devices';

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

const defaultScope = 'inventory';

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;
};

const defaultFilter = { key: '', scope: defaultScope };

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

mendersoftware / gui / 963124858

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