Bump GraphQL Tools for Schema Sorting and the fix for the schema definition handling (#6625)

* transformSchemaAST sort schema support

* #6624 - transformSchemaAST add test

* feat: sort the schema if sort option is provided

* Another changeset

Co-authored-by: zubkov7 <[email protected]>
Co-authored-by: Arda TANRIKULU <[email protected]>

Author: 3 people

.changeset/heavy-tables-float.md

@@ -0,0 +1,5 @@
+---
+'@graphql-codegen/cli': patch
+---
+
+fix: handle convertExtensions properly with schema definitions

.changeset/quick-candles-suffer.md

@@ -0,0 +1,6 @@
+---
+'@graphql-codegen/cli': minor
+'@graphql-codegen/schema-ast': minor
+---
+
+feat: sort the schema if "sort" option is provided

examples/programmatic-typescript/package.json

@@ -14,7 +14,7 @@
     "@graphql-codegen/typescript-operations": "*",
     "@graphql-codegen/typescript-resolvers": "*",
     "@graphql-tools/graphql-file-loader": "^7.0.1",
-    "@graphql-tools/load": "^7.1.8",
+    "@graphql-tools/load": "^7.3.0",
     "@graphql-tools/schema": "^8.1.2",
     "graphql": "^15.5.1",
     "graphql-tag": "^2.12.5",

packages/graphql-codegen-cli/package.json

@@ -48,7 +48,7 @@
     "@graphql-tools/github-loader": "^7.0.5",
     "@graphql-tools/graphql-file-loader": "^7.0.5",
     "@graphql-tools/json-file-loader": "^7.1.2",
-    "@graphql-tools/load": "^7.1.8",
+    "@graphql-tools/load": "^7.3.0",
     "@graphql-tools/prisma-loader": "^7.0.6",
     "@graphql-tools/url-loader": "^7.0.11",
     "@graphql-tools/utils": "^8.1.1",

packages/graphql-codegen-cli/tests/codegen.spec.ts

@@ -1011,4 +1011,54 @@ describe('Codegen Executor', () => {
     expect(output.length).toBe(1);
     expect(output[0].content).toContain('Hello world!');
   });
+
+  it('Should sort the input schema', async () => {
+    const nonSortedSchema = /* GraphQL */ `
+      type Query {
+        d: String
+        z: String
+        a: String
+      }
+
+      type User {
+        aa: String
+        a: String
+      }
+
+      type A {
+        s: String
+        b: String
+      }
+    `;
+    const output = await executeCodegen({
+      schema: [nonSortedSchema],
+      generates: {
+        'out1.graphql': {
+          plugins: ['schema-ast'],
+        },
+      },
+      config: {
+        sort: true,
+      },
+    });
+
+    expect(output.length).toBe(1);
+    expect(output[0].content).toBeSimilarStringTo(/* GraphQL */ `
+      type A {
+        b: String
+        s: String
+      }
+
+      type Query {
+        a: String
+        d: String
+        z: String
+      }
+
+      type User {
+        a: String
+        aa: String
+      }
+    `);
+  });
 });

packages/plugins/other/schema-ast/src/index.ts

