graphql 0.16.0 → 2.0.15

data/lib/graphql/schema/scalar.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Scalar < GraphQL::Schema::Member
+      extend GraphQL::Schema::Member::ValidatesInput
+
+      class << self
+        def coerce_input(val, ctx)
+          val
+        end
+
+        def coerce_result(val, ctx)
+          val
+        end
+
+        def kind
+          GraphQL::TypeKinds::SCALAR
+        end
+
+        def specified_by_url(new_url = nil)
+          if new_url
+            @specified_by_url = new_url
+          elsif defined?(@specified_by_url)
+            @specified_by_url
+          elsif superclass.respond_to?(:specified_by_url)
+            superclass.specified_by_url
+          else
+            nil
+          end
+        end
+
+        def default_scalar(is_default = nil)
+          if !is_default.nil?
+            @default_scalar = is_default
+          end
+          @default_scalar
+        end
+
+        def default_scalar?
+          @default_scalar ||= false
+        end
+
+        def validate_non_null_input(value, ctx, max_errors: nil)
+          coerced_result = begin
+            coerce_input(value, ctx)
+          rescue GraphQL::CoercionError => err
+            err
+          rescue StandardError => err
+            ctx.query.handle_or_reraise(err)
+          end
+
+          if coerced_result.nil?
+            str_value = if value == Float::INFINITY
+              ""
+            else
+              " #{GraphQL::Language.serialize(value)}"
+            end
+            Query::InputValidationResult.from_problem("Could not coerce value#{str_value} to #{graphql_name}")
+          elsif coerced_result.is_a?(GraphQL::CoercionError)
+            Query::InputValidationResult.from_problem(coerced_result.message, message: coerced_result.message, extensions: coerced_result.extensions)
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/subscription.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    # This class can be extended to create fields on your subscription root.
+    #
+    # It provides hooks for the different parts of the subscription lifecycle:
+    #
+    # - `#authorized?`: called before initial subscription and subsequent updates
+    # - `#subscribe`: called for the initial subscription
+    # - `#update`: called for subsequent update
+    #
+    # Also, `#unsubscribe` terminates the subscription.
+    class Subscription < GraphQL::Schema::Resolver
+      extend GraphQL::Schema::Resolver::HasPayloadType
+      extend GraphQL::Schema::Member::HasFields
+      NO_UPDATE = :no_update
+      # The generated payload type is required; If there's no payload,
+      # propagate null.
+      null false
+
+      def initialize(object:, context:, field:)
+        super
+        # Figure out whether this is an update or an initial subscription
+        @mode = context.query.subscription_update? ? :update : :subscribe
+      end
+
+      def resolve_with_support(**args)
+        result = nil
+        unsubscribed = true
+        catch :graphql_subscription_unsubscribed do
+          result = super
+          unsubscribed = false
+        end
+
+
+        if unsubscribed
+          context.skip
+        else
+          result
+        end
+      end
+
+      # Implement the {Resolve} API
+      def resolve(**args)
+        # Dispatch based on `@mode`, which will raise a `NoMethodError` if we ever
+        # have an unexpected `@mode`
+        public_send("resolve_#{@mode}", **args)
+      end
+
+      # Wrap the user-defined `#subscribe` hook
+      def resolve_subscribe(**args)
+        ret_val = args.any? ? subscribe(**args) : subscribe
+        if ret_val == :no_response
+          context.skip
+        else
+          ret_val
+        end
+      end
+
+      # The default implementation returns nothing on subscribe.
+      # Override it to return an object or
+      # `:no_response` to (explicitly) return nothing.
+      def subscribe(args = {})
+        :no_response
+      end
+
+      # Wrap the user-provided `#update` hook
+      def resolve_update(**args)
+        ret_val = args.any? ? update(**args) : update
+        if ret_val == NO_UPDATE
+          context.namespace(:subscriptions)[:no_update] = true
+          context.skip
+        else
+          ret_val
+        end
+      end
+
+      # The default implementation returns the root object.
+      # Override it to return {NO_UPDATE} if you want to
+      # skip updates sometimes. Or override it to return a different object.
+      def update(args = {})
+        object
+      end
+
+      # If an argument is flagged with `loads:` and no object is found for it,
+      # remove this subscription (assuming that the object was deleted in the meantime,
+      # or that it became inaccessible).
+      def load_application_object_failed(err)
+        if @mode == :update
+          unsubscribe
+        end
+        super
+      end
+
+      # Call this to halt execution and remove this subscription from the system
+      def unsubscribe
+        context.namespace(:subscriptions)[:unsubscribed] = true
+        throw :graphql_subscription_unsubscribed
+      end
+
+      READING_SCOPE = ::Object.new
+      # Call this method to provide a new subscription_scope; OR
+      # call it without an argument to get the subscription_scope
+      # @param new_scope [Symbol]
+      # @param optional [Boolean] If true, then don't require `scope:` to be provided to updates to this subscription.
+      # @return [Symbol]
+      def self.subscription_scope(new_scope = READING_SCOPE, optional: false)
+        if new_scope != READING_SCOPE
+          @subscription_scope = new_scope
+          @subscription_scope_optional = optional
+        elsif defined?(@subscription_scope)
+          @subscription_scope
+        else
+          find_inherited_value(:subscription_scope)
+        end
+      end
+
+      def self.subscription_scope_optional?
+        if defined?(@subscription_scope_optional)
+          @subscription_scope_optional
+        else
+          find_inherited_value(:subscription_scope_optional, false)
+        end
+      end
+
+      # This is called during initial subscription to get a "name" for this subscription.
+      # Later, when `.trigger` is called, this will be called again to build another "name".
+      # Any subscribers with matching topic will begin the update flow.
+      #
+      # The default implementation creates a string using the field name, subscription scope, and argument keys and values.
+      # In that implementation, only `.trigger` calls with _exact matches_ result in updates to subscribers.
+      #
+      # To implement a filtered stream-type subscription flow, override this method to return a string with field name and subscription scope.
+      # Then, implement {#update} to compare its arguments to the current `object` and return {NO_UPDATE} when an
+      # update should be filtered out.
+      #
+      # @see {#update} for how to skip updates when an event comes with a matching topic.
+      # @param arguments [Hash<String => Object>] The arguments for this topic, in GraphQL-style (camelized strings)
+      # @param field [GraphQL::Schema::Field]
+      # @param scope [Object, nil] A value corresponding to `.trigger(... scope:)` (for updates) or the `subscription_scope` found in `context` (for initial subscriptions).
+      # @return [String] An identifier corresponding to a stream of updates
+      def self.topic_for(arguments:, field:, scope:)
+        Subscriptions::Serialize.dump_recursive([scope, field.graphql_name, arguments])
+      end
+    end
+  end
+end

