fix(utils): prevent race conditions when validating documents (#5795)

* fix(utils): prevent race conditions when validating documents * Changeset --------- Co-authored-by: Arda TANRIKULU <ardatanrikulu@gmail.com>
ardatan · Jan 22, 2024 · f85c093 · f85c093
1 parent 8770be9
commit f85c093
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 5 deletions.
diff --git a/.changeset/twenty-walls-sleep.md b/.changeset/twenty-walls-sleep.md
@@ -0,0 +1,5 @@
+---
+'@graphql-tools/utils': patch
+---
+
+prevent race conditions when validating documents
diff --git a/packages/utils/src/validate-documents.ts b/packages/utils/src/validate-documents.ts
@@ -17,19 +17,20 @@ export function validateGraphQlDocuments(
   documents: DocumentNode[],
   rules: ValidationRule[] = createDefaultRules(),
 ) {
-  const definitionMap = new Map<string, DefinitionNode>();
+  const definitions = new Set<DefinitionNode>();
+  const fragmentsDefinitionsMap = new Map<string, DefinitionNode>();
   for (const document of documents) {
     for (const docDefinition of document.definitions) {
-      if ('name' in docDefinition && docDefinition.name) {
-        definitionMap.set(`${docDefinition.kind}_${docDefinition.name.value}`, docDefinition);
+      if (docDefinition.kind === Kind.FRAGMENT_DEFINITION) {
+        fragmentsDefinitionsMap.set(docDefinition.name.value, docDefinition);
       } else {
-        definitionMap.set(Date.now().toString(), docDefinition);
+        definitions.add(docDefinition);
       }
     }
   }
   const fullAST: DocumentNode = {
     kind: Kind.DOCUMENT,
-    definitions: Array.from(definitionMap.values()),
+    definitions: Array.from([...definitions, ...fragmentsDefinitionsMap.values()]),
   };
   const errors = validate(schema, fullAST, rules);
   for (const error of errors) {

diff --git a/packages/utils/tests/validate-documents.spec.ts b/packages/utils/tests/validate-documents.spec.ts
@@ -59,6 +59,62 @@ describe('validateGraphQlDocuments', () => {
     at packages/client/src/pages/search/searchPage.query.graphql:6:15`);
   });
 
+  it('Should throw a validation error when multiple anonymous queries are present', async () => {
+    const schema = buildSchema(/* GraphQL */ `
+      type OtherStuff {
+        foo: String
+      }
+
+      type Pizzeria {
+        id: Int
+        name: String
+        location: String
+      }
+
+      type Query {
+        otherStuff: OtherStuff
+        pizzeria: Pizzeria
+      }
+    `);
+
+    const result = validateGraphQlDocuments(schema, [
+      parse(
+        new Source(
+          /* GraphQL */ `
+            query {
+              pizzeria {
+                id
+                name
+              }
+            }
+          `,
+          'packages/client/src/pages/products/productPage.query.graphql',
+        ),
+      ),
+      parse(
+        new Source(
+          /* GraphQL */ `
+            query {
+              otherStuff {
+                foo
+              }
+            }
+          `,
+          'packages/client/src/pages/search/searchPage.query.graphql',
+        ),
+      ),
+    ]);
+
+    expect(result).toHaveLength(2);
+    expect(result[0].source?.name).toBe(
+      'packages/client/src/pages/products/productPage.query.graphql',
+    );
+    expect(result[0] instanceof GraphQLError).toBeTruthy();
+    expect(result[0].message).toBe('This anonymous operation must be the only defined operation.');
+    expect(result[0].stack).toBe(`This anonymous operation must be the only defined operation.
+    at packages/client/src/pages/products/productPage.query.graphql:2:13`);
+  });
+
   it('Should not swallow fragments on operation/fragment name conflict', async () => {
     const schema = buildSchema(/* GraphQL */ `
       type Query {