graphql-java · bbakerman · Nov 12, 2022 · Nov 9, 2022 · Nov 9, 2022 · Nov 9, 2022
diff --git a/src/main/java/graphql/ErrorClassification.java b/src/main/java/graphql/ErrorClassification.java
@@ -23,4 +23,21 @@ public interface ErrorClassification {
     default Object toSpecification(GraphQLError error) {
         return String.valueOf(this);
     }
+
+    /**
+     * This produces a simple ErrorClassification that represents the provided String.  You can
+     * use this factory method to give out simple but custom error classifications.
+     *
+     * @param errorClassification the string that represents the error classification
+     *
+     * @return a ErrorClassification that is that provided string
+     */
+    static ErrorClassification errorClassification(String errorClassification) {
+        return new ErrorClassification() {
+            @Override
+            public String toString() {
+                return errorClassification;
+            }
+        };
+    }
 }
diff --git a/src/main/java/graphql/GraphQLError.java b/src/main/java/graphql/GraphQLError.java
@@ -1,7 +1,9 @@
 package graphql;
 
 
+import graphql.execution.ResultPath;
 import graphql.language.SourceLocation;
+import org.jetbrains.annotations.Nullable;
 
 import java.io.Serializable;
 import java.util.List;
@@ -66,5 +68,85 @@ default Map<String, Object> getExtensions() {
         return null;
     }
 
+    /**
+     * @return a new builder of {@link GraphQLError}s
+     */
+    static Builder<?> newError() {
+        return new GraphqlErrorBuilder<>();
+    }
+
+    /**
+     * A builder of {@link GraphQLError}s
+     */
+    interface Builder<B extends Builder<B>> {
+
+        /**
+         * Sets the message of the error using {@link String#format(String, Object...)} with the arguments
+         *
+         * @param message    the message
+         * @param formatArgs the arguments to use
+         *
+         * @return this builder
+         */
+        B message(String message, Object... formatArgs);
 
+        /**
+         * This adds locations to the error
+         *
+         * @param locations the locations to add
+         *
+         * @return this builder
+         */
+        B locations(@Nullable List<SourceLocation> locations);
+
+        /**
+         * This adds a location to the error
+         *
+         * @param location the locations to add
+         *
+         * @return this builder
+         */
+        B location(@Nullable SourceLocation location);
+
+        /**
+         * Sets the path of the message
+         *
+         * @param path can be null
+         *
+         * @return this builder
+         */
+        B path(@Nullable ResultPath path);
+
+        /**
+         * Sets the path of the message
+         *
+         * @param path can be null
+         *
+         * @return this builder
+         */
+        B path(@Nullable List<Object> path);
+
+        /**
+         * Sets the {@link ErrorClassification} of the message
+         *
+         * @param errorType the error classification to use
+         *
+         * @return this builder
+         */
+        B errorType(ErrorClassification errorType);
+
+        /**
+         * Sets the extensions of the message
+         *
+         * @param extensions the extensions to use
+         *
+         * @return this builder
+         */
+        B extensions(@Nullable Map<String, Object> extensions);
+
+        /**
+         * @return a newly built GraphqlError
+         */
+        GraphQLError build();
+    }
 }
diff --git a/src/main/java/graphql/GraphqlErrorBuilder.java b/src/main/java/graphql/GraphqlErrorBuilder.java
@@ -4,8 +4,8 @@
 import graphql.execution.ResultPath;
 import graphql.language.SourceLocation;
 import graphql.schema.DataFetchingEnvironment;
-
 import org.jetbrains.annotations.Nullable;
+
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -20,7 +20,7 @@
  */
 @SuppressWarnings("unchecked")
 @PublicApi
-public class GraphqlErrorBuilder<B extends GraphqlErrorBuilder<B>> {
+public class GraphqlErrorBuilder<B extends GraphqlErrorBuilder<B>> implements GraphQLError.Builder<B> {
 
     private String message;
     private List<Object> path;

diff --git a/src/test/groovy/graphql/GraphqlErrorBuilderTest.groovy b/src/test/groovy/graphql/GraphqlErrorBuilderTest.groovy
@@ -137,4 +137,19 @@ class GraphqlErrorBuilderTest extends Specification {
         error.path == null
         error.extensions == null
     }
+
+    def "can use a builder direct from graphql error"() {
+        when:
+        def error = GraphQLError.newError().message("msg")
+                .locations(null)
+                .extensions([x : "y"])
+                .path(null)
+                .build()
+        then:
+        error.message == "msg"
+        error.locations == null
+        error.extensions == [x : "y"]
+        error.path == null
+
+    }
 }
diff --git a/src/test/groovy/readme/ReadmeExamples.java b/src/test/groovy/readme/ReadmeExamples.java
@@ -1,5 +1,6 @@
 package readme;
 
+import graphql.ErrorClassification;
 import graphql.GraphQLError;
 import graphql.GraphqlErrorBuilder;
 import graphql.InvalidSyntaxError;
@@ -470,7 +471,10 @@ public SpecialError build() {
     }
 
     private void errorBuilderExample() {
-        GraphQLError err = GraphqlErrorBuilder.newError().message("direct").build();
+        GraphQLError err = GraphQLError.newError()
+                .message("direct")
+                .errorType(ErrorClassification.errorClassification("customClassification"))
+                .build();
 
         SpecialError specialErr = new SpecialErrorBuilder().message("special").build();
     }