data/lib/graphql/schema/timeout.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    # This plugin will stop resolving new fields after `max_seconds` have elapsed.
+    # After the time has passed, any remaining fields will be `nil`, with errors added
+    # to the `errors` key. Any already-resolved fields will be in the `data` key, so
+    # you'll get a partial response.
+    #
+    # You can subclass `GraphQL::Schema::Timeout` and override `max_seconds` and/or `handle_timeout`
+    # to provide custom logic when a timeout error occurs.
+    #
+    # Note that this will stop a query _in between_ field resolutions, but
+    # it doesn't interrupt long-running `resolve` functions. Be sure to use
+    # timeout options for external connections. For more info, see
+    # www.mikeperham.com/2015/05/08/timeout-rubys-most-dangerous-api/
+    #
+    # @example Stop resolving fields after 2 seconds
+    #   class MySchema < GraphQL::Schema
+    #     use GraphQL::Schema::Timeout, max_seconds: 2
+    #   end
+    #
+    # @example Notifying Bugsnag and logging a timeout
+    #   class MyTimeout < GraphQL::Schema::Timeout
+    #     def handle_timeout(error, query)
+    #        Rails.logger.warn("GraphQL Timeout: #{error.message}: #{query.query_string}")
+    #        Bugsnag.notify(error, {query_string: query.query_string})
+    #     end
+    #   end
+    #
+    #   class MySchema < GraphQL::Schema
+    #     use MyTimeout, max_seconds: 2
+    #   end
+    #
+    class Timeout
+      def self.use(schema, **options)
+        tracer = new(**options)
+        schema.tracer(tracer)
+      end
+
+      # @param max_seconds [Numeric] how many seconds the query should be allowed to resolve new fields
+      def initialize(max_seconds:)
+        @max_seconds = max_seconds
+      end
+
+      def trace(key, data)
+        case key
+        when 'execute_multiplex'
+          data.fetch(:multiplex).queries.each do |query|
+            timeout_duration_s = max_seconds(query)
+            timeout_state = if timeout_duration_s == false
+              # if the method returns `false`, don't apply a timeout
+              false
+            else
+              now = Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond)
+              timeout_at = now + (max_seconds(query) * 1000)
+              {
+                timeout_at: timeout_at,
+                timed_out: false
+              }
+            end
+            query.context.namespace(self.class)[:state] = timeout_state
+          end
+
+          yield
+        when 'execute_field', 'execute_field_lazy'
+          query_context = data[:context] || data[:query].context
+          timeout_state = query_context.namespace(self.class).fetch(:state)
+          # If the `:state` is `false`, then `max_seconds(query)` opted out of timeout for this query.
+          if timeout_state != false && Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond) > timeout_state.fetch(:timeout_at)
+            error = if data[:context]
+              GraphQL::Schema::Timeout::TimeoutError.new(query_context.parent_type, query_context.field)
+            else
+              field = data.fetch(:field)
+              GraphQL::Schema::Timeout::TimeoutError.new(field.owner, field)
+            end
+
+            # Only invoke the timeout callback for the first timeout
+            if !timeout_state[:timed_out]
+              timeout_state[:timed_out] = true
+              handle_timeout(error, query_context.query)
+            end
+
+            error
+          else
+            yield
+          end
+        else
+          yield
+        end
+      end
+
+      # Called at the start of each query.
+      # The default implementation returns the `max_seconds:` value from installing this plugin.
+      #
+      # @param query [GraphQL::Query] The query that's about to run
+      # @return [Integer, false] The number of seconds after which to interrupt query execution and call {#handle_error}, or `false` to bypass the timeout.
+      def max_seconds(query)
+        @max_seconds
+      end
+
+      # Invoked when a query times out.
+      # @param error [GraphQL::Schema::Timeout::TimeoutError]
+      # @param query [GraphQL::Error]
+      def handle_timeout(error, query)
+        # override to do something interesting
+      end
+
+      # This error is raised when a query exceeds `max_seconds`.
+      # Since it's a child of {GraphQL::ExecutionError},
+      # its message will be added to the response's `errors` key.
+      #
+      # To raise an error that will stop query resolution, use a custom block
+      # to take this error and raise a new one which _doesn't_ descend from {GraphQL::ExecutionError},
+      # such as `RuntimeError`.
+      class TimeoutError < GraphQL::ExecutionError
+        def initialize(parent_type, field)
+          super("Timeout on #{parent_type.graphql_name}.#{field.graphql_name}")
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/type_expression.rb

