graphql 1.9.21 → 2.0.16

data/lib/graphql/schema/build_from_definition.rb

@@ -5,23 +5,17 @@ module GraphQL
   class Schema
     module BuildFromDefinition
       class << self
-        def from_definition(definition_string, default_resolve:, parser: DefaultParser)
-          document = parser.parse(definition_string)
-          Builder.build(document, default_resolve: default_resolve)
+        # @see {Schema.from_definition}
+        def from_definition(schema_superclass, definition_string, parser: GraphQL.default_parser, **kwargs)
+          from_document(schema_superclass, parser.parse(definition_string), **kwargs)
         end
-      end
 
-      # @api private
-      DefaultParser = GraphQL::Language::Parser
+        def from_definition_path(schema_superclass, definition_path, parser: GraphQL.default_parser, **kwargs)
+          from_document(schema_superclass, parser.parse_file(definition_path), **kwargs)
+        end
 
-      # @api private
-      module DefaultResolve
-        def self.call(type, field, obj, args, ctx)
-          if field.arguments.any?
-            obj.public_send(field.name, args, ctx)
-          else
-            obj.public_send(field.name)
-          end
+        def from_document(schema_superclass, document, default_resolve:, using: {}, relay: false)
+          Builder.build(schema_superclass, document, default_resolve: default_resolve || {}, relay: relay, using: using)
         end
       end
 
@@ -29,42 +23,66 @@ module GraphQL
       module Builder
         extend self
 
-        def build(document, default_resolve: DefaultResolve)
+        def build(schema_superclass, document, default_resolve:, using: {}, relay:)
           raise InvalidDocumentError.new('Must provide a document ast.') if !document || !document.is_a?(GraphQL::Language::Nodes::Document)
 
           if default_resolve.is_a?(Hash)
             default_resolve = ResolveMap.new(default_resolve)
           end
 
-          schema_definition = nil
+          schema_defns = document.definitions.select { |d| d.is_a?(GraphQL::Language::Nodes::SchemaDefinition) }
+          if schema_defns.size > 1
+            raise InvalidDocumentError.new('Must provide only one schema definition.')
+          end
+          schema_definition = schema_defns.first
           types = {}
-          types.merge!(GraphQL::Schema::BUILT_IN_TYPES)
-          directives = {}
-          type_resolver = ->(type) { -> { resolve_type(types, type) } }
+          directives = schema_superclass.directives.dup
+          type_resolver = build_resolve_type(types, directives, ->(type_name) { types[type_name] ||= Schema::LateBoundType.new(type_name)})
+          # Make a different type resolver because we need to coerce directive arguments
+          # _while_ building the schema.
+          # It will dig for a type if it encounters a custom type. This could be a problem if there are cycles.
+          directive_type_resolver = nil
+          directive_type_resolver = build_resolve_type(types, directives, ->(type_name) {
+            types[type_name] ||= begin
+              defn = document.definitions.find { |d| d.respond_to?(:name) && d.name == type_name }
+              if defn
+                build_definition_from_node(defn, directive_type_resolver, default_resolve)
+              elsif (built_in_defn = GraphQL::Schema::BUILT_IN_TYPES[type_name])
+                built_in_defn
+              else
+                raise "No definition for #{type_name.inspect} found in schema document or built-in types. Add a definition for it or remove it."
+              end
+            end
+          })
 
+          directives.merge!(GraphQL::Schema.default_directives)
+          document.definitions.each do |definition|
+            if definition.is_a?(GraphQL::Language::Nodes::DirectiveDefinition)
+              directives[definition.name] = build_directive(definition, directive_type_resolver)
+            end
+          end
+
+          # In case any directives referenced built-in types for their arguments:
+          replace_late_bound_types_with_built_in(types)
+
+          schema_extensions = nil
           document.definitions.each do |definition|
             case definition
