Add .path method to schema members for debugging

Author: rmosolgo

lib/graphql/schema/argument.rb

@@ -4,6 +4,7 @@ class Schema
     class Argument
       include GraphQL::Schema::Member::CachedGraphQLDefinition
       include GraphQL::Schema::Member::AcceptsDefinition
+      include GraphQL::Schema::Member::HasPath
 
       NO_DEFAULT = :__no_default__
 

lib/graphql/schema/enum_value.rb

@@ -27,6 +27,7 @@ class Schema
     #   end
     class EnumValue < GraphQL::Schema::Member
       include GraphQL::Schema::Member::AcceptsDefinition
+      include GraphQL::Schema::Member::HasPath
 
       attr_reader :graphql_name
 

lib/graphql/schema/field.rb

@@ -6,6 +6,7 @@ class Field
       include GraphQL::Schema::Member::CachedGraphQLDefinition
       include GraphQL::Schema::Member::AcceptsDefinition
       include GraphQL::Schema::Member::HasArguments
+      include GraphQL::Schema::Member::HasPath
 
       # @return [String] the GraphQL name for this field, camelized unless `camelize: false` is provided
       attr_reader :name

lib/graphql/schema/interface.rb

@@ -9,6 +9,7 @@ module DefinitionMethods
         include GraphQL::Schema::Member::BaseDSLMethods
         include GraphQL::Schema::Member::TypeSystemHelpers
         include GraphQL::Schema::Member::HasFields
+        include GraphQL::Schema::Member::HasPath
         include GraphQL::Schema::Member::RelayShortcuts
         include GraphQL::Schema::Member::Scoped
 

lib/graphql/schema/member.rb

@@ -3,6 +3,7 @@
 require 'graphql/schema/member/base_dsl_methods'
 require 'graphql/schema/member/cached_graphql_definition'
 require 'graphql/schema/member/graphql_type_names'
+require 'graphql/schema/member/has_path'
 require 'graphql/schema/member/relay_shortcuts'
 require 'graphql/schema/member/scoped'
 require 'graphql/schema/member/type_system_helpers'
@@ -22,6 +23,7 @@ class Member
       extend TypeSystemHelpers
       extend Scoped
       extend RelayShortcuts
+      extend HasPath
     end
   end
 end

lib/graphql/schema/member/base_dsl_methods.rb

@@ -108,6 +108,8 @@ def authorized?(object, context)
           end
         end
 
+
+
         private
 
         def find_inherited_method(method_name, default_value)

lib/graphql/schema/member/has_path.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Member
+      module HasPath
+        # @return [String] A description of this member's place in the GraphQL schema
+        def path
+          path_str = if self.respond_to?(:graphql_name)
+            self.graphql_name
+          elsif self.class.respond_to?(:graphql_name)
+            # Instances of resolvers
+            self.class.graphql_name
+          end
+
+          if self.respond_to?(:owner) && owner.respond_to?(:path)
+            path_str = "#{owner.path}.#{path_str}"
+          end
+
+          path_str
+        end
+      end
+    end
+  end
+end

lib/graphql/schema/resolver.rb

@@ -23,6 +23,8 @@ class Resolver
       # Really we only need description from here, but:
       extend Schema::Member::BaseDSLMethods
       extend GraphQL::Schema::Member::HasArguments
+      include Schema::Member::HasPath
+      extend Schema::Member::HasPath
 
       # @param object [Object] the initialize object, pass to {Query.initialize} as `root_value`
       # @param context [GraphQL::Query::Context]

spec/graphql/schema/argument_spec.rb

@@ -29,7 +29,11 @@ class Schema < GraphQL::Schema
     end
   end
 
-
+  describe "#path" do
+    it "includes type, field and argument names" do
+      assert_equal "Query.field.argWithBlock", SchemaArgumentTest::Query.fields["field"].arguments["argWithBlock"].path
+    end
+  end
 
   describe "#name" do
     it "reflects camelization" do

spec/graphql/schema/enum_spec.rb

@@ -3,6 +3,13 @@
 
 describe GraphQL::Schema::Enum do
   let(:enum) { Jazz::Family }
+
+  describe ".path" do
+    it "is the name" do
+      assert_equal "Family", enum.path
+    end
+  end
+
   describe "type info" do
     it "tells about the definition" do
       assert_equal "Family", enum.graphql_name

