Skip to content

fix: Suspense issues in v3 #4428

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

Draft
siddhsuresh wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix: Suspense issues in v3 #4428

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
105 changes: 85 additions & 20 deletions packages/blitz-rpc/src/query/react-query/react-query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,16 @@ import type {
UseSuspenseInfiniteQueryOptions,
} from "@tanstack/react-query"

function throwNextSuspenseError() {
const e = new NextError()
e.name = "Rendering Suspense fallback..."
e.digest = "DYNAMIC_SERVER_USAGE"
// Backwards compatibility for nextjs 13.0.7
e.message = "DYNAMIC_SERVER_USAGE"
delete e.stack
throw e
}

import {isServer, FirstParam, PromiseReturnType, AsyncFunc} from "blitz"
import {
emptyQueryFn,
Expand Down Expand Up @@ -172,16 +182,6 @@ export function useSuspenseQuery<
routerIsReady = true
}

if (isServer) {
const e = new NextError()
e.name = "Rendering Suspense fallback..."
e.digest = "DYNAMIC_SERVER_USAGE"
// Backwards compatibility for nextjs 13.0.7
e.message = "DYNAMIC_SERVER_USAGE"
delete e.stack
throw e
}

const {data, ...queryRest} = useSuspenseReactQuery({
queryKey: routerIsReady ? queryKey : ["_routerNotReady_"],
queryFn: routerIsReady
Expand All @@ -190,6 +190,10 @@ export function useSuspenseQuery<
...options,
})

if (queryRest.fetchStatus === "idle" && isServer && !data) {
throwNextSuspenseError()
}

const rest = {
...queryRest,
...getQueryCacheFunctions<FirstParam<T>, TResult, T>(queryFn, params),
Expand Down Expand Up @@ -259,7 +263,75 @@ export function usePaginatedQuery<
enabled,
})

if (queryRest.fetchStatus === "idle" && isServer && !data) {
const rest = {
...queryRest,
...getQueryCacheFunctions<FirstParam<T>, TResult, T>(queryFn, params),
}

return [data, rest as RestPaginatedResult<TResult, TError>]
}

// -------------------------
// useSuspensePaginatedQuery
// -------------------------
export function useSuspensePaginatedQuery<
T extends AsyncFunc,
TResult = PromiseReturnType<T>,
TError = DefaultError,
TSelectedData = TResult,
>(
queryFn: T,
params: FirstParam<T>,
options?: Omit<UseSuspenseQueryOptions<TResult, TError, TSelectedData>, "queryKey"> &
QueryNonLazyOptions,
): [TSelectedData, RestPaginatedResult<TSelectedData, TError>]
export function useSuspensePaginatedQuery<
T extends AsyncFunc,
TResult = PromiseReturnType<T>,
TError = DefaultError,
TSelectedData = TResult,
>(
queryFn: T,
params: FirstParam<T>,
options: Omit<UseSuspenseQueryOptions<TResult, TError, TSelectedData>, "queryKey"> &
QueryLazyOptions,
): [TSelectedData | undefined, RestPaginatedResult<TSelectedData, TError>]
export function useSuspensePaginatedQuery<
T extends AsyncFunc,
TResult = PromiseReturnType<T>,
TError = DefaultError,
TSelectedData = TResult,
>(
queryFn: T,
params: FirstParam<T>,
options: Omit<UseSuspenseQueryOptions<TResult, TError, TSelectedData>, "queryKey"> = {},
) {
if (typeof queryFn === "undefined") {
throw new Error(
"useSuspensePaginatedQuery is missing the first argument - it must be a query function",
)
}

let routerIsReady = false
const router = useRouter()
if (router) {
routerIsReady = router?.isReady || isServer
} else {
routerIsReady = true
}
const enhancedResolverRpcClient = sanitizeQuery(queryFn)
const queryKey = getQueryKey(queryFn, params)

const {data, ...queryRest} = useReactQuery({
queryKey: routerIsReady ? queryKey : ["_routerNotReady_"],
queryFn: routerIsReady
? ({signal}) => enhancedResolverRpcClient(params, {fromQueryHook: true}, signal)
: (emptyQueryFn as PromiseReturnType<T>),
...options,
placeholderData: keepPreviousData,
})

if (queryRest.fetchStatus === "idle" || (isServer && !data)) {
const e = new NextError()
e.name = "Rendering Suspense fallback..."
e.digest = "DYNAMIC_SERVER_USAGE"
Expand All @@ -274,8 +346,7 @@ export function usePaginatedQuery<
...getQueryCacheFunctions<FirstParam<T>, TResult, T>(queryFn, params),
}

// return [data, rest as RestPaginatedResult<TResult>]
return [data, rest]
return [data, rest as RestPaginatedResult<TResult, TError>]
}

// -------------------------
Expand Down Expand Up @@ -439,13 +510,7 @@ export function useSuspenseInfiniteQuery<
const infiniteQueryData = data as InfiniteData<TResult>

if (queryRest.fetchStatus === "idle" && isServer && !infiniteQueryData) {
const e = new NextError()
e.name = "Rendering Suspense fallback..."
e.digest = "DYNAMIC_SERVER_USAGE"
// Backwards compatibility for nextjs 13.0.7
e.message = "DYNAMIC_SERVER_USAGE"
delete e.stack
throw e
throwNextSuspenseError()
}

const rest = {
Expand Down
Loading