Open History to see the last commit
1import { getDefaultState } from './mutation'
2import { notifyManager } from './notifyManager'
3import { Subscribable } from './subscribable'
4import { hashKey, shallowEqualObjects } from './utils'
5import type { QueryClient } from './queryClient'
6import type {
7 DefaultError,
8 MutateOptions,
9 MutationObserverOptions,
10 MutationObserverResult,
11} from './types'
12import type { Action, Mutation } from './mutation'
13β
14// TYPES
15β
16type MutationObserverListener<TData, TError, TVariables, TContext> = (
17 result: MutationObserverResult<TData, TError, TVariables, TContext>,
18) => void
19β
20// CLASS
21β
22export class MutationObserver<
23 TData = unknown,
24 TError = DefaultError,
25 TVariables = void,
26 TContext = unknown,
27> extends Subscribable<
28 MutationObserverListener<TData, TError, TVariables, TContext>
29> {
30 options!: MutationObserverOptions<TData, TError, TVariables, TContext>
31β
32 #client: QueryClient
33 #currentResult: MutationObserverResult<TData, TError, TVariables, TContext> =
34 undefined!
35 #currentMutation?: Mutation<TData, TError, TVariables, TContext>
36 #mutateOptions?: MutateOptions<TData, TError, TVariables, TContext>
37β
38 constructor(
39 client: QueryClient,
40 options: MutationObserverOptions<TData, TError, TVariables, TContext>,
41 ) {
42 super()
43β
44 this.#client = client
45 this.setOptions(options)
46 this.bindMethods()
47 this.#updateResult()
48 }
49β
50 protected bindMethods(): void {
51 this.mutate = this.mutate.bind(this)
52 this.reset = this.reset.bind(this)
53 }
54β
55 setOptions(
56 options: MutationObserverOptions<TData, TError, TVariables, TContext>,
57 ) {
58 const prevOptions = this.options as
59 | MutationObserverOptions<TData, TError, TVariables, TContext>
60 | undefined
61 this.options = this.#client.defaultMutationOptions(options)
62 if (!shallowEqualObjects(this.options, prevOptions)) {
63 this.#client.getMutationCache().notify({
64 type: 'observerOptionsUpdated',
65 mutation: this.#currentMutation,
66 observer: this,
67 })
68 }
69β
70 if (
71 prevOptions?.mutationKey &&
72 this.options.mutationKey &&
73 hashKey(prevOptions.mutationKey) !== hashKey(this.options.mutationKey)
74 ) {
75 this.reset()
76 } else if (this.#currentMutation?.state.status === 'pending') {
77 this.#currentMutation.setOptions(this.options)
78 }
79 }
80β
81 protected onUnsubscribe(): void {
82 if (!this.hasListeners()) {
83 this.#currentMutation?.removeObserver(this)
84 }
85 }
86β
87 onMutationUpdate(action: Action<TData, TError, TVariables, TContext>): void {
88 this.#updateResult()
89β
90 this.#notify(action)
91 }
92β
93 getCurrentResult(): MutationObserverResult<
94 TData,
95 TError,
96 TVariables,
97 TContext
98 > {
99 return this.#currentResult
100 }
101β
102 reset(): void {
103 // reset needs to remove the observer from the mutation because there is no way to "get it back"
104 // another mutate call will yield a new mutation!
105 this.#currentMutation?.removeObserver(this)
106 this.#currentMutation = undefined
107 this.#updateResult()
108 this.#notify()
109 }
110β
111 mutate(
112 variables: TVariables,
113 options?: MutateOptions<TData, TError, TVariables, TContext>,
114 ): Promise<TData> {
115 this.#mutateOptions = options
116β
117 this.#currentMutation?.removeObserver(this)
118β
119 this.#currentMutation = this.#client
120 .getMutationCache()
121 .build(this.#client, this.options)
122β
123 this.#currentMutation.addObserver(this)
124β
125 return this.#currentMutation.execute(variables)
126 }
127β
128 #updateResult(): void {
129 const state =
130 this.#currentMutation?.state ??
131 getDefaultState<TData, TError, TVariables, TContext>()
132β
133 this.#currentResult = {
134 ...state,
135 isPending: state.status === 'pending',
136 isSuccess: state.status === 'success',
137 isError: state.status === 'error',
138 isIdle: state.status === 'idle',
139 mutate: this.mutate,
140 reset: this.reset,
141 } as MutationObserverResult<TData, TError, TVariables, TContext>
142 }
143β
144 #notify(action?: Action<TData, TError, TVariables, TContext>): void {
145 notifyManager.batch(() => {
146 // First trigger the mutate callbacks
147 if (this.#mutateOptions && this.hasListeners()) {
148 const variables = this.#currentResult.variables!
149 const context = this.#currentResult.context
150β
151 if (action?.type === 'success') {
152 this.#mutateOptions.onSuccess?.(action.data, variables, context!)
153 this.#mutateOptions.onSettled?.(action.data, null, variables, context)
154 } else if (action?.type === 'error') {
155 this.#mutateOptions.onError?.(action.error, variables, context)
156 this.#mutateOptions.onSettled?.(
157 undefined,
158 action.error,
159 variables,
160 context,
161 )
162 }
163 }
164β
165 // Then trigger the listeners
166 this.listeners.forEach((listener) => {
167 listener(this.#currentResult)
168 })
169 })
170 }
171}