@@ -1,17 +1,41 @@
+# frozen_string_literal: true
 module GraphQL
   class Schema
+    # @api private
     module TypeExpression
-      def self.build_type(schema, ast_node)
+      # Fetch a type from a type map by its AST specification.
+      # Return `nil` if not found.
+      # @param type_owner [#get_type] A thing for looking up types by name
+      # @param ast_node [GraphQL::Language::Nodes::AbstractNode]
+      # @return [Class, GraphQL::Schema::NonNull, GraphQL::Schema:List]
+      def self.build_type(type_owner, ast_node)
         case ast_node
         when GraphQL::Language::Nodes::TypeName
-          type_name = ast_node.name
-          schema.types[type_name]
+          type_owner.get_type(ast_node.name) # rubocop:disable Development/ContextIsPassedCop -- this is a `context` or `warden`, it's already query-aware
         when GraphQL::Language::Nodes::NonNullType
           ast_inner_type = ast_node.of_type
-          build_type(schema, ast_inner_type).to_non_null_type
+          inner_type = build_type(type_owner, ast_inner_type)
+          wrap_type(inner_type, :to_non_null_type)
         when GraphQL::Language::Nodes::ListType
           ast_inner_type = ast_node.of_type
-          build_type(schema, ast_inner_type).to_list_type
+          inner_type = build_type(type_owner, ast_inner_type)
+          wrap_type(inner_type, :to_list_type)
+        else
+          raise "Invariant: unexpected type from ast: #{ast_node.inspect}"
+        end
+      end
+
+      class << self
+        private
+
+        def wrap_type(type, wrapper_method)
+          if type.nil?
+            nil
+          elsif wrapper_method == :to_list_type || wrapper_method == :to_non_null_type
+            type.public_send(wrapper_method)
+          else
+            raise ArgumentError, "Unexpected wrapper method: #{wrapper_method.inspect}"
+          end
         end
       end
     end

