graphql 1.9.0 → 2.1.1

data/lib/graphql/schema/built_in_types.rb

@@ -2,11 +2,11 @@
 module GraphQL
   class Schema
     BUILT_IN_TYPES = {
-      "Int" => INT_TYPE,
-      "String" => STRING_TYPE,
-      "Float" => FLOAT_TYPE,
-      "Boolean" => BOOLEAN_TYPE,
-      "ID" => ID_TYPE,
+      "Int" => GraphQL::Types::Int,
+      "String" => GraphQL::Types::String,
+      "Float" => GraphQL::Types::Float,
+      "Boolean" => GraphQL::Types::Boolean,
+      "ID" => GraphQL::Types::ID,
     }
   end
 end

data/lib/graphql/schema/directive/deprecated.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Directive < GraphQL::Schema::Member
+      class Deprecated < GraphQL::Schema::Directive
+        description "Marks an element of a GraphQL schema as no longer supported."
+        locations(GraphQL::Schema::Directive::FIELD_DEFINITION, GraphQL::Schema::Directive::ENUM_VALUE, GraphQL::Schema::Directive::ARGUMENT_DEFINITION, GraphQL::Schema::Directive::INPUT_FIELD_DEFINITION)
+
+        reason_description = "Explains why this element was deprecated, usually also including a "\
+        "suggestion for how to access supported similar data. Formatted "\
+        "in [Markdown](https://daringfireball.net/projects/markdown/)."
+
+        argument :reason, String, reason_description, default_value: Directive::DEFAULT_DEPRECATION_REASON, required: false
+        default_directive true
+      end
+    end
+  end
+end

data/lib/graphql/schema/directive/feature.rb

@@ -42,7 +42,7 @@ module GraphQL
           GraphQL::Schema::Directive::INLINE_FRAGMENT
         )
 
-        argument :flag, String, required: true,
+        argument :flag, String,
           description: "The name of the feature to check before continuing"
 
         # Implement the Directive API
@@ -58,7 +58,7 @@ module GraphQL
         # @param context [GraphQL::Query::Context]
         # @return [Boolean] If truthy, execution will continue
         def self.enabled?(flag_name, object, context)
-          raise NotImplementedError, "Implement `.enabled?(flag_name, object, context)` to return true or false for the feature flag (#{flag_name.inspect})"
+          raise GraphQL::RequiredImplementationMissingError, "Implement `.enabled?(flag_name, object, context)` to return true or false for the feature flag (#{flag_name.inspect})"
         end
       end
     end

data/lib/graphql/schema/directive/flagged.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Directive < GraphQL::Schema::Member
+      # This is _similar_ to {Directive::Feature}, except it's prescribed by the server, not the client.
+      #
+      # In this case, the server hides types and fields _entirely_, unless the current context has certain `:flags` present.
+      class Flagged < GraphQL::Schema::Directive
+        def initialize(target, **options)
+          if target.is_a?(Module) && !target.ancestors.include?(VisibleByFlag)
+            # This is type class of some kind, `include` will put this module
+            # in between the type class itself and its super class, so `super` will work fine
+            target.include(VisibleByFlag)
+          elsif !target.is_a?(VisibleByFlag)
+            # This is an instance of a base class. `include` won't put this in front of the
+            # base class implementation, so we need to `.prepend`.
+            # `#visible?` could probably be moved to a module and then this could use `include` instead.
+            target.class.prepend(VisibleByFlag)
+          end
+          super
+        end
+
+        description "Hides this part of the schema unless the named flag is present in context[:flags]"
+
+        locations(
+          GraphQL::Schema::Directive::FIELD_DEFINITION,
+          GraphQL::Schema::Directive::OBJECT,
+          GraphQL::Schema::Directive::SCALAR,
+          GraphQL::Schema::Directive::ENUM,
+          GraphQL::Schema::Directive::UNION,
+          GraphQL::Schema::Directive::INTERFACE,
+          GraphQL::Schema::Directive::INPUT_OBJECT,
+          GraphQL::Schema::Directive::ENUM_VALUE,
+          GraphQL::Schema::Directive::ARGUMENT_DEFINITION,
+          GraphQL::Schema::Directive::INPUT_FIELD_DEFINITION,
+        )
+
+        argument :by, [String], "Flags to check for this schema member"
+
+        module VisibleByFlag
+          def self.included(schema_class)
+            schema_class.extend(self)
+          end
+
+          def visible?(context)
+            if dir = self.directives.find { |d| d.is_a?(Flagged) }
+              relevant_flags = (f = context[:flags]) && dir.arguments[:by] & f # rubocop:disable Development/ContextIsPassedCop -- definition-related
+              relevant_flags && relevant_flags.any? && super
+            else
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/directive/include.rb

