import React from 'react';
import {
act,
fireEvent,
render,
renderHook,
screen,
waitFor,
} from '@testing-library/react';
import { VALIDATION_MODE } from '../../constants';
import { useFieldArray } from '../../useFieldArray';
import { useForm } from '../../useForm';
import noop from '../../utils/noop';
let i = 0;
jest.mock('../../logic/generateId', () => () => String(i++));
describe('move', () => {
beforeEach(() => {
i = 0;
});
it.each(['isDirty', 'dirtyFields'])(
'should move dirtyFields into pointed position when formState.%s is defined',
() => {
const { result } = renderHook(() => {
const { formState, control } = useForm({
defaultValues: { test: [{ value: '1' }] },
});
const methods = useFieldArray({
control,
name: 'test',
});
return {
formState,
...methods,
};
});
result.current.formState.isDirty;
result.current.formState.dirtyFields;
act(() => {
result.current.append({ value: '2' });
});
act(() => {
result.current.append({ value: '3' });
});
act(() => {
result.current.move(0, 1);
});
expect(result.current.formState.isDirty).toBeTruthy();
expect(result.current.formState.dirtyFields).toEqual({
test: [{ value: true }, { value: true }, { value: true }],
});
},
);
it('should move errors', async () => {
let errors: any;
const Component = () => {
const { register, handleSubmit, control, ...rest } = useForm({
defaultValues: { test: [{ value: 'test' }] },
});
const { fields, append, move } = useFieldArray({
control,
name: 'test',
});
errors = rest.formState.errors;
return (
);
};
render();
fireEvent.click(screen.getByRole('button', { name: /append/i }));
fireEvent.click(screen.getByRole('button', { name: /submit/i }));
await waitFor(() => expect(errors.test[0]).toBeUndefined());
expect(errors.test[1]).toBeDefined();
fireEvent.click(screen.getByRole('button', { name: /move/i }));
expect(errors.test[0]).toBeDefined();
expect(errors.test[1]).toBeUndefined();
});
it('should move touched fields', async () => {
let touched: any;
const Component = () => {
const { register, formState, control } = useForm({
defaultValues: { test: [{ value: 'test' }] },
});
const { fields, append, move } = useFieldArray({
control,
name: 'test',
});
touched = formState.touchedFields;
return (
);
};
render();
fireEvent.click(screen.getByRole('button', { name: /append/i }));
fireEvent.blur(screen.getAllByRole('textbox')[0]);
fireEvent.click(screen.getByRole('button', { name: /move/i }));
expect(touched).toEqual({
test: [undefined, { value: true }],
});
});
it('should trigger reRender when user is watching the all field array', () => {
const watched: any[] = [];
const Component = () => {
const { register, watch, control } = useForm({
defaultValues: {
test: [{ value: '1' }, { value: '2' }],
},
});
const { fields, move } = useFieldArray({
control,
name: 'test',
});
watched.push(watch());
return (
);
};
render();
fireEvent.click(screen.getByRole('button', { name: 'move' }));
expect(watched).toEqual([
{ test: [{ value: '1' }, { value: '2' }] }, // first render
{ test: [{ value: '1' }, { value: '2' }] }, // render inside useEffect in useFieldArray
{ test: [{ value: '2' }, { value: '1' }] }, // render inside move method
{ test: [{ value: '2' }, { value: '1' }] }, // render inside useEffect in useFieldArray
]);
});
it('should populate all fields with default values', () => {
let getValues: any;
const Component = () => {
const {
register,
control,
getValues: tempGetValues,
} = useForm({
defaultValues: {
test: [{ value: '1' }, { value: '2' }],
},
});
const { fields } = useFieldArray({
control,
name: 'test',
});
getValues = tempGetValues;
return (
);
};
render();
expect(getValues()).toEqual({ test: [{ value: '1' }, { value: '2' }] });
});
it('should return watched value with watch API', async () => {
const renderedItems: any = [];
const Component = () => {
const { watch, register, control } = useForm<{
test: {
value: string;
}[];
}>();
const { fields, append, move } = useFieldArray({
name: 'test',
control,
});
const watched = watch('test');
const isMoved = React.useRef(false);
if (isMoved.current) {
renderedItems.push(watched);
}
return (
{fields.map((field, i) => (
))}
);
};
render();
fireEvent.click(screen.getByRole('button', { name: /append/i }));
fireEvent.click(screen.getByRole('button', { name: /append/i }));
const inputs = screen.getAllByRole('textbox');
fireEvent.change(inputs[0], {
target: { name: 'test[0].value', value: '111' },
});
fireEvent.change(inputs[1], {
target: { name: 'test[1].value', value: '222' },
});
fireEvent.click(screen.getByRole('button', { name: /move/i }));
await waitFor(() =>
expect(renderedItems).toEqual([
[{ value: '222' }, { value: '111' }],
[{ value: '222' }, { value: '111' }],
]),
);
});
describe('with resolver', () => {
it('should invoke resolver when formState.isValid true', async () => {
const resolver = jest.fn().mockReturnValue({});
const { result } = renderHook(() => {
const { formState, control } = useForm({
mode: VALIDATION_MODE.onChange,
resolver,
defaultValues: {
test: [{ value: '1' }, { value: '2' }],
},
});
const { move } = useFieldArray({ control, name: 'test' });
return { formState, move };
});
result.current.formState.isValid;
await act(async () => {
result.current.move(0, 1);
});
expect(resolver).toBeCalledWith(
{
test: [{ value: '2' }, { value: '1' }],
},
undefined,
{
criteriaMode: undefined,
fields: {},
names: [],
},
);
});
it('should not invoke resolver when formState.isValid false', () => {
const resolver = jest.fn().mockReturnValue({});
const { result } = renderHook(() => {
const { formState, control } = useForm({
mode: VALIDATION_MODE.onChange,
resolver,
defaultValues: {
test: [{ value: '1' }, { value: '2' }],
},
});
const { move } = useFieldArray({ control, name: 'test' });
return { formState, move };
});
act(() => {
result.current.move(0, 1);
});
expect(resolver).toBeCalled();
});
});
it('should not omit keyName when provided', async () => {
type FormValues = {
test: {
test: string;
id: string;
}[];
};
const App = () => {
const [data, setData] = React.useState();
const { control, register, handleSubmit } = useForm({
defaultValues: {
test: [
{ id: '1234', test: 'data' },
{ id: '4567', test: 'data1' },
],
},
});
const { fields, move } = useFieldArray({
control,
name: 'test',
});
return (
);
};
render();
fireEvent.click(screen.getByRole('button', { name: 'move' }));
fireEvent.click(screen.getByRole('button', { name: 'submit' }));
expect(
await screen.findByText(
'{"test":[{"id":"4567","test":"data1"},{"id":"1234","test":"data"}]}',
),
).toBeVisible();
});
it('should not omit keyName when provided and defaultValue is empty', async () => {
type FormValues = {
test: {
test: string;
id: string;
}[];
};
let k = 0;
const App = () => {
const [data, setData] = React.useState();
const { control, register, handleSubmit } = useForm();
const { fields, append, move } = useFieldArray({
control,
name: 'test',
});
return (
);
};
render();
fireEvent.click(screen.getByRole('button', { name: 'append' }));
fireEvent.click(screen.getByRole('button', { name: 'append' }));
fireEvent.click(screen.getByRole('button', { name: 'move' }));
fireEvent.click(screen.getByRole('button', { name: 'submit' }));
expect(
await screen.findByText(
'{"test":[{"id":"whatever1","test":"12341"},{"id":"whatever0","test":"12340"}]}',
),
).toBeVisible();
});
});