Skip to content

Support defer directive on nested fragments #9384

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 2 commits into from
May 12, 2023
Merged

Support defer directive on nested fragments #9384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8bc88cc
Support defer directive on nested fragments
beerose May 10, 2023
6037636
Add changeset
beerose May 10, 2023
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
6 changes: 6 additions & 0 deletions .changeset/chilly-moons-yawn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@graphql-codegen/visitor-plugin-common': patch
'@graphql-codegen/client-preset': patch
---

Support @defer directive in nested fragments
10 changes: 9 additions & 1 deletion packages/plugins/other/visitor-plugin-common/src/selection-set-to-object.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -753,7 +753,15 @@ export class SelectionSetToObject<Config extends ParsedDocumentsConfig = ParsedD
return null;
}

return { name: declarationName, content: possibleFields.join(' & ') };
const content = possibleFields
.map(selectionObject => {
if (typeof selectionObject === 'string') return selectionObject;

return '(' + selectionObject.union.join(' | ') + ')';
})
.join(' & ');

return { name: declarationName, content };
})
.filter(Boolean);

Expand Down
62 changes: 60 additions & 2 deletions packages/presets/client/tests/client-preset.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1803,6 +1803,7 @@ export * from "./gql.js";`);
}

type Foo {
id: String
value: String
}
`,
Expand Down Expand Up @@ -1837,6 +1838,7 @@ export * from "./gql.js";`);

export type Foo = {
__typename?: 'Foo';
id?: Maybe<Scalars['String']>;
value?: Maybe<Scalars['String']>;
};

Expand Down Expand Up @@ -1864,7 +1866,10 @@ export * from "./gql.js";`);

export type FooFragment = { __typename?: 'Foo', value?: string | null } & { ' $fragmentName'?: 'FooFragment' };

export type FooFragment = { __typename?: 'Foo', id?: string | null } & ({ __typename?: 'Foo', value?: string | null } | { __typename?: 'Foo', value?: never }) & { ' $fragmentName'?: 'FooFragment' };

export const FooFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Foo"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Foo"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]} as unknown as DocumentNode<FooFragment, unknown>;
export const FooFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"foo"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Foo"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Foo"}},"directives":[{"kind":"Directive","name":{"kind":"Name","value":"defer"}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]}}]} as unknown as DocumentNode<FooFragment, unknown>;
export const FooDocument = {"__meta__":{"deferredFields":{"Foo":["value"]}},"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"Foo"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"foo"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"Foo"},"directives":[{"kind":"Directive","name":{"kind":"Name","value":"defer"}}]}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Foo"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Foo"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]} as unknown as DocumentNode<FooQuery, FooQueryVariables>;
export const FoosDocument = {"__meta__":{"deferredFields":{"Foo":["value"]}},"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"Foos"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"foos"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"Foo"},"directives":[{"kind":"Directive","name":{"kind":"Name","value":"defer"}}]}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Foo"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Foo"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]} as unknown as DocumentNode<FoosQuery, FoosQueryVariables>;"
`);
Expand All @@ -1880,6 +1885,7 @@ export * from "./gql.js";`);
}

type Foo {
id: String
value: String
}
`,
Expand Down Expand Up @@ -1917,6 +1923,7 @@ export * from "./gql.js";`);

export type Foo = {
__typename?: 'Foo';
id?: Maybe<Scalars['String']>;
value?: Maybe<Scalars['String']>;
};

Expand Down Expand Up @@ -1944,7 +1951,10 @@ export * from "./gql.js";`);

export type FooFragment = { __typename?: 'Foo', value?: string | null } & { ' $fragmentName'?: 'FooFragment' };

export type FooFragment = { __typename?: 'Foo', id?: string | null } & ({ __typename?: 'Foo', value?: string | null } | { __typename?: 'Foo', value?: never }) & { ' $fragmentName'?: 'FooFragment' };

export const FooFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Foo"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Foo"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]} as unknown as DocumentNode<FooFragment, unknown>;
export const FooFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"foo"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Foo"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Foo"}},"directives":[{"kind":"Directive","name":{"kind":"Name","value":"defer"}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]}}]} as unknown as DocumentNode<FooFragment, unknown>;
export const FooDocument = {"__meta__":{"hash":"39c47d2da0fb0e6867abbe2ec942d9858f2d76c7","deferredFields":{"Foo":["value"]}},"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"Foo"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"foo"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"Foo"},"directives":[{"kind":"Directive","name":{"kind":"Name","value":"defer"}}]}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Foo"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Foo"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]} as unknown as DocumentNode<FooQuery, FooQueryVariables>;
export const FoosDocument = {"__meta__":{"hash":"8aba765173b2302b9857334e9959d97a2168dbc8","deferredFields":{"Foo":["value"]}},"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"Foos"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"foos"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"Foo"},"directives":[{"kind":"Directive","name":{"kind":"Name","value":"defer"}}]}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Foo"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Foo"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]} as unknown as DocumentNode<FoosQuery, FoosQueryVariables>;"
`);
Expand All @@ -1960,6 +1970,7 @@ export * from "./gql.js";`);
}

type Foo {
id: String
value: String
}
`,
Expand Down Expand Up @@ -1997,6 +2008,7 @@ export * from "./gql.js";`);

export type Foo = {
__typename?: 'Foo';
id?: Maybe<Scalars['String']>;
value?: Maybe<Scalars['String']>;
};

Expand Down Expand Up @@ -2024,6 +2036,8 @@ export * from "./gql.js";`);

