graphql 1.8.0 → 1.12.12

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Directive < GraphQL::Schema::Member
+      # An example directive to show how you might interact with the runtime.
+      #
+      # This directive might be used along with a server-side feature flag system like Flipper.
+      #
+      # With that system, you could use this directive to exclude parts of a query
+      # if the current viewer doesn't have certain flags enabled.
+      # (So, this flag would be for internal clients, like your iOS app, not third-party API clients.)
+      #
+      # To use it, you have to implement `.enabled?`, for example:
+      #
+      # @example Implementing the Feature directive
+      #   # app/graphql/directives/feature.rb
+      #   class Directives::Feature < GraphQL::Schema::Directive::Feature
+      #     def self.enabled?(flag_name, _obj, context)
+      #       # Translate some GraphQL data for Ruby:
+      #       flag_key = flag_name.underscore
+      #       current_user = context[:viewer]
+      #       # Check the feature flag however your app does it:
+      #       MyFeatureFlags.enabled?(current_user, flag_key)
+      #     end
+      #   end
+      #
+      # @example Flagging a part of the query
+      #   viewer {
+      #     # This field only runs if `.enabled?("recommendationEngine", obj, context)`
+      #     # returns true. Otherwise, it's treated as if it didn't exist.
+      #     recommendations @feature(flag: "recommendationEngine") {
+      #       name
+      #       rating
+      #     }
+      #   }
+      class Feature < Schema::Directive
+        description "Directs the executor to run this only if a certain server-side feature is enabled."
+
+        locations(
+          GraphQL::Schema::Directive::FIELD,
+          GraphQL::Schema::Directive::FRAGMENT_SPREAD,
+          GraphQL::Schema::Directive::INLINE_FRAGMENT
+        )
+
+        argument :flag, String, required: true,
+          description: "The name of the feature to check before continuing"
+
+        # Implement the Directive API
+        def self.include?(object, arguments, context)
+          flag_name = arguments[:flag]
+          self.enabled?(flag_name, object, context)
+        end
+
+        # Override this method in your app's subclass of this directive.
+        #
+        # @param flag_name [String] The client-provided string of a feature to check
+        # @param object [GraphQL::Schema::Objct] The currently-evaluated GraphQL object instance
+        # @param context [GraphQL::Query::Context]
+        # @return [Boolean] If truthy, execution will continue
+        def self.enabled?(flag_name, object, context)
+          raise GraphQL::RequiredImplementationMissingError, "Implement `.enabled?(flag_name, object, context)` to return true or false for the feature flag (#{flag_name.inspect})"
+        end
+      end
+    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", required: true
+
+        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
+              relevant_flags && relevant_flags.any? && super
+            else
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Directive < GraphQL::Schema::Member
+      class Include < GraphQL::Schema::Directive
+        description "Directs the executor to include this field or fragment only when the `if` argument is true."
+
+        locations(
+          GraphQL::Schema::Directive::FIELD,
+          GraphQL::Schema::Directive::FRAGMENT_SPREAD,
+          GraphQL::Schema::Directive::INLINE_FRAGMENT
+        )
+
+        argument :if, Boolean, required: true,
+          description: "Included when true."
+
+        default_directive true
+
+        def self.static_include?(args, ctx)
+          !!args[:if]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Directive < GraphQL::Schema::Member
+      class Skip < Schema::Directive
+        description "Directs the executor to skip this field or fragment when the `if` argument is true."
+
+        locations(
+          GraphQL::Schema::Directive::FIELD,
+          GraphQL::Schema::Directive::FRAGMENT_SPREAD,
+          GraphQL::Schema::Directive::INLINE_FRAGMENT
+        )
+
+        argument :if, Boolean, required: true,
+          description: "Skipped when true."
+
+        default_directive true
+
+        def self.static_include?(args, ctx)
+          !args[:if]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Directive < GraphQL::Schema::Member
+      # An example directive to show how you might interact with the runtime.
+      #
+      # This directive takes the return value of the tagged part of the query,
+      # and if the named transform is whitelisted and applies to the return value,
+      # it's applied by calling a method with that name.
+      #
+      # @example Installing the directive
+      #   class MySchema < GraphQL::Schema
+      #     directive(GraphQL::Schema::Directive::Transform)
+      #   end
+      #
+      # @example Transforming strings
+      #   viewer {
+      #     username @transform(by: "upcase")
+      #   }
+      class Transform < Schema::Directive
+        description "Directs the executor to run named transform on the return value."
+
+        locations(
+          GraphQL::Schema::Directive::FIELD,
+        )
+
+        argument :by, String, required: true,
+          description: "The name of the transform to run if applicable"
+
+        TRANSFORMS = [
+          "upcase",
+          "downcase",
+          # ??
+        ]
+        # Implement the Directive API
+        def self.resolve(object, arguments, context)
+          path = context.namespace(:interpreter)[:current_path]
+          return_value = yield
+          transform_name = arguments[:by]
+          if TRANSFORMS.include?(transform_name) && return_value.respond_to?(transform_name)
+            return_value = return_value.public_send(transform_name)
+            response = context.namespace(:interpreter)[:runtime].response
+            *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
+    end
+  end
+end

