Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Select onChange is being fired without explicit selection #24698

Merged
merged 5 commits into from
Jul 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ describe('ListView', () => {
});

await act(async () => {
wrapper2.find('[aria-label="Sort"]').first().props().onChange({
wrapper2.find('[aria-label="Sort"]').first().props().onSelect({
desc: false,
id: 'something',
label: 'Alphabetical',
Expand Down
23 changes: 21 additions & 2 deletions superset-frontend/src/components/Select/AsyncSelect.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,7 @@ test('changes the selected item in single mode', async () => {
label: firstOption.label,
value: firstOption.value,
}),
firstOption,
expect.objectContaining(firstOption),
);
expect(await findSelectValue()).toHaveTextContent(firstOption.label);
userEvent.click(await findSelectOption(secondOption.label));
Expand All @@ -531,7 +531,7 @@ test('changes the selected item in single mode', async () => {
label: secondOption.label,
value: secondOption.value,
}),
secondOption,
expect.objectContaining(secondOption),
);
expect(await findSelectValue()).toHaveTextContent(secondOption.label);
});
Expand Down Expand Up @@ -804,6 +804,25 @@ test('Renders only an overflow tag if dropdown is open in oneLine mode', async (
expect(withinSelector.getByText('+ 2 ...')).toBeVisible();
});

test('does not fire onChange when searching but no selection', async () => {
const onChange = jest.fn();
render(
<div role="main">
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This div is to simulate a click outside of the select.

<AsyncSelect
{...defaultProps}
onChange={onChange}
mode="multiple"
allowNewOptions
/>
</div>,
);
await open();
await type('Joh');
userEvent.click(await findSelectOption('John'));
userEvent.click(screen.getByRole('main'));
expect(onChange).toHaveBeenCalledTimes(1);
});

/*
TODO: Add tests that require scroll interaction. Needs further investigation.
- Fetches more data when scrolling and more data is available
Expand Down
76 changes: 64 additions & 12 deletions superset-frontend/src/components/Select/AsyncSelect.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import React, {
useCallback,
useImperativeHandle,
} from 'react';
import { ensureIsArray, t } from '@superset-ui/core';
import { ensureIsArray, t, usePrevious } from '@superset-ui/core';
import { LabeledValue as AntdLabeledValue } from 'antd/lib/select';
import debounce from 'lodash/debounce';
import { isEqual } from 'lodash';
Expand All @@ -47,13 +47,15 @@ import {
getSuffixIcon,
dropDownRenderHelper,
handleFilterOptionHelper,
mapOptions,
} from './utils';
import {
AsyncSelectProps,
AsyncSelectRef,
SelectOptionsPagePromise,
SelectOptionsType,
SelectOptionsTypePage,
SelectProps,
} from './types';
import {
StyledCheckOutlined,
Expand Down Expand Up @@ -102,6 +104,7 @@ const AsyncSelect = forwardRef(
allowClear,
allowNewOptions = false,
ariaLabel,
autoClearSearchValue = false,
fetchOnlyOnSearch,
filterOption = true,
header = null,
Expand All @@ -113,10 +116,13 @@ const AsyncSelect = forwardRef(
mode = 'single',
name,
notFoundContent,
onBlur,
onError,
onChange,
onClear,
onDropdownVisibleChange,
onDeselect,
onSelect,
optionFilterProps = ['label', 'value'],
options,
pageSize = DEFAULT_PAGE_SIZE,
Expand Down Expand Up @@ -150,10 +156,16 @@ const AsyncSelect = forwardRef(
? 'tags'
: 'multiple';
const allowFetch = !fetchOnlyOnSearch || inputValue;

const [maxTagCount, setMaxTagCount] = useState(
propsMaxTagCount ?? MAX_TAG_COUNT,
);
const [onChangeCount, setOnChangeCount] = useState(0);
const previousChangeCount = usePrevious(onChangeCount, 0);

const fireOnChange = useCallback(
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simple counter used to fire the onChange event.

() => setOnChangeCount(onChangeCount + 1),
[onChangeCount],
);

useEffect(() => {
if (oneLine) {
Expand Down Expand Up @@ -209,9 +221,7 @@ const AsyncSelect = forwardRef(
: selectOptions;
}, [selectOptions, selectValue]);

const handleOnSelect = (
selectedItem: string | number | AntdLabeledValue | undefined,
) => {
const handleOnSelect: SelectProps['onSelect'] = (selectedItem, option) => {
if (isSingleMode) {
setSelectValue(selectedItem);
} else {
Expand All @@ -228,12 +238,11 @@ const AsyncSelect = forwardRef(
return previousState;
});
}
setInputValue('');
fireOnChange();
onSelect?.(selectedItem, option);
};

const handleOnDeselect = (
value: string | number | AntdLabeledValue | undefined,
) => {
const handleOnDeselect: SelectProps['onDeselect'] = (value, option) => {
if (Array.isArray(selectValue)) {
if (isLabeledValue(value)) {
const array = selectValue as AntdLabeledValue[];
Expand All @@ -245,7 +254,8 @@ const AsyncSelect = forwardRef(
setSelectValue(array.filter(element => element !== value));
}
}
setInputValue('');
fireOnChange();
onDeselect?.(value, option);
};

const internalOnError = useCallback(
Expand Down Expand Up @@ -425,8 +435,50 @@ const AsyncSelect = forwardRef(
if (onClear) {
onClear();
}
fireOnChange();
};

const handleOnBlur = (event: React.FocusEvent<HTMLElement>) => {
const tagsMode = !isSingleMode && allowNewOptions;
const searchValue = inputValue.trim();
// Searched values will be autoselected during onBlur events when in tags mode.
// We want to make sure a value is only selected if the user has actually selected it
// by pressing Enter or clicking on it.
if (
tagsMode &&
searchValue &&
!hasOption(searchValue, selectValue, true)
) {
// The search value will be added so we revert to the previous value
setSelectValue(selectValue || []);
}
onBlur?.(event);
};

useEffect(() => {
if (onChangeCount !== previousChangeCount) {
const array = ensureIsArray(selectValue);
const set = new Set(array.map(getValue));
const options = mapOptions(
fullSelectOptions.filter(opt => set.has(opt.value)),
);
if (isSingleMode) {
// @ts-ignore
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original typescript definition does not allow undefined but I checked and the component allows it when using allowClear.

onChange?.(selectValue, options[0]);
} else {
// @ts-ignore
onChange?.(array, options);
}
}
}, [
fullSelectOptions,
isSingleMode,
onChange,
onChangeCount,
previousChangeCount,
selectValue,
]);

useEffect(() => {
// when `options` list is updated from component prop, reset states
fetchedQueries.current.clear();
Expand Down Expand Up @@ -482,7 +534,7 @@ const AsyncSelect = forwardRef(
<StyledSelect
allowClear={!isLoading && allowClear}
aria-label={ariaLabel || name}
autoClearSearchValue={false}
autoClearSearchValue={autoClearSearchValue}
dropdownRender={dropdownRender}
filterOption={handleFilterOption}
filterSort={sortComparatorWithSearch}
Expand All @@ -494,13 +546,13 @@ const AsyncSelect = forwardRef(
maxTagCount={maxTagCount}
mode={mappedMode}
notFoundContent={isLoading ? t('Loading...') : notFoundContent}
onBlur={handleOnBlur}
onDeselect={handleOnDeselect}
onDropdownVisibleChange={handleOnDropdownVisibleChange}
onPopupScroll={handlePagination}
onSearch={showSearch ? handleOnSearch : undefined}
onSelect={handleOnSelect}
onClear={handleClear}
onChange={onChange}
options={
hasCustomLabels(fullSelectOptions) ? undefined : fullSelectOptions
}
Expand Down
2 changes: 2 additions & 0 deletions superset-frontend/src/components/Select/Select.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,8 @@ InteractiveSelect.args = {
autoFocus: true,
allowNewOptions: false,
allowClear: false,
autoClearSearchValue: false,
allowSelectAll: true,
showSearch: true,
disabled: false,
invertSelection: false,
Expand Down
19 changes: 19 additions & 0 deletions superset-frontend/src/components/Select/Select.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -890,6 +890,25 @@ test('"Select All" does not affect disabled options', async () => {
expect(await findSelectValue()).not.toHaveTextContent(options[1].label);
});

test('does not fire onChange when searching but no selection', async () => {
const onChange = jest.fn();
render(
<div role="main">
<Select
{...defaultProps}
onChange={onChange}
mode="multiple"
allowNewOptions
/>
</div>,
);
await open();
await type('Joh');
userEvent.click(await findSelectOption('John'));
userEvent.click(screen.getByRole('main'));
expect(onChange).toHaveBeenCalledTimes(1);
});

/*
TODO: Add tests that require scroll interaction. Needs further investigation.
- Fetches more data when scrolling and more data is available
Expand Down
Loading
Loading