-            when GraphQL::Language::Nodes::SchemaDefinition
-              raise InvalidDocumentError.new('Must provide only one schema definition.') if schema_definition
-              schema_definition = definition
-            when GraphQL::Language::Nodes::EnumTypeDefinition
-              types[definition.name] = build_enum_type(definition, type_resolver)
-            when GraphQL::Language::Nodes::ObjectTypeDefinition
-              types[definition.name] = build_object_type(definition, type_resolver, default_resolve: default_resolve)
-            when GraphQL::Language::Nodes::InterfaceTypeDefinition
-              types[definition.name] = build_interface_type(definition, type_resolver)
-            when GraphQL::Language::Nodes::UnionTypeDefinition
-              types[definition.name] = build_union_type(definition, type_resolver)
-            when GraphQL::Language::Nodes::ScalarTypeDefinition
-              types[definition.name] = build_scalar_type(definition, type_resolver, default_resolve: default_resolve)
-            when GraphQL::Language::Nodes::InputObjectTypeDefinition
-              types[definition.name] = build_input_object_type(definition, type_resolver)
-            when GraphQL::Language::Nodes::DirectiveDefinition
-              directives[definition.name] = build_directive(definition, type_resolver)
+            when GraphQL::Language::Nodes::SchemaDefinition, GraphQL::Language::Nodes::DirectiveDefinition
+              nil # already handled
+            when GraphQL::Language::Nodes::SchemaExtension
+              schema_extensions ||= []
+              schema_extensions << definition
+            else
+              # It's possible that this was already loaded by the directives
+              prev_type = types[definition.name]
+              if prev_type.nil? || prev_type.is_a?(Schema::LateBoundType)
+                types[definition.name] = build_definition_from_node(definition, type_resolver, default_resolve)
+              end
             end
           end
 
-          directives = GraphQL::Schema.default_directives.merge(directives)
+          replace_late_bound_types_with_built_in(types)
 
           if schema_definition
             if schema_definition.query
@@ -89,54 +107,170 @@ module GraphQL
 
           raise InvalidDocumentError.new('Must provide schema definition with query type or a type named Query.') unless query_root_type
 
-          schema = Schema.define do
-            raise_definition_error true
+          schema_class = Class.new(schema_superclass) do
+            begin
+              # Add these first so that there's some chance of resolving late-bound types
+              orphan_types types.values
+              query query_root_type
+              mutation mutation_root_type
+              subscription subscription_root_type
+            rescue Schema::UnresolvedLateBoundTypeError  => err
+              type_name = err.type.name
+              err_backtrace =  err.backtrace
+              raise InvalidDocumentError, "Type \"#{type_name}\" not found in document.", err_backtrace
+            end
 
-            query query_root_type
-            mutation mutation_root_type
-            subscription subscription_root_type
-            orphan_types types.values
             if default_resolve.respond_to?(:resolve_type)
-              resolve_type(default_resolve.method(:resolve_type))
+              def self.resolve_type(*args)
+                self.definition_default_resolve.resolve_type(*args)
+              end
             else
-              resolve_type(NullResolveType)
+              def self.resolve_type(*args)
+                NullResolveType.call(*args)
+              end
             end
 
             directives directives.values
+
+            if schema_definition
+              ast_node(schema_definition)
+            end
+
+            using.each do |plugin, options|
+              if options
+                use(plugin, **options)
+              else
+                use(plugin)
+              end
+            end
+
+            # Empty `orphan_types` -- this will make unreachable types ... unreachable.
+            own_orphan_types.clear
+
+            class << self
+              attr_accessor :definition_default_resolve
+            end
+
+            self.definition_default_resolve = default_resolve
+
+            def definition_default_resolve
+              self.class.definition_default_resolve
+            end
+
+            def self.inherited(child_class)
+              child_class.definition_default_resolve = self.definition_default_resolve
+            end
           end
 
-          schema.ast_node = schema_definition if schema_definition
+          if schema_extensions
+            schema_extensions.each do |ext|
+              build_directives(schema_class, ext, type_resolver)
+            end
+          end
 
-          schema
+          schema_class
         end
 
         NullResolveType = ->(type, obj, ctx) {
           raise(GraphQL::RequiredImplementationMissingError, "Generated Schema cannot use Interface or Union types for execution. Implement resolve_type on your resolver.")
         }
 
