refactoring

andimarek · andimarek · commit b8fdebb60590 · 2017-05-28T03:08:07.000+02:00
add some comments
diff --git a/src/main/java/graphql/validation/TraversalContext.java b/src/main/java/graphql/validation/TraversalContext.java
@@ -102,7 +102,7 @@ private void enterImpl(Field field) {
             fieldDefinition = getFieldDef(schema, parentType, field);
         }
         addFieldDef(fieldDefinition);
-        addType(fieldDefinition != null ? fieldDefinition.getType() : null);
+        addOutputType(fieldDefinition != null ? fieldDefinition.getType() : null);
     }
 
     private void enterImpl(Directive directive) {
@@ -111,11 +111,11 @@ private void enterImpl(Directive directive) {
 
     private void enterImpl(OperationDefinition operationDefinition) {
         if (operationDefinition.getOperation() == OperationDefinition.Operation.MUTATION) {
-            addType(schema.getMutationType());
+            addOutputType(schema.getMutationType());
         } else if (operationDefinition.getOperation() == OperationDefinition.Operation.QUERY) {
-            addType(schema.getQueryType());
+            addOutputType(schema.getQueryType());
         } else if (operationDefinition.getOperation() == OperationDefinition.Operation.SUBSCRIPTION) {
-            addType(schema.getSubscriptionType());
+            addOutputType(schema.getSubscriptionType());
         } else {
             throw new ShouldNotHappenException();
         }
@@ -129,12 +129,12 @@ private void enterImpl(InlineFragment inlineFragment) {
         } else {
             type = (GraphQLOutputType) getParentType();
         }
-        addType(type);
+        addOutputType(type);
     }
 
     private void enterImpl(FragmentDefinition fragmentDefinition) {
         GraphQLType type = schema.getType(fragmentDefinition.getTypeCondition().getName());
-        addType((GraphQLOutputType) type);
+        addOutputType((GraphQLOutputType) type);
     }
 
     private void enterImpl(VariableDefinition variableDefinition) {
@@ -214,11 +214,15 @@ private GraphQLNullableType getNullableType(GraphQLType type) {
         return (GraphQLNullableType) (type instanceof GraphQLNonNull ? ((GraphQLNonNull) type).getWrappedType() : type);
     }
 
+    /**
+     * @return can be null if current node does not have a OutputType associated: for example
+     * if the current field is unknown
+     */
     public GraphQLOutputType getOutputType() {
         return lastElement(outputTypeStack);
     }
 
-    private void addType(GraphQLOutputType type) {
+    private void addOutputType(GraphQLOutputType type) {
         outputTypeStack.add(type);
     }
 
@@ -228,6 +232,9 @@ private <T> T lastElement(List<T> list) {
         return list.get(list.size() - 1);
     }
 
+    /**
+     * @return can be null if the parent is not a CompositeType
+     */
     public GraphQLCompositeType getParentType() {
         return lastElement(parentTypeStack);
     }
diff --git a/src/main/java/graphql/validation/rules/FieldsOnCorrectType.java b/src/main/java/graphql/validation/rules/FieldsOnCorrectType.java
@@ -4,7 +4,11 @@
 import graphql.language.Field;
 import graphql.schema.GraphQLCompositeType;
 import graphql.schema.GraphQLFieldDefinition;
-import graphql.validation.*;
+import graphql.validation.AbstractRule;
+import graphql.validation.ValidationContext;
+import graphql.validation.ValidationError;
+import graphql.validation.ValidationErrorCollector;
+import graphql.validation.ValidationErrorType;
 
 public class FieldsOnCorrectType extends AbstractRule {
 
@@ -17,6 +21,7 @@ public FieldsOnCorrectType(ValidationContext validationContext, ValidationErrorC
     @Override
     public void checkField(Field field) {
         GraphQLCompositeType parentType = getValidationContext().getParentType();
+        // this means the parent type is not a CompositeType, which is an error handled elsewhere
         if (parentType == null) return;
         GraphQLFieldDefinition fieldDef = getValidationContext().getFieldDef();
         if (fieldDef == null) {

Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ private void enterImpl(Field field) {`
`102`	`102`	`fieldDefinition = getFieldDef(schema, parentType, field);`
`103`	`103`	`}`
`104`	`104`	`addFieldDef(fieldDefinition);`
`105`		`- addType(fieldDefinition != null ? fieldDefinition.getType() : null);`
	`105`	`+ addOutputType(fieldDefinition != null ? fieldDefinition.getType() : null);`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`private void enterImpl(Directive directive) {`
`@@ -111,11 +111,11 @@ private void enterImpl(Directive directive) {`
`111`	`111`
`112`	`112`	`private void enterImpl(OperationDefinition operationDefinition) {`
`113`	`113`	`if (operationDefinition.getOperation() == OperationDefinition.Operation.MUTATION) {`
`114`		`- addType(schema.getMutationType());`
	`114`	`+ addOutputType(schema.getMutationType());`
`115`	`115`	`} else if (operationDefinition.getOperation() == OperationDefinition.Operation.QUERY) {`
`116`		`- addType(schema.getQueryType());`
	`116`	`+ addOutputType(schema.getQueryType());`
`117`	`117`	`} else if (operationDefinition.getOperation() == OperationDefinition.Operation.SUBSCRIPTION) {`
`118`		`- addType(schema.getSubscriptionType());`
	`118`	`+ addOutputType(schema.getSubscriptionType());`
`119`	`119`	`} else {`
`120`	`120`	`throw new ShouldNotHappenException();`
`121`	`121`	`}`
`@@ -129,12 +129,12 @@ private void enterImpl(InlineFragment inlineFragment) {`
`129`	`129`	`} else {`
`130`	`130`	`type = (GraphQLOutputType) getParentType();`
`131`	`131`	`}`
`132`		`- addType(type);`
	`132`	`+ addOutputType(type);`
`133`	`133`	`}`
`134`	`134`
`135`	`135`	`private void enterImpl(FragmentDefinition fragmentDefinition) {`
`136`	`136`	`GraphQLType type = schema.getType(fragmentDefinition.getTypeCondition().getName());`
`137`		`- addType((GraphQLOutputType) type);`
	`137`	`+ addOutputType((GraphQLOutputType) type);`
`138`	`138`	`}`
`139`	`139`
`140`	`140`	`private void enterImpl(VariableDefinition variableDefinition) {`
`@@ -214,11 +214,15 @@ private GraphQLNullableType getNullableType(GraphQLType type) {`
`214`	`214`	`return (GraphQLNullableType) (type instanceof GraphQLNonNull ? ((GraphQLNonNull) type).getWrappedType() : type);`
`215`	`215`	`}`
`216`	`216`
	`217`	`+ /**`
	`218`	`+ * @return can be null if current node does not have a OutputType associated: for example`
	`219`	`+ * if the current field is unknown`
	`220`	`+ */`
`217`	`221`	`public GraphQLOutputType getOutputType() {`
`218`	`222`	`return lastElement(outputTypeStack);`
`219`	`223`	`}`
`220`	`224`
`221`		`- private void addType(GraphQLOutputType type) {`
	`225`	`+ private void addOutputType(GraphQLOutputType type) {`
`222`	`226`	`outputTypeStack.add(type);`
`223`	`227`	`}`
`224`	`228`
`@@ -228,6 +232,9 @@ private <T> T lastElement(List<T> list) {`
`228`	`232`	`return list.get(list.size() - 1);`
`229`	`233`	`}`
`230`	`234`
	`235`	`+ /**`
	`236`	`+ * @return can be null if the parent is not a CompositeType`
	`237`	`+ */`
`231`	`238`	`public GraphQLCompositeType getParentType() {`
`232`	`239`	`return lastElement(parentTypeStack);`
`233`	`240`	`}`