Open History to see the last commit
1import {
2 QueryFilters,
3 hashQueryKeyByOptions,
4 matchQuery,
5 parseFilterArgs,
6} from './utils'
7import { Action, Query, QueryState } from './query'
8import type { QueryKey, QueryOptions } from './types'
9import { notifyManager } from './notifyManager'
10import type { QueryClient } from './queryClient'
11import { Subscribable } from './subscribable'
12import { QueryObserver } from './queryObserver'
13β
14// TYPES
15β
16interface QueryCacheConfig {
17 onError?: (error: unknown, query: Query<unknown, unknown, unknown>) => void
18 onSuccess?: (data: unknown, query: Query<unknown, unknown, unknown>) => void
19}
20β
21interface QueryHashMap {
22 [hash: string]: Query<any, any, any, any>
23}
24β
25interface NotifyEventQueryAdded {
26 type: 'queryAdded'
27 query: Query<any, any, any, any>
28}
29β
30interface NotifyEventQueryRemoved {
31 type: 'queryRemoved'
32 query: Query<any, any, any, any>
33}
34β
35interface NotifyEventQueryUpdated {
36 type: 'queryUpdated'
37 query: Query<any, any, any, any>
38 action: Action<any, any>
39}
40β
41interface NotifyEventObserverAdded {
42 type: 'observerAdded'
43 query: Query<any, any, any, any>
44 observer: QueryObserver<any, any, any, any, any>
45}
46β
47interface NotifyEventObserverRemoved {
48 type: 'observerRemoved'
49 query: Query<any, any, any, any>
50 observer: QueryObserver<any, any, any, any, any>
51}
52β
53interface NotifyEventObserverResultsUpdated {
54 type: 'observerResultsUpdated'
55 query: Query<any, any, any, any>
56}
57β
58type QueryCacheNotifyEvent =
59 | NotifyEventQueryAdded
60 | NotifyEventQueryRemoved
61 | NotifyEventQueryUpdated
62 | NotifyEventObserverAdded
63 | NotifyEventObserverRemoved
64 | NotifyEventObserverResultsUpdated
65β
66type QueryCacheListener = (event?: QueryCacheNotifyEvent) => void
67β
68// CLASS
69β
70export class QueryCache extends Subscribable<QueryCacheListener> {
71 config: QueryCacheConfig
72β
73 private queries: Query<any, any, any, any>[]
74 private queriesMap: QueryHashMap
75β
76 constructor(config?: QueryCacheConfig) {
77 super()
78 this.config = config || {}
79 this.queries = []
80 this.queriesMap = {}
81 }
82β
83 build<TQueryFnData, TError, TData, TQueryKey extends QueryKey>(
84 client: QueryClient,
85 options: QueryOptions<TQueryFnData, TError, TData, TQueryKey>,
86 state?: QueryState<TData, TError>
87 ): Query<TQueryFnData, TError, TData, TQueryKey> {
88 const queryKey = options.queryKey!
89 const queryHash =
90 options.queryHash ?? hashQueryKeyByOptions(queryKey, options)
91 let query = this.get<TQueryFnData, TError, TData, TQueryKey>(queryHash)
92β
93 if (!query) {
94 query = new Query({
95 cache: this,
96 queryKey,
97 queryHash,
98 options: client.defaultQueryOptions(options),
99 state,
100 defaultOptions: client.getQueryDefaults(queryKey),
101 meta: options.meta,
102 })
103 this.add(query)
104 }
105β
106 return query
107 }
108β
109 add(query: Query<any, any, any, any>): void {
110 if (!this.queriesMap[query.queryHash]) {
111 this.queriesMap[query.queryHash] = query
112 this.queries.push(query)
113 this.notify({
114 type: 'queryAdded',
115 query,
116 })
117 }
118 }
119β
120 remove(query: Query<any, any, any, any>): void {
121 const queryInMap = this.queriesMap[query.queryHash]
122β
123 if (queryInMap) {
124 query.destroy()
125β
126 this.queries = this.queries.filter(x => x !== query)
127β
128 if (queryInMap === query) {
129 delete this.queriesMap[query.queryHash]
130 }
131β
132 this.notify({ type: 'queryRemoved', query })
133 }
134 }
135β
136 clear(): void {
137 notifyManager.batch(() => {
138 this.queries.forEach(query => {
139 this.remove(query)
140 })
141 })
142 }
143β
144 get<
145 TQueryFnData = unknown,
146 TError = unknown,
147 TData = TQueryFnData,
148 TQueyKey extends QueryKey = QueryKey
149 >(
150 queryHash: string
151 ): Query<TQueryFnData, TError, TData, TQueyKey> | undefined {
152 return this.queriesMap[queryHash]
153 }
154β
155 getAll(): Query[] {
156 return this.queries
157 }
158β
159 find<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData>(
160 arg1: QueryKey,
161 arg2?: QueryFilters
162 ): Query<TQueryFnData, TError, TData> | undefined {
163 const [filters] = parseFilterArgs(arg1, arg2)
164β
165 if (typeof filters.exact === 'undefined') {
166 filters.exact = true
167 }
168β
169 return this.queries.find(query => matchQuery(filters, query))
170 }
171β
172 findAll(queryKey?: QueryKey, filters?: QueryFilters): Query[]
173 findAll(filters?: QueryFilters): Query[]
174 findAll(arg1?: QueryKey | QueryFilters, arg2?: QueryFilters): Query[]
175 findAll(arg1?: QueryKey | QueryFilters, arg2?: QueryFilters): Query[] {
176 const [filters] = parseFilterArgs(arg1, arg2)
177 return Object.keys(filters).length > 0
178 ? this.queries.filter(query => matchQuery(filters, query))
179 : this.queries
180 }
181β
182 notify(event: QueryCacheNotifyEvent) {
183 notifyManager.batch(() => {
184 this.listeners.forEach(listener => {
185 listener(event)
186 })
187 })
188 }
189β
190 onFocus(): void {
191 notifyManager.batch(() => {
192 this.queries.forEach(query => {
193 query.onFocus()
194 })
195 })
196 }
197β
198 onOnline(): void {
199 notifyManager.batch(() => {
200 this.queries.forEach(query => {
201 query.onOnline()
202 })
203 })
204 }
205}