-        NullScalarCoerce = ->(val, _ctx) { val }
+        def build_definition_from_node(definition, type_resolver, default_resolve)
+          case definition
+          when GraphQL::Language::Nodes::EnumTypeDefinition
+            build_enum_type(definition, type_resolver)
+          when GraphQL::Language::Nodes::ObjectTypeDefinition
+            build_object_type(definition, type_resolver)
+          when GraphQL::Language::Nodes::InterfaceTypeDefinition
+            build_interface_type(definition, type_resolver)
+          when GraphQL::Language::Nodes::UnionTypeDefinition
+            build_union_type(definition, type_resolver)
+          when GraphQL::Language::Nodes::ScalarTypeDefinition
+            build_scalar_type(definition, type_resolver, default_resolve: default_resolve)
+          when GraphQL::Language::Nodes::InputObjectTypeDefinition
+            build_input_object_type(definition, type_resolver)
+          end
+        end
 
-        def build_enum_type(enum_type_definition, type_resolver)
-          enum = GraphQL::EnumType.define(
-            name: enum_type_definition.name,
-            description: enum_type_definition.description,
-            values: enum_type_definition.values.map do |enum_value_definition|
-              value = EnumType::EnumValue.define(
-                name: enum_value_definition.name,
-                value: enum_value_definition.name,
-                deprecation_reason: build_deprecation_reason(enum_value_definition.directives),
-                description: enum_value_definition.description,
-              )
+        # Modify `types`, replacing any late-bound references to built-in types
+        # with their actual definitions.
+        #
+        # (Schema definitions are allowed to reference those built-ins without redefining them.)
+        # @return void
+        def replace_late_bound_types_with_built_in(types)
+          GraphQL::Schema::BUILT_IN_TYPES.each do |scalar_name, built_in_scalar|
+            existing_type = types[scalar_name]
+            if existing_type.is_a?(GraphQL::Schema::LateBoundType)
+              types[scalar_name] = built_in_scalar
+            end
+          end
+        end
 
-              value.ast_node = enum_value_definition
+        def build_directives(definition, ast_node, type_resolver)
+          dirs = prepare_directives(ast_node, type_resolver)
+          dirs.each do |(dir_class, options)|
+            if definition.respond_to?(:schema_directive)
+              # it's a schema
+              definition.schema_directive(dir_class, **options)
+            else
+              definition.directive(dir_class, **options)
+            end
+          end
+        end
 
-              value
+        def prepare_directives(ast_node, type_resolver)
+          dirs = []
+          ast_node.directives.each do |dir_node|
+            if dir_node.name == "deprecated"
+              # This is handled using `deprecation_reason`
+              next
+            else
+              dir_class = type_resolver.call(dir_node.name)
+              if dir_class.nil?
+                raise ArgumentError, "No definition for @#{dir_node.name} #{ast_node.respond_to?(:name) ? "on #{ast_node.name} " : ""}at #{ast_node.line}:#{ast_node.col}"
+              end
+              options = args_to_kwargs(dir_class, dir_node)
+              dirs << [dir_class, options]
             end
-          )
+          end
+          dirs
+        end
 
-          enum.ast_node = enum_type_definition
+        def args_to_kwargs(arg_owner, node)
+          if node.respond_to?(:arguments)
+            kwargs = {}
+            node.arguments.each do |arg_node|
+              arg_defn = arg_owner.get_argument(arg_node.name)
+              kwargs[arg_defn.keyword] = args_to_kwargs(arg_defn.type.unwrap, arg_node.value)
+            end
+            kwargs
+          elsif node.is_a?(Array)
+            node.map { |n| args_to_kwargs(arg_owner, n) }
+          elsif node.is_a?(Language::Nodes::Enum)
+            node.name
+          else
+            # scalar
+            node
+          end
+        end
 
-          enum
+        def build_enum_type(enum_type_definition, type_resolver)
+          builder = self
+          Class.new(GraphQL::Schema::Enum) do
+            graphql_name(enum_type_definition.name)
+            builder.build_directives(self, enum_type_definition, type_resolver)
+            description(enum_type_definition.description)
+            ast_node(enum_type_definition)
+            enum_type_definition.values.each do |enum_value_definition|
+              value(enum_value_definition.name,
+                value: enum_value_definition.name,
+                deprecation_reason: builder.build_deprecation_reason(enum_value_definition.directives),
+                description: enum_value_definition.description,
+                directives: builder.prepare_directives(enum_value_definition, type_resolver),
+                ast_node: enum_value_definition,
+              )
+            end
+          end
         end
 
         def build_deprecation_reason(directives)
