fix(GraphQL): Typename for types should be filled in query for schema…

… introspection queries (dgraph-io#5827) There was a missing " in the __typename that was filled in for types in schema introspection queries. That resulted in JSON parsing errors, we have fixed it and modified the existing test to test for it. Fixes dgraph-io#5792.
dna2fork · Jul 18, 2020 · 17949ce · 17949ce
1 parent bee014e
commit 17949ce
Show file tree

Hide file tree

Showing 6 changed files with 697 additions and 415 deletions.
diff --git a/graphql/e2e/common/schema.go b/graphql/e2e/common/schema.go
@@ -40,7 +40,9 @@ const (
             }
 		],
 		"enumValues":[]
-	} }`
+	},
+	  "__typename" : "Query"
+	}`
 
 	expectedForType = `
 	{ "__type": {
@@ -75,7 +77,7 @@ const (
             }
 		],
 		"enumValues":[]
-	} }`
+	}, "__typename" : "Query" }`
 
 	expectedForEnum = `
 	{ "__type": {
@@ -98,7 +100,7 @@ const (
             }
 		],
 		"fields":[]
-    } }`
+    }, "__typename" : "Query" }`
 )
 
 func SchemaTest(t *testing.T, expectedDgraphSchema string) {
@@ -138,6 +140,7 @@ func graphQLDescriptions(t *testing.T) {
 				description
 			}
 		}
+		__typename
 	}`
 
 	for testName, tCase := range testCases {

diff --git a/graphql/resolve/resolver.go b/graphql/resolve/resolver.go
@@ -235,6 +235,10 @@ func (rf *resolverFactory) WithSchemaIntrospection() ResolverFactory {
 				return QueryResolverFunc(resolveIntrospection)
 			}).
 		WithQueryResolver("__type",
+			func(q schema.Query) QueryResolver {
+				return QueryResolverFunc(resolveIntrospection)
+			}).
+		WithQueryResolver("__typename",
 			func(q schema.Query) QueryResolver {
 				return QueryResolverFunc(resolveIntrospection)
 			})

diff --git a/graphql/schema/introspection.go b/graphql/schema/introspection.go
@@ -25,7 +25,7 @@ import (
 // Introspect performs an introspection query given a query that's expected to be either
 // __schema or __type.
 func Introspect(q Query) (json.RawMessage, error) {
-	if q.Name() != "__schema" && q.Name() != "__type" {
+	if q.Name() != "__schema" && q.Name() != "__type" && q.Name() != Typename {
 		return nil, errors.New("call to introspect for field that isn't an introspection query " +
 			"this indicates bug (Please let us know : https://github.com/dgraph-io/dgraph/issues)")
 	}
@@ -164,7 +164,6 @@ func (ec *executionContext) handleQuery(sel ast.Selection) []byte {
 		}
 		ec.writeKey(field.Alias)
 		switch field.Name {
-		// TODO - Add tests for __typename.
 		case Typename:
 			x.Check2(ec.b.WriteString(`"Query"`))
 		case "__type":
@@ -327,7 +326,7 @@ func (ec *executionContext) handleType(sel ast.SelectionSet, obj *introspection.
 		ec.writeKey(field.Alias)
 		switch field.Name {
 		case Typename:
-			x.Check2(ec.b.WriteString(`"__Type`))
+			x.Check2(ec.b.WriteString(`"__Type"`))
 		case "kind":
 			ec.writeStringValue(obj.Kind())
 		case "name":

diff --git a/graphql/schema/introspection_test.go b/graphql/schema/introspection_test.go
@@ -1,6 +1,7 @@
 package schema
 
 import (
+	"fmt"
 	"io/ioutil"
 	"path/filepath"
 	"testing"
@@ -143,7 +144,7 @@ func TestIntrospectionQueryMissingNameArg(t *testing.T) {
 		schema {
 			query: TestType
 		}
-	
+
 		type TestType {
 			testField: String
 		}
@@ -220,6 +221,122 @@ func TestIntrospectionQueryWithVars(t *testing.T) {
 	testutil.CompareJSON(t, string(expectedBuf), string(resp))
 }
 
+const (
+	testIntrospectionQuery = `query {
+		__schema {
+		  __typename
+		  queryType {
+			name
+			__typename
+		  }
+		  mutationType {
+			name
+			__typename
+		  }
+		  subscriptionType {
+			name
+			__typename
+		  }
+		  types {
+			...FullType
+		  }
+		  directives {
+			__typename
+			name
+			locations
+			args {
+			  ...InputValue
+			}
+		  }
+		}
+	  }
+	  fragment FullType on __Type {
+		kind
+		name
+		fields(includeDeprecated: true) {
+		  __typename
+		  name
+		  args {
+			...InputValue
+			__typename
+		  }
+		  type {
+			...TypeRef
+			__typename
+		  }
+		  isDeprecated
+		  deprecationReason
+		}
+		inputFields {
+		  ...InputValue
+		  __typename
+		}
+		interfaces {
+		  ...TypeRef
+		  __typename
+		}
+		enumValues(includeDeprecated: true) {
+		  name
+		  isDeprecated
+		  deprecationReason
+		  __typename
+		}
+		possibleTypes {
+		  ...TypeRef
+		  __typename
+		}
+		__typename
+	  }
+	  fragment InputValue on __InputValue {
+		__typename
+		name
+		type {
+		  ...TypeRef
+		}
+		defaultValue
+	  }
+	  fragment TypeRef on __Type {
+		kind
+		name
+		ofType {
+		  kind
+		  name
+		  ofType {
+			kind
+			name
+			ofType {
+			  kind
+			  name
+			  ofType {
+				kind
+				name
+				ofType {
+				  kind
+				  name
+				  ofType {
+					kind
+					name
+					ofType {
+					  kind
+					  name
+					  __typename
+					}
+					__typename
+				  }
+				  __typename
+				}
+				__typename
+			  }
+			  __typename
+			}
+			__typename
+		  }
+		  __typename
+		}
+		__typename
+	  }`
+)
+
 func TestFullIntrospectionQuery(t *testing.T) {
 	sch := gqlparser.MustLoadSchema(
 		&ast.Source{Name: "schema.graphql", Input: `
@@ -232,7 +349,7 @@ func TestFullIntrospectionQuery(t *testing.T) {
 	}
 `})
 
-	doc, gqlErr := parser.ParseQuery(&ast.Source{Input: introspectionQuery})
+	doc, gqlErr := parser.ParseQuery(&ast.Source{Input: testIntrospectionQuery})
 	require.Nil(t, gqlErr)
 
 	listErr := validator.Validate(sch, doc)
@@ -242,13 +359,14 @@ func TestFullIntrospectionQuery(t *testing.T) {
 	require.NotNil(t, op)
 	oper := &operation{op: op,
 		vars:     map[string]interface{}{},
-		query:    string(introspectionQuery),
+		query:    string(testIntrospectionQuery),
 		doc:      doc,
 		inSchema: &schema{schema: sch},
 	}
 
 	queries := oper.Queries()
 	resp, err := Introspect(queries[0])
+	fmt.Println(string(resp))
 	require.NoError(t, err)
 
 	expectedBuf, err := ioutil.ReadFile("testdata/introspection/output/full_query.json")