spec/graphql/schema/enum_value_spec.rb

@@ -2,6 +2,17 @@
 require "spec_helper"
 
 describe GraphQL::Schema::EnumValue do
+  describe "#path" do
+    it "Has the owner name too" do
+      enum = Class.new(GraphQL::Schema::Enum) do
+        graphql_name "Abc"
+        value(:XYZ)
+      end
+
+      assert_equal "Abc.XYZ", enum.values["XYZ"].path
+    end
+  end
+
   describe "#deprecation_reason" do
     it "can be written and read" do
       enum_value = GraphQL::Schema::EnumValue.new(:x, owner: nil)

spec/graphql/schema/field_spec.rb

@@ -6,6 +6,13 @@
     let(:object_class) { Jazz::Query }
     let(:field) { object_class.fields["inspectInput"] }
 
+    describe "path" do
+      it "is the object/interface and field name" do
+        assert_equal "Query.inspectInput", field.path
+        assert_equal "GloballyIdentifiable.id", Jazz::GloballyIdentifiableType.fields["id"].path
+      end
+    end
+
     it "uses the argument class" do
       arg_defn = field.graphql_definition.arguments.values.first
       assert_equal :ok, arg_defn.metadata[:custom]

spec/graphql/schema/input_object_spec.rb

@@ -3,6 +3,17 @@
 
 describe GraphQL::Schema::InputObject do
   let(:input_object) { Jazz::EnsembleInput }
+
+  describe ".path" do
+    it "is the name" do
+      assert_equal "EnsembleInput", input_object.path
+    end
+
+    it "is used in argument paths" do
+      assert_equal "EnsembleInput.name", input_object.arguments["name"].path
+    end
+  end
+
   describe "type info" do
     it "has it" do
       assert_equal "EnsembleInput", input_object.graphql_name

spec/graphql/schema/interface_spec.rb

@@ -4,6 +4,12 @@
 describe GraphQL::Schema::Interface do
   let(:interface) { Jazz::GloballyIdentifiableType }
 
+  describe ".path" do
+    it "is the name" do
+      assert_equal "GloballyIdentifiable", interface.path
+    end
+  end
+
   describe "type info" do
     it "tells its type info" do
       assert_equal "GloballyIdentifiable", interface.graphql_name

spec/graphql/schema/object_spec.rb

@@ -14,6 +14,12 @@
       assert object_class.respond_to?(:connection_type)
     end
 
+    describe "path" do
+      it "is the type name" do
+        assert_equal "Ensemble", object_class.path
+      end
+    end
+
     it "inherits fields and interfaces" do
       new_object_class = Class.new(object_class) do
         field :newField, String, null: true

spec/graphql/schema/resolver_spec.rb

@@ -291,6 +291,22 @@ def exec_query(*args)
     ResolverTest::Schema.execute(*args)
   end
 
+  describe ".path" do
+    it "is the name" do
+      assert_equal "Resolver1", ResolverTest::Resolver1.path
+    end
+
+    it "is used for arguments and fields" do
+      assert_equal "Resolver1.value", ResolverTest::Resolver1.arguments["value"].path
+      assert_equal "PrepResolver7.int", ResolverTest::PrepResolver7.fields["int"].path
+    end
+
+    it "works on instances" do
+      r = ResolverTest::Resolver1.new(object: nil, context: nil)
+      assert_equal "Resolver1", r.path
+    end
+  end
+
   it "gets initialized for each resolution" do
     # State isn't shared between calls:
     res = exec_query " { r1: resolver1(value: 1) r2: resolver1 }"

spec/graphql/schema/scalar_spec.rb

@@ -2,6 +2,12 @@
 require "spec_helper"
 
 describe GraphQL::Schema::Scalar do
+  describe ".path" do
+    it "is the name" do
+      assert_equal "String", GraphQL::Types::String.path
+    end
+  end
+
   describe "in queries" do
     it "becomes output" do
       query_str = <<-GRAPHQL

spec/graphql/schema/union_spec.rb

@@ -3,6 +3,13 @@
 
 describe GraphQL::Schema::Union do
   let(:union) { Jazz::PerformingAct }
+
+  describe ".path" do
+    it "is the name" do
+      assert_equal "PerformingAct", union.path
+    end
+  end
+
   describe "type info" do
     it "has some" do
       assert_equal 2, union.possible_types.size