@@ -144,69 +278,72 @@ module GraphQL
           return unless deprecated_directive
 
           reason = deprecated_directive.arguments.find{ |a| a.name == 'reason' }
-          return GraphQL::Directive::DEFAULT_DEPRECATION_REASON unless reason
+          return GraphQL::Schema::Directive::DEFAULT_DEPRECATION_REASON unless reason
 
           reason.value
         end
 
         def build_scalar_type(scalar_type_definition, type_resolver, default_resolve:)
-          scalar_type = GraphQL::ScalarType.define(
-            name: scalar_type_definition.name,
-            description: scalar_type_definition.description,
-            coerce: NullScalarCoerce,
-          )
-
-          scalar_type.ast_node = scalar_type_definition
-
-          if default_resolve.respond_to?(:coerce_input)
-            scalar_type = scalar_type.redefine(
-              coerce_input: ->(val, ctx) { default_resolve.coerce_input(scalar_type, val, ctx) },
-              coerce_result: ->(val, ctx) { default_resolve.coerce_result(scalar_type, val, ctx) },
-            )
+          builder = self
+          Class.new(GraphQL::Schema::Scalar) do
+            graphql_name(scalar_type_definition.name)
+            description(scalar_type_definition.description)
+            ast_node(scalar_type_definition)
+            builder.build_directives(self, scalar_type_definition, type_resolver)
+
+            if default_resolve.respond_to?(:coerce_input)
+              # Put these method definitions in another method to avoid retaining `type_resolve`
+              # from this method's bindiing
+              builder.build_scalar_type_coerce_method(self, :coerce_input, default_resolve)
+              builder.build_scalar_type_coerce_method(self, :coerce_result, default_resolve)
+            end
           end
+        end
 
-          scalar_type
+        def build_scalar_type_coerce_method(scalar_class, method_name, default_definition_resolve)
+          scalar_class.define_singleton_method(method_name) do |val, ctx|
+            default_definition_resolve.public_send(method_name, self, val, ctx)
+          end
         end
 
         def build_union_type(union_type_definition, type_resolver)
-          union = GraphQL::UnionType.define(
-            name: union_type_definition.name,
-            description: union_type_definition.description,
-            possible_types: union_type_definition.types.map{ |type_name| type_resolver.call(type_name) },
-          )
+          builder = self
+          Class.new(GraphQL::Schema::Union) do
+            graphql_name(union_type_definition.name)
+            description(union_type_definition.description)
+            possible_types(*union_type_definition.types.map { |type_name| type_resolver.call(type_name) })
+            ast_node(union_type_definition)
+            builder.build_directives(self, union_type_definition, type_resolver)
+          end
+        end
 
-          union.ast_node = union_type_definition
+        def build_object_type(object_type_definition, type_resolver)
+          builder = self
 
-          union
-        end
+          Class.new(GraphQL::Schema::Object) do
+            graphql_name(object_type_definition.name)
+            description(object_type_definition.description)
+            ast_node(object_type_definition)
+            builder.build_directives(self, object_type_definition, type_resolver)
 
-        def build_object_type(object_type_definition, type_resolver, default_resolve:)
-          type_def = nil
-          typed_resolve_fn = ->(field, obj, args, ctx) { default_resolve.call(type_def, field, obj, args, ctx) }
-          defns = {
-            name: object_type_definition.name,
-            description: object_type_definition.description,
-            interfaces: object_type_definition.interfaces.map{ |interface_name| type_resolver.call(interface_name) },
-          }
-          obj_fields = Hash[build_fields(object_type_definition.fields, type_resolver, default_resolve: typed_resolve_fn)]
-          if obj_fields.any?
-            defns[:fields] = obj_fields
+            object_type_definition.interfaces.each do |interface_name|
+              interface_defn = type_resolver.call(interface_name)
+              implements(interface_defn)
+            end
+
+            builder.build_fields(self, object_type_definition.fields, type_resolver, default_resolve: true)
           end
-          type_def = GraphQL::ObjectType.define(**defns)
-          type_def.ast_node = object_type_definition
-          type_def
         end
 
         def build_input_object_type(input_object_type_definition, type_resolver)
