Skip to content

fix: add empty object in place of variables for more consistent keys #894

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

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

fix: add empty object in place of variables for more consistent keys #894

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
5 changes: 5 additions & 0 deletions .changeset/many-maps-hang.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@graphql-codegen/typescript-react-query': patch
---

add empty object in place of variables for more consistent keys
10 changes: 4 additions & 6 deletions dev-test/githunt/types.react-query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,11 +507,11 @@ export const CurrentUserForProfileDocument = `

export const useCurrentUserForProfileQuery = <TData = CurrentUserForProfileQuery, TError = unknown>(
dataSource: { endpoint: string; fetchParams?: RequestInit },
variables?: CurrentUserForProfileQueryVariables,
variables: CurrentUserForProfileQueryVariables = {},
options?: UseQueryOptions<CurrentUserForProfileQuery, TError, TData>,
) => {
return useQuery<CurrentUserForProfileQuery, TError, TData>(
variables === undefined ? ['CurrentUserForProfile'] : ['CurrentUserForProfile', variables],
['CurrentUserForProfile', variables],
fetcher<CurrentUserForProfileQuery, CurrentUserForProfileQueryVariables>(
dataSource.endpoint,
dataSource.fetchParams || {},
Expand All @@ -527,13 +527,11 @@ export const useInfiniteCurrentUserForProfileQuery = <
TError = unknown,
>(
dataSource: { endpoint: string; fetchParams?: RequestInit },
variables?: CurrentUserForProfileQueryVariables,
variables: CurrentUserForProfileQueryVariables = {},
options?: UseInfiniteQueryOptions<CurrentUserForProfileQuery, TError, TData>,
) => {
return useInfiniteQuery<CurrentUserForProfileQuery, TError, TData>(
variables === undefined
? ['CurrentUserForProfile.infinite']
: ['CurrentUserForProfile.infinite', variables],
['CurrentUserForProfile.infinite', variables],
metaData =>
fetcher<CurrentUserForProfileQuery, CurrentUserForProfileQueryVariables>(
dataSource.endpoint,
Expand Down
13 changes: 4 additions & 9 deletions packages/plugins/typescript/react-query/src/fetcher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ export abstract class FetcherRenderer {
hasRequiredVariables,
operationVariablesTypes,
}: GenerateConfig): string {
return `variables${hasRequiredVariables ? '' : '?'}: ${operationVariablesTypes}`;
return `variables: ${operationVariablesTypes}${hasRequiredVariables ? '' : ' = {}'}`;
}

private generateQueryOptionsSignature(
Expand All @@ -203,9 +203,7 @@ export abstract class FetcherRenderer {

private generateInfiniteQueryVariablesSignature(config: GenerateConfig): string {
if (this.visitor.config.reactQueryVersion <= 4) {
return `variables${config.hasRequiredVariables ? '' : '?'}: ${
config.operationVariablesTypes
}`;
return `variables: ${config.operationVariablesTypes}${config.hasRequiredVariables ? '' : ' = {}'}`;
}
return `variables: ${config.operationVariablesTypes}`;
}
Expand All @@ -224,9 +222,7 @@ export abstract class FetcherRenderer {

public generateInfiniteQueryKey(config: GenerateConfig, isSuspense: boolean): string {
const identifier = isSuspense ? 'infiniteSuspense' : 'infinite';
if (config.hasRequiredVariables)
return `['${config.node.name.value}.${identifier}', variables]`;
return `variables === undefined ? ['${config.node.name.value}.${identifier}'] : ['${config.node.name.value}.${identifier}', variables]`;
return `['${config.node.name.value}.${identifier}', variables]`;
}

public generateInfiniteQueryOutput(config: GenerateConfig, isSuspense = false) {
Expand All @@ -244,8 +240,7 @@ export abstract class FetcherRenderer {

public generateQueryKey(config: GenerateConfig, isSuspense: boolean): string {
const identifier = isSuspense ? `${config.node.name.value}Suspense` : config.node.name.value;
if (config.hasRequiredVariables) return `['${identifier}', variables]`;
return `variables === undefined ? ['${identifier}'] : ['${identifier}', variables]`;
return `['${identifier}', variables]`;
}

public generateQueryOutput(config: GenerateConfig, isSuspense = false) {
Expand Down
Loading