data/lib/graphql/schema/directive.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    # Subclasses of this can influence how {GraphQL::Execution::Interpreter} runs queries.
+    #
+    # - {.include?}: if it returns `false`, the field or fragment will be skipped altogether, as if it were absent
+    # - {.resolve}: Wraps field resolution (so it should call `yield` to continue)
+    class Directive < GraphQL::Schema::Member
+      extend GraphQL::Schema::Member::HasArguments
+      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
+          @default_graphql_name ||= begin
+            camelized_name = super
+            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 : [])
+          end
+        end
+
+        def default_directive(new_default_directive = nil)
+          if new_default_directive != nil
+            @default_directive = new_default_directive
+          elsif @default_directive.nil?
+            @default_directive = (superclass.respond_to?(:default_directive) ? superclass.default_directive : false)
+          else
+            !!@default_directive
+          end
+        end
+
+        def default_directive?
+          default_directive
+        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.ast_node = ast_node
+          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
+          # Make a reference to a classic-style Arguments class
+          defn.arguments_class = GraphQL::Query::Arguments.construct_arguments_class(defn)
+
+          defn
+        end
+
+        # If false, this part of the query won't be evaluated
+        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
+
+        # Continuing is passed as a block; `yield` to continue
+        def resolve(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
+      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
+
+      LOCATIONS = [
+        QUERY =                  :QUERY,
+        MUTATION =               :MUTATION,
+        SUBSCRIPTION =           :SUBSCRIPTION,
+        FIELD =                  :FIELD,
+        FRAGMENT_DEFINITION =    :FRAGMENT_DEFINITION,
+        FRAGMENT_SPREAD =        :FRAGMENT_SPREAD,
+        INLINE_FRAGMENT =        :INLINE_FRAGMENT,
+        SCHEMA =                 :SCHEMA,
+        SCALAR =                 :SCALAR,
+        OBJECT =                 :OBJECT,
+        FIELD_DEFINITION =       :FIELD_DEFINITION,
+        ARGUMENT_DEFINITION =    :ARGUMENT_DEFINITION,
+        INTERFACE =              :INTERFACE,
+        UNION =                  :UNION,
+        ENUM =                   :ENUM,
+        ENUM_VALUE =             :ENUM_VALUE,
+        INPUT_OBJECT =           :INPUT_OBJECT,
+        INPUT_FIELD_DEFINITION = :INPUT_FIELD_DEFINITION,
+      ]
+
+      DEFAULT_DEPRECATION_REASON = 'No longer supported'
+      LOCATION_DESCRIPTIONS = {
+        QUERY:                    'Location adjacent to a query operation.',
+        MUTATION:                 'Location adjacent to a mutation operation.',
+        SUBSCRIPTION:             'Location adjacent to a subscription operation.',
+        FIELD:                    'Location adjacent to a field.',
+        FRAGMENT_DEFINITION:      'Location adjacent to a fragment definition.',
+        FRAGMENT_SPREAD:          'Location adjacent to a fragment spread.',
+        INLINE_FRAGMENT:          'Location adjacent to an inline fragment.',
+        SCHEMA:                   'Location adjacent to a schema definition.',
+        SCALAR:                   'Location adjacent to a scalar definition.',
+        OBJECT:                   'Location adjacent to an object type definition.',
+        FIELD_DEFINITION:         'Location adjacent to a field definition.',
+        ARGUMENT_DEFINITION:      'Location adjacent to an argument definition.',
+        INTERFACE:                'Location adjacent to an interface definition.',
+        UNION:                    'Location adjacent to a union definition.',
+        ENUM:                     'Location adjacent to an enum definition.',
+        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.',
+      }
+
+      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

@@ -21,11 +21,12 @@ module GraphQL
   class Schema
     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
+      class UnresolvedValueError < GraphQL::EnumType::UnresolvedValueError
+      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,6 +37,9 @@ module GraphQL
         def value(*args, **kwargs, &block)
           kwargs[:owner] = self
           value = enum_value_class.new(*args, **kwargs, &block)
+          if own_values.key?(value.graphql_name)
+            raise ArgumentError, "#{value.graphql_name} is already defined for #{self.graphql_name}, please remove one of the definitions."
+          end
           own_values[value.graphql_name] = value
           nil
         end
@@ -53,6 +57,7 @@ module GraphQL
           enum_type.name = graphql_name
           enum_type.description = description
           enum_type.introspection = introspection
+          enum_type.ast_node = ast_node
           values.each do |name, val|
             enum_type.add_value(val.to_graphql)
           end
@@ -64,14 +69,60 @@ module GraphQL
         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)
+          result = GraphQL::Query::InputValidationResult.new
+
+          allowed_values = ctx.warden.enum_values(self)
+          matching_value = allowed_values.find { |v| v.graphql_name == value_name }
+
+          if matching_value.nil?
+            result.add_problem("Expected #{GraphQL::Language.serialize(value_name)} to be one of: #{allowed_values.map(&:graphql_name).join(', ')}")
+          end
+
+          result
+        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, "Can't resolve enum #{graphql_name} for #{value.inspect}")
+          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

@@ -26,19 +26,33 @@ module GraphQL
     #     enum_value_class CustomEnumValue
     #   end
     class EnumValue < GraphQL::Schema::Member
+      include GraphQL::Schema::Member::CachedGraphQLDefinition
       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
 
-      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: nil, deprecation_reason: nil, &block)
         @graphql_name = graphql_name.to_s
+        GraphQL::NameValidator.validate!(@graphql_name)
         @description = desc || description
-        @value = value || @graphql_name
-        @deprecation_reason = deprecation_reason
+        @value = value.nil? ? @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)
@@ -53,7 +67,7 @@ module GraphQL
       end
 
       def value(new_val = nil)
-        if new_val
+        unless new_val.nil?
           @value = new_val
         end
         @value
@@ -65,10 +79,15 @@ module GraphQL
         enum_value.name = @graphql_name
         enum_value.description = @description
         enum_value.value = @value
-        enum_value.deprecation_reason = @deprecation_reason
+        enum_value.deprecation_reason = self.deprecation_reason
         enum_value.metadata[:type_class] = self
+        enum_value.ast_node = ast_node
         enum_value
       end
+
+      def visible?(_ctx); true; end
+      def accessible?(_ctx); true; end
+      def authorized?(_ctx); true; end
     end
   end
 end