Skip to content
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

fix: implement default caching options for react-query #265

Merged
merged 2 commits into from
Feb 5, 2025
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
12 changes: 11 additions & 1 deletion src/components/react-query-provider.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { V1ListActiveWorkspacesResponse } from "@/api/generated";
import { v1ListActiveWorkspacesQueryKey } from "@/api/generated/@tanstack/react-query.gen";
import { getQueryCacheConfig } from "@/lib/react-query-utils";
import {
QueryCacheNotifyEvent,
QueryClient,
Expand Down Expand Up @@ -36,7 +37,16 @@ export function QueryClientProvider({ children }: { children: ReactNode }) {
null,
);

const [queryClient] = useState(() => new QueryClient());
const [queryClient] = useState(
() =>
new QueryClient({
defaultOptions: {
queries: {
...getQueryCacheConfig("short"),
},
},
}),
);

useEffect(() => {
const queryCache = queryClient.getQueryCache();
Expand Down
31 changes: 30 additions & 1 deletion src/lib/react-query-utils.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import { OpenApiTsReactQueryKey } from "@/types/openapi-ts";
import { OptionsLegacyParser } from "@hey-api/client-fetch";
import { Query, QueryClient } from "@tanstack/react-query";
import {
Query,
QueryClient,
QueryObserverOptions,
} from "@tanstack/react-query";

// NOTE: This is copy/pasted from @/api/generated/@tanstack/react-query.gen
type QueryKey<TOptions extends OptionsLegacyParser = OptionsLegacyParser> = [
Expand Down Expand Up @@ -33,6 +37,7 @@ export function invalidateQueries(
) {
return queryClient.invalidateQueries({
refetchType: "all",
stale: true,
predicate: (
query: Query<unknown, Error, unknown, OpenApiTsReactQueryKey>,
) => {
Expand All @@ -42,3 +47,27 @@ export function invalidateQueries(
},
});
}

export function getQueryCacheConfig(
lifetime: "dynamic" | "short" | "indefinite",
) {
switch (lifetime) {
case "dynamic":
return {
staleTime: 0,
} as const satisfies Pick<QueryObserverOptions, "staleTime">;

case "short":
return {
staleTime: 5 * 1_000,
} as const satisfies Pick<QueryObserverOptions, "staleTime">;

case "indefinite":
return {
staleTime: Infinity,
} as const satisfies Pick<QueryObserverOptions, "staleTime">;

default:
return lifetime satisfies never;
}
}
Loading