Skip to content

add example to reproduce defect of serializeQueryArgs with skipToken #4708

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 1 commit into from
Nov 23, 2024
Merged

add example to reproduce defect of serializeQueryArgs with skipToken #4708

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: 4 additions & 3 deletions packages/toolkit/src/query/core/buildSelectors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,9 @@ export function buildSelectors<
endpointDefinition: QueryDefinition<any, any, any, any>,
) {
return ((queryArgs: any) => {
if (queryArgs === skipToken) {
return createSelector(selectSkippedQuery, withRequestFlags)
}
const serializedArgs = serializeQueryArgs({
queryArgs,
endpointDefinition,
Expand All @@ -176,10 +179,8 @@ export function buildSelectors<
const selectQuerySubstate = (state: RootState) =>
selectInternalState(state)?.queries?.[serializedArgs] ??
defaultQuerySubState
const finalSelectQuerySubState =
queryArgs === skipToken ? selectSkippedQuery : selectQuerySubstate

return createSelector(finalSelectQuerySubState, withRequestFlags)
return createSelector(selectQuerySubstate, withRequestFlags)
}) as QueryResultSelectorFactory<any, RootState>
}

Expand Down
12 changes: 12 additions & 0 deletions packages/toolkit/src/query/tests/buildHooks.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,12 @@ const api = createApi({
return true
},
}),
queryWithDeepArg: build.query<string, { param: { nested: string } }>({
query: ({ param: { nested }}) => nested,
serializeQueryArgs: ({ queryArgs }) => {
return queryArgs.param.nested
}
}),
}),
})

Expand Down Expand Up @@ -667,6 +673,12 @@ describe('hooks tests', () => {
await screen.findByText('ID: 3')
})

test(`useQuery shouldn't call args serialization if request skipped`, async () => {
expect(() => renderHook(() => api.endpoints.queryWithDeepArg.useQuery(skipToken), {
wrapper: storeRef.wrapper,
})).not.toThrow()
})

test(`useQuery gracefully handles bigint types`, async () => {
function ItemList() {
const [pageNumber, setPageNumber] = useState(0)
Expand Down