Skip to content

fix(query-db-collection): sync on-demand tanstack-query lifecycle #1007

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.

Sign up for GitHub

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

Open
delphinaubin wants to merge 1 commit into
base: main
Choose a base branch
from
+29 −16
Open

fix(query-db-collection): sync on-demand tanstack-query lifecycle #1007

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions .changeset/sync-on-demand-collection-fix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'@tanstack/query-db-collection': patch
---

Fix on-demand sync behavior so the full TanStack Query lifecycle is respected.

This patch resolves an issue where using on-demand synchronization could break the query lifecycle, including the error reported in https://github.com/TanStack/db/issues/998.
34 changes: 20 additions & 14 deletions packages/query-db-collection/src/query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -692,13 +692,16 @@ export function queryCollectionOptions(
// Query is still loading, wait for the first result
return new Promise<void>((resolve, reject) => {
const unsubscribe = observer.subscribe((result) => {
if (result.isSuccess) {
unsubscribe()
resolve()
} else if (result.isError) {
unsubscribe()
reject(result.error)
}
// Use a microtask in case `subscribe` is called synchronously, before `unsubscribe` is initialized
queueMicrotask(() => {
if (result.isSuccess) {
unsubscribe()
resolve()
} else if (result.isError) {
unsubscribe()
reject(result.error)
}
})
})
})
}
Expand Down Expand Up @@ -745,13 +748,16 @@ export function queryCollectionOptions(
// Create a promise that resolves when the query result is first available
const readyPromise = new Promise<void>((resolve, reject) => {
const unsubscribe = localObserver.subscribe((result) => {
if (result.isSuccess) {
unsubscribe()
resolve()
} else if (result.isError) {
unsubscribe()
reject(result.error)
}
// Use a microtask in case `subscribe` is called synchronously, before `unsubscribe` is initialized
queueMicrotask(() => {
if (result.isSuccess) {
unsubscribe()
resolve()
} else if (result.isError) {
unsubscribe()
reject(result.error)
}
})
})
})

Expand Down
4 changes: 2 additions & 2 deletions packages/query-db-collection/tests/query.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4219,7 +4219,7 @@ describe(`QueryCollection`, () => {
defaultOptions: {
queries: {
gcTime: 5 * 60 * 1000, // 5 minutes
staleTime: 0,
staleTime: Infinity, // set an Infinity staleTime to prevent a refetch
retry: false,
},
},
Expand Down Expand Up @@ -4562,7 +4562,7 @@ describe(`QueryCollection`, () => {
const testQueryClient = new QueryClient({
defaultOptions: {
queries: {
staleTime: 0,
staleTime: Infinity, // set an Infinity staleTime to prevent a refetch
gcTime: 300,
retry: false,
},
Expand Down