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 ArrayInput ghost error after removing scalar item #9918

Merged
merged 2 commits into from
Jun 17, 2024
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
26 changes: 24 additions & 2 deletions packages/ra-ui-materialui/src/input/ArrayInput/ArrayInput.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ import { TextInput } from '../TextInput';
import { ArrayInput } from './ArrayInput';
import { SimpleFormIterator } from './SimpleFormIterator';
import { useFormContext } from 'react-hook-form';
import { GlobalValidation, ValidationInFormTab } from './ArrayInput.stories';
import {
GlobalValidation,
ScalarWithValidation,
ValidationInFormTab,
} from './ArrayInput.stories';

describe('<ArrayInput />', () => {
it('should pass its record props to its child', async () => {
Expand Down Expand Up @@ -359,17 +363,35 @@ describe('<ArrayInput />', () => {
});
});

it('should correctly update validation state after removing an item', async () => {
render(<ScalarWithValidation />);

await screen.findByDisplayValue('classic');
fireEvent.click(await screen.findByLabelText('Add'));
fireEvent.click(await screen.findByText('Save'));
await screen.findByText('Required');
fireEvent.click((await screen.findAllByLabelText('Remove'))[0]);
await waitFor(() => {
expect(screen.queryByText('Required')).toBeNull();
});
});

describe('used within a form with global validation', () => {
it('should display an error if the array is required and empty', async () => {
render(<GlobalValidation />);
await screen.findByDisplayValue('Leo Tolstoy');
const RemoveButtons = screen.getAllByLabelText('Remove');
fireEvent.click(RemoveButtons[1]);
fireEvent.click(RemoveButtons[0]);
await waitFor(() => {
expect(screen.queryAllByLabelText('Remove')).toHaveLength(0);
});
const SaveButton = screen.getByText('Save');
fireEvent.click(SaveButton);
await screen.findByText(
'The form is not valid. Please check for errors'
'The form is not valid. Please check for errors',
undefined,
{ timeout: 3000 }
);
});
it('should display an error if one of the required field is empty', async () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,38 @@ export const Scalar = () => (
</Admin>
);

export const ScalarWithValidation = () => (
<Admin dataProvider={dataProvider} history={history}>
<Resource
name="books"
edit={() => (
<Edit
mutationMode="pessimistic"
mutationOptions={{
onSuccess: data => {
console.log(data);
},
}}
>
<SimpleForm>
<TextInput source="title" />
<ArrayInput source="tags" fullWidth>
<SimpleFormIterator disableReordering>
<TextInput
source=""
label="tag"
validate={required()}
helperText={false}
/>
</SimpleFormIterator>
</ArrayInput>
</SimpleForm>
</Edit>
)}
/>
</Admin>
);

const order = {
id: 1,
date: '2022-08-30',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,16 +61,24 @@ export const SimpleFormIterator = (props: SimpleFormIteratorProps) => {
} = props;
const [confirmIsOpen, setConfirmIsOpen] = useState<boolean>(false);
const { append, fields, move, remove, replace } = useArrayInput(props);
const { resetField } = useFormContext();
const { resetField, trigger, getValues } = useFormContext();
const translate = useTranslate();
const record = useRecordContext(props);
const initialDefaultValue = useRef({});

const removeField = useCallback(
(index: number) => {
remove(index);
const isScalarArray = getValues(source).every(
(value: any) => typeof value !== 'object'
);
if (isScalarArray) {
// Trigger validation on the Array to avoid ghost errors.
// Otherwise, validation errors on removed fields might still be displayed
trigger(source);
}
},
[remove]
[remove, trigger, source, getValues]
);

if (fields.length > 0) {
Expand Down
Loading