Fix deduplicating fragments for DocumentMode.string visitor (#6668)

dotansimha · Oct 11, 2021 · 3c2c847 · 3c2c847
1 parent 3789169
commit 3c2c847
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 4 deletions.
diff --git a/.changeset/selfish-impalas-whisper.md b/.changeset/selfish-impalas-whisper.md
@@ -0,0 +1,5 @@
+---
+'@graphql-codegen/visitor-plugin-common': patch
+---
+
+Fix dedupleFragments option for typescript-react-query (and possibly others)
diff --git a/packages/plugins/c-sharp/c-sharp-operations/src/visitor.ts b/packages/plugins/c-sharp/c-sharp-operations/src/visitor.ts
@@ -155,7 +155,7 @@ export class CSharpOperationsVisitor extends ClientSideBaseVisitor<
 
   protected _gql(node: OperationDefinitionNode): string {
     const fragments = this._transformFragments(node);
-    const doc = this._prepareDocument([print(node), this._includeFragments(fragments)].join('\n'));
+    const doc = this._prepareDocument([print(node), this._includeFragments(fragments, node.kind)].join('\n'));
 
     return doc.replace(/"/g, '""');
   }

diff --git a/packages/plugins/other/visitor-plugin-common/src/client-side-base-visitor.ts b/packages/plugins/other/visitor-plugin-common/src/client-side-base-visitor.ts
@@ -271,7 +271,7 @@ export class ClientSideBaseVisitor<
     );
   }
 
-  protected _includeFragments(fragments: string[]): string {
+  protected _includeFragments(fragments: string[], nodeKind: 'FragmentDefinition' | 'OperationDefinition'): string {
     if (fragments && fragments.length > 0) {
       if (this.config.documentMode === DocumentMode.documentNode) {
         return this._fragments
@@ -281,6 +281,9 @@ export class ClientSideBaseVisitor<
       } else if (this.config.documentMode === DocumentMode.documentNodeImportFragments) {
         return '';
       } else {
+        if (this.config.dedupeFragments && nodeKind !== 'OperationDefinition') {
+          return '';
+        }
         return `${fragments.map(name => '${' + name + '}').join('\n')}`;
       }
     }
@@ -297,7 +300,7 @@ export class ClientSideBaseVisitor<
 
     const doc = this._prepareDocument(`
     ${print(node).split('\\').join('\\\\') /* Re-escape escaped values in GraphQL syntax */}
-    ${this._includeFragments(fragments)}`);
+    ${this._includeFragments(fragments, node.kind)}`);
 
     if (this.config.documentMode === DocumentMode.documentNode) {
       let gqlObj = gqlTag([doc]);

diff --git a/packages/plugins/typescript/react-query/tests/react-query.spec.ts b/packages/plugins/typescript/react-query/tests/react-query.spec.ts
@@ -1,5 +1,5 @@
 import { validateTs } from '@graphql-codegen/testing';
-import { parse, buildClientSchema, GraphQLSchema } from 'graphql';
+import { parse, buildClientSchema, GraphQLSchema, buildSchema } from 'graphql';
 import { plugin } from '../src';
 import { Types, mergeOutputs } from '@graphql-codegen/plugin-helpers';
 import { plugin as tsPlugin } from '../../typescript/src/index';
@@ -20,6 +20,57 @@ const validateTypeScript = async (
 };
 
 describe('React-Query', () => {
+  it('Duplicated nested fragments are removed', async () => {
+    const schema = buildSchema(/* GraphQL */ `
+      schema {
+        query: Query
+      }
+
+      type Query {
+        user(id: ID!): User
+      }
+
+      type User {
+        id: ID!
+        name: String!
+      }
+    `);
+
+    const ast = parse(/* GraphQL */ `
+      query foo {
+        user1: user(id: 1) {
+          ...userWithEmail
+        }
+        user2: user(id: 2) {
+          ...userWithName
+        }
+      }
+
+      fragment userBase on User {
+        id
+      }
+
+      fragment userWithEmail on User {
+        ...userBase
+        email
+      }
+
+      fragment userWithName on User {
+        ...userBase
+        name
+      }
+    `);
+
+    const res = (await plugin(
+      schema,
+      [{ location: '', document: ast }],
+      { dedupeFragments: true },
+      { outputFile: '' }
+    )) as Types.ComplexPluginOutput;
+
+    expect((res.content.match(/\{UserBaseFragmentDoc\}/g) || []).length).toBe(1);
+  });
+
   const schema = buildClientSchema(require('../../../../../dev-test/githunt/schema.json'));
   const basicDoc = parse(/* GraphQL */ `
     query test {