@tanstack/query-core 4.24.10 → 5.0.0-alpha.1

package/src/queryCache.ts

@@ -1,8 +1,14 @@
 import type { QueryFilters } from './utils'
-import { hashQueryKeyByOptions, matchQuery, parseFilterArgs } from './utils'
+import { hashQueryKeyByOptions, matchQuery } from './utils'
 import type { Action, QueryState } from './query'
 import { Query } from './query'
-import type { NotifyEvent, QueryKey, QueryOptions } from './types'
+import type {
+  NotifyEvent,
+  QueryKey,
+  QueryOptions,
+  RegisteredError,
+  WithRequired,
+} from './types'
 import { notifyManager } from './notifyManager'
 import type { QueryClient } from './queryClient'
 import { Subscribable } from './subscribable'
@@ -13,10 +19,7 @@ import type { QueryObserver } from './queryObserver'
 interface QueryCacheConfig {
   onError?: (error: unknown, query: Query<unknown, unknown, unknown>) => void
   onSuccess?: (data: unknown, query: Query<unknown, unknown, unknown>) => void
-}
-
-interface QueryHashMap {
-  [hash: string]: Query<any, any, any, any>
+  createStore?: () => QueryStore
 }
 
 interface NotifyEventQueryAdded extends NotifyEvent {
@@ -69,19 +72,22 @@ type QueryCacheNotifyEvent =
 
 type QueryCacheListener = (event: QueryCacheNotifyEvent) => void
 
+export interface QueryStore {
+  has: (queryKey: string) => boolean
+  set: (queryKey: string, query: Query) => void
+  get: (queryKey: string) => Query | undefined
+  delete: (queryKey: string) => void
+  values: () => IterableIterator<Query>
+}
+
 // CLASS
 
 export class QueryCache extends Subscribable<QueryCacheListener> {
-  config: QueryCacheConfig
+  #queries: QueryStore
 
-  private queries: Query<any, any, any, any>[]
-  private queriesMap: QueryHashMap
-
-  constructor(config?: QueryCacheConfig) {
+  constructor(public config: QueryCacheConfig = {}) {
     super()
-    this.config = config || {}
-    this.queries = []
-    this.queriesMap = {}
+    this.#queries = config.createStore?.() ?? new Map<string, Query>()
   }
 
   build<TQueryFnData, TError, TData, TQueryKey extends QueryKey>(
@@ -97,7 +103,6 @@ export class QueryCache extends Subscribable<QueryCacheListener> {
     if (!query) {
       query = new Query({
         cache: this,
-        logger: client.getLogger(),
         queryKey,
         queryHash,
         options: client.defaultQueryOptions(options),
@@ -111,9 +116,9 @@ export class QueryCache extends Subscribable<QueryCacheListener> {
   }
 
   add(query: Query<any, any, any, any>): void {
-    if (!this.queriesMap[query.queryHash]) {
-      this.queriesMap[query.queryHash] = query
-      this.queries.push(query)
+    if (!this.#queries.has(query.queryHash)) {
+      this.#queries.set(query.queryHash, query)
+
       this.notify({
         type: 'added',
         query,
@@ -122,15 +127,13 @@ export class QueryCache extends Subscribable<QueryCacheListener> {
   }
 
   remove(query: Query<any, any, any, any>): void {
-    const queryInMap = this.queriesMap[query.queryHash]
+    const queryInMap = this.#queries.get(query.queryHash)
 
     if (queryInMap) {
       query.destroy()
 
-      this.queries = this.queries.filter((x) => x !== query)
-
       if (queryInMap === query) {
-        delete this.queriesMap[query.queryHash]
+        this.#queries.delete(query.queryHash)
       }
 
       this.notify({ type: 'removed', query })
@@ -139,7 +142,7 @@ export class QueryCache extends Subscribable<QueryCacheListener> {
 
   clear(): void {
     notifyManager.batch(() => {
-      this.queries.forEach((query) => {
+      this.getAll().forEach((query) => {
         this.remove(query)
       })
     })
@@ -147,40 +150,38 @@ export class QueryCache extends Subscribable<QueryCacheListener> {
 
   get<
     TQueryFnData = unknown,
-    TError = unknown,
+    TError = RegisteredError,
     TData = TQueryFnData,
     TQueryKey extends QueryKey = QueryKey,
   >(
     queryHash: string,
   ): Query<TQueryFnData, TError, TData, TQueryKey> | undefined {
-    return this.queriesMap[queryHash]
+    return this.#queries.get(queryHash) as
+      | Query<TQueryFnData, TError, TData, TQueryKey>
+      | undefined
   }
 
   getAll(): Query[] {
-    return this.queries
+    return [...this.#queries.values()]
   }
 
-  find<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData>(
-    arg1: QueryKey,
-    arg2?: QueryFilters,
+  find<TQueryFnData = unknown, TError = RegisteredError, TData = TQueryFnData>(
+    filters: WithRequired<QueryFilters, 'queryKey'>,
   ): Query<TQueryFnData, TError, TData> | undefined {
-    const [filters] = parseFilterArgs(arg1, arg2)
-
     if (typeof filters.exact === 'undefined') {
       filters.exact = true
     }
 
-    return this.queries.find((query) => matchQuery(filters, query))
+    return this.getAll().find((query) => matchQuery(filters, query)) as
+      | Query<TQueryFnData, TError, TData>
+      | undefined
   }
 
-  findAll(queryKey?: QueryKey, filters?: QueryFilters): Query[]
-  findAll(filters?: QueryFilters): Query[]
-  findAll(arg1?: QueryKey | QueryFilters, arg2?: QueryFilters): Query[]
-  findAll(arg1?: QueryKey | QueryFilters, arg2?: QueryFilters): Query[] {
-    const [filters] = parseFilterArgs(arg1, arg2)
+  findAll(filters: QueryFilters = {}): Query[] {
+    const queries = this.getAll()
     return Object.keys(filters).length > 0
-      ? this.queries.filter((query) => matchQuery(filters, query))
-      : this.queries
+      ? queries.filter((query) => matchQuery(filters, query))
+      : queries
   }
 
   notify(event: QueryCacheNotifyEvent) {
@@ -193,7 +194,7 @@ export class QueryCache extends Subscribable<QueryCacheListener> {
 
   onFocus(): void {
     notifyManager.batch(() => {
-      this.queries.forEach((query) => {
+      this.getAll().forEach((query) => {
         query.onFocus()
       })
     })
@@ -201,7 +202,7 @@ export class QueryCache extends Subscribable<QueryCacheListener> {
 
   onOnline(): void {
     notifyManager.batch(() => {
-      this.queries.forEach((query) => {
+      this.getAll().forEach((query) => {
         query.onOnline()
       })
     })