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

mutationCache.ts

130 lines3.3 KB

1import type { MutationOptions } from './types'
2import type { QueryClient } from './queryClient'
3import { notifyManager } from './notifyManager'
4import { Mutation, MutationState } from './mutation'
5import { matchMutation, MutationFilters, noop } from './utils'
6import { Subscribable } from './subscribable'
7​
8// TYPES
9​
10interface MutationCacheConfig {
11 onError?: (
12 error: unknown,
13 variables: unknown,
14 context: unknown,
15 mutation: Mutation<unknown, unknown, unknown, unknown>
16 ) => void
17 onSuccess?: (
18 data: unknown,
19 variables: unknown,
20 context: unknown,
21 mutation: Mutation<unknown, unknown, unknown, unknown>
22 ) => void
23 onMutate?: (
24 variables: unknown,
25 mutation: Mutation<unknown, unknown, unknown, unknown>
26 ) => void
28​
29type MutationCacheListener = (mutation?: Mutation) => void
30​
31// CLASS
32​
33export class MutationCache extends Subscribable<MutationCacheListener> {
34 config: MutationCacheConfig
35​
36 private mutations: Mutation<any, any, any, any>[]
37 private mutationId: number
38​
39 constructor(config?: MutationCacheConfig) {
40 super()
41 this.config = config || {}
42 this.mutations = []
43 this.mutationId = 0
44 }
45​
46 build<TData, TError, TVariables, TContext>(
47 client: QueryClient,
48 options: MutationOptions<TData, TError, TVariables, TContext>,
49 state?: MutationState<TData, TError, TVariables, TContext>
50 ): Mutation<TData, TError, TVariables, TContext> {
51 const mutation = new Mutation({
52 mutationCache: this,
53 mutationId: ++this.mutationId,
54 options: client.defaultMutationOptions(options),
55 state,
56 defaultOptions: options.mutationKey
57 ? client.getMutationDefaults(options.mutationKey)
58 : undefined,
59 meta: options.meta,
60 })
61​
62 this.add(mutation)
63​
64 return mutation
65 }
66​
67 add(mutation: Mutation<any, any, any, any>): void {
68 this.mutations.push(mutation)
69 this.notify(mutation)
70 }
71​
72 remove(mutation: Mutation<any, any, any, any>): void {
73 this.mutations = this.mutations.filter(x => x !== mutation)
74 mutation.cancel()
75 this.notify(mutation)
76 }
77​
78 clear(): void {
79 notifyManager.batch(() => {
80 this.mutations.forEach(mutation => {
81 this.remove(mutation)
82 })
83 })
84 }
85​
86 getAll(): Mutation[] {
87 return this.mutations
88 }
89​
90 find<TData = unknown, TError = unknown, TVariables = any, TContext = unknown>(
91 filters: MutationFilters
92 ): Mutation<TData, TError, TVariables, TContext> | undefined {
93 if (typeof filters.exact === 'undefined') {
94 filters.exact = true
95 }
96​
97 return this.mutations.find(mutation => matchMutation(filters, mutation))
98 }
99​
100 findAll(filters: MutationFilters): Mutation[] {
101 return this.mutations.filter(mutation => matchMutation(filters, mutation))
102 }
103​
104 notify(mutation?: Mutation<any, any, any, any>) {
105 notifyManager.batch(() => {
106 this.listeners.forEach(listener => {
107 listener(mutation)
108 })
109 })
110 }
111​
112 onFocus(): void {
113 this.resumePausedMutations()
114 }
115​
116 onOnline(): void {
117 this.resumePausedMutations()
118 }
119​
120 resumePausedMutations(): Promise<void> {
121 const pausedMutations = this.mutations.filter(x => x.state.isPaused)
122 return notifyManager.batch(() =>
123 pausedMutations.reduce(
124 (promise, mutation) =>
125 promise.then(() => mutation.continue().catch(noop)),
126 Promise.resolve()
127 )
128 )
129 }