Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

details.ts

218 lines6.1 KB

1import { LiteDebouncer } from '@tanstack/pacer-lite'
2import { formDevtoolsEventClient } from '../../eventClient.lib'
3import { getDevtoolsFieldDetail } from './detailSnapshot'
4import type {
5 AnyInternalFieldApi,
6 InternalFieldMeta,
7} from '@tanstack/form-core/internals'
8import type {
9 FieldDetailSettings,
10 FieldDetailSubscriptionDescriptor,
11} from '../../eventClientTypes'
12import type { FormId } from '../../types/branded'
13import type { MountedFormsController } from '../forms/mountedForms'
14import type { FieldIdentityController } from './identity'
15​
16interface ActiveFieldDetailSubscription {
17 descriptor: FieldDetailSubscriptionDescriptor
18 field: AnyInternalFieldApi
19 atomSubscription: { unsubscribe: () => void }
20 debouncer: LiteDebouncer<() => void>
21 lastObservedMeta: InternalFieldMeta
23​
24interface FieldDetailsController {
25 dispose: () => void
26 fieldsUpdated: (fields: Iterable<AnyInternalFieldApi>) => void
27 fieldSubtreeRemoved: (fields: Array<AnyInternalFieldApi>) => void
28 formUnmounted: (formInstanceId: FormId) => void
30​
31function getSubscriptionKey({
32 formInstanceId,
33 fieldId,
34}: FieldDetailSubscriptionDescriptor): string {
35 return `${formInstanceId}\0${fieldId}`
37​
38function areSettingsEqual(
39 left: FieldDetailSettings,
40 right: FieldDetailSettings,
41): boolean {
42 return (
43 left.includeValues === right.includeValues &&
44 left.errorPayloadMode === right.errorPayloadMode &&
45 left.debounceMs === right.debounceMs
46 )
48​
49function areDescriptorsEqual(
50 left: FieldDetailSubscriptionDescriptor,
51 right: FieldDetailSubscriptionDescriptor,
52): boolean {
53 return (
54 left.formInstanceId === right.formInstanceId &&
55 left.fieldId === right.fieldId &&
56 areSettingsEqual(left.settings, right.settings)
57 )
59​
60export function createFieldDetailsController({
61 identity,
62 mountedForms,
63}: {
64 identity: FieldIdentityController
65 mountedForms: MountedFormsController
66}): FieldDetailsController {
67 const subscriptions = new Map<string, ActiveFieldDetailSubscription>()
68 let disposed = false
69​
70 const removeSubscription = (key: string): void => {
71 const subscription = subscriptions.get(key)
72 if (!subscription) return
73​
74 subscriptions.delete(key)
75 subscription.atomSubscription.unsubscribe()
76 subscription.debouncer.cancel()
77 }
78​
79 const emitDetail = (subscription: ActiveFieldDetailSubscription): void => {
80 if (disposed) return
81​
82 const key = getSubscriptionKey(subscription.descriptor)
83 if (subscriptions.get(key) !== subscription) return
84​
85 const form = mountedForms.getMountedForm(
86 subscription.descriptor.formInstanceId,
87 )
88 if (
89 !form ||
90 subscription.field.form !== form ||
91 subscription.field._isKilled
92 ) {
93 removeSubscription(key)
94 return
95 }
96​
97 formDevtoolsEventClient.emit(
98 'field-detail-changed',
99 getDevtoolsFieldDetail(
100 subscription.field,
101 subscription.descriptor,
102 identity,
103 ),
104 )
105 }
106​
107 const scheduleDetail = (
108 subscription: ActiveFieldDetailSubscription,
109 ): void => {
110 if (subscription.descriptor.settings.debounceMs <= 0) {
111 emitDetail(subscription)
112 } else {
113 subscription.debouncer.maybeExecute()
114 }
115 }
116​
117 const subscribe = (descriptor: FieldDetailSubscriptionDescriptor): void => {
118 if (disposed) return
119​
120 const key = getSubscriptionKey(descriptor)
121 const existing = subscriptions.get(key)
122 const form = mountedForms.getMountedForm(descriptor.formInstanceId)
123 const field = identity.getField(descriptor.fieldId)
124​
125 if (!form || !field || field.form !== form || field._isKilled) {
126 removeSubscription(key)
127 return
128 }
129​
130 if (
131 existing &&
132 existing.field === field &&
133 areDescriptorsEqual(existing.descriptor, descriptor)
134 ) {
135 existing.debouncer.cancel()
136 emitDetail(existing)
137 return
138 }
139​
140 removeSubscription(key)
141​
142 const debouncer = new LiteDebouncer(() => emitDetail(subscription), {
143 wait: Math.max(0, descriptor.settings.debounceMs),
144 })
145 const initialState = field.atom.get()
146 const subscription: ActiveFieldDetailSubscription = {
147 descriptor,
148 field,
149 atomSubscription: { unsubscribe: () => {} },
150 debouncer,
151 lastObservedMeta: initialState.meta,
152 }
153 subscription.atomSubscription = field.atom.subscribe((state) => {
154 if (
155 !descriptor.settings.includeValues &&
156 state.meta === subscription.lastObservedMeta
157 ) {
158 return
159 }
160​
161 subscription.lastObservedMeta = state.meta
162 scheduleDetail(subscription)
163 })
164 subscriptions.set(key, subscription)
165 emitDetail(subscription)
166 }
167​
168 const unsubscribe = (descriptor: FieldDetailSubscriptionDescriptor): void => {
169 const key = getSubscriptionKey(descriptor)
170 const existing = subscriptions.get(key)
171 if (!existing || !areDescriptorsEqual(existing.descriptor, descriptor)) {
172 return
173 }
174​
175 removeSubscription(key)
176 }
177​
178 const cleanupSubscribeListener = formDevtoolsEventClient.on(
179 'field-detail-subscribe',
180 (event) => subscribe(event.payload),
181 )
182 const cleanupUnsubscribeListener = formDevtoolsEventClient.on(
183 'field-detail-unsubscribe',
184 (event) => unsubscribe(event.payload),
185 )
186​
187 return {
188 dispose: () => {
189 disposed = true
190 cleanupSubscribeListener()
191 cleanupUnsubscribeListener()
192 for (const key of Array.from(subscriptions.keys())) {
193 removeSubscription(key)
194 }
195 },
196 fieldsUpdated: (fields) => {
197 const updatedFields = new Set<AnyInternalFieldApi>(fields)
198 if (updatedFields.size === 0) return
199​
200 for (const subscription of subscriptions.values()) {
201 if (updatedFields.has(subscription.field)) scheduleDetail(subscription)
202 }
203 },
204 fieldSubtreeRemoved: (fields) => {
205 const removedFields = new Set(fields)
206 for (const [key, subscription] of subscriptions) {
207 if (removedFields.has(subscription.field)) removeSubscription(key)
208 }
209 },
210 formUnmounted: (formInstanceId) => {
211 for (const [key, subscription] of subscriptions) {
212 if (subscription.descriptor.formInstanceId === formInstanceId) {
213 removeSubscription(key)
214 }
215 }
216 },
217 }