fix(GraphQL::Backtrace) always stringify everything for the table

Author: rmosolgo

lib/graphql/backtrace/inspect_result.rb

@@ -43,7 +43,7 @@ def inspect_truncated(obj)
         when GraphQL::Execution::Lazy
           "(unresolved)"
         else
-          obj.inspect
+          "#{obj.inspect}"
         end
       end
     end

lib/graphql/backtrace/table.rb

@@ -87,7 +87,7 @@ def build_rows(context_entry, rows:, top: false)
           rows << [
             "#{position}",
             "#{field_name}#{field_alias ? " as #{field_alias}" : ""}",
-            ctx.object.inspect,
+            "#{ctx.object.inspect}",
             ctx.irep_node.arguments.to_h.inspect,
             Backtrace::InspectResult.inspect(top && @override_value ? @override_value : ctx.value),
           ]
@@ -107,7 +107,7 @@ def build_rows(context_entry, rows:, top: false)
           rows << [
             "#{position}",
             "#{op_type}#{op_name ? " #{op_name}" : ""}",
-            query.root_value.inspect,
+            "#{query.root_value.inspect}",
             query.variables.to_h.inspect,
             Backtrace::InspectResult.inspect(query.context.value),
           ]

spec/graphql/backtrace_spec.rb

@@ -24,11 +24,17 @@ def call(_memo, visit_type, irep_node)
     end
   end
 
+  class NilInspectObject
+    # Oops, this is evil, but it happens and we should handle it.
+    def inspect; nil; end
+  end
+
   let(:resolvers) {
     {
       "Query" => {
         "field1" => Proc.new { :something },
         "field2" => Proc.new { :something },
+        "nilInspect" => Proc.new { NilInspectObject.new },
       },
       "Thing" => {
         "listField" => Proc.new { :not_a_list },
@@ -44,6 +50,7 @@ def call(_memo, visit_type, irep_node)
     type Query {
       field1: Thing
       field2: OtherThing
+      nilInspect: Thing
     }
 
     type Thing {
@@ -112,7 +119,7 @@ def call(_memo, visit_type, irep_node)
       assert_includes err.message, rendered_table
       # The message includes the original error message
       assert_includes err.message, "This is broken: Boom"
-      assert_includes err.message, "spec/graphql/backtrace_spec.rb:35", "It includes the original backtrace"
+      assert_includes err.message, "spec/graphql/backtrace_spec.rb:41", "It includes the original backtrace"
       assert_includes err.message, "more lines"
     end
 
@@ -147,6 +154,21 @@ def call(_memo, visit_type, irep_node)
       res = schema.execute("query raiseError { __typename }")
       assert_equal "this should not be wrapped by a backtrace, but instead, returned to the client", res["errors"].first["message"]
     end
+
+    it "always stringifies the #inspect response" do
+      err = assert_raises(GraphQL::Backtrace::TracedError) {
+        schema.execute("query { nilInspect { raiseField(message: \"💥\") } }")
+      }
+
+      rendered_table = [
+        'Loc  | Field            | Object | Arguments        | Result',
+        '1:22 | Thing.raiseField |        | {"message"=>"💥"} | #<RuntimeError: This is broken: 💥>',
+        '1:9  | Query.nilInspect | nil    | {}               | {}',
+        '1:1  | query            | nil    | {}               | {}',
+      ].join("\n")
+
+      assert_includes(err.message, rendered_table)
+    end
   end
 
   # This will get brittle when execution code moves between files