data/lib/graphql/schema/type_membership.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    # This class joins an object type to an abstract type (interface or union) of which
+    # it is a member.
+    class TypeMembership
+      # @return [Class<GraphQL::Schema::Object>]
+      attr_accessor :object_type
+
+      # @return [Class<GraphQL::Schema::Union>, Module<GraphQL::Schema::Interface>]
+      attr_reader :abstract_type
+
+      # @return [Hash]
+      attr_reader :options
+
+      # Called when an object is hooked up to an abstract type, such as {Schema::Union.possible_types}
+      # or {Schema::Object.implements} (for interfaces).
+      #
+      # @param abstract_type [Class<GraphQL::Schema::Union>, Module<GraphQL::Schema::Interface>]
+      # @param object_type [Class<GraphQL::Schema::Object>]
+      # @param options [Hash] Any options passed to `.possible_types` or `.implements`
+      def initialize(abstract_type, object_type, **options)
+        @abstract_type = abstract_type
+        @object_type = object_type
+        @options = options
+      end
+
+      # @return [Boolean] if false, {#object_type} will be treated as _not_ a member of {#abstract_type}
+      def visible?(ctx)
+        warden = Warden.from_context(ctx)
+        (@object_type.respond_to?(:visible?) ? warden.visible_type?(@object_type, ctx) : true) &&
+          (@abstract_type.respond_to?(:visible?) ? warden.visible_type?(@abstract_type, ctx) : true)
+      end
+
+      def graphql_name
+        "#{@object_type.graphql_name}.#{@abstract_type.kind.interface? ? "implements" : "belongsTo" }.#{@abstract_type.graphql_name}"
+      end
+
+      def path
+        graphql_name
+      end
+
+      def inspect
+        "#<#{self.class} #{@object_type.inspect} => #{@abstract_type.inspect}>"
+      end
+
+      alias :type_class :itself
+    end
+  end
+end

data/lib/graphql/schema/union.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+module GraphQL
+  class Schema
+    class Union < GraphQL::Schema::Member
+      extend GraphQL::Schema::Member::HasUnresolvedTypeError
+
+      class << self
+        def inherited(child_class)
+          add_unresolved_type_error(child_class)
+          super
+        end
+
+        def possible_types(*types, context: GraphQL::Query::NullContext, **options)
+          if types.any?
+            types.each do |t|
+              assert_valid_union_member(t)
+              type_memberships << type_membership_class.new(self, t, **options)
+            end
+          else
+            visible_types = []
+            warden = Warden.from_context(context)
+            type_memberships.each do |type_membership|
+              if warden.visible_type_membership?(type_membership, context)
+                visible_types << type_membership.object_type
+              end
+            end
+            visible_types
+          end
+        end
+
+        def all_possible_types
+          type_memberships.map(&:object_type)
+        end
+
+        def type_membership_class(membership_class = nil)
+          if membership_class
+            @type_membership_class = membership_class
+          else
+            @type_membership_class || find_inherited_value(:type_membership_class, GraphQL::Schema::TypeMembership)
+          end
+        end
+
+        def kind
+          GraphQL::TypeKinds::UNION
+        end
+
+        def type_memberships
+          @type_memberships ||= []
+        end
+
+        # Update a type membership whose `.object_type` is a string or late-bound type
+        # so that the type membership's `.object_type` is the given `object_type`.
+        # (This is used for updating the union after the schema as lazily loaded the union member.)
+        # @api private
+        def assign_type_membership_object_type(object_type)
+          assert_valid_union_member(object_type)
+          type_memberships.each { |tm|
+            possible_type = tm.object_type
+            if possible_type.is_a?(String) && (possible_type == object_type.name)
+              # This is a match of Ruby class names, not graphql names,
+              # since strings are used to refer to constants.
+              tm.object_type = object_type
+            elsif possible_type.is_a?(LateBoundType) && possible_type.graphql_name == object_type.graphql_name
+              tm.object_type = object_type
+            end
+          }
+          nil
+        end
+
+        private
+
+        def assert_valid_union_member(type_defn)
+          if type_defn.is_a?(Module) && !type_defn.is_a?(Class)
+            # it's an interface type, defined as a module
+            raise ArgumentError, "Union possible_types can only be object types (not interface types), remove #{type_defn.graphql_name} (#{type_defn.inspect})"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/unique_within_type.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require 'graphql/schema/base_64_bp'
+
+module GraphQL
+  class Schema
+    module UniqueWithinType
+      class << self
+        attr_accessor :default_id_separator
+      end
+      self.default_id_separator = "-"
+
+      module_function
+
+      # @param type_name [String]
+      # @param object_value [Any]
+      # @return [String] a unique, opaque ID generated as a function of the two inputs
+      def encode(type_name, object_value, separator: self.default_id_separator)
+        object_value_str = object_value.to_s
+
+        if type_name.include?(separator)
+          raise "encode(#{type_name}, #{object_value_str}) contains reserved characters `#{separator}` in the type name"
+        end
+
+        Base64.strict_encode64([type_name, object_value_str].join(separator))
+      end
+
+      # @param node_id [String] A unique ID generated by {.encode}
+      # @return [Array<(String, String)>] The type name & value passed to {.encode}
+      def decode(node_id, separator: self.default_id_separator)
+        GraphQL::Schema::Base64Encoder.decode(node_id).split(separator, 2)
+      end
+    end
+  end
+end

