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
5 changes: 5 additions & 0 deletions src/vue/__tests__/test-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ export function simpleFetcher(): Promise<string> {
});
}

export function getSimpleFetcherWithReturnData(returnData: unknown) {
return () =>
new Promise((resolve) => setTimeout(() => resolve(returnData), 0));
}

export function infiniteFetcher({
pageParam = 0,
}: {
Expand Down
38 changes: 26 additions & 12 deletions src/vue/__tests__/useQueries.test.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import { onUnmounted, reactive, set } from "vue-demi";
import { onUnmounted, reactive } from "vue-demi";
import { setLogger } from "react-query/core";

import {
flushPromises,
rejectFetcher,
simpleFetcher,
getSimpleFetcherWithReturnData,
noop,
} from "./test-utils";
import { useQueries } from "../useQueries";
Expand Down Expand Up @@ -112,38 +113,51 @@ describe("useQueries", () => {
});

test("should return state for new queries", async () => {
const initialQueries = reactive([]);
const queries = [
const queries = reactive([
{
queryKey: "key31",
queryFn: simpleFetcher,
queryFn: getSimpleFetcherWithReturnData("value31"),
},
{
queryKey: "key32",
queryFn: simpleFetcher,
queryFn: getSimpleFetcherWithReturnData("value32"),
},
];
const queriesState = useQueries(initialQueries);
{
queryKey: "key33",
queryFn: getSimpleFetcherWithReturnData("value33"),
},
]);
const queriesState = useQueries(queries);

expect(queriesState.length).toEqual(0);
await flushPromises();

queries.forEach((query, index) => {
set(initialQueries, index, query);
});
queries.splice(
0,
queries.length,
{
queryKey: "key31",
queryFn: getSimpleFetcherWithReturnData("value31"),
},
{
queryKey: "key34",
queryFn: getSimpleFetcherWithReturnData("value34"),
}
);

await flushPromises();
await flushPromises();

expect(queriesState.length).toEqual(2);

expect(queriesState).toMatchObject([
{
data: "value31",
status: "success",
isLoading: false,
isFetching: false,
isStale: true,
},
{
data: "value34",
status: "success",
isLoading: false,
isFetching: false,
Expand Down
48 changes: 30 additions & 18 deletions src/vue/useQueries.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import { QueriesObserver } from "react-query/core";
import { onUnmounted, reactive, readonly, set, watch } from "vue-demi";
import {
onUnmounted,
reactive,
readonly,
watch,
unref,
Ref,
isRef,
isReactive,
} from "vue-demi";

import type {
QueryFunction,
Expand Down Expand Up @@ -114,33 +123,36 @@ export type UseQueriesResults<
: // Fallback
QueryObserverResult[];

type UseQueriesOptionsArg<T extends any[]> = readonly [...UseQueriesOptions<T>];

export function useQueries<T extends any[]>(
queries: readonly [...UseQueriesOptions<T>]
queries: Ref<UseQueriesOptionsArg<T>> | UseQueriesOptionsArg<T>
): Readonly<UseQueriesResults<T>> {
const queryClientKey = queries[0]?.queryClientKey;
const queryClientKey = (unref(queries) as UseQueriesOptionsArg<T>)[0]
?.queryClientKey;
Comment on lines +131 to +132
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to do the as UseQueriesOptionsArg<T> assertions because typescript apparently can't properly derive the return type of unref

It works totally fine in my IDE, no ts failures.

Maybe the failure come from the way Typescript works with Rollup: maybe it can't infer the type from the function and has to rely on the function type (which apparently is not enough)

image

const queryClient = useQueryClient(queryClientKey);
const defaultedQueries = queries.map((options) => {
return queryClient.defaultQueryObserverOptions(options);
});
const defaultedQueries = (unref(queries) as UseQueriesOptionsArg<T>).map(
(options) => {
return queryClient.defaultQueryObserverOptions(options);
}
);

const observer = new QueriesObserver(queryClient, defaultedQueries);
const state = reactive(observer.getCurrentResult());
const unsubscribe = observer.subscribe((result) => {
result.forEach((resultEntry, index) => {
set(state, index, resultEntry);
});
state.splice(0, state.length, ...result);
});

watch(
() => queries,
() => {
const defaulted = queries.map((options) => {
return queryClient.defaultQueryObserverOptions(options);
});
if (isRef(queries) || isReactive(queries)) {
watch(queries, () => {
const defaulted = (unref(queries) as UseQueriesOptionsArg<T>).map(
(options) => {
return queryClient.defaultQueryObserverOptions(options);
}
);
observer.setQueries(defaulted);
},
{ deep: true }
);
});
}

onUnmounted(() => {
unsubscribe();
Expand Down