export type FooFragment = { __typename?: 'Foo', value?: string | null } & { ' $fragmentName'?: 'FooFragment' };

export type FooFragment = { __typename?: 'Foo', id?: string | null } & ({ __typename?: 'Foo', value?: string | null } | { __typename?: 'Foo', value?: never }) & { ' $fragmentName'?: 'FooFragment' };

export class TypedDocumentString<TResult, TVariables>
extends String
implements DocumentTypeDecoration<TResult, TVariables>
Expand All @@ -2043,6 +2057,14 @@ export * from "./gql.js";`);
value
}
\`, {"fragmentName":"Foo"}) as unknown as TypedDocumentString<FooFragment, unknown>;
export const FooFragmentDoc = new TypedDocumentString(\`
fragment foo on Foo {
id
... on Foo @defer {
value
}
}
\`, {"fragmentName":"foo"}) as unknown as TypedDocumentString<FooFragment, unknown>;
export const FooDocument = new TypedDocumentString(\`
query Foo {
foo {
Expand All @@ -2051,6 +2073,12 @@ export * from "./gql.js";`);
}
fragment Foo on Foo {
value
}
fragment foo on Foo {
id
... on Foo @defer {
value
}
}\`, {"deferredFields":{"Foo":["value"]}}) as unknown as TypedDocumentString<FooQuery, FooQueryVariables>;
export const FoosDocument = new TypedDocumentString(\`
query Foos {
Expand All @@ -2060,6 +2088,12 @@ export * from "./gql.js";`);
}
fragment Foo on Foo {
value
}
fragment foo on Foo {
id
... on Foo @defer {
value
}
}\`, {"deferredFields":{"Foo":["value"]}}) as unknown as TypedDocumentString<FoosQuery, FoosQueryVariables>;"
`);
});
Expand All @@ -2074,6 +2108,7 @@ export * from "./gql.js";`);
}

type Foo {
id: String
value: String
}
`,
Expand Down Expand Up @@ -2114,6 +2149,7 @@ export * from "./gql.js";`);

export type Foo = {
__typename?: 'Foo';
id?: Maybe<Scalars['String']>;
value?: Maybe<Scalars['String']>;
};

Expand Down Expand Up @@ -2141,6 +2177,8 @@ export * from "./gql.js";`);

export type FooFragment = { __typename?: 'Foo', value?: string | null } & { ' $fragmentName'?: 'FooFragment' };

export type FooFragment = { __typename?: 'Foo', id?: string | null } & ({ __typename?: 'Foo', value?: string | null } | { __typename?: 'Foo', value?: never }) & { ' $fragmentName'?: 'FooFragment' };

export class TypedDocumentString<TResult, TVariables>
extends String
implements DocumentTypeDecoration<TResult, TVariables>
Expand All @@ -2160,6 +2198,14 @@ export * from "./gql.js";`);
value
}
\`, {"fragmentName":"Foo"}) as unknown as TypedDocumentString<FooFragment, unknown>;
export const FooFragmentDoc = new TypedDocumentString(\`
fragment foo on Foo {
id
... on Foo @defer {
value
}
}
\`, {"fragmentName":"foo"}) as unknown as TypedDocumentString<FooFragment, unknown>;
export const FooDocument = new TypedDocumentString(\`
query Foo {
foo {
Expand All @@ -2168,7 +2214,13 @@ export * from "./gql.js";`);
}
fragment Foo on Foo {
value
}\`, {"hash":"39c47d2da0fb0e6867abbe2ec942d9858f2d76c7","deferredFields":{"Foo":["value"]}}) as unknown as TypedDocumentString<FooQuery, FooQueryVariables>;
}
fragment foo on Foo {
id
... on Foo @defer {
value
}
}\`, {"hash":"2687841b00fe0b3b4fd0dfa2e943f80936594f58","deferredFields":{"Foo":["value"]}}) as unknown as TypedDocumentString<FooQuery, FooQueryVariables>;
export const FoosDocument = new TypedDocumentString(\`
query Foos {
foos {
Expand All @@ -2177,7 +2229,13 @@ export * from "./gql.js";`);
}
fragment Foo on Foo {
value
}\`, {"hash":"8aba765173b2302b9857334e9959d97a2168dbc8","deferredFields":{"Foo":["value"]}}) as unknown as TypedDocumentString<FoosQuery, FoosQueryVariables>;"
}
fragment foo on Foo {
id
... on Foo @defer {
value
}
}\`, {"hash":"8db613cc1f12f64dbde9cd6fef167fd12246330d","deferredFields":{"Foo":["value"]}}) as unknown as TypedDocumentString<FoosQuery, FoosQueryVariables>;"
`);
});
});
Expand Down
10 changes: 10 additions & 0 deletions packages/presets/client/tests/fixtures/with-deferred-fragment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,13 @@ const Fragment = gql(/* GraphQL */ `
value
}
`);

//@ts-ignore
const NestedFragment = gql(/* GraphQL */ `
fragment foo on Foo {
id
... on Foo @defer {
value
}
}
`);