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.

Sign up for GitHub

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

Jump to bottom

Fix <AutocompleteInput> should not use matchSuggestion when in a <ReferenceInput> #8956

Merged
merged 1 commit into from
May 31, 2023
Merged

Fix <AutocompleteInput> should not use matchSuggestion when in a <ReferenceInput> #8956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 34 additions & 0 deletions packages/ra-ui-materialui/src/input/AutocompleteInput.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import {
DifferentShapeInGetMany,
InsideReferenceInput,
InsideReferenceInputDefaultValue,
InsideReferenceInputWithCustomizedItemRendering,
Nullable,
NullishValuesSupport,
VeryLargeOptionsNumber,
Expand Down Expand Up @@ -1393,6 +1394,39 @@ describe('<AutocompleteInput />', () => {
expect(testFailed).toBe(false);
expect(input.value).toBe('Leo Tolstoy test');
});

it('should not use getSuggestions to do client-side filtering', async () => {
// filtering should be done server-side only, and hence matchSuggestion should never be called
const matchSuggestion = jest.fn().mockReturnValue(true);
render(
<InsideReferenceInputWithCustomizedItemRendering
matchSuggestion={matchSuggestion}
/>
);
await waitFor(
() => {
expect(
(screen.getByRole('textbox') as HTMLInputElement).value
).toBe('Leo Tolstoy - Russian');
},
{ timeout: 2000 }
);
screen.getByRole('textbox').focus();
fireEvent.click(screen.getByLabelText('Clear value'));
await waitFor(() => {
expect(screen.getByRole('listbox').children).toHaveLength(5);
});
fireEvent.change(screen.getByRole('textbox'), {
target: { value: 'French' },
});
await waitFor(
() => {
screen.getByText('No options');
},
{ timeout: 2000 }
);
expect(matchSuggestion).not.toHaveBeenCalled();
});
});

it("should allow to edit the input if it's inside a FormDataConsumer", () => {
Expand Down
42 changes: 41 additions & 1 deletion packages/ra-ui-materialui/src/input/AutocompleteInput.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import fakeRestProvider from 'ra-data-fakerest';

import { Edit } from '../detail';
import { SimpleForm } from '../form';
import { AutocompleteInput } from './AutocompleteInput';
import { AutocompleteInput, AutocompleteInputProps } from './AutocompleteInput';
import { ReferenceInput } from './ReferenceInput';
import { TextInput } from './TextInput';
import { useCreateSuggestionContext } from './useSupportCreateSuggestion';
Expand Down Expand Up @@ -689,6 +689,46 @@ export const InsideReferenceInputWithCreationSupport = () => (
</Admin>
);

const BookOptionText = () => {
const book = useRecordContext();
if (!book) return null;
return <div>{`${book.name} - ${book.language}`}</div>;
};

export const InsideReferenceInputWithCustomizedItemRendering = (
props: Partial<AutocompleteInputProps>
) => (
<Admin dataProvider={dataProviderWithAuthors} history={history}>
<Resource name="authors" />
<Resource
name="books"
edit={() => (
<Edit
mutationMode="pessimistic"
mutationOptions={{
onSuccess: data => {
console.log(data);
},
}}
>
<SimpleForm>
<ReferenceInput reference="authors" source="author">
<AutocompleteInput
fullWidth
optionText={<BookOptionText />}
inputText={book =>
`${book.name} - ${book.language}`
}
{...props}
/>
</ReferenceInput>
</SimpleForm>
</Edit>
)}
/>
</Admin>
);

const OptionItem = props => {
const record = useRecordContext();
return (
Expand Down
11 changes: 8 additions & 3 deletions packages/ra-ui-materialui/src/input/AutocompleteInput.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,12 @@ export const AutocompleteInput = <
throw new Error(`
If you provided a React element for the optionText prop, you must also provide the inputText prop (used for the text input)`);
}
// eslint-disable-next-line eqeqeq
if (isValidElement(optionText) && matchSuggestion == undefined) {
if (
isValidElement(optionText) &&
!isFromReference &&
// eslint-disable-next-line eqeqeq
matchSuggestion == undefined
) {
throw new Error(`
If you provided a React element for the optionText prop, you must also provide the matchSuggestion prop (used to match the user input with a choice)`);
}
Expand Down Expand Up @@ -515,7 +519,7 @@ If you provided a React element for the optionText prop, you must also provide t
const oneSecondHasPassed = useTimeout(1000, filterValue);

const suggestions = useMemo(() => {
if (matchSuggestion || limitChoicesToValue) {
if (!isFromReference && (matchSuggestion || limitChoicesToValue)) {
return getSuggestions(filterValue);
}
return finalChoices?.slice(0, suggestionLimit) || [];
Expand All @@ -526,6 +530,7 @@ If you provided a React element for the optionText prop, you must also provide t
limitChoicesToValue,
matchSuggestion,
suggestionLimit,
isFromReference,
]);

const isOptionEqualToValue = (option, value) => {
Expand Down