Open History to see the last commit
1'use client'
2import * as React from 'react'
3β
4import { isServer, notifyManager } from '@tanstack/query-core'
5import { useQueryClient } from './QueryClientProvider'
6import { useQueryErrorResetBoundary } from './QueryErrorResetBoundary'
7import {
8 ensurePreventErrorBoundaryRetry,
9 getHasError,
10 useClearResetErrorBoundary,
11} from './errorBoundaryUtils'
12import { useIsRestoring } from './isRestoring'
13import {
14 ensureSuspenseTimers,
15 fetchOptimistic,
16 shouldSuspend,
17 willFetch,
18} from './suspense'
19import { noop } from './utils'
20import type {
21 QueryClient,
22 QueryKey,
23 QueryObserver,
24 QueryObserverResult,
25} from '@tanstack/query-core'
26import type { UseBaseQueryOptions } from './types'
27β
28export function useBaseQuery<
29 TQueryFnData,
30 TError,
31 TData,
32 TQueryData,
33 TQueryKey extends QueryKey,
34>(
35 options: UseBaseQueryOptions<
36 TQueryFnData,
37 TError,
38 TData,
39 TQueryData,
40 TQueryKey
41 >,
42 Observer: typeof QueryObserver,
43 queryClient?: QueryClient,
44): QueryObserverResult<TData, TError> {
45 if (process.env.NODE_ENV !== 'production') {
46 if (typeof options !== 'object' || Array.isArray(options)) {
47 throw new Error(
48 'Bad argument type. Starting with v5, only the "Object" form is allowed when calling query related functions. Please use the error stack to find the culprit call. More info here: https://tanstack.com/query/latest/docs/react/guides/migrating-to-v5#supports-a-single-signature-one-object',
49 )
50 }
51 }
52β
53 const client = useQueryClient(queryClient)
54 const isRestoring = useIsRestoring()
55 const errorResetBoundary = useQueryErrorResetBoundary()
56 const defaultedOptions = client.defaultQueryOptions(options)
57β
58 ;(client.getDefaultOptions().queries as any)?._experimental_beforeQuery?.(
59 defaultedOptions,
60 )
61β
62 if (process.env.NODE_ENV !== 'production') {
63 if (!defaultedOptions.queryFn) {
64 console.error(
65 `[${defaultedOptions.queryHash}]: No queryFn was passed as an option, and no default queryFn was found. The queryFn parameter is only optional when using a default queryFn. More info here: https://tanstack.com/query/latest/docs/framework/react/guides/default-query-function`,
66 )
67 }
68 }
69β
70 // Make sure results are optimistically set in fetching state before subscribing or updating options
71 defaultedOptions._optimisticResults = isRestoring
72 ? 'isRestoring'
73 : 'optimistic'
74β
75 ensureSuspenseTimers(defaultedOptions)
76 ensurePreventErrorBoundaryRetry(defaultedOptions, errorResetBoundary)
77β
78 useClearResetErrorBoundary(errorResetBoundary)
79β
80 // this needs to be invoked before creating the Observer because that can create a cache entry
81 const isNewCacheEntry = !client
82 .getQueryCache()
83 .get(defaultedOptions.queryHash)
84β
85 const [observer] = React.useState(
86 () =>
87 new Observer<TQueryFnData, TError, TData, TQueryData, TQueryKey>(
88 client,
89 defaultedOptions,
90 ),
91 )
92β
93 // note: this must be called before useSyncExternalStore
94 const result = observer.getOptimisticResult(defaultedOptions)
95β
96 const shouldSubscribe = !isRestoring && options.subscribed !== false
97 React.useSyncExternalStore(
98 React.useCallback(
99 (onStoreChange) => {
100 const unsubscribe = shouldSubscribe
101 ? observer.subscribe(notifyManager.batchCalls(onStoreChange))
102 : noop
103β
104 // Update result to make sure we did not miss any query updates
105 // between creating the observer and subscribing to it.
106 observer.updateResult()
107β
108 return unsubscribe
109 },
110 [observer, shouldSubscribe],
111 ),
112 () => observer.getCurrentResult(),
113 () => observer.getCurrentResult(),
114 )
115β
116 React.useEffect(() => {
117 observer.setOptions(defaultedOptions)
118 }, [defaultedOptions, observer])
119β
120 // Handle suspense
121 if (shouldSuspend(defaultedOptions, result)) {
122 throw fetchOptimistic(defaultedOptions, observer, errorResetBoundary)
123 }
124β
125 // Handle error boundary
126 if (
127 getHasError({
128 result,
129 errorResetBoundary,
130 throwOnError: defaultedOptions.throwOnError,
131 query: client
132 .getQueryCache()
133 .get<
134 TQueryFnData,
135 TError,
136 TQueryData,
137 TQueryKey
138 >(defaultedOptions.queryHash),
139 suspense: defaultedOptions.suspense,
140 })
141 ) {
142 throw result.error
143 }
144β
145 ;(client.getDefaultOptions().queries as any)?._experimental_afterQuery?.(
146 defaultedOptions,
147 result,
148 )
149β
150 if (
151 defaultedOptions.experimental_prefetchInRender &&
152 !isServer &&
153 willFetch(result, isRestoring)
154 ) {
155 const promise = isNewCacheEntry
156 ? // Fetch immediately on render in order to ensure `.promise` is resolved even if the component is unmounted
157 fetchOptimistic(defaultedOptions, observer, errorResetBoundary)
158 : // subscribe to the "cache promise" so that we can finalize the currentThenable once data comes in
159 client.getQueryCache().get(defaultedOptions.queryHash)?.promise
160β
161 promise?.catch(noop).finally(() => {
162 // `.updateResult()` will trigger `.#currentThenable` to finalize
163 observer.updateResult()
164 })
165 }
166β
167 // Handle result property usage tracking
168 return !defaultedOptions.notifyOnChangeProps
169 ? observer.trackResult(result)
170 : result
171}