fix(documents): do not order mutations (#6196)

* fix(documents): do not order mutations * Go --------- Co-authored-by: Arda TANRIKULU <[email protected]>
ardatan · May 27, 2024 · 26d29d0 · 26d29d0
1 parent 7368829
commit 26d29d0
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 3 deletions.
diff --git a/.changeset/tough-flowers-listen.md b/.changeset/tough-flowers-listen.md
@@ -0,0 +1,5 @@
+---
+'@graphql-tools/documents': patch
+---
+
+Do not sort mutations when using `printExecutableGraphQLDocument`
diff --git a/packages/documents/src/sort-executable-document.ts b/packages/documents/src/sort-executable-document.ts
@@ -1,10 +1,13 @@
-import { visit, type DocumentNode } from 'graphql';
+import { SelectionNode, SelectionSetNode, visit, type DocumentNode } from 'graphql';
 import { sortExecutableNodes } from './sort-executable-nodes.js';
 
 /**
  * Sort an executable GraphQL document.
  */
 export function sortExecutableDocument(document: DocumentNode): DocumentNode {
+  const ignoredNodes = new WeakSet<SelectionSetNode>();
+  const ignoredSelectionsArr = new Set<readonly SelectionNode[]>();
+  const ignoredFragments = new Set<string>();
   return visit(document, {
     Document(node) {
       return {
@@ -13,30 +16,49 @@ export function sortExecutableDocument(document: DocumentNode): DocumentNode {
       };
     },
     OperationDefinition(node) {
+      if (node.operation === 'mutation') {
+        ignoredNodes.add(node.selectionSet);
+        ignoredSelectionsArr.add(node.selectionSet.selections);
+      }
       return {
         ...node,
         variableDefinitions: sortExecutableNodes(node.variableDefinitions),
       };
     },
     SelectionSet(node) {
+      if (ignoredNodes.has(node)) {
+        ignoredSelectionsArr.add(node.selections);
+        return node;
+      }
       return {
         ...node,
         selections: sortExecutableNodes(node.selections),
       };
     },
-    FragmentSpread(node) {
+    FragmentSpread(node, _key, parent) {
+      if (Array.isArray(parent) && ignoredSelectionsArr.has(parent)) {
+        ignoredFragments.add(node.name.value);
+      }
       return {
         ...node,
         directives: sortExecutableNodes(node.directives),
       };
     },
-    InlineFragment(node) {
+    InlineFragment(node, _key, parent) {
+      if (Array.isArray(parent) && ignoredSelectionsArr.has(parent)) {
+        ignoredNodes.add(node.selectionSet);
+        ignoredSelectionsArr.add(node.selectionSet.selections);
+        return node;
+      }
       return {
         ...node,
         directives: sortExecutableNodes(node.directives),
       };
     },
     FragmentDefinition(node) {
+      if (ignoredFragments.has(node.name.value)) {
+        return node;
+      }
       return {
         ...node,
         directives: sortExecutableNodes(node.directives),

diff --git a/packages/documents/tests/print-executable-graphql-document.spec.ts b/packages/documents/tests/print-executable-graphql-document.spec.ts
@@ -83,4 +83,30 @@ describe('printExecutableGraphQLDocument', () => {
       `"fragment B on Query { c } query A { ... on Query { a { a ...B } } ... on Query { a { b ...B } } }"`,
     );
   });
+
+  test('should not sort a mutation as mutations run in series and order matters', () => {
+    const inputDocument = parse(/* GraphQL */ `
+      mutation A {
+        ... on Mutation {
+          c
+          b
+          d
+        }
+        c {
+          d
+          e {
+            b
+            a
+          }
+          f
+        }
+        b
+        a
+      }
+    `);
+    const outputStr = printExecutableGraphQLDocument(inputDocument);
+    expect(outputStr).toMatchInlineSnapshot(
+      `"mutation A { ... on Mutation { c b d } c { d e { a b } f } b a }"`,
+    );
+  });
 });