@@ -11,12 +11,12 @@ module GraphQL
           GraphQL::Schema::Directive::INLINE_FRAGMENT
         )
 
-        argument :if, Boolean, required: true,
+        argument :if, Boolean,
           description: "Included when true."
 
         default_directive true
 
-        def self.include?(obj, args, ctx)
+        def self.static_include?(args, ctx)
           !!args[:if]
         end
       end

data/lib/graphql/schema/directive/one_of.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Directive < GraphQL::Schema::Member
+      class OneOf < GraphQL::Schema::Directive
+        description "Requires that exactly one field must be supplied and that field must not be `null`."
+        locations(GraphQL::Schema::Directive::INPUT_OBJECT)
+        default_directive true
+      end
+    end
+  end
+end

data/lib/graphql/schema/directive/skip.rb

@@ -11,12 +11,12 @@ module GraphQL
           GraphQL::Schema::Directive::INLINE_FRAGMENT
         )
 
-        argument :if, Boolean, required: true,
+        argument :if, Boolean,
           description: "Skipped when true."
 
         default_directive true
 
-        def self.include?(obj, args, ctx)
+        def self.static_include?(args, ctx)
           !args[:if]
         end
       end

data/lib/graphql/schema/directive/specified_by.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Directive < GraphQL::Schema::Member
+      class SpecifiedBy < GraphQL::Schema::Directive
+        description "Exposes a URL that specifies the behavior of this scalar."
+        locations(GraphQL::Schema::Directive::SCALAR)
+        default_directive true
+
+        argument :url, String, description: "The URL that specifies the behavior of this scalar."
+      end
+    end
+  end
+end

data/lib/graphql/schema/directive/transform.rb

@@ -24,7 +24,7 @@ module GraphQL
           GraphQL::Schema::Directive::FIELD,
         )
 