data/lib/graphql/schema/validator/allow_blank_validator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Validator
+      # Use this to specifically reject values that respond to `.blank?` and respond truthy for that method.
+      #
+      # @example Require a non-empty string for an argument
+      #   argument :name, String, required: true, validate: { allow_blank: false }
+      class AllowBlankValidator < Validator
+        def initialize(allow_blank_positional, allow_blank: nil, message: "%{validated} can't be blank", **default_options)
+          @message = message
+          super(**default_options)
+          @allow_blank = allow_blank.nil? ? allow_blank_positional : allow_blank
+        end
+
+        def validate(_object, _context, value)
+          if value.respond_to?(:blank?) && value.blank?
+            if (value.nil? && @allow_null) || @allow_blank
+              # pass
+            else
+              @message
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/validator/allow_null_validator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Validator
+      # Use this to specifically reject or permit `nil` values (given as `null` from GraphQL).
+      #
+      # @example require a non-null value for an argument if it is provided
+      #   argument :name, String, required: false, validates: { allow_null: false }
+      class AllowNullValidator < Validator
+        MESSAGE = "%{validated} can't be null"
+        def initialize(allow_null_positional, allow_null: nil, message: MESSAGE, **default_options)
+          @message = message
+          super(**default_options)
+          @allow_null = allow_null.nil? ? allow_null_positional : allow_null
+        end
+
+        def validate(_object, _context, value)
+          if value.nil? && !@allow_null
+            @message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/validator/exclusion_validator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Validator
+      # Use this to specifically reject values from an argument.
+      #
+      # @example disallow certain values
+      #
+      #   argument :favorite_non_prime, Integer, required: true,
+      #     validates: { exclusion: { in: [2, 3, 5, 7, ... ]} }
+      #
+      class ExclusionValidator < Validator
+        # @param message [String]
+        # @param in [Array] The values to reject
+        def initialize(message: "%{validated} is reserved", in:, **default_options)
+          # `in` is a reserved word, so work around that
+          @in_list = binding.local_variable_get(:in)
+          @message = message
+          super(**default_options)
+        end
+
+        def validate(_object, _context, value)
+          if permitted_empty_value?(value)
+            # pass
+          elsif @in_list.include?(value)
+            @message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema/validator/format_validator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Schema
+    class Validator
+      # Use this to assert that string values match (or don't match) the given RegExp.
+      #
+      # @example requiring input to match a pattern
+      #
+      #   argument :handle, String, required: true,
+      #     validates: { format: { with: /\A[a-z0-9_]+\Z/ } }
+      #
+      # @example reject inputs that match a pattern
+      #
+      #   argument :word_that_doesnt_begin_with_a_vowel, String, required: true,
+      #     validates: { format: { without: /\A[aeiou]/ } }
+      #
+      #   # It's pretty hard to come up with a legitimate use case for `without:`
+      #
+      class FormatValidator < Validator
+        # @param with [RegExp, nil]
+        # @param without [Regexp, nil]
+        # @param message [String]
+        def initialize(
+          with: nil,
+          without: nil,
+          message: "%{validated} is invalid",
+          **default_options
+        )
+          @with_pattern = with
+          @without_pattern = without
+          @message = message
+          super(**default_options)
+        end
+
+        def validate(_object, _context, value)
+          if permitted_empty_value?(value)
+            # Do nothing
+          elsif value.nil? ||
+              (@with_pattern && !value.match?(@with_pattern)) ||
+              (@without_pattern && value.match?(@without_pattern))
+            @message
+          end
+        end
+      end
+    end
+  end
+end