Skip to content

fix(svelte-query): Fix staleTime reactivity bug #5682

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

Merged
merged 5 commits into from
Jul 6, 2023
Merged

fix(svelte-query): Fix staleTime reactivity bug #5682

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4389b8b
Set up demo for reactivity bug
lachlancollins Jul 5, 2023
add572e
Add derived log
lachlancollins Jul 5, 2023
f623333
Fix by subscribing to defaultedOptionsStore
lachlancollins Jul 6, 2023
2549729
Run prettier
lachlancollins Jul 6, 2023
5fe1332
Remove debugging changes
lachlancollins Jul 6, 2023
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
25 changes: 16 additions & 9 deletions packages/svelte-query/src/createBaseQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,20 @@ export function createBaseQuery<
Observer: typeof QueryObserver,
queryClient?: QueryClient,
): CreateBaseQueryResult<TData, TError> {
/** Load query client */
const client = useQueryClient(queryClient)

/** Converts options to a svelte store if not already a store object */
const optionsStore = isSvelteStore(options) ? options : readable(options)

const defaultedOptionsStore = derived(optionsStore, ($options) => {
const defaultedOptions = client.defaultQueryOptions($options)
/** Creates a store that has the default options applied */
const defaultedOptionsStore = derived(optionsStore, ($optionsStore) => {
const defaultedOptions = client.defaultQueryOptions($optionsStore)
defaultedOptions._optimisticResults = 'optimistic'

return defaultedOptions
})

/** Creates the observer */
const observer = new Observer<
TQueryFnData,
TError,
Expand All @@ -51,12 +54,16 @@ export function createBaseQuery<
return observer.subscribe(notifyManager.batchCalls(set))
})

const { subscribe } = derived(result, ($result) => {
$result = observer.getOptimisticResult(get(defaultedOptionsStore))
return !get(defaultedOptionsStore).notifyOnChangeProps
? observer.trackResult($result)
: $result
})
/** Subscribe to changes in result and defaultedOptionsStore */
const { subscribe } = derived(
[result, defaultedOptionsStore],
([$result, $defaultedOptionsStore]) => {
$result = observer.getOptimisticResult($defaultedOptionsStore)
return !$defaultedOptionsStore.notifyOnChangeProps
? observer.trackResult($result)
: $result
},
)

return { subscribe }
}