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

mutationObserver.ts

195 lines4.7 KB

1import { Action, getDefaultState, Mutation } from './mutation'
2import { notifyManager } from './notifyManager'
3import type { QueryClient } from './queryClient'
4import { Subscribable } from './subscribable'
5import type {
6 MutateOptions,
7 MutationObserverBaseResult,
8 MutationObserverResult,
9 MutationObserverOptions,
10} from './types'
11​
12// TYPES
13​
14type MutationObserverListener<TData, TError, TVariables, TContext> = (
15 result: MutationObserverResult<TData, TError, TVariables, TContext>
16) => void
17​
18interface NotifyOptions {
19 listeners?: boolean
20 onError?: boolean
21 onSuccess?: boolean
23​
24// CLASS
25​
26export class MutationObserver<
27 TData = unknown,
28 TError = unknown,
29 TVariables = void,
30 TContext = unknown
31> extends Subscribable<
32 MutationObserverListener<TData, TError, TVariables, TContext>
33> {
34 options!: MutationObserverOptions<TData, TError, TVariables, TContext>
35​
36 private client: QueryClient
37 private currentResult!: MutationObserverResult<
38 TData,
39 TError,
40 TVariables,
41 TContext
42 >
43 private currentMutation?: Mutation<TData, TError, TVariables, TContext>
44 private mutateOptions?: MutateOptions<TData, TError, TVariables, TContext>
45​
46 constructor(
47 client: QueryClient,
48 options: MutationObserverOptions<TData, TError, TVariables, TContext>
49 ) {
50 super()
51​
52 this.client = client
53 this.setOptions(options)
54 this.bindMethods()
55 this.updateResult()
56 }
57​
58 protected bindMethods(): void {
59 this.mutate = this.mutate.bind(this)
60 this.reset = this.reset.bind(this)
61 }
62​
63 setOptions(
64 options?: MutationObserverOptions<TData, TError, TVariables, TContext>
65 ) {
66 this.options = this.client.defaultMutationOptions(options)
67 }
68​
69 protected onUnsubscribe(): void {
70 if (!this.listeners.length) {
71 this.currentMutation?.removeObserver(this)
72 }
73 }
74​
75 onMutationUpdate(action: Action<TData, TError, TVariables, TContext>): void {
76 this.updateResult()
77​
78 // Determine which callbacks to trigger
79 const notifyOptions: NotifyOptions = {
80 listeners: true,
81 }
82​
83 if (action.type === 'success') {
84 notifyOptions.onSuccess = true
85 } else if (action.type === 'error') {
86 notifyOptions.onError = true
87 }
88​
89 this.notify(notifyOptions)
90 }
91​
92 getCurrentResult(): MutationObserverResult<
93 TData,
94 TError,
95 TVariables,
96 TContext
97 > {
98 return this.currentResult
99 }
100​
101 reset(): void {
102 this.currentMutation = undefined
103 this.updateResult()
104 this.notify({ listeners: true })
105 }
106​
107 mutate(
108 variables?: TVariables,
109 options?: MutateOptions<TData, TError, TVariables, TContext>
110 ): Promise<TData> {
111 this.mutateOptions = options
112​
113 if (this.currentMutation) {
114 this.currentMutation.removeObserver(this)
115 }
116​
117 this.currentMutation = this.client.getMutationCache().build(this.client, {
118 ...this.options,
119 variables:
120 typeof variables !== 'undefined' ? variables : this.options.variables,
121 })
122​
123 this.currentMutation.addObserver(this)
124​
125 return this.currentMutation.execute()
126 }
127​
128 private updateResult(): void {
129 const state = this.currentMutation
130 ? this.currentMutation.state
131 : getDefaultState<TData, TError, TVariables, TContext>()
132​
133 const result: MutationObserverBaseResult<
134 TData,
135 TError,
136 TVariables,
137 TContext
138 > = {
139 ...state,
140 isLoading: state.status === 'loading',
141 isSuccess: state.status === 'success',
142 isError: state.status === 'error',
143 isIdle: state.status === 'idle',
144 mutate: this.mutate,
145 reset: this.reset,
146 }
147​
148 this.currentResult = result as MutationObserverResult<
149 TData,
150 TError,
151 TVariables,
152 TContext
153 >
154 }
155​
156 private notify(options: NotifyOptions) {
157 notifyManager.batch(() => {
158 // First trigger the mutate callbacks
159 if (this.mutateOptions) {
160 if (options.onSuccess) {
161 this.mutateOptions.onSuccess?.(
162 this.currentResult.data!,
163 this.currentResult.variables!,
164 this.currentResult.context!
165 )
166 this.mutateOptions.onSettled?.(
167 this.currentResult.data!,
168 null,
169 this.currentResult.variables!,
170 this.currentResult.context
171 )
172 } else if (options.onError) {
173 this.mutateOptions.onError?.(
174 this.currentResult.error!,
175 this.currentResult.variables!,
176 this.currentResult.context
177 )
178 this.mutateOptions.onSettled?.(
179 undefined,
180 this.currentResult.error,
181 this.currentResult.variables!,
182 this.currentResult.context
183 )
184 }
185 }
186​
187 // Then trigger the listeners
188 if (options.listeners) {
189 this.listeners.forEach(listener => {
190 listener(this.currentResult)
191 })
192 }
193 })
194 }