-          input = GraphQL::InputObjectType.define(
-            name: input_object_type_definition.name,
-            description: input_object_type_definition.description,
-            arguments: Hash[build_input_arguments(input_object_type_definition, type_resolver)],
-          )
-
-          input.ast_node = input_object_type_definition
-
-          input
+          builder = self
+          Class.new(GraphQL::Schema::InputObject) do
+            graphql_name(input_object_type_definition.name)
+            description(input_object_type_definition.description)
+            ast_node(input_object_type_definition)
+            builder.build_directives(self, input_object_type_definition, type_resolver)
+            builder.build_arguments(self, input_object_type_definition.fields, type_resolver)
+          end
         end
 
         def build_default_value(default_value)
@@ -224,142 +361,119 @@ module GraphQL
           end
         end
 
-        def build_input_arguments(input_object_type_definition, type_resolver)
-          input_object_type_definition.fields.map do |input_argument|
-            kwargs = {}
+        NO_DEFAULT_VALUE = {}.freeze
+
+        def build_arguments(type_class, arguments, type_resolver)
+          builder = self
 
-            if !input_argument.default_value.nil?
-              kwargs[:default_value] = build_default_value(input_argument.default_value)
+          arguments.each do |argument_defn|
+            default_value_kwargs = if !argument_defn.default_value.nil?
+              { default_value: builder.build_default_value(argument_defn.default_value) }
+            else
+              NO_DEFAULT_VALUE
             end
 