-        argument :by, String, required: true,
+        argument :by, String,
           description: "The name of the transform to run if applicable"
 
         TRANSFORMS = [
@@ -39,7 +39,19 @@ module GraphQL
           transform_name = arguments[:by]
           if TRANSFORMS.include?(transform_name) && return_value.respond_to?(transform_name)
             return_value = return_value.public_send(transform_name)
-            context.namespace(:interpreter)[:runtime].write_in_response(path, return_value)
+            response = context.namespace(:interpreter_runtime)[:runtime].final_result
+            *keys, last = path
+            keys.each do |key|
+              if response && (response = response[key])
+                next
+              else
+                break
+              end
+            end
+            if response
+              response[last] = return_value
+            end
+            nil
           end
         end
       end

data/lib/graphql/schema/directive.rb

@@ -8,13 +8,33 @@ module GraphQL
     # - {.resolve}: Wraps field resolution (so it should call `yield` to continue)
     class Directive < GraphQL::Schema::Member
       extend GraphQL::Schema::Member::HasArguments
+      extend GraphQL::Schema::Member::HasArguments::HasDirectiveArguments
+
       class << self
+        # Directives aren't types, they don't have kinds.
+        undef_method :kind
+
+        def path
+          "@#{super}"
+        end
+
+        # Return a name based on the class name,
+        # but downcase the first letter.
         def default_graphql_name
-          super.downcase
+          @default_graphql_name ||= begin
+            camelized_name = super.dup
+            camelized_name[0] = camelized_name[0].downcase
+            -camelized_name
+          end
         end
 
         def locations(*new_locations)
           if new_locations.any?
+            new_locations.each do |new_loc|
+              if !LOCATIONS.include?(new_loc.to_sym)
+                raise ArgumentError, "#{self} (#{self.graphql_name}) has an invalid directive location: `locations #{new_loc}` "
+              end
+            end
             @locations = new_locations
           else
             @locations ||= (superclass.respond_to?(:locations) ? superclass.locations : [])
@@ -27,26 +47,21 @@ module GraphQL
           elsif @default_directive.nil?
             @default_directive = (superclass.respond_to?(:default_directive) ? superclass.default_directive : false)
           else
-            @default_directive
+            !!@default_directive
           end
         end
 
-        def to_graphql
-          defn = GraphQL::Directive.new
-          defn.name = self.graphql_name
-          defn.description = self.description
-          defn.locations = self.locations
-          defn.default_directive = self.default_directive
-          defn.metadata[:type_class] = self
-          arguments.each do |name, arg_defn|
-            arg_graphql = arg_defn.to_graphql
-            defn.arguments[arg_graphql.name] = arg_graphql
-          end
-          defn
+        def default_directive?
+          default_directive
         end
 
         # If false, this part of the query won't be evaluated
-        def include?(_object, _arguments, _context)
+        def include?(_object, arguments, context)
+          static_include?(arguments, context)
+        end
+
+        # Determines whether {Execution::Lookahead} considers the field to be selected
+        def static_include?(_arguments, _context)
           true
         end
 
@@ -54,6 +69,61 @@ module GraphQL
         def resolve(object, arguments, context)
           yield
         end
+
+        # Continuing is passed as a block, yield to continue.
+        def resolve_each(object, arguments, context)
+          yield
+        end
+
+        def on_field?
+          locations.include?(FIELD)
+        end
+
+        def on_fragment?
+          locations.include?(FRAGMENT_SPREAD) && locations.include?(INLINE_FRAGMENT)
+        end
+
+        def on_operation?
+          locations.include?(QUERY) && locations.include?(MUTATION) && locations.include?(SUBSCRIPTION)
+        end
+
+        def repeatable?
+          !!@repeatable
+        end
+
+        def repeatable(new_value)
+          @repeatable = new_value
+        end
+
+        private
+
+        def inherited(subclass)
+          super
+          subclass.class_eval do
+            @default_graphql_name ||= nil
+          end
+        end
+      end
+
+      # @return [GraphQL::Schema::Field, GraphQL::Schema::Argument, Class, Module]
+      attr_reader :owner
+
+      # @return [GraphQL::Interpreter::Arguments]
+      attr_reader :arguments
+
+      def initialize(owner, **arguments)
+        @owner = owner
+        assert_valid_owner
+        # It's be nice if we had the real context here, but we don't. What we _would_ get is:
+        # - error handling
+        # - lazy resolution
+        # Probably, those won't be needed here, since these are configuration arguments,
+        # not runtime arguments.
+        @arguments = self.class.coerce_arguments(nil, arguments, Query::NullContext)
+      end
+
+      def graphql_name
+        self.class.graphql_name
       end
 
       LOCATIONS = [
@@ -75,6 +145,7 @@ module GraphQL
         ENUM_VALUE =             :ENUM_VALUE,
         INPUT_OBJECT =           :INPUT_OBJECT,
         INPUT_FIELD_DEFINITION = :INPUT_FIELD_DEFINITION,
+        VARIABLE_DEFINITION =    :VARIABLE_DEFINITION,
       ]
 
       DEFAULT_DEPRECATION_REASON = 'No longer supported'
@@ -97,7 +168,55 @@ module GraphQL
         ENUM_VALUE:               'Location adjacent to an enum value definition.',
         INPUT_OBJECT:             'Location adjacent to an input object type definition.',
         INPUT_FIELD_DEFINITION:   'Location adjacent to an input object field definition.',
+        VARIABLE_DEFINITION:      'Location adjacent to a variable definition.',
       }
