Schema: keep order of user provided types (#2410)

Motivation: #2362
graphql · Jan 29, 2020 · 68a0818 · 68a0818
1 parent 6652178
commit 68a0818
Show file tree

Hide file tree

Showing 6 changed files with 185 additions and 136 deletions.
diff --git a/src/__tests__/starWarsIntrospection-test.js b/src/__tests__/starWarsIntrospection-test.js
@@ -32,16 +32,16 @@ describe('Star Wars Introspection Tests', () => {
       expect(data).to.deep.equal({
         __schema: {
           types: [
-            { name: 'Query' },
-            { name: 'Episode' },
+            { name: 'Human' },
             { name: 'Character' },
             { name: 'String' },
-            { name: 'Human' },
+            { name: 'Episode' },
             { name: 'Droid' },
+            { name: 'Query' },
+            { name: 'Boolean' },
             { name: '__Schema' },
             { name: '__Type' },
             { name: '__TypeKind' },
-            { name: 'Boolean' },
             { name: '__Field' },
             { name: '__InputValue' },
             { name: '__EnumValue' },

diff --git a/src/execution/__tests__/union-interface-test.js b/src/execution/__tests__/union-interface-test.js
@@ -199,7 +199,7 @@ describe('Execute: Union and intersection types', () => {
           name: 'Named',
           fields: [{ name: 'name' }],
           interfaces: [],
-          possibleTypes: [{ name: 'Person' }, { name: 'Dog' }, { name: 'Cat' }],
+          possibleTypes: [{ name: 'Dog' }, { name: 'Cat' }, { name: 'Person' }],
           enumValues: null,
           inputFields: null,
         },
@@ -208,7 +208,7 @@ describe('Execute: Union and intersection types', () => {
           name: 'Mammal',
           fields: [{ name: 'progeny' }, { name: 'mother' }, { name: 'father' }],
           interfaces: [{ name: 'Life' }],
-          possibleTypes: [{ name: 'Person' }, { name: 'Dog' }, { name: 'Cat' }],
+          possibleTypes: [{ name: 'Dog' }, { name: 'Cat' }, { name: 'Person' }],
           enumValues: null,
           inputFields: null,
         },

diff --git a/src/type/__tests__/introspection-test.js b/src/type/__tests__/introspection-test.js
@@ -69,6 +69,15 @@ describe('Introspection', () => {
               enumValues: null,
               possibleTypes: null,
             },
+            {
+              kind: 'SCALAR',
+              name: 'Boolean',
+              fields: null,
+              inputFields: null,
+              interfaces: null,
+              enumValues: null,
+              possibleTypes: null,
+            },
             {
               kind: 'OBJECT',
               name: '__Schema',
@@ -385,15 +394,6 @@ describe('Introspection', () => {
               ],
               possibleTypes: null,
             },
-            {
-              kind: 'SCALAR',
-              name: 'Boolean',
-              fields: null,
-              inputFields: null,
-              interfaces: null,
-              enumValues: null,
-              possibleTypes: null,
-            },
             {
               kind: 'OBJECT',
               name: '__Field',

diff --git a/src/type/__tests__/schema-test.js b/src/type/__tests__/schema-test.js
@@ -253,6 +253,57 @@ describe('Type System: Schema', () => {
     });
   });
 
+  it('preserve order of use provided types', () => {
+    const aType = new GraphQLObjectType({
+      name: 'A',
+      fields: {
+        sub: { type: new GraphQLScalarType({ name: 'ASub' }) },
+      },
+    });
+    const zType = new GraphQLObjectType({
+      name: 'Z',
+      fields: {
+        sub: { type: new GraphQLScalarType({ name: 'ZSub' }) },
+      },
+    });
+    const queryType = new GraphQLObjectType({
+      name: 'Query',
+      fields: {
+        a: { type: aType },
+        z: { type: zType },
+        sub: { type: new GraphQLScalarType({ name: 'QuerySub' }) },
+      },
+    });
+    const schema = new GraphQLSchema({
+      types: [zType, queryType, aType],
+      query: queryType,
+    });
+
+    const typeNames = Object.keys(schema.getTypeMap());
+    expect(typeNames).to.deep.equal([
+      'Z',
+      'ZSub',
+      'Query',
+      'QuerySub',
+      'A',
+      'ASub',
+      'Boolean',
+      'String',
+      '__Schema',
+      '__Type',
+      '__TypeKind',
+      '__Field',
+      '__InputValue',
+      '__EnumValue',
+      '__Directive',
+      '__DirectiveLocation',
+    ]);
+
+    // Also check that this order is stable
+    const copySchema = new GraphQLSchema(schema.toConfig());
+    expect(Object.keys(copySchema.getTypeMap())).to.deep.equal(typeNames);
+  });
+
   it('can be Object.toStringified', () => {
     const schema = new GraphQLSchema({});
 

diff --git a/src/type/__tests__/validation-test.js b/src/type/__tests__/validation-test.js
@@ -1330,11 +1330,11 @@ describe('Type System: Interface fields must have output types', () => {
     expect(validateSchema(schema)).to.deep.equal([
       {
         message:
-          'The type of BadInterface.badField must be Output Type but got: undefined.',
+          'The type of BadImplementing.badField must be Output Type but got: undefined.',
       },
       {
         message:
-          'The type of BadImplementing.badField must be Output Type but got: undefined.',
+          'The type of BadInterface.badField must be Output Type but got: undefined.',
       },
     ]);
   });
@@ -1346,10 +1346,10 @@ describe('Type System: Interface fields must have output types', () => {
       const schema = schemaWithInterfaceFieldOfType(type);
       expect(validateSchema(schema)).to.deep.equal([
         {
-          message: `The type of BadInterface.badField must be Output Type but got: ${typeStr}.`,
+          message: `The type of BadImplementing.badField must be Output Type but got: ${typeStr}.`,
         },
         {
-          message: `The type of BadImplementing.badField must be Output Type but got: ${typeStr}.`,
+          message: `The type of BadInterface.badField must be Output Type but got: ${typeStr}.`,
         },
       ]);
     });
@@ -1361,14 +1361,14 @@ describe('Type System: Interface fields must have output types', () => {
     expect(validateSchema(schema)).to.deep.equal([
       {
         message:
-          'The type of BadInterface.badField must be Output Type but got: [function Number].',
+          'The type of BadImplementing.badField must be Output Type but got: [function Number].',
       },
       {
-        message: 'Expected GraphQL named type but got: [function Number].',
+        message:
+          'The type of BadInterface.badField must be Output Type but got: [function Number].',
       },
       {
-        message:
-          'The type of BadImplementing.badField must be Output Type but got: [function Number].',
+        message: 'Expected GraphQL named type but got: [function Number].',
       },
     ]);
   });