Merge pull request #90 from graphql-java/graphql-context-added

GraphqlContext added as well as the locale fix promised for so long

Author: dondonz

src/main/java/graphql/validation/locale/LocaleUtil.java

@@ -23,9 +23,9 @@ public class LocaleUtil {
      */
     public static Locale determineLocale(DataFetchingEnvironment environment, Locale defaultLocale) {
         //
-        // in a future version of graphql java the DFE will have the Locale but in the mean time
-        Locale locale;
-        locale = extractLocale(environment);
+        // The DFE has a locale now, but we retain the old look-ups for backwards compat reasons
+        //
+        Locale locale = environment.getLocale();
         if (locale == null) {
             locale = extractLocale(environment.getContext());
             if (locale == null) {

src/main/java/graphql/validation/rules/ValidationEnvironment.java

@@ -1,5 +1,6 @@
 package graphql.validation.rules;
 
+import graphql.GraphQLContext;
 import graphql.PublicApi;
 import graphql.execution.ResultPath;
 import graphql.language.SourceLocation;
@@ -55,6 +56,8 @@ public enum ValidatedElement {
     private final Object validatedValue;
     private final GraphQLInputType validatedType;
     private final ValidatedElement validatedElement;
+
+    private final GraphQLContext graphQLContext;
     private final List<GraphQLAppliedDirective> directives;
 
     private ValidationEnvironment(Builder builder) {
@@ -71,6 +74,7 @@ private ValidationEnvironment(Builder builder) {
         this.location = builder.location;
         this.validatedValue = builder.validatedValue;
         this.validatedElement = builder.validatedElement;
+        this.graphQLContext = builder.graphQLContext;
         this.directives = builder.directives;
     }
 
@@ -135,6 +139,10 @@ public List<GraphQLAppliedDirective> getDirectives() {
         return directives;
     }
 
+    public GraphQLContext getGraphQLContext() {
+        return graphQLContext;
+    }
+
     public ValidationEnvironment transform(Consumer<Builder> builderConsumer) {
         Builder builder = newValidationEnvironment().validationEnvironment(this);
         builderConsumer.accept(builder);
@@ -156,6 +164,7 @@ public static class Builder {
         private GraphQLInputType validatedType;
         private ValidatedElement validatedElement;
         private List<GraphQLAppliedDirective> directives = Collections.emptyList();
+        private GraphQLContext graphQLContext = GraphQLContext.getDefault();
 
         public Builder validationEnvironment(ValidationEnvironment validationEnvironment) {
             this.argument = validationEnvironment.argument;
@@ -172,6 +181,7 @@ public Builder validationEnvironment(ValidationEnvironment validationEnvironment
             this.validatedValue = validationEnvironment.validatedValue;
             this.validatedElement = validationEnvironment.validatedElement;
             this.directives = validationEnvironment.directives;
+            this.graphQLContext = validationEnvironment.graphQLContext;
             return this;
         }
 
@@ -184,6 +194,7 @@ public Builder dataFetchingEnvironment(DataFetchingEnvironment dataFetchingEnvir
             location(dataFetchingEnvironment.getField().getSourceLocation());
             argumentValues(dataFetchingEnvironment.getArguments());
             validatedElement(ValidatedElement.FIELD);
+            graphQLContext(dataFetchingEnvironment.getGraphQlContext());
             return this;
         }
 
@@ -252,6 +263,11 @@ public Builder locale(Locale locale) {
             return this;
         }
 
+        public Builder graphQLContext(GraphQLContext graphQLContext) {
+            this.graphQLContext = graphQLContext;
+            return this;
+        }
+
         public Builder directives(List<GraphQLAppliedDirective> directives) {
             this.directives = directives;
             return this;

src/test/groovy/graphql/validation/locale/LocaleUtilTest.groovy

@@ -1,7 +1,7 @@
 package graphql.validation.locale
 
+import graphql.GraphQLContext
 import graphql.GraphQLError
-import graphql.GraphqlErrorBuilder
 import graphql.execution.ExecutionStepInfo
 import graphql.execution.MergedField
 import graphql.schema.DataFetchingEnvironment
@@ -18,6 +18,8 @@ import graphql.validation.rules.ValidationEnvironment
 import graphql.validation.rules.ValidationRule
 import spock.lang.Specification
 
+import static graphql.GraphqlErrorBuilder.newError
+
 class LocaleUtilTest extends Specification {
 
     def directiveRules = DirectiveConstraints.newDirectiveConstraints().build()
@@ -99,7 +101,10 @@ class LocaleUtilTest extends Specification {
 
             @Override
             List<GraphQLError> runValidation(ValidationEnvironment validationEnvironment) {
-                return [GraphqlErrorBuilder.newError().message("Locale=" + validationEnvironment.getLocale().getCountry()).build()]
+                return [
+                        newError().message("Locale=" + validationEnvironment.getLocale().getCountry()).build(),
+                        newError().message("Context=" + (validationEnvironment.getGraphQLContext() != null)).build()
+                ]
             }
         }
 
@@ -176,5 +181,31 @@ class LocaleUtilTest extends Specification {
         errors = targetedValidationRules.runValidationRules(dfe, new ResourceBundleMessageInterpolator(), Locale.CHINA)
         then:
         errors[0].message == "Locale=GB"
+
+        // use DFE direct
+        when:
+
+        dfe = DataFetchingEnvironmentImpl.newDataFetchingEnvironment(dfe)
+                .locale(Locale.UK)
+                .build()
+
+        errors = targetedValidationRules.runValidationRules(dfe, new ResourceBundleMessageInterpolator(), Locale.CHINA)
+        then:
+        errors[0].message == "Locale=GB"
+        errors[1].message == "Context=false"
+
+        // sneaking in a test that graphql context gets picked up here
+        // cheeky I know but the setup of a clean test in the exact right place is not worth it
+        when:
+
+        dfe = DataFetchingEnvironmentImpl.newDataFetchingEnvironment(dfe)
+                .locale(Locale.UK)
+                .graphQLContext(GraphQLContext.of([x: "present"]))
+                .build()
+
+        errors = targetedValidationRules.runValidationRules(dfe, new ResourceBundleMessageInterpolator(), Locale.CHINA)
+        then:
+        errors[0].message == "Locale=GB"
+        errors[1].message == "Context=true"
     }
 }