Skip to content
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
6 changes: 4 additions & 2 deletions packages/angular-query-experimental/src/inject-queries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -236,8 +236,10 @@ export function injectQueries<
)
})

const [, getCombinedResult] =
observer.getOptimisticResult(defaultedQueries())
const [, getCombinedResult] = observer.getOptimisticResult(
defaultedQueries(),
(options as QueriesObserverOptions<TCombinedResult>).combine,
)

const result = signal(getCombinedResult() as any)

Expand Down
17 changes: 12 additions & 5 deletions packages/query-core/src/queriesObserver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,14 @@ function replaceAt<T>(array: Array<T>, index: number, value: T): Array<T> {

type QueriesObserverListener = (result: Array<QueryObserverResult>) => void

type CombineFn<TCombinedResult> = (
result: Array<QueryObserverResult>,
) => TCombinedResult

export interface QueriesObserverOptions<
TCombinedResult = Array<QueryObserverResult>,
> {
combine?: (result: Array<QueryObserverResult>) => TCombinedResult
combine?: CombineFn<TCombinedResult>
}

export class QueriesObserver<
Expand Down Expand Up @@ -55,7 +59,7 @@ export class QueriesObserver<

#setResult(value: Array<QueryObserverResult>) {
this.#result = value
this.#combinedResult = this.#combineResult(value)
this.#combinedResult = this.#combineResult(value, this.#options?.combine)
}

protected onSubscribe(): void {
Expand Down Expand Up @@ -151,6 +155,7 @@ export class QueriesObserver<

getOptimisticResult(
queries: Array<QueryObserverOptions>,
combine: CombineFn<TCombinedResult> | undefined,
): [
rawResult: Array<QueryObserverResult>,
combineResult: (r?: Array<QueryObserverResult>) => TCombinedResult,
Expand All @@ -164,7 +169,7 @@ export class QueriesObserver<
return [
result,
(r?: Array<QueryObserverResult>) => {
return this.#combineResult(r ?? result)
return this.#combineResult(r ?? result, combine)
},
() => {
return matches.map((match, index) => {
Expand All @@ -177,8 +182,10 @@ export class QueriesObserver<
]
}

#combineResult(input: Array<QueryObserverResult>): TCombinedResult {
const combine = this.#options?.combine
#combineResult(
input: Array<QueryObserverResult>,
combine: CombineFn<TCombinedResult> | undefined,
): TCombinedResult {
if (combine) {
return replaceEqualDeep(this.#combinedResult, combine(input))
}
Expand Down
42 changes: 42 additions & 0 deletions packages/react-query/src/__tests__/useQueries.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -1167,4 +1167,46 @@ describe('useQueries', () => {
// no further re-render because data didn't change
expect(results.length).toBe(length)
})

it('should not have stale closures with combine (#6648)', async () => {
const key = queryKey()

function Page() {
const [count, setCount] = React.useState(0)
const queries = useQueries(
{
queries: [
{
queryKey: key,
queryFn: () => Promise.resolve('result'),
},
],
combine: (results) => {
return {
count,
res: results.map((res) => res.data).join(','),
}
},
},
queryClient,
)

return (
<div>
<div>
data: {String(queries.count)} {queries.res}
</div>
<button onClick={() => setCount((c) => c + 1)}>inc</button>
</div>
)
}

const rendered = render(<Page />)

await waitFor(() => rendered.getByText('data: 0 result'))

fireEvent.click(rendered.getByRole('button', { name: /inc/i }))

await waitFor(() => rendered.getByText('data: 1 result'))
})
})
5 changes: 4 additions & 1 deletion packages/react-query/src/useQueries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,10 @@ export function useQueries<
)

const [optimisticResult, getCombinedResult, trackResult] =
observer.getOptimisticResult(defaultedQueries)
observer.getOptimisticResult(
defaultedQueries,
(options as QueriesObserverOptions<TCombinedResult>).combine,
)

React.useSyncExternalStore(
React.useCallback(
Expand Down
14 changes: 12 additions & 2 deletions packages/solid-query/src/createQueries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -239,13 +239,23 @@ export function createQueries<
)

const [state, setState] = createStore<TCombinedResult>(
observer.getOptimisticResult(defaultedQueries())[1](),
observer.getOptimisticResult(
defaultedQueries(),
(queriesOptions() as QueriesObserverOptions<TCombinedResult>).combine,
)[1](),
)

createRenderEffect(
on(
() => queriesOptions().queries.length,
() => setState(observer.getOptimisticResult(defaultedQueries())[1]()),
() =>
setState(
observer.getOptimisticResult(
defaultedQueries(),
(queriesOptions() as QueriesObserverOptions<TCombinedResult>)
.combine,
)[1](),
),
),
)

Expand Down
5 changes: 4 additions & 1 deletion packages/svelte-query/src/createQueries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,10 @@ export function createQueries<
// @ts-ignore svelte-check thinks this is unused
([$result, $defaultedQueriesStore]) => {
const [rawResult, combineResult, trackResult] =
observer.getOptimisticResult($defaultedQueriesStore)
observer.getOptimisticResult(
$defaultedQueriesStore,
(options as QueriesObserverOptions<TCombinedResult>).combine,
)
$result = rawResult
return combineResult(trackResult())
},
Expand Down
4 changes: 4 additions & 0 deletions packages/vue-query/src/useQueries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@ export function useQueries<
)
const [, getCombinedResult] = observer.getOptimisticResult(
defaultedQueries.value,
(options as QueriesObserverOptions<TCombinedResult>).combine,
)
const state = ref(getCombinedResult()) as Ref<TCombinedResult>

Expand All @@ -307,12 +308,14 @@ export function useQueries<
unsubscribe = observer.subscribe(() => {
const [, getCombinedResultRestoring] = observer.getOptimisticResult(
defaultedQueries.value,
(options as QueriesObserverOptions<TCombinedResult>).combine,
)
state.value = getCombinedResultRestoring()
})
// Subscription would not fire for persisted results
const [, getCombinedResultPersisted] = observer.getOptimisticResult(
defaultedQueries.value,
(options as QueriesObserverOptions<TCombinedResult>).combine,
)
state.value = getCombinedResultPersisted()
}
Expand All @@ -329,6 +332,7 @@ export function useQueries<
)
const [, getCombinedResultPersisted] = observer.getOptimisticResult(
defaultedQueries.value,
(options as QueriesObserverOptions<TCombinedResult>).combine,
)
state.value = getCombinedResultPersisted()
},
Expand Down