@@ -1,4 +1,4 @@
-import { GraphQLSchema, lexicographicSortSchema, printSchema, visit, buildASTSchema } from 'graphql';
+import { GraphQLSchema, printSchema, visit, buildASTSchema, print } from 'graphql';
 import {
   PluginFunction,
   PluginValidateFn,
@@ -7,7 +7,6 @@ import {
   getCachedDocumentNodeFromSchema,
 } from '@graphql-codegen/plugin-helpers';
 import { extname } from 'path';
-import { printSchemaWithDirectives } from '@graphql-tools/utils';
 
 /**
  * @description This plugin prints the merged schema as string. If multiple schemas are provided, they will be merged and printed as one schema.
@@ -59,14 +58,13 @@ export const plugin: PluginFunction<SchemaASTConfig> = async (
   _documents,
   { commentDescriptions = false, includeDirectives = false, sort = false, federation }
 ): Promise<string> => {
-  let outputSchema = federation ? removeFederation(schema) : schema;
-  outputSchema = sort ? lexicographicSortSchema(outputSchema) : outputSchema;
+  const transformedSchemaAndAst = transformSchemaAST(schema, { sort, federation });
 
   if (includeDirectives) {
-    return printSchemaWithDirectives(outputSchema);
+    return print(transformedSchemaAndAst.ast);
   }
 
-  return printSchema(outputSchema, { commentDescriptions: commentDescriptions });
+  return printSchema(transformedSchemaAndAst.schema, { commentDescriptions: commentDescriptions });
 };
 
 export const validate: PluginValidateFn<any> = async (
@@ -84,21 +82,20 @@ export const validate: PluginValidateFn<any> = async (
 };
 
 export function transformSchemaAST(schema: GraphQLSchema, config: { [key: string]: any }) {
-  const astNode = getCachedDocumentNodeFromSchema(schema);
-
-  const transformedAST = config.disableDescriptions
-    ? visit(astNode, {
+  schema = config.federation ? removeFederation(schema) : schema;
+  let ast = getCachedDocumentNodeFromSchema(schema);
+  ast = config.disableDescriptions
+    ? visit(ast, {
         leave: node => ({
           ...node,
           description: undefined,
         }),
       })
-    : astNode;
-
-  const transformedSchema = config.disableDescriptions ? buildASTSchema(transformedAST) : schema;
+    : ast;
+  schema = config.disableDescriptions ? buildASTSchema(ast) : schema;
 
   return {
-    schema: transformedSchema,
-    ast: transformedAST,
+    schema,
+    ast,
   };
 }

packages/plugins/other/schema-ast/tests/schema-ast.spec.ts

@@ -8,44 +8,6 @@ import { codegen } from '@graphql-codegen/core';
 const SHOULD_THROW_ERROR = 'SHOULD_THROW_ERROR';
 
 describe('Schema AST', () => {
-  describe('Issues', () => {
-    it('#4919 - should support sorting the schema', async () => {
-      const schema = buildSchema(/* GraphQL */ `
-        type Query {
-          d: String
-          z: String
-          a: String
-        }
-
-        type User {
-          aa: String
-          a: String
-        }
-
-        type A {
-          s: String
-          b: String
-        }
-      `);
-      const content = await plugin(schema, [], { sort: true });
-      expect(content).toBeSimilarStringTo(`
-      type A {
-        b: String
-        s: String
-      }
-      
-      type Query {
-        a: String
-        d: String
-        z: String
-      }
-      
-      type User {
-        a: String
-        aa: String
-      }`);
-    });
-  });
   describe('Validation', () => {
     it('Should enforce graphql extension when its the only plugin', async () => {
       const fileName = 'output.ts';
@@ -164,7 +126,7 @@ describe('Schema AST', () => {
       const content = await plugin(schema, [], { includeDirectives: true });
 
       expect(content).toBeSimilarStringTo(`
-        directive @modify(limit: Int) on FIELD_DEFINITION 
+        directive @modify(limit: Int) on FIELD_DEFINITION
       `);
       expect(content).toBeSimilarStringTo(`
         type Query {
@@ -231,14 +193,14 @@ describe('Schema AST', () => {
           id: ID
           side: String
         }
-        
+
         type Droid {
           id: ID
           model: String
         }
-        
+
         union People = Character | Jedi | Droid
-        
+
         type Query {
           allPeople: [People]
         }

yarn.lock

@@ -2093,13 +2093,13 @@
     unixify "1.0.0"
     valid-url "1.0.9"
 
-"@graphql-tools/load@^7.1.0", "@graphql-tools/load@^7.1.8":
-  version "7.1.8"
-  resolved "https://registry.yarnpkg.com/@graphql-tools/load/-/load-7.1.8.tgz#c6f2ce19e7497d2f56d572d4fe2aded01a87edf1"
-  integrity sha512-dVl2jJon9VL0qLTC98hJH4CkQ/oat6j9TouCk69ezzWHFxiPlz6tF78BzLr86Mz+bY6QCGeNIJ75Ovyn7EutCQ==
+"@graphql-tools/load@^7.1.0", "@graphql-tools/load@^7.3.0":
+  version "7.3.0"
+  resolved "https://registry.yarnpkg.com/@graphql-tools/load/-/load-7.3.0.tgz#dc4177bb4b7ae537c833a2fcd97ab07b6c789c65"
+  integrity sha512-ZVipT7yzOpf/DJ2sLI3xGwnULVFp/icu7RFEgDo2ZX0WHiS7EjWZ0cegxEm87+WN4fMwpiysRLzWx67VIHwKGA==
   dependencies:
-    "@graphql-tools/schema" "8.1.2"
-    "@graphql-tools/utils" "^8.1.1"
+    "@graphql-tools/schema" "8.2.0"
+    "@graphql-tools/utils" "^8.2.0"
     p-limit "3.1.0"
     tslib "~2.3.0"
 
@@ -3262,7 +3262,12 @@
   resolved "https://registry.yarnpkg.com/@types/ms/-/ms-0.7.31.tgz#31b7ca6407128a3d2bbc27fe2d21b345397f6197"
   integrity sha512-iiUgKzV9AuaEkZqkOLDIvlQiL6ltuZd9tGcW3gwpnX8JbuiuhFlEGmmFXEXkN50Cvq7Os88IY2v0dkDqXYWVgA==
 
-"@types/node@*", "@types/[email protected]", "@types/node@^14.14.33":
+"@types/node@*", "@types/node@^16.4.10":
+  version "16.4.13"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-16.4.13.tgz#7dfd9c14661edc65cccd43a29eb454174642370d"
+  integrity sha512-bLL69sKtd25w7p1nvg9pigE4gtKVpGTPojBFLMkGHXuUgap2sLqQt2qUnqmVCDfzGUL0DRNZP+1prIZJbMeAXg==
+
+"@types/[email protected]", "@types/node@^14.14.33":
   version "14.17.14"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-14.17.14.tgz#6fda9785b41570eb628bac27be4b602769a3f938"
   integrity sha512-rsAj2u8Xkqfc332iXV12SqIsjVi07H479bOP4q94NAcjzmAvapumEhuVIt53koEf7JFrpjgNKjBga5Pnn/GL8A==
@@ -3282,11 +3287,6 @@
   resolved "https://registry.yarnpkg.com/@types/node/-/node-15.14.7.tgz#29fea9a5b14e2b75c19028e1c7a32edd1e89fe92"
   integrity sha512-FA45p37/mLhpebgbPWWCKfOisTjxGK9lwcHlJ6XVLfu3NgfcazOJHdYUZCWPMK8QX4LhNZdmfo6iMz9FqpUbaw==
 
-"@types/node@^16.4.10":
-  version "16.4.13"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-16.4.13.tgz#7dfd9c14661edc65cccd43a29eb454174642370d"
-  integrity sha512-bLL69sKtd25w7p1nvg9pigE4gtKVpGTPojBFLMkGHXuUgap2sLqQt2qUnqmVCDfzGUL0DRNZP+1prIZJbMeAXg==
-
 "@types/normalize-package-data@^2.4.0":
   version "2.4.1"
   resolved "https://registry.yarnpkg.com/@types/normalize-package-data/-/normalize-package-data-2.4.1.tgz#d3357479a0fdfdd5907fe67e17e0a85c906e1301"
@@ -13561,12 +13561,12 @@ rxjs@^6.3.3, rxjs@^6.4.0, rxjs@^6.5.1, rxjs@^6.6.0, rxjs@^6.6.3, rxjs@^6.6.7:
   dependencies:
     tslib "^1.9.0"
 
-[email protected], safe-buffer@>=5.1.0, safe-buffer@^5.0.1, safe-buffer@^5.1.0, safe-buffer@^5.1.1, safe-buffer@^5.1.2, safe-buffer@~5.1.0, safe-buffer@~5.1.1:
+[email protected], safe-buffer@~5.1.0, safe-buffer@~5.1.1:
   version "5.1.2"
   resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d"
   integrity sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==
 
-safe-buffer@^5.2.0, safe-buffer@~5.2.0:
+safe-buffer@>=5.1.0, safe-buffer@^5.0.1, safe-buffer@^5.1.0, safe-buffer@^5.1.1, safe-buffer@^5.1.2, safe-buffer@^5.2.0, safe-buffer@~5.2.0:
   version "5.2.1"
   resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6"
   integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==