import React from 'react'; import { act, fireEvent, render, renderHook, screen, waitFor, } from '@testing-library/react'; import { VALIDATION_MODE } from '../../constants'; import type { Control } from '../../types'; import { useController } from '../../useController'; import { useFieldArray } from '../../useFieldArray'; import { useForm } from '../../useForm'; let i = 0; jest.mock('../../logic/generateId', () => () => String(i++)); describe('update', () => { beforeEach(() => { i = 0; }); it('should update dirtyFields fields correctly', async () => { let dirtyInputs = {}; const Component = () => { const { register, control, formState: { dirtyFields }, } = useForm<{ test: { value: string }[]; }>({ defaultValues: { test: [ { value: 'plz change' }, { value: 'dont change' }, { value: 'dont change' }, ], }, }); const { fields, update } = useFieldArray({ control, name: 'test', }); dirtyInputs = dirtyFields; return (
{fields.map((field, i) => ( ))} {dirtyFields.test?.length && 'dirty'}
); }; render(); fireEvent.click(screen.getByRole('button')); expect(await screen.findByText('dirty')).toBeVisible(); expect(dirtyInputs).toEqual({ test: [{ value: true }, { value: false }, { value: false }], }); }); it.each(['isDirty', 'dirtyFields'])('should update state with %s', () => { let isDirtyValue; let dirtyValue; const Component = () => { const { register, control, formState: { isDirty, dirtyFields }, } = useForm<{ test: { test: string }[]; }>({ defaultValues: {}, }); const { fields, update } = useFieldArray({ control, name: 'test', }); isDirtyValue = isDirty; dirtyValue = dirtyFields; return (
{fields.map((field, index) => { return ( ); })}
); }; render(); fireEvent.click(screen.getByRole('button', { name: 'update' })); expect(isDirtyValue).toBeTruthy(); expect(dirtyValue).toEqual({ test: [undefined, undefined, { test: true }], }); }); it('should trigger reRender when user update input and is watching the all field array', () => { const watched: any[] = []; const Component = () => { const { register, watch, control } = useForm<{ test: { value: string }[]; }>(); const { fields, update } = useFieldArray({ control, name: 'test', }); watched.push(watch()); return (
{fields.map((field, i) => ( ))}
); }; render(); expect(watched).toEqual([ {}, { test: [], }, ]); fireEvent.click(screen.getByRole('button', { name: /update/i })); expect(watched).toEqual([ {}, { test: [], }, { test: [ { value: '', }, ], }, { test: [ { value: '', }, ], }, ]); }); it('should return watched value with update and watch API', async () => { const renderedItems: any = []; const Component = () => { const { watch, register, control } = useForm<{ test: { value: string }[]; }>(); const { fields, update } = useFieldArray({ name: 'test', control, }); const watched = watch('test'); renderedItems.push(watched); return (
{fields.map((field, i) => (
))}
); }; render(); fireEvent.click(screen.getByRole('button', { name: /update/i })); await waitFor(() => expect(renderedItems).toEqual([ undefined, [], [{ value: 'test' }], [{ value: 'test' }], ]), ); }); it('should update group input correctly', () => { type FormValues = { test: { value: { firstName: string; lastName: string; }; }[]; }; const fieldArrayValues: unknown[] = []; const GroupInput = ({ control, index, }: { control: Control; index: number; }) => { const { field } = useController({ control, name: `test.${index}.value` as const, }); return (
{ field.onChange({ ...field.value, firstName: e.target.name, }); }} /> { field.onChange({ ...field.value, lastName: e.target.name, }); }} />
); }; const App = () => { const { control } = useForm({ defaultValues: { test: [ { value: { firstName: 'bill', lastName: 'luo', }, }, ], }, }); const { fields, update } = useFieldArray({ name: 'test', control, }); fieldArrayValues.push(fields); return (
{fields.map((field, i) => (
))}
); }; render(); expect(fieldArrayValues.at(-1)).toEqual([ { id: '0', value: { firstName: 'bill', lastName: 'luo', }, }, ]); fireEvent.click(screen.getByRole('button')); expect( (screen.getAllByRole('textbox')[0] as HTMLInputElement).value, ).toEqual('firstName'); expect( (screen.getAllByRole('textbox')[1] as HTMLInputElement).value, ).toEqual('lastName'); // Let's check all values of renders with implicitly the number of render (for each value) expect(fieldArrayValues).toEqual([ [ { id: '0', value: { firstName: 'bill', lastName: 'luo', }, }, ], [ { id: '0', value: { firstName: 'bill', lastName: 'luo', }, }, ], [ { id: '2', value: { firstName: 'firstName', lastName: 'lastName', }, }, ], ]); }); it('should update field array with single value', () => { let fieldArrayValues: { value: string }[] | [] = []; const App = () => { const { register, control } = useForm<{ test: { value: string }[]; }>({ defaultValues: { test: [ { value: 'bill', }, ], }, }); const { fields, update } = useFieldArray({ name: 'test', control, }); fieldArrayValues = fields; return (
{fields.map((field, i) => (
))}
); }; render(); fireEvent.click(screen.getByRole('button')); expect((screen.getByRole('textbox') as HTMLInputElement).value).toEqual( 'test', ); expect(fieldArrayValues[0].value).toEqual('test'); }); it('should update field array with multiple values', () => { let fieldArrayValues: { firstName: string; lastName: string }[] | [] = []; const App = () => { const { register, control } = useForm<{ test: { firstName: string; lastName: string }[]; }>({ defaultValues: { test: [ { firstName: 'bill', lastName: 'luo', }, { firstName: 'bill1', lastName: 'luo1', }, ], }, }); const { fields, update } = useFieldArray({ name: 'test', control, }); fieldArrayValues = fields; return (
{fields.map((field, i) => (
))}
); }; render(); expect(fieldArrayValues).toEqual([ { firstName: 'bill', id: '0', lastName: 'luo', }, { firstName: 'bill1', id: '1', lastName: 'luo1', }, ]); fireEvent.click(screen.getByRole('button')); expect( (screen.getAllByRole('textbox')[0] as HTMLInputElement).value, ).toEqual('test1'); expect( (screen.getAllByRole('textbox')[1] as HTMLInputElement).value, ).toEqual('test2'); expect( (screen.getAllByRole('textbox')[2] as HTMLInputElement).value, ).toEqual('test3'); expect( (screen.getAllByRole('textbox')[3] as HTMLInputElement).value, ).toEqual('test4'); expect(fieldArrayValues).toEqual([ { firstName: 'test1', id: '4', lastName: 'test2', }, { firstName: 'test3', id: '5', lastName: 'test4', }, ]); }); 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, }); const { update } = useFieldArray({ control, name: 'test' }); return { formState, update }; }); result.current.formState.isValid; await act(async () => { result.current.update(0, { value: '1' }); }); expect(resolver).toBeCalledWith( { test: [{ 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, }); const { update } = useFieldArray({ control, name: 'test' }); return { formState, update }; }); act(() => { result.current.update(0, { value: '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' }], }, }); const { fields, update } = useFieldArray({ control, name: 'test', }); return (
{fields.map((field, index) => { return ; })}

{JSON.stringify(data)}

); }; render(); fireEvent.click(screen.getByRole('button', { name: 'update' })); fireEvent.click(screen.getByRole('button', { name: 'submit' })); expect( await screen.findByText('{"test":[{"id":"whatever","test":"1234"}]}'), ).toBeVisible(); }); it('should not omit keyName when provided and defaultValue is empty', async () => { type FormValues = { test: { test: string; id: string; }[]; }; const App = () => { const [data, setData] = React.useState(); const { control, register, handleSubmit } = useForm(); const { fields, update } = useFieldArray({ control, name: 'test', }); return (
{fields.map((field, index) => { return ; })}

{JSON.stringify(data)}

); }; render(); fireEvent.click(screen.getByRole('button', { name: 'update' })); fireEvent.click(screen.getByRole('button', { name: 'submit' })); expect( await screen.findByText('{"test":[{"id":"whatever","test":"1234"}]}'), ).toBeVisible(); }); it('should not update errors state', async () => { const App = () => { const { control, register, trigger, formState: { errors }, } = useForm({ defaultValues: { test: [ { firstName: '', }, ], }, }); const { fields, update } = useFieldArray({ name: 'test', control, }); React.useEffect(() => { trigger(); }, [trigger]); return (
{fields.map((field, i) => ( ))}

{errors?.test?.[0]?.firstName?.message}

); }; render(); expect(await screen.findByText('This is required')).toBeVisible(); fireEvent.click(screen.getByRole('button')); expect(await screen.findByText('This is required')).toBeVisible(); }); });