Merge pull request #4823 from eapache-opslevel/errors-before-data

Reorder errors before data in the response
rmosolgo · Feb 5, 2024 · 18f3ded · 18f3ded
2 parents 6779577 + a662168
commit 18f3ded
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/lib/graphql/execution/interpreter.rb b/lib/graphql/execution/interpreter.rb
@@ -111,15 +111,15 @@ def run_all(schema, query_options, context: {}, max_complexity: schema.max_compl
                     data_result
                   end
                 else
-                  result = {
-                    "data" => query.context.namespace(:interpreter_runtime)[:runtime].final_result
-                  }
+                  result = {}
 
                   if query.context.errors.any?
                     error_result = query.context.errors.map(&:to_h)
                     result["errors"] = error_result
                   end
 
+                  result["data"] = query.context.namespace(:interpreter_runtime)[:runtime].final_result
+
                   result
                 end
                 if query.context.namespace?(:__query_result_extensions__)

diff --git a/spec/graphql/execution/interpreter_spec.rb b/spec/graphql/execution/interpreter_spec.rb
@@ -480,6 +480,19 @@ def execute_multiplex(multiplex:)
       assert_nil Thread.current[:__graphql_runtime_info]
     end
 
+    it "places errors ahead of data in the response" do
+      query_str = <<-GRAPHQL
+      {
+        expansion(sym: "XYZ") {
+          name
+        }
+      }
+      GRAPHQL
+
+      res = InterpreterTest::Schema.execute(query_str)
+      assert_equal ["errors", "data"], res.keys
+    end
+
     it "propagates nulls in lists" do
       query_str = <<-GRAPHQL
       {

diff --git a/spec/graphql/execution/multiplex_spec.rb b/spec/graphql/execution/multiplex_spec.rb
@@ -219,7 +219,7 @@ def raise_exception
 
     it "can access the query results" do
       InspectSchema.execute("{ raiseExecutionError }")
-      handled_err_json = '{"data":{"raiseExecutionError":null},"errors":[{"message":"Whoops","locations":[{"line":1,"column":3}],"path":["raiseExecutionError"]}]}'
+      handled_err_json = '{"errors":[{"message":"Whoops","locations":[{"line":1,"column":3}],"path":["raiseExecutionError"]}],"data":{"raiseExecutionError":null}}'
       assert_equal handled_err_json, InspectQueryInstrumentation.last_json