import React from 'react'; import { act, fireEvent, render, renderHook, screen, waitFor, } from '@testing-library/react'; import { VALIDATION_MODE } from '../../constants'; import type { Control, FieldPath } from '../../types'; import { useController } from '../../useController'; import { useFieldArray } from '../../useFieldArray'; import { useForm } from '../../useForm'; import noop from '../../utils/noop'; let i = 0; jest.mock('../../logic/generateId', () => () => String(i++)); describe('prepend', () => { beforeEach(() => { i = 0; }); it('should pre-append data into the fields', async () => { let currentFields: any = []; const Component = () => { const { control, register } = useForm<{ test: { test: string; }[]; }>(); const { fields, prepend } = useFieldArray({ control, name: 'test', }); currentFields = fields; return (
{fields.map((field, index) => (
))}
); }; render(); fireEvent.click(screen.getByRole('button', { name: 'prepend' })); expect(currentFields).toEqual([{ id: '0', test: 'test' }]); fireEvent.click(screen.getByRole('button', { name: 'prepend' })); expect(currentFields).toEqual([ { id: '2', test: 'test' }, { id: '0', test: 'test' }, ]); fireEvent.click(screen.getByRole('button', { name: 'prependBatch' })); expect(currentFields).toEqual([ { id: '5', test: 'test-batch' }, { id: '6', test: 'test-batch1' }, { id: '2', test: 'test' }, { id: '0', test: 'test' }, ]); }); it.each(['isDirty', 'dirtyFields'])( 'should be dirtyFields when value is prepended with %s', () => { const { result } = renderHook(() => { const { register, formState, control } = useForm(); const { fields, prepend } = useFieldArray({ control, name: 'test', }); return { register, formState, fields, prepend }; }); result.current.formState.isDirty; result.current.formState.dirtyFields; act(() => { result.current.prepend({ value: 'test' }); }); act(() => { result.current.prepend({ value: 'test1' }); }); act(() => { result.current.prepend({ value: 'test2' }); }); expect(result.current.formState.isDirty).toBeTruthy(); expect(result.current.formState.dirtyFields).toEqual({ test: [{ value: true }, { value: true }, { value: true }], }); }, ); it('should set prepended values to formState.touchedFields', () => { let touched: any; const Component = () => { const { register, formState, control } = useForm(); const { fields, prepend } = useFieldArray({ control, name: 'test', }); touched = formState.touchedFields; return (
{fields.map((field, i) => ( ))}
); }; render(); fireEvent.click(screen.getByRole('button', { name: /prepend/i })); fireEvent.blur(screen.getAllByRole('textbox')[0]); fireEvent.click(screen.getByRole('button', { name: /prepend/i })); fireEvent.click(screen.getByRole('button', { name: /prepend/i })); expect(touched).toEqual({ test: [undefined, { value: true }, { value: true }], }); }); it('should prepend error', async () => { let errors: any; const Component = () => { const { register, formState: { errors: tempErrors }, handleSubmit, control, } = useForm<{ test: { value: string }[]; }>(); const { fields, prepend } = useFieldArray({ control, name: 'test', }); errors = tempErrors; return (
{fields.map((field, i) => ( ))}
); }; render(); fireEvent.click(screen.getByRole('button', { name: /prepend/i })); expect(errors.test).toBeUndefined(); fireEvent.click(screen.getByRole('button', { name: /submit/i })); await waitFor(() => { expect(errors.test).toHaveLength(1); }); fireEvent.click(screen.getByRole('button', { name: /prepend/i })); await waitFor(() => { expect(errors.test).toHaveLength(2); }); }); it('should trigger reRender when user is watching the all field array', () => { const watched: any[] = []; const Component = () => { const { register, watch, control } = useForm<{ test: { value: string }[]; }>(); const { fields, prepend } = useFieldArray({ control, name: 'test', }); watched.push(watch()); return (
{fields.map((field, i) => ( ))}
); }; render(); fireEvent.click(screen.getByRole('button', { name: 'prepend' })); expect(watched).toEqual([ {}, // first render { test: [] }, // render inside useEffect in useFieldArray { test: [{ value: '' }] }, // render inside prepend method { test: [{ value: '' }] }, // render inside useEffect in useFieldArray ]); }); 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, prepend } = useFieldArray({ name: 'test', control, }); const watched = watch('test'); const isPrepended = React.useRef(false); if (isPrepended.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.input(inputs[0], { target: { name: 'test[0].value', value: '111' }, }); fireEvent.input(inputs[1], { target: { name: 'test[1].value', value: '222' }, }); fireEvent.click(screen.getByRole('button', { name: /prepend/i })); await waitFor(() => expect(renderedItems).toEqual([ [{ value: 'test' }, { value: '111' }, { value: '222' }], [{ value: 'test' }, { value: '111' }, { value: '222' }], ]), ); }); it('should focus if shouldFocus is true', () => { const Component = () => { const { register, control } = useForm<{ test: { value: string }[]; }>({ defaultValues: { test: [{ value: '1' }, { value: '2' }], }, }); const { fields, prepend } = useFieldArray({ name: 'test', control }); return (
{fields.map((field, i) => ( ))}
); }; render(); fireEvent.click(screen.getByRole('button', { name: /prepend/i })); const inputs = screen.getAllByRole('textbox'); expect(inputs).toHaveLength(3); expect(document.activeElement).toEqual(inputs[0]); }); it('should not focus if shouldFocus is false', () => { const Component = () => { const { register, control } = useForm({ defaultValues: { test: [{ value: '1' }, { value: '2' }], }, }); const { fields, prepend } = useFieldArray({ name: 'test', control }); return (
{fields.map((field, i) => ( ))}
); }; render(); fireEvent.click(screen.getByRole('button', { name: /prepend/i })); const inputs = screen.getAllByRole('textbox'); expect(inputs).toHaveLength(3); expect(document.activeElement).toEqual(document.body); }); it('should append nested field value without its reference', () => { type FormValues = { test: { name: { deep: string } }[]; }; function Input({ name, control, }: { name: FieldPath; control: Control; }) { const { field } = useController({ name: name as 'test.0.name.deep', control, }); return ; } function FieldArray({ control, name, itemDefaultValue, }: { control: Control; name: FieldPath; itemDefaultValue: { name: { deep: string } }; }) { const { fields, prepend } = useFieldArray({ control, name: name as 'test', }); return ( <> {fields.map((item, index) => ( ))} ); } function App() { const { control } = useForm({ defaultValues: { test: [], }, }); return (
); } render(); fireEvent.click(screen.getByRole('button')); fireEvent.change(screen.getByRole('textbox'), { target: { value: '1234' }, }); fireEvent.click(screen.getByRole('button')); expect( (screen.getAllByRole('textbox')[0] as HTMLInputElement).value, ).toEqual(''); }); 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 { prepend } = useFieldArray({ control, name: 'test' }); return { formState, prepend }; }); result.current.formState.isValid; await act(async () => { result.current.prepend({ 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 { prepend } = useFieldArray({ control, name: 'test' }); return { formState, prepend }; }); act(() => { result.current.prepend({ 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, prepend } = useFieldArray({ control, name: 'test', }); return (
{fields.map((field, index) => { return ; })}

{JSON.stringify(data)}

); }; render(); fireEvent.click(screen.getByRole('button', { name: 'prepend' })); fireEvent.click(screen.getByRole('button', { name: 'submit' })); expect( await screen.findByText( '{"test":[{"id":"whatever","test":"1234"},{"id":"1234","test":"data"}]}', ), ).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, prepend } = useFieldArray({ control, name: 'test', }); return (
{fields.map((field, index) => { return ; })}

{JSON.stringify(data)}

); }; render(); fireEvent.click(screen.getByRole('button', { name: 'prepend' })); fireEvent.click(screen.getByRole('button', { name: 'submit' })); expect( await screen.findByText('{"test":[{"id":"whatever","test":"1234"}]}'), ).toBeVisible(); }); });