Put validate behinda flag on the SchemaBuilder

Author: josie-atkins

graphql-builder/src/main/java/com/phocassoftware/graphql/builder/EntityProcessor.java

@@ -21,6 +21,7 @@
 import graphql.schema.GraphQLOutputType;
 import graphql.schema.GraphQLScalarType;
 import graphql.schema.GraphQLType;
+
 import java.lang.annotation.Annotation;
 import java.lang.reflect.AnnotatedElement;
 import java.lang.reflect.Type;
@@ -38,13 +39,13 @@ public class EntityProcessor {
 	private final Map<String, EntityHolder> entities;
 	private final MethodProcessor methodProcessor;
 
-	EntityProcessor(DataFetcherRunner dataFetcherRunner, List<GraphQLScalarType> scalars, DirectivesSchema diretives) {
-		this.methodProcessor = new MethodProcessor(dataFetcherRunner, this, diretives);
+	EntityProcessor(DataFetcherRunner dataFetcherRunner, List<GraphQLScalarType> scalars, DirectivesSchema directives) {
+		this.methodProcessor = new MethodProcessor(dataFetcherRunner, this, directives);
 		this.entities = new HashMap<>();
 		addDefaults();
 		addScalars(scalars);
 
-		this.directives = diretives;
+		this.directives = directives;
 	}
 
 	private void addDefaults() {

graphql-builder/src/main/java/com/phocassoftware/graphql/builder/MethodProcessor.java

@@ -66,7 +66,7 @@ public MethodProcessor(DataFetcherRunner dataFetcherRunner, EntityProcessor enti
 		graphSubscriptions.name("Subscriptions");
 	}
 
-	void process(AuthorizerSchema authorizer, Method method) {
+	void process(AuthorizerSchema authorizer, Method method, boolean shouldValidate) {
 		if (!Modifier.isStatic(method.getModifiers())) {
 			throw new RuntimeException("End point must be a static method");
 		}
@@ -85,10 +85,14 @@ void process(AuthorizerSchema authorizer, Method method) {
 			return;
 		}
 
-		object.field(process(authorizer, coordinates, null, method));
+		object.field(process(authorizer, coordinates, null, method, shouldValidate));
 	}
 
 	Builder process(AuthorizerSchema authorizer, FieldCoordinates coordinates, TypeMeta parentMeta, Method method) {
+		return process(authorizer, coordinates, parentMeta, method, false);
+	}
+
+	Builder process(AuthorizerSchema authorizer, FieldCoordinates coordinates, TypeMeta parentMeta, Method method, boolean shouldValidate) {
 		GraphQLFieldDefinition.Builder field = GraphQLFieldDefinition.newFieldDefinition();
 
 		entityProcessor.addSchemaDirective(method, method.getDeclaringClass(), field::withAppliedDirective);
@@ -130,22 +134,28 @@ Builder process(AuthorizerSchema authorizer, FieldCoordinates coordinates, TypeM
 			field.argument(argument);
 		}
 
-		DataFetcher<?> fetcher = buildFetcher(directives, authorizer, method, meta);
+		DataFetcher<?> fetcher = buildFetcher(directives, authorizer, method, meta, shouldValidate);
 		codeRegistry.dataFetcher(coordinates, fetcher);
 		return field;
 	}
 
-	private <T extends Annotation> DataFetcher<?> buildFetcher(DirectivesSchema diretives, AuthorizerSchema authorizer, Method method, TypeMeta meta) {
-		DataFetcher<?> fetcher = buildDataFetcher(meta, method);
-		fetcher = diretives.wrap(method, meta, fetcher);
+	private <T extends Annotation> DataFetcher<?> buildFetcher(
+		DirectivesSchema directives,
+		AuthorizerSchema authorizer,
+		Method method,
+		TypeMeta meta,
+		boolean shouldValidate
+	) {
+		DataFetcher<?> fetcher = buildDataFetcher(meta, method, shouldValidate);
+		fetcher = directives.wrap(method, meta, fetcher);
 
 		if (authorizer != null) {
 			fetcher = authorizer.wrap(fetcher, method);
 		}
 		return fetcher;
 	}
 
-	private DataFetcher<?> buildDataFetcher(TypeMeta meta, Method method) {
+	private DataFetcher<?> buildDataFetcher(TypeMeta meta, Method method, boolean shouldValidate) {
 		Function<DataFetchingEnvironment, Object>[] resolvers = new Function[method.getParameterCount()];
 
 		method.setAccessible(true);
@@ -163,9 +173,11 @@ private DataFetcher<?> buildDataFetcher(TypeMeta meta, Method method) {
 
 		DataFetcher<?> fetcher = env -> {
 			try {
-				List<GraphQLError> errors = validationRules.runValidationRules(env);
-				if (!errors.isEmpty()) {
-					return DataFetcherResult.newResult().errors(errors).data(null).build();
+				if (shouldValidate) {
+					List<GraphQLError> errors = validationRules.runValidationRules(env);
+					if (!errors.isEmpty()) {
+						return DataFetcherResult.newResult().errors(errors).data(null).build();
+					}
 				}
 
 				Object[] args = new Object[resolvers.length];

graphql-builder/src/main/java/com/phocassoftware/graphql/builder/SchemaBuilder.java

@@ -57,10 +57,10 @@ private SchemaBuilder processTypes(Set<Class<?>> types) {
 		return this;
 	}
 
-	private SchemaBuilder process(HashSet<Method> endPoints) throws ReflectiveOperationException {
+	private SchemaBuilder process(HashSet<Method> endPoints, boolean shouldValidate) throws ReflectiveOperationException {
 		var methodProcessor = this.entityProcessor.getMethodProcessor();
 		for (var method : endPoints) {
-			methodProcessor.process(authorizer, method);
+			methodProcessor.process(authorizer, method, shouldValidate);
 		}
 
 		return this;
@@ -112,6 +112,7 @@ public static class Builder {
 		private DataFetcherRunner dataFetcherRunner = (method, fetcher) -> fetcher;
 		private final List<String> classpaths = new ArrayList<>();
 		private final List<GraphQLScalarType> scalars = new ArrayList<>();
+		private boolean shouldValidate = false;
 
 		private Builder() {}
 
@@ -130,6 +131,11 @@ public Builder scalar(GraphQLScalarType scalar) {
 			return this;
 		}
 
+		public Builder validate() {
+			this.shouldValidate = true;
+			return this;
+		}
+
 		public GraphQLSchema.Builder build() {
 			try {
 				this.scalar(ExtendedScalars.GraphQLLong);
@@ -158,7 +164,7 @@ public GraphQLSchema.Builder build() {
 
 				return new SchemaBuilder(dataFetcherRunner, scalars, directivesSchema, authorizer)
 					.processTypes(types)
-					.process(endPoints)
+					.process(endPoints, shouldValidate)
 					.build(schemaConfiguration);
 			} catch (ReflectiveOperationException e) {
 				throw new RuntimeException(e);

graphql-builder/src/test/java/com/phocassoftware/graphql/builder/JakartaValidationDirectiveTest.java

@@ -38,7 +38,7 @@ void testJakartaSizeAnnotationAddedAsDirectiveOnARecord() {
 
 	@Test
 	void testJakartaSizeDirectiveArgumentDefinition() {
-		Map<String, Object> response = execute("query IntrospectionQuery { __schema { directives { name locations args { name } } } }", null).getData();
+		Map<String, Object> response = execute("query IntrospectionQuery { __schema { directives { name locations args { name } } } }", null, true).getData();
 		List<LinkedHashMap<String, Object>> dir = (List<LinkedHashMap<String, Object>>) ((Map<String, Object>) response.get("__schema")).get("directives");
 		LinkedHashMap<String, Object> constraint = dir.stream().filter(map -> map.get("name").equals("Size")).collect(Collectors.toList()).get(0);
 
@@ -56,38 +56,49 @@ void testJakartaSizeDirectiveArgumentDefinition() {
 	@Test
 	void testJakartaSizeValidationIsApplied() {
 		var name = "Roger";
-		Map<String, String> response = execute("mutation setName($name: String!){setName(name: $name)} ", Map.of("name", name)).getData();
+		Map<String, String> response = execute("mutation setName($name: String!){setName(name: $name)} ", Map.of("name", name), true).getData();
 		var result = response.get("setName");
 
 		assertEquals(name, result);
 
 		name = "Po";
-		var error = execute("mutation setName($name: String!){setName(name: $name)} ", Map.of("name", name)).getErrors().getFirst();
+		var error = execute("mutation setName($name: String!){setName(name: $name)} ", Map.of("name", name), true).getErrors().getFirst();
 
 		assertEquals("size must be between 3 and 2147483647", error.getMessage());
 	}
 
+	@Test
+	void testJakartaSizeValidationIsNotAppliedWhenFlagIsFalse() {
+		var name = "Po";
+		Map<String, String> response = execute("mutation setName($name: String!){setName(name: $name)} ", Map.of("name", name), false).getData();
+		var result = response.get("setName");
+
+		assertEquals(name, result);
+	}
+
 	@Test
 	void testJakartaMinAndMaxValidationIsApplied() {
 		var age = 4;
-		Map<String, Integer> response = execute("mutation setAge($age: Int!){setAge(age: $age)} ", Map.of("age", age)).getData();
+		Map<String, Integer> response = execute("mutation setAge($age: Int!){setAge(age: $age)} ", Map.of("age", age), true).getData();
 		var result = response.get("setAge");
 
 		assertEquals(age, result);
 
 		age = 2;
-		var error = execute("mutation setAge($age: Int!){setAge(age: $age)} ", Map.of("age", age)).getErrors().getFirst();
+		var error = execute("mutation setAge($age: Int!){setAge(age: $age)} ", Map.of("age", age), true).getErrors().getFirst();
 
 		assertEquals("must be greater than or equal to 3", error.getMessage());
 
 		age = 100;
-		error = execute("mutation setAge($age: Int!){setAge(age: $age)} ", Map.of("age", age)).getErrors().getFirst();
+		error = execute("mutation setAge($age: Int!){setAge(age: $age)} ", Map.of("age", age), true).getErrors().getFirst();
 
 		assertEquals("must be less than or equal to 99", error.getMessage());
 	}
 
-	private ExecutionResult execute(String query, Map<String, Object> variables) {
-		GraphQLSchema preSchema = SchemaBuilder.builder().classpath("com.phocassoftware.graphql.builder.type.directive").build().build();
+	private ExecutionResult execute(String query, Map<String, Object> variables, boolean validate) {
+		var builder = SchemaBuilder.builder().classpath("com.phocassoftware.graphql.builder.type.directive");
+		if (validate) builder = builder.validate();
+		GraphQLSchema preSchema = builder.build().build();
 		GraphQL schema = GraphQL.newGraphQL(new IntrospectionWithDirectivesSupport().apply(preSchema)).build();
 
 		var input = ExecutionInput.newExecutionInput();