+
+      private
+
+      def assert_valid_owner
+        case @owner
+        when Class
+          if @owner < GraphQL::Schema::Object
+            assert_has_location(OBJECT)
+          elsif @owner < GraphQL::Schema::Union
+            assert_has_location(UNION)
+          elsif @owner < GraphQL::Schema::Enum
+            assert_has_location(ENUM)
+          elsif @owner < GraphQL::Schema::InputObject
+            assert_has_location(INPUT_OBJECT)
+          elsif @owner < GraphQL::Schema::Scalar
+            assert_has_location(SCALAR)
+          elsif @owner < GraphQL::Schema
+            assert_has_location(SCHEMA)
+          else
+            raise "Unexpected directive owner class: #{@owner}"
+          end
+        when Module
+          assert_has_location(INTERFACE)
+        when GraphQL::Schema::Argument
+          if @owner.owner.is_a?(GraphQL::Schema::Field)
+            assert_has_location(ARGUMENT_DEFINITION)
+          else
+            assert_has_location(INPUT_FIELD_DEFINITION)
+          end
+        when GraphQL::Schema::Field
+          assert_has_location(FIELD_DEFINITION)
+        when GraphQL::Schema::EnumValue
+          assert_has_location(ENUM_VALUE)
+        else
+          raise "Unexpected directive owner: #{@owner.inspect}"
+        end
+      end
+
+      def assert_has_location(location)
+        if !self.class.locations.include?(location)
+          raise ArgumentError, <<-MD
+Directive `@#{self.class.graphql_name}` can't be attached to #{@owner.graphql_name} because #{location} isn't included in its locations (#{self.class.locations.join(", ")}).
+
+Use `locations(#{location})` to update this directive's definition, or remove it from #{@owner.graphql_name}.
+MD
+        end
+      end
     end
   end
 end

data/lib/graphql/schema/enum.rb

@@ -1,31 +1,47 @@
 # frozen_string_literal: true
 
 module GraphQL
-  # Extend this class to define GraphQL enums in your schema.
-  #
-  # By default, GraphQL enum values are translated into Ruby strings.
-  # You can provide a custom value with the `value:` keyword.
-  #
-  # @example
-  #   # equivalent to
-  #   # enum PizzaTopping {
-  #   #   MUSHROOMS
-  #   #   ONIONS
-  #   #   PEPPERS
-  #   # }
-  #   class PizzaTopping < GraphQL::Enum
-  #     value :MUSHROOMS
-  #     value :ONIONS
-  #     value :PEPPERS
-  #   end
   class Schema
+    # Extend this class to define GraphQL enums in your schema.
+    #
+    # By default, GraphQL enum values are translated into Ruby strings.
+    # You can provide a custom value with the `value:` keyword.
+    #
+    # @example
+    #   # equivalent to
+    #   # enum PizzaTopping {
+    #   #   MUSHROOMS
+    #   #   ONIONS
+    #   #   PEPPERS
+    #   # }
+    #   class PizzaTopping < GraphQL::Enum
+    #     value :MUSHROOMS
+    #     value :ONIONS
+    #     value :PEPPERS
+    #   end
     class Enum < GraphQL::Schema::Member
-      extend GraphQL::Schema::Member::AcceptsDefinition
+      extend GraphQL::Schema::Member::ValidatesInput
 
-      class << self
-        extend Forwardable
-        def_delegators :graphql_definition, :coerce_isolated_input, :coerce_isolated_result, :coerce_input, :coerce_result
+      class UnresolvedValueError < GraphQL::Error
+        def initialize(value:, enum:, context:)
+          fix_message = ", but this isn't a valid value for `#{enum.graphql_name}`. Update the field or resolver to return one of `#{enum.graphql_name}`'s values instead."
+          message = if (cp = context[:current_path]) && (cf = context[:current_field])
+            "`#{cf.path}` returned `#{value.inspect}` at `#{cp.join(".")}`#{fix_message}"
+          else
+            "`#{value.inspect}` was returned for `#{enum.graphql_name}`#{fix_message}"
+          end
+          super(message)
+        end
+      end
 
+      class MissingValuesError < GraphQL::Error
+        def initialize(enum_type)
+          @enum_type = enum_type
+          super("Enum types require at least one value, but #{enum_type.graphql_name} didn't provide any for this query. Make sure at least one value is defined and visible for this query.")
+        end
+      end
+
+      class << self
         # Define a value for this enum
         # @param graphql_name [String, Symbol] the GraphQL value for this, usually `SCREAMING_CASE`
         # @param description [String], the GraphQL description for this value, present in documentation
@@ -36,42 +52,124 @@ module GraphQL
         def value(*args, **kwargs, &block)
           kwargs[:owner] = self
           value = enum_value_class.new(*args, **kwargs, &block)
-          own_values[value.graphql_name] = value
-          nil
+          key = value.graphql_name
+          prev_value = own_values[key]
+          case prev_value
+          when nil
+            own_values[key] = value
+          when GraphQL::Schema::EnumValue
+            own_values[key] = [prev_value, value]
+          when Array
+            prev_value << value
+          else
+            raise "Invariant: Unexpected enum value for #{key.inspect}: #{prev_value.inspect}"
+          end
+          value
         end
 
-        # @return [Hash<String => GraphQL::Schema::Enum::Value>] Possible values of this enum, keyed by name
-        def values
-          inherited_values = superclass <= GraphQL::Schema::Enum ? superclass.values : {}
-          # Local values take precedence over inherited ones
-          inherited_values.merge(own_values)
+        # @return [Array<GraphQL::Schema::EnumValue>] Possible values of this enum
+        def enum_values(context = GraphQL::Query::NullContext)
+          inherited_values = superclass.respond_to?(:enum_values) ? superclass.enum_values(context) : nil
+          visible_values = []
+          warden = Warden.from_context(context)
+          own_values.each do |key, values_entry|
+            if (v = Warden.visible_entry?(:visible_enum_value?, values_entry, context, warden))
+              visible_values << v
+            end
+          end
+
+          if inherited_values
+            # Local values take precedence over inherited ones
+            inherited_values.each do |i_val|
+              if !visible_values.any? { |v| v.graphql_name == i_val.graphql_name }
+                visible_values << i_val
+              end
+            end
+          end
+
+          visible_values
         end
 
-        # @return [GraphQL::EnumType]
-        def to_graphql
-          enum_type = GraphQL::EnumType.new
-          enum_type.name = graphql_name
-          enum_type.description = description
-          enum_type.introspection = introspection
-          values.each do |name, val|
-            enum_type.add_value(val.to_graphql)
+        # @return [Array<Schema::EnumValue>] An unfiltered list of all definitions
+        def all_enum_value_definitions
+          all_defns = if superclass.respond_to?(:all_enum_value_definitions)
+            superclass.all_enum_value_definitions
+          else
+            []
+          end
+
+          @own_values && @own_values.each do |_key, value|
+            if value.is_a?(Array)
+              all_defns.concat(value)
+            else
+              all_defns << value
+            end
           end
-          enum_type.metadata[:type_class] = self
-          enum_type
+
+          all_defns
+        end
+
+        # @return [Hash<String => GraphQL::Schema::EnumValue>] Possible values of this enum, keyed by name.
+        def values(context = GraphQL::Query::NullContext)
+          enum_values(context).each_with_object({}) { |val, obj| obj[val.graphql_name] = val }
         end
 
         # @return [Class] for handling `value(...)` inputs and building `GraphQL::Enum::EnumValue`s out of them
         def enum_value_class(new_enum_value_class = nil)
           if new_enum_value_class
             @enum_value_class = new_enum_value_class
+          elsif defined?(@enum_value_class) && @enum_value_class
+            @enum_value_class
+          else
+            superclass <= GraphQL::Schema::Enum ? superclass.enum_value_class : nil
           end
-          @enum_value_class || (superclass <= GraphQL::Schema::Enum ? superclass.enum_value_class : nil)
         end
 
         def kind
           GraphQL::TypeKinds::ENUM
         end
 
+        def validate_non_null_input(value_name, ctx, max_errors: nil)
+          allowed_values = ctx.warden.enum_values(self)
+          matching_value = allowed_values.find { |v| v.graphql_name == value_name }
+
+          if matching_value.nil?
+            GraphQL::Query::InputValidationResult.from_problem("Expected #{GraphQL::Language.serialize(value_name)} to be one of: #{allowed_values.map(&:graphql_name).join(', ')}")
+          else
+            nil
+          end
+        end
+
+        def coerce_result(value, ctx)
+          warden = ctx.warden
+          all_values = warden ? warden.enum_values(self) : values.each_value
+          enum_value = all_values.find { |val| val.value == value }
+          if enum_value
+            enum_value.graphql_name
+          else
+            raise self::UnresolvedValueError.new(enum: self, value: value, context: ctx)
+          end
+        end
+
+        def coerce_input(value_name, ctx)
+          all_values = ctx.warden ? ctx.warden.enum_values(self) : values.each_value
+
+          if v = all_values.find { |val| val.graphql_name == value_name }
+            v.value
+          elsif v = all_values.find { |val| val.value == value_name }
+            # this is for matching default values, which are "inputs", but they're
+            # the Ruby value, not the GraphQL string.
+            v.value
+          else
+            nil
+          end
+        end
+
+        def inherited(child_class)
+          child_class.const_set(:UnresolvedValueError, Class.new(Schema::Enum::UnresolvedValueError))
+          super
+        end
+
         private
 
         def own_values

data/lib/graphql/schema/enum_value.rb

@@ -13,12 +13,6 @@ module GraphQL
     #       # arguments to `value(...)` in Enum classes are passed here
     #       super
     #     end
-    #
-    #     def to_graphql
-    #       enum_value = super
-    #       # customize the derived GraphQL::EnumValue here
-    #       enum_value
-    #     end
     #   end
     #
     #   class BaseEnum < GraphQL::Schema::Enum
@@ -26,23 +20,31 @@ module GraphQL
     #     enum_value_class CustomEnumValue
     #   end
     class EnumValue < GraphQL::Schema::Member
-      include GraphQL::Schema::Member::AcceptsDefinition
       include GraphQL::Schema::Member::HasPath
+      include GraphQL::Schema::Member::HasAstNode
+      include GraphQL::Schema::Member::HasDirectives
+      include GraphQL::Schema::Member::HasDeprecationReason
 
       attr_reader :graphql_name
 
       # @return [Class] The enum type that owns this value
       attr_reader :owner
 
-      # @return [String] Explains why this value was deprecated (if present, this will be marked deprecated in introspection)
-      attr_accessor :deprecation_reason
-
-      def initialize(graphql_name, desc = nil, owner:, description: nil, value: nil, deprecation_reason: nil, &block)
+      def initialize(graphql_name, desc = nil, owner:, ast_node: nil, directives: nil, description: nil, value: NOT_CONFIGURED, deprecation_reason: nil, &block)
         @graphql_name = graphql_name.to_s
+        GraphQL::NameValidator.validate!(@graphql_name)
         @description = desc || description
-        @value = value.nil? ? @graphql_name : value
-        @deprecation_reason = deprecation_reason
+        @value = value == NOT_CONFIGURED ? @graphql_name : value
+        if deprecation_reason
+          self.deprecation_reason = deprecation_reason
+        end
         @owner = owner
+        @ast_node = ast_node
+        if directives
+          directives.each do |dir_class, dir_options|
+            directive(dir_class, **dir_options)
+          end
+        end
 
         if block_given?
           instance_eval(&block)
@@ -63,19 +65,11 @@ module GraphQL
         @value
       end
 
-      # @return [GraphQL::EnumType::EnumValue] A runtime-ready object derived from this object
-      def to_graphql
-        enum_value = GraphQL::EnumType::EnumValue.new
-        enum_value.name = @graphql_name
-        enum_value.description = @description
-        enum_value.value = @value
-        enum_value.deprecation_reason = @deprecation_reason
-        enum_value.metadata[:type_class] = self
-        enum_value
+      def inspect
+        "#<#{self.class} #{path} @value=#{@value.inspect}#{description ? " @description=#{description.inspect}" : ""}>"
       end
 
       def visible?(_ctx); true; end
-      def accessible?(_ctx); true; end
       def authorized?(_ctx); true; end
     end
   end