-            argument = GraphQL::Argument.define(
-              name: input_argument.name,
-              type: type_resolver.call(input_argument.type),
-              description: input_argument.description,
-              method_access: false,
-              **kwargs,
+            type_class.argument(
+              argument_defn.name,
+              type: type_resolver.call(argument_defn.type),
+              required: false,
+              description: argument_defn.description,
+              deprecation_reason: builder.build_deprecation_reason(argument_defn.directives),
+              ast_node: argument_defn,
+              camelize: false,
+              directives: prepare_directives(argument_defn, type_resolver),
+              **default_value_kwargs
             )
-
-            argument.ast_node = input_argument
-
-            [
-              input_argument.name,
-              argument
-            ]
           end
         end
 
         def build_directive(directive_definition, type_resolver)
-          directive_args = Hash[build_directive_arguments(directive_definition, type_resolver)]
-
-          defn = {
-            name: directive_definition.name,
-            description: directive_definition.description,
-            locations: directive_definition.locations.map { |location| location.name.to_sym },
-          }
-
-          if directive_args.any?
-            defn[:arguments] = directive_args
+          builder = self
+          Class.new(GraphQL::Schema::Directive) do
+            graphql_name(directive_definition.name)
+            description(directive_definition.description)
+            repeatable(directive_definition.repeatable)
+            locations(*directive_definition.locations.map { |location| location.name.to_sym })
+            ast_node(directive_definition)
+            builder.build_arguments(self, directive_definition.arguments, type_resolver)
           end
-
-          directive = GraphQL::Directive.define(**defn)
-          directive.ast_node = directive_definition
-
-          directive
         end
 
-        def build_directive_arguments(directive_definition, type_resolver)
-          directive_definition.arguments.map do |directive_argument|
-            kwargs = {}
-
-            if !directive_argument.default_value.nil?
-              kwargs[:default_value] = build_default_value(directive_argument.default_value)
+        def build_interface_type(interface_type_definition, type_resolver)
+          builder = self
+          Module.new do
+            include GraphQL::Schema::Interface
+            graphql_name(interface_type_definition.name)
+            description(interface_type_definition.description)
+            interface_type_definition.interfaces.each do |interface_name|
+              interface_defn = type_resolver.call(interface_name)
+              implements(interface_defn)
             end
+            ast_node(interface_type_definition)
+            builder.build_directives(self, interface_type_definition, type_resolver)
 
-            argument = GraphQL::Argument.define(
-              name: directive_argument.name,
-              type: type_resolver.call(directive_argument.type),
-              description: directive_argument.description,
-              method_access: false,
-              **kwargs,
-            )
-
-            argument.ast_node = directive_argument
-
-            [
-              directive_argument.name,
-              argument
-            ]
+            builder.build_fields(self, interface_type_definition.fields, type_resolver, default_resolve: nil)
           end
         end
 
-        def build_interface_type(interface_type_definition, type_resolver)
-          interface = GraphQL::InterfaceType.define(
-            name: interface_type_definition.name,
-            description: interface_type_definition.description,
-            fields: Hash[build_fields(interface_type_definition.fields, type_resolver, default_resolve: nil)],
-          )
-
-          interface.ast_node = interface_type_definition
-
-          interface
-        end
-
-        def build_fields(field_definitions, type_resolver, default_resolve:)
-          field_definitions.map do |field_definition|
-            field_arguments = Hash[field_definition.arguments.map do |argument|
-              kwargs = {}
-
-              if !argument.default_value.nil?
-                kwargs[:default_value] = build_default_value(argument.default_value)
-              end
-
-              arg = GraphQL::Argument.define(
-                name: argument.name,
-                description: argument.description,
-                type: type_resolver.call(argument.type),
-                method_access: false,
-                **kwargs,
-              )
-
-              arg.ast_node = argument
-
-              [argument.name, arg]
-            end]
-
-            field = nil
+        def build_fields(owner, field_definitions, type_resolver, default_resolve:)
+          builder = self
 
-            defns = {
-              name: field_definition.name,
+          field_definitions.each do |field_definition|
+            type_name = resolve_type_name(field_definition.type)
+            resolve_method_name = -"resolve_field_#{field_definition.name}"
+            schema_field_defn = owner.field(
+              field_definition.name,
               description: field_definition.description,
               type: type_resolver.call(field_definition.type),
-              resolve: ->(obj, args, ctx) { default_resolve.call(field, obj, args, ctx) },
+              null: true,
+              connection: type_name.end_with?("Connection"),
+              connection_extension: nil,
               deprecation_reason: build_deprecation_reason(field_definition.directives),
-            }
+              ast_node: field_definition,
+              method_conflict_warning: false,
+              camelize: false,
+              directives: prepare_directives(field_definition, type_resolver),
+              resolver_method: resolve_method_name,
+            )
 
-            if field_arguments.any?
-              defns[:arguments] = field_arguments
+            builder.build_arguments(schema_field_defn, field_definition.arguments, type_resolver)
+
+            # Don't do this for interfaces
+            if default_resolve
+              owner.class_eval <<-RUBY, __FILE__, __LINE__
+                # frozen_string_literal: true
+                def #{resolve_method_name}(**args)
+                  field_instance = self.class.get_field("#{field_definition.name}")
+                  context.schema.definition_default_resolve.call(self.class, field_instance, object, args, context)
+                end
+              RUBY
             end
-
-            field = GraphQL::Field.define(**defns)
-
-            field.ast_node = field_definition
-
-            type_name = resolve_type_name(field_definition.type)
-            field.connection = type_name.end_with?("Connection")
-            [field_definition.name, field]
           end
         end
 
-        def resolve_type(types, ast_node)
-          type = GraphQL::Schema::TypeExpression.build_type(types, ast_node)
-          if type.nil?
-            while ast_node.respond_to?(:of_type)
-              ast_node = ast_node.of_type
+        def build_resolve_type(lookup_hash, directives, missing_type_handler)
+          resolve_type_proc = nil
+          resolve_type_proc = ->(ast_node) {
+            case ast_node
+            when GraphQL::Language::Nodes::TypeName
+              type_name = ast_node.name
+              if lookup_hash.key?(type_name)
+                lookup_hash[type_name]
+              else
+                missing_type_handler.call(type_name)
+              end
+            when GraphQL::Language::Nodes::NonNullType
+              resolve_type_proc.call(ast_node.of_type).to_non_null_type
+            when GraphQL::Language::Nodes::ListType
+              resolve_type_proc.call(ast_node.of_type).to_list_type
+            when String
+              directives[ast_node]
+            else
+              raise "Unexpected ast_node: #{ast_node.inspect}"
             end
-            raise InvalidDocumentError.new("Type \"#{ast_node.name}\" not found in document.")
-          end
-          type
+          }
+          resolve_type_proc
         end
 
         def resolve_type_name(type)