Open History to see the last commit
1import { InternalFormApi } from '@tanstack/form-core/internals'
2import { describe, expect, it, vi } from 'vitest'
3import { createFieldsController } from '../src/bridge/fields'
4import { createMountedFormsController } from '../src/bridge/forms/mountedForms'
5import { formDevtoolsEventClient } from '../src/eventClient.lib'
6import { connectTestEventBus } from './testEventBus'
7import type { DevtoolsFieldDetail } from '../src/eventClientTypes'
8import type { FieldId } from '../src/types/branded'
9β
10describe('field actions bridge', () => {
11 it('runs change, blur, and reset actions on an unmounted field', () => {
12 const disconnectEventBus = connectTestEventBus()
13 const mountedForms = createMountedFormsController()
14 const fields = createFieldsController(mountedForms)
15 const changeListener = vi.fn()
16 const blurListener = vi.fn()
17 const details: Array<DevtoolsFieldDetail> = []
18 const cleanupDetails = formDevtoolsEventClient.on(
19 'field-detail-changed',
20 (event) => details.push(event.payload),
21 )
22 const form = new InternalFormApi({ defaultValues: { name: 'Ada' } })
23 const field = form._getOrCreateFieldApi({
24 name: 'name',
25 listeners: [
26 { triggers: ['change'], run: changeListener },
27 { triggers: ['blur'], run: blurListener },
28 ],
29 })
30β
31 try {
32 mountedForms.mountForm(form)
33 const formInstanceId =
34 mountedForms.getMountedFormsSnapshot()[0]!.instanceId
35 const fieldId = fields.getFieldRowsSnapshot(form)[0]!.fieldId
36 const request = { formInstanceId, fieldId }
37 formDevtoolsEventClient.emit('field-detail-subscribe', {
38 ...request,
39 settings: {
40 includeValues: true,
41 errorPayloadMode: 'full',
42 debounceMs: 0,
43 },
44 })
45β
46 expect(field._isMounted).toBe(false)
47β
48 formDevtoolsEventClient.emit('field-handle-change-request', request)
49 expect(changeListener).toHaveBeenCalledOnce()
50 expect(field.value).toBe('Ada')
51β
52 formDevtoolsEventClient.emit('field-handle-blur-request', request)
53 expect(blurListener).toHaveBeenCalledOnce()
54 expect(field.meta).toMatchObject({
55 isTouched: true,
56 isBlurred: true,
57 })
58β
59 field.handleChange('Grace')
60 changeListener.mockClear()
61 formDevtoolsEventClient.emit('field-reset-request', request)
62 expect(changeListener).not.toHaveBeenCalled()
63 expect(field.value).toBe('Ada')
64 expect(field.meta).toMatchObject({
65 isTouched: false,
66 isDirty: false,
67 isBlurred: false,
68 })
69 expect(details.at(-1)?.state.meta).toMatchObject({
70 isTouched: false,
71 isDirty: false,
72 isBlurred: false,
73 })
74 expect(field._isMounted).toBe(false)
75 } finally {
76 cleanupDetails()
77 fields.dispose()
78 mountedForms.dispose()
79 disconnectEventBus()
80 }
81 })
82β
83 it('ignores invalid targets and stops handling requests after disposal', () => {
84 const disconnectEventBus = connectTestEventBus()
85 const mountedForms = createMountedFormsController()
86 const fields = createFieldsController(mountedForms)
87 const firstForm = new InternalFormApi({ defaultValues: { name: '' } })
88 const secondForm = new InternalFormApi({ defaultValues: { name: '' } })
89 const firstField = firstForm._getOrCreateFieldApi({ name: 'name' })
90 const secondField = secondForm._getOrCreateFieldApi({ name: 'name' })
91 const firstBlur = vi.spyOn(firstField, 'handleBlur')
92 const secondBlur = vi.spyOn(secondField, 'handleBlur')
93β
94 mountedForms.mountForm(firstForm)
95 mountedForms.mountForm(secondForm)
96 const [firstMountedForm, secondMountedForm] =
97 mountedForms.getMountedFormsSnapshot()
98 const firstFieldId = fields.getFieldRowsSnapshot(firstForm)[0]!.fieldId
99 const secondFieldId = fields.getFieldRowsSnapshot(secondForm)[0]!.fieldId
100β
101 formDevtoolsEventClient.emit('field-handle-blur-request', {
102 formInstanceId: secondMountedForm!.instanceId,
103 fieldId: firstFieldId,
104 })
105 formDevtoolsEventClient.emit('field-handle-blur-request', {
106 formInstanceId: firstMountedForm!.instanceId,
107 fieldId: 'missing-field' as FieldId,
108 })
109 firstField._kill()
110 formDevtoolsEventClient.emit('field-handle-blur-request', {
111 formInstanceId: firstMountedForm!.instanceId,
112 fieldId: firstFieldId,
113 })
114β
115 expect(firstBlur).not.toHaveBeenCalled()
116 expect(secondBlur).not.toHaveBeenCalled()
117β
118 fields.dispose()
119 formDevtoolsEventClient.emit('field-handle-blur-request', {
120 formInstanceId: secondMountedForm!.instanceId,
121 fieldId: secondFieldId,
122 })
123 expect(secondBlur).not.toHaveBeenCalled()
124β
125 mountedForms.dispose()
126 disconnectEventBus()
127 })
128})