Skip to content

feat: add support for concurrent mode #1775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions docs/src/pages/guides/placeholder-query-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,12 @@ function Todos() {

### Placeholder Data as a Function

If the process for accessing a query's placeholder data is intensive or just not something you want to perform on every render, you can pass a function as the `placeholderData` value. This function will be executed only once when the query is placeholderized, saving you precious memory and/or CPU:
If the process for accessing a query's placeholder data is intensive or just not something you want to perform on every render, you can memoize the value or pass a memoized function as the `placeholderData` value:

```js
function Todos() {
const result = useQuery('todos', () => fetch('/todos'), {
placeholderData: () => {
return generateFakeTodos()
},
})
const placeholderData = useMemo(() => generateFakeTodos(), [])
const result = useQuery('todos', () => fetch('/todos'), { placeholderData })
}
```

Expand Down
13 changes: 11 additions & 2 deletions src/core/infiniteQueryObserver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import {
hasPreviousPage,
infiniteQueryBehavior,
} from './infiniteQueryBehavior'
import { Query } from './query'

type InfiniteQueryObserverListener<TData, TError> = (
result: InfiniteQueryObserverResult<TData, TError>
Expand Down Expand Up @@ -98,9 +99,17 @@ export class InfiniteQueryObserver<
})
}

