aboutsummaryrefslogtreecommitdiffstats
path: root/src/utils/hooks/use-form/use-form.test.ts
blob: e2c30b5f68cda53f4297744013230540a22e2b6d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
import { describe, expect, it } from '@jest/globals';
import { act, renderHook } from '@testing-library/react';
import type { ChangeEvent, FormEvent } from 'react';
import { useForm } from './use-form';

const generateSubmitEvent = () =>
  new Event('submit', {
    bubbles: true,
    cancelable: true,
  }) as unknown as FormEvent<HTMLFormElement>;

/**
 * Generate a new change event.
 *
 * @param {string} name - The field name.
 * @param {unknown} value - The new value of the field.
 * @returns {ChangeEvent<HTMLInputElement>} The event.
 */
const generateChangeEvent = (name: string, value: unknown, type = 'text') => {
  const ev = new Event('change');
  Object.defineProperty(ev, 'target', {
    value: {
      checked: type === 'checkbox' || type === 'radio' ? value : undefined,
      name,
      type,
      value: type === 'checkbox' || type === 'radio' ? undefined : value,
    },
    writable: false,
  });

  return ev as unknown as ChangeEvent<HTMLInputElement>;
};

describe('useForm', () => {
  it('can initialize the data', () => {
    const initialValues = {
      foo: 'impedit',
      bar: 42,
    };
    const { result } = renderHook(() => useForm({ initialValues }));

    expect(result.current.values.bar).toBe(initialValues.bar);
    expect(result.current.values.foo).toBe(initialValues.foo);
  });

  it('can use a handler to validate the submit process', async () => {
    const data = {
      name: 'John',
    };
    const submitHandler = jest.fn((_data) => undefined);
    const { result } = renderHook(() =>
      useForm({
        initialValues: data,
        submitHandler,
      })
    );

    // eslint-disable-next-line @typescript-eslint/no-magic-numbers
    expect.assertions(3);

    await act(async () => {
      await result.current.submit(generateSubmitEvent());
    });

    expect(result.current.validationErrors).toBeNull();
    expect(submitHandler).toHaveBeenCalled();
    expect(result.current.submitStatus).toBe('SUCCEEDED');
  });

  it('can submit the data and reset to initial values', async () => {
    const data = {
      initial: {
        name: 'John',
      },
      new: {
        name: 'Phoebe',
      },
    };
    const { result } = renderHook(() =>
      useForm({
        initialValues: data.initial,
      })
    );

    // eslint-disable-next-line @typescript-eslint/no-magic-numbers
    expect.assertions(3);

    act(() => {
      result.current.update(generateChangeEvent('name', data.new.name));
    });

    expect(result.current.values.name).toBe(data.new.name);

    await act(async () => {
      await result.current.submit(generateSubmitEvent());
    });

    expect(result.current.submitStatus).toBe('SUCCEEDED');
    expect(result.current.values.name).toBe(data.initial.name);
  });

  it('can submit after validating the data', async () => {
    const data = {
      initial: {
        name: 'John',
      },
      new: {
        name: 'Phoebe',
      },
      errors: {
        name: 'Expect name to have at least 2 letters.',
      },
    };
    const submitHandler = jest.fn((_data) => undefined);
    const { result } = renderHook(() =>
      useForm({
        initialValues: data.initial,
        submitHandler,
        validations: {
          name: {
            error: data.errors.name,
            validator: (value) => value.length > 1,
          },
        },
      })
    );

    // eslint-disable-next-line @typescript-eslint/no-magic-numbers
    expect.assertions(4);

    act(() => {
      result.current.update(generateChangeEvent('name', data.new.name));
    });

    expect(result.current.values.name).toBe(data.new.name);

    await act(async () => {
      await result.current.submit(generateSubmitEvent());
    });

    expect(result.current.validationErrors).toBeNull();
    expect(submitHandler).toHaveBeenCalled();
    expect(result.current.submitStatus).toBe('SUCCEEDED');
  });

  it('can abort submit if data validation fails', async () => {
    const minAge = 18;
    const data = {
      initial: {
        name: 'H',
        age: 17,
      },
      errors: {
        age: `Expect age to be at least ${minAge}.`,
        name: 'Expect name to have at least 2 letters.',
      },
    };
    const submitHandler = jest.fn((_data) => undefined);
    const { result } = renderHook(() =>
      useForm({
        initialValues: data.initial,
        submitHandler,
        validations: {
          age: {
            error: data.errors.age,
            validator: (value) => value >= minAge,
          },
          name: {
            error: data.errors.name,
            validator: (value) => value.length > 1,
          },
        },
      })
    );

    // eslint-disable-next-line @typescript-eslint/no-magic-numbers
    expect.assertions(4);

    await act(async () => {
      await result.current.submit(generateSubmitEvent());
    });

    expect(result.current.validationErrors?.age).toBe(data.errors.age);
    expect(result.current.validationErrors?.name).toBe(data.errors.name);
    expect(submitHandler).not.toHaveBeenCalled();
    expect(result.current.submitStatus).toBe('FAILED');
  });

  it('can partially validate the data before submit', async () => {
    const data = {
      initial: {
        name: 'H',
        age: 17,
      },
      errors: {
        name: 'Expect name to have at least 2 letters.',
      },
    };
    const submitHandler = jest.fn((_data) => undefined);
    const { result } = renderHook(() =>
      useForm({
        initialValues: data.initial,
        submitHandler,
        validations: {
          name: {
            error: data.errors.name,
            validator: (value) => value.length > 1,
          },
        },
      })
    );

    // eslint-disable-next-line @typescript-eslint/no-magic-numbers
    expect.assertions(4);

    await act(async () => {
      await result.current.submit(generateSubmitEvent());
    });

    expect(result.current.validationErrors?.age).toBeUndefined();
    expect(result.current.validationErrors?.name).toBe(data.errors.name);
    expect(submitHandler).not.toHaveBeenCalled();
    expect(result.current.submitStatus).toBe('FAILED');
  });
});