protected getNewResult(): InfiniteQueryObserverResult<TData, TError> {
protected createResult(
query: Query<TQueryFnData, TError, InfiniteData<TQueryData>>,
options: InfiniteQueryObserverOptions<
TQueryFnData,
TError,
TData,
TQueryData
>
): InfiniteQueryObserverResult<TData, TError> {
const { state } = this.getCurrentQuery()
const result = super.getNewResult()
const result = super.createResult(query, options)
return {
...result,
fetchNextPage: this.fetchNextPage,
Expand Down
6 changes: 4 additions & 2 deletions src/core/mutationObserver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import type {
MutationObserverResult,
MutationObserverOptions,
} from './types'
import { getStatusProps } from './utils'

// TYPES

Expand Down Expand Up @@ -132,7 +131,10 @@ export class MutationObserver<

this.currentResult = {
...state,
...getStatusProps(state.status),
isLoading: state.status === 'loading',
isSuccess: state.status === 'success',
isError: state.status === 'error',
isIdle: state.status === 'idle',
mutate: this.mutate,
reset: this.reset,
}
Expand Down
98 changes: 64 additions & 34 deletions src/core/queriesObserver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { difference, getQueryKeyHashFn, replaceAt } from './utils'
import { notifyManager } from './notifyManager'
import type { QueryObserverOptions, QueryObserverResult } from './types'
import type { QueryClient } from './queryClient'
import { QueryObserver } from './queryObserver'
import { NotifyOptions, QueryObserver } from './queryObserver'
import { Subscribable } from './subscribable'

type QueriesObserverListener = (result: QueryObserverResult[]) => void
Expand All @@ -20,9 +20,7 @@ export class QueriesObserver extends Subscribable<QueriesObserverListener> {
this.queries = queries || []
this.result = []
this.observers = []

// Subscribe to queries
this.updateObservers()
this.setQueries(this.queries)
}

protected onSubscribe(): void {
Expand All @@ -48,21 +46,21 @@ export class QueriesObserver extends Subscribable<QueriesObserverListener> {
})
}

setQueries(queries: QueryObserverOptions[]): void {
setQueries(
queries: QueryObserverOptions[],
notifyOptions?: NotifyOptions
): void {
this.queries = queries
this.updateObservers()
this.updateObservers(notifyOptions)
}

getCurrentResult(): QueryObserverResult[] {
return this.result
}

private updateObservers(): void {
let hasIndexChange = false

const prevObservers = this.observers
const newObservers = this.queries.map((options, i) => {
let observer: QueryObserver | undefined = prevObservers[i]
getOptimisticResult(queries: QueryObserverOptions[]): QueryObserverResult[] {
return queries.map((options, i) => {
let observer: QueryObserver | undefined = this.observers[i]

const defaultedOptions = this.client.defaultQueryObserverOptions(options)
const hashFn = getQueryKeyHashFn(defaultedOptions)
Expand All @@ -72,42 +70,74 @@ export class QueriesObserver extends Subscribable<QueriesObserverListener> {
!observer ||
observer.getCurrentQuery().queryHash !== defaultedOptions.queryHash
) {
hasIndexChange = true
observer = prevObservers.find(
observer = this.observers.find(
x => x.getCurrentQuery().queryHash === defaultedOptions.queryHash
)
}

if (observer) {
observer.setOptions(defaultedOptions)
return observer
if (!observer) {
observer = new QueryObserver(this.client, defaultedOptions)
}

return new QueryObserver(this.client, defaultedOptions)
return observer.getOptimisticResult(defaultedOptions)
})
}

if (prevObservers.length === newObservers.length && !hasIndexChange) {
return
}
private updateObservers(notifyOptions?: NotifyOptions): void {
notifyManager.batch(() => {
let hasIndexChange = false

this.observers = newObservers
this.result = newObservers.map(observer => observer.getCurrentResult())
const prevObservers = this.observers
const newObservers = this.queries.map((options, i) => {
let observer: QueryObserver | undefined = prevObservers[i]

if (!this.listeners.length) {
return
}
const defaultedOptions = this.client.defaultQueryObserverOptions(
options
)
const hashFn = getQueryKeyHashFn(defaultedOptions)
defaultedOptions.queryHash = hashFn(defaultedOptions.queryKey!)

if (
!observer ||
observer.getCurrentQuery().queryHash !== defaultedOptions.queryHash
) {
hasIndexChange = true
observer = prevObservers.find(
x => x.getCurrentQuery().queryHash === defaultedOptions.queryHash
)
}

if (observer) {
observer.setOptions(defaultedOptions, notifyOptions)
return observer
}

return new QueryObserver(this.client, defaultedOptions)
})

difference(prevObservers, newObservers).forEach(observer => {
observer.destroy()
})
if (prevObservers.length === newObservers.length && !hasIndexChange) {
return
}

difference(newObservers, prevObservers).forEach(observer => {
observer.subscribe(result => {
this.onUpdate(observer, result)
this.observers = newObservers
this.result = newObservers.map(observer => observer.getCurrentResult())

if (!this.listeners.length) {
return
}

difference(prevObservers, newObservers).forEach(observer => {
observer.destroy()
})
})

this.notify()
difference(newObservers, prevObservers).forEach(observer => {
observer.subscribe(result => {
this.onUpdate(observer, result)
})
})

this.notify()
})
}

private onUpdate(observer: QueryObserver, result: QueryObserverResult): void {
Expand Down
7 changes: 4 additions & 3 deletions src/core/query.ts
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ export class Query<
}

onFocus(): void {
const observer = this.observers.find(x => x.willFetchOnWindowFocus())
const observer = this.observers.find(x => x.shouldFetchOnWindowFocus())

if (observer) {
observer.refetch()
Expand All @@ -271,7 +271,7 @@ export class Query<
}

onOnline(): void {
const observer = this.observers.find(x => x.willFetchOnReconnect())
const observer = this.observers.find(x => x.shouldFetchOnReconnect())

if (observer) {
observer.refetch()
Expand Down Expand Up @@ -328,14 +328,15 @@ export class Query<
options?: QueryOptions<TQueryFnData, TError, TData>,
fetchOptions?: FetchOptions
): Promise<TData> {
if (this.state.isFetching)
if (this.state.isFetching) {
if (this.state.dataUpdatedAt && fetchOptions?.cancelRefetch) {
// Silently cancel current fetch if the user wants to cancel refetches
this.cancel({ silent: true })
} else if (this.promise) {
// Return current promise if we are already fetching
return this.promise
}
}

// Update config if passed, otherwise the config from the last execution is used
if (options) {
Expand Down
3 changes: 1 addition & 2 deletions src/core/queryCache.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,8 @@ export class QueryCache extends Subscribable<QueryCacheListener> {
options: QueryOptions<TQueryFnData, TError, TData>,
state?: QueryState<TData, TError>
): Query<TQueryFnData, TError, TData> {
const hashFn = getQueryKeyHashFn(options)
const queryKey = options.queryKey!
const queryHash = options.queryHash ?? hashFn(queryKey)
const queryHash = options.queryHash ?? getQueryKeyHashFn(options)(queryKey)
let query = this.get<TQueryFnData, TError, TData>(queryHash)

if (!query) {
Expand Down
12 changes: 11 additions & 1 deletion src/core/queryClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
parseFilterArgs,
parseQueryArgs,
partialMatchKey,
getQueryKeyHashFn,
} from './utils'
import type {
DefaultOptions,
Expand Down Expand Up @@ -446,12 +447,21 @@ export class QueryClient {
if (options?._defaulted) {
return options
}
return {

const defaultedOptions = {
...this.defaultOptions.queries,
...this.getQueryDefaults(options?.queryKey),
...options,
_defaulted: true,
} as T

if (!defaultedOptions.queryHash && defaultedOptions.queryKey) {
defaultedOptions.queryHash = getQueryKeyHashFn(defaultedOptions)(
defaultedOptions.queryKey
)
}

return defaultedOptions
}

defaultQueryObserverOptions<
Expand Down
Loading