graphql 1.10.2 → 2.0.21

data/lib/graphql/schema/validation.rb

@@ -1,303 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  class Schema
-    # This module provides a function for validating GraphQL types.
-    #
-    # Its {RULES} contain objects that respond to `#call(type)`. Rules are
-    # looked up for given types (by class ancestry), then applied to
-    # the object until an error is returned.
-    class Validation
-      # Lookup the rules for `object` based on its class,
-      # Then returns an error message or `nil`
-      # @param object [Object] something to be validated
-      # @return [String, Nil] error message, if there was one
-      def self.validate(object)
-        RULES.each do |parent_class, validations|
-          if object.is_a?(parent_class)
-            validations.each do |rule|
-              if error = rule.call(object)
-                return error
-              end
-            end
-          end
-        end
-        nil
-      end
-
-      module Rules
-        # @param property_name [Symbol] The method to validate
-        # @param allowed_classes [Class] Classes which the return value may be an instance of
-        # @return [Proc] A proc which will validate the input by calling `property_name` and asserting it is an instance of one of `allowed_classes`
-        def self.assert_property(property_name, *allowed_classes)
-          # Hide LateBoundType from user-facing errors
-          allowed_classes_message = allowed_classes.map(&:name).reject {|n| n.include?("LateBoundType") }.join(" or ")
-          ->(obj) {
-            property_value = obj.public_send(property_name)
-            is_valid_value = allowed_classes.any? { |allowed_class| property_value.is_a?(allowed_class) }
-            is_valid_value ? nil : "#{property_name} must return #{allowed_classes_message}, not #{property_value.class.name} (#{property_value.inspect})"
-          }
-        end
-
-        # @param property_name [Symbol] The method whose return value will be validated
-        # @param from_class [Class] The class for keys in the return value
-        # @param to_class [Class] The class for values in the return value
-        # @return [Proc] A proc to validate that validates the input by calling `property_name` and asserting that the return value is a Hash of `{from_class => to_class}` pairs
-        def self.assert_property_mapping(property_name, from_class, to_class)
-          ->(obj) {
-            property_value = obj.public_send(property_name)
-            if !property_value.is_a?(Hash)
-              "#{property_name} must be a hash of {#{from_class.name} => #{to_class.name}}, not a #{property_value.class.name} (#{property_value.inspect})"
-            else
-              invalid_key, invalid_value = property_value.find { |key, value| !key.is_a?(from_class) || !value.is_a?(to_class) }
-              if invalid_key
-                "#{property_name} must map #{from_class} => #{to_class}, not #{invalid_key.class.name} => #{invalid_value.class.name} (#{invalid_key.inspect} => #{invalid_value.inspect})"
-              else
-                nil # OK
-              end
-            end
-          }
-        end
-
-        # @param property_name [Symbol] The method whose return value will be validated
-        # @param list_member_class [Class] The class which each member of the returned array should be an instance of
-        # @return [Proc] A proc to validate the input by calling `property_name` and asserting that the return is an Array of `list_member_class` instances
-        def self.assert_property_list_of(property_name, list_member_class)
-          ->(obj) {
-            property_value = obj.public_send(property_name)
-            if !property_value.is_a?(Array)
-              "#{property_name} must be an Array of #{list_member_class.name}, not a #{property_value.class.name} (#{property_value.inspect})"
-            else
-              invalid_member = property_value.find { |value| !value.is_a?(list_member_class) }
-              if invalid_member
-                "#{property_name} must contain #{list_member_class.name}, not #{invalid_member.class.name} (#{invalid_member.inspect})"
-              else
-                nil # OK
-              end
-            end
-          }
-        end
-
-        def self.count_at_least(item_name, minimum_count, get_items_proc)
-          ->(type) {
-            items = get_items_proc.call(type)
-
-            if items.size < minimum_count
-              "#{type.name} must define at least #{minimum_count} #{item_name}. #{items.size} defined."
-            else
-              nil
-            end
-          }
-        end
-
-        def self.assert_named_items_are_valid(item_name, get_items_proc)
-          ->(type) {
-            items = get_items_proc.call(type)
-            error_message = nil
-            items.each do |item|
-              item_message = GraphQL::Schema::Validation.validate(item)
-              if item_message
-                error_message = "#{item_name} #{item.name.inspect} #{item_message}"
-                break
-              end
-            end
-            error_message
-          }
-        end
-
-        HAS_AT_LEAST_ONE_FIELD = Rules.count_at_least("field", 1, ->(type) { type.all_fields })
-        FIELDS_ARE_VALID = Rules.assert_named_items_are_valid("field", ->(type) { type.all_fields })
-        HAS_AT_LEAST_ONE_ARGUMENT = Rules.count_at_least("argument", 1, ->(type) { type.arguments })
-
-        HAS_ONE_OR_MORE_POSSIBLE_TYPES = ->(type) {
-          type.possible_types.length >= 1 ? nil : "must have at least one possible type"
-        }
-
-        NAME_IS_STRING = Rules.assert_property(:name, String)
-        DESCRIPTION_IS_STRING_OR_NIL = Rules.assert_property(:description, String, NilClass)
-        ARGUMENTS_ARE_STRING_TO_ARGUMENT = Rules.assert_property_mapping(:arguments, String, GraphQL::Argument)
-        ARGUMENTS_ARE_VALID =  Rules.assert_named_items_are_valid("argument", ->(type) { type.arguments.values })
-
-        DEFAULT_VALUE_IS_VALID_FOR_TYPE = ->(type) {
-          if !type.default_value.nil?
-            coerced_value = begin
-              type.type.coerce_isolated_result(type.default_value)
-            rescue => ex
-              ex
-            end
-
-            if coerced_value.nil? || coerced_value.is_a?(StandardError)
-              msg = "default value #{type.default_value.inspect} is not valid for type #{type.type}"
-              msg += " (#{coerced_value})" if coerced_value.is_a?(StandardError)
-              msg
-            end
-          end
-        }
-
-        TYPE_IS_VALID_INPUT_TYPE = ->(type) {
-          outer_type = type.type
-          inner_type = outer_type.respond_to?(:unwrap) ? outer_type.unwrap : nil
-
-          case inner_type
-          when GraphQL::ScalarType, GraphQL::InputObjectType, GraphQL::EnumType
-            # OK
-          else
-            "type must be a valid input type (Scalar or InputObject), not #{outer_type.class} (#{outer_type})"
-          end
-        }
-
-        SCHEMA_CAN_RESOLVE_TYPES = ->(schema) {
-          if schema.types.values.any? { |type| type.kind.abstract? } && schema.resolve_type_proc.nil?
-            "schema contains Interfaces or Unions, so you must define a `resolve_type -> (obj, ctx) { ... }` function"
-          else
-            # :+1:
-          end
-        }
-
-        SCHEMA_CAN_FETCH_IDS = ->(schema) {
-          has_node_field = schema.query && schema.query.fields.each_value.any?(&:relay_node_field)
-          if has_node_field && schema.object_from_id_proc.nil?
-            "schema contains `node(id:...)` field, so you must define a `object_from_id -> (id, ctx) { ... }` function"
-          else
-            # :rocket:
-          end
-        }
-
-        SCHEMA_CAN_GENERATE_IDS = ->(schema) {
-          has_id_field = schema.types.values.any? { |t| t.kind.fields? && t.all_fields.any? { |f| f.resolve_proc.is_a?(GraphQL::Relay::GlobalIdResolve) } }
-          if has_id_field && schema.id_from_object_proc.nil?
-            "schema contains `global_id_field`, so you must define a `id_from_object -> (obj, type, ctx) { ... }` function"
-          else
-            # :ok_hand:
-          end
-        }
-
-        SCHEMA_INSTRUMENTERS_ARE_VALID = ->(schema) {
-          errs = []
-          schema.instrumenters[:query].each do |inst|
-            if !inst.respond_to?(:before_query) || !inst.respond_to?(:after_query)
-              errs << "`instrument(:query, #{inst})` is invalid: must respond to `before_query(query)` and `after_query(query)` "
-            end
-          end
-
-          schema.instrumenters[:field].each do |inst|
-            if !inst.respond_to?(:instrument)
-              errs << "`instrument(:field, #{inst})` is invalid: must respond to `instrument(type, field)`"
-            end
-          end
-
-          if errs.any?
-            errs.join("Invalid instrumenters:\n" + errs.join("\n"))
-          else
-            nil
-          end
-        }
-
-        RESERVED_TYPE_NAME = ->(type) {
-          if type.name.start_with?('__') && !type.introspection?
-            # TODO: make this a hard failure in a later version
-            warn("Name #{type.name.inspect} must not begin with \"__\", which is reserved by GraphQL introspection.")
-            nil
-          else
-            # ok name
-          end
-        }
-
-        RESERVED_NAME = ->(named_thing) {
-          if named_thing.name.start_with?('__')
-            # TODO: make this a hard failure in a later version
-            warn("Name #{named_thing.name.inspect} must not begin with \"__\", which is reserved by GraphQL introspection.")
-            nil
-          else
-            # no worries
-          end
-        }
-
-        INTERFACES_ARE_IMPLEMENTED = ->(obj_type) {
-          field_errors = []
-          obj_type.interfaces.each do |interface_type|
-            interface_type.fields.each do |field_name, field_defn|
-              object_field = obj_type.get_field(field_name)
-              if object_field.nil?
-                field_errors << %|"#{field_name}" is required by #{interface_type.name} but not implemented by #{obj_type.name}|
-              elsif !GraphQL::Execution::Typecast.subtype?(field_defn.type, object_field.type)
-                field_errors << %|"#{field_name}" is required by #{interface_type.name} to return #{field_defn.type} but #{obj_type.name}.#{field_name} returns #{object_field.type}|
-              else
-                field_defn.arguments.each do |arg_name, arg_defn|
-                  object_field_arg = object_field.arguments[arg_name]
-                  if object_field_arg.nil?
-                    field_errors << %|"#{arg_name}" argument is required by #{interface_type.name}.#{field_name} but not accepted by #{obj_type.name}.#{field_name}|
-                  elsif arg_defn.type != object_field_arg.type
-                    field_errors << %|"#{arg_name}" is required by #{interface_type.name}.#{field_defn.name} to accept #{arg_defn.type} but #{obj_type.name}.#{field_name} accepts #{object_field_arg.type} for "#{arg_name}"|
-                  end
-                end
-
-                object_field.arguments.each do |arg_name, arg_defn|
-                  if field_defn.arguments[arg_name].nil? && arg_defn.type.is_a?(GraphQL::NonNullType)
-                    field_errors << %|"#{arg_name}" is not accepted by #{interface_type.name}.#{field_name} but required by #{obj_type.name}.#{field_name}|
-                  end
-                end
-              end
-            end
-          end
-          if field_errors.any?
-            "#{obj_type.name} failed to implement some interfaces: #{field_errors.join(", ")}"
-          else
-            nil
-          end
-        }
-      end
-
-      # A mapping of `{Class => [Proc, Proc...]}` pairs.
-      # To validate an instance, find entries where `object.is_a?(key)` is true.
-      # Then apply each rule from the matching values.
-      RULES = {
-        GraphQL::Field => [
-          Rules::NAME_IS_STRING,
-          Rules::RESERVED_NAME,
-          Rules::DESCRIPTION_IS_STRING_OR_NIL,
-          Rules.assert_property(:deprecation_reason, String, NilClass),
-          Rules.assert_property(:type, GraphQL::BaseType, GraphQL::Schema::LateBoundType),
-          Rules.assert_property(:property, Symbol, NilClass),
-          Rules::ARGUMENTS_ARE_STRING_TO_ARGUMENT,
-          Rules::ARGUMENTS_ARE_VALID,
-        ],
-        GraphQL::Argument => [
-          Rules::NAME_IS_STRING,
-          Rules::RESERVED_NAME,
-          Rules::DESCRIPTION_IS_STRING_OR_NIL,
-          Rules::TYPE_IS_VALID_INPUT_TYPE,
-          Rules::DEFAULT_VALUE_IS_VALID_FOR_TYPE,
-        ],
-        GraphQL::BaseType => [
-          Rules::NAME_IS_STRING,
-          Rules::RESERVED_TYPE_NAME,
-          Rules::DESCRIPTION_IS_STRING_OR_NIL,
-        ],
-        GraphQL::ObjectType => [
-          Rules::HAS_AT_LEAST_ONE_FIELD,
-          Rules.assert_property_list_of(:interfaces, GraphQL::InterfaceType),
-          Rules::FIELDS_ARE_VALID,
-          Rules::INTERFACES_ARE_IMPLEMENTED,
-        ],
-        GraphQL::InputObjectType => [
-          Rules::HAS_AT_LEAST_ONE_ARGUMENT,
-          Rules::ARGUMENTS_ARE_STRING_TO_ARGUMENT,
-          Rules::ARGUMENTS_ARE_VALID,
-        ],
-        GraphQL::UnionType => [
-          Rules.assert_property_list_of(:possible_types, GraphQL::ObjectType),
-          Rules::HAS_ONE_OR_MORE_POSSIBLE_TYPES,
-        ],
-        GraphQL::InterfaceType => [
-          Rules::FIELDS_ARE_VALID,
-        ],
-        GraphQL::Schema => [
-          Rules::SCHEMA_INSTRUMENTERS_ARE_VALID,
-          Rules::SCHEMA_CAN_RESOLVE_TYPES,
-          Rules::SCHEMA_CAN_FETCH_IDS,
-          Rules::SCHEMA_CAN_GENERATE_IDS,
-        ],
-      }
-    end
-  end
-end

data/lib/graphql/static_validation/default_visitor.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module StaticValidation
-    class DefaultVisitor < BaseVisitor
-      include(GraphQL::StaticValidation::DefinitionDependencies)
-
-      StaticValidation::ALL_RULES.reverse_each do |r|
-        include(r)
-      end
-
-      include(GraphQL::InternalRepresentation::Rewrite)
-      include(ContextMethods)
-    end
-  end
-end

data/lib/graphql/static_validation/no_validate_visitor.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module StaticValidation
-    class NoValidateVisitor < StaticValidation::BaseVisitor
-      include(GraphQL::InternalRepresentation::Rewrite)
-      include(GraphQL::StaticValidation::DefinitionDependencies)
-      include(ContextMethods)
-    end
-  end
-end

data/lib/graphql/string_type.rb

@@ -1,2 +0,0 @@
-# frozen_string_literal: true
-GraphQL::STRING_TYPE = GraphQL::Types::String.graphql_definition

data/lib/graphql/subscriptions/subscription_root.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module GraphQL
-  class Subscriptions
-    # Extend this module in your subscription root when using {GraphQL::Execution::Interpreter}.
-    module SubscriptionRoot
-      def self.extended(child_cls)
-        child_cls.include(InstanceMethods)
-      end
-
-      # This is for maintaining backwards compatibility:
-      # if a subscription field is created without a `subscription:` resolver class,
-      # then implement the method with the previous default behavior.
-      module InstanceMethods
-        def skip_subscription_root(*)
-          if context.query.subscription_update?
-            object
-          else
-            context.skip
-          end
-        end
-      end
-
-      def field(*args, extensions: [], **rest, &block)
-        extensions += [Extension]
-        # Backwards-compat for schemas
-        if !rest[:subscription]
-          name = args.first
-          alias_method(name, :skip_subscription_root)
-        end
-        super(*args, extensions: extensions, **rest, &block)
-      end
-
-      class Extension < GraphQL::Schema::FieldExtension
-        def after_resolve(value:, context:, object:, arguments:, **rest)
-          if value.is_a?(GraphQL::ExecutionError)
-            value
-          elsif (events = context.namespace(:subscriptions)[:events])
-            # This is the first execution, so gather an Event
-            # for the backend to register:
-            events << Subscriptions::Event.new(
-              name: field.name,
-              arguments: arguments,
-              context: context,
-              field: field,
-            )
-            value
-          elsif context.query.subscription_topic == Subscriptions::Event.serialize(
-              field.name,
-              arguments,
-              field,
-              scope: (field.subscription_scope ? context[field.subscription_scope] : nil),
-            )
-            # This is a subscription update. The resolver returned `skip` if it should be skipped,
-            # or else it returned an object to resolve the update.
-            value
-          else
-            # This is a subscription update, but this event wasn't triggered.
-            context.skip
-          end
-        end
-      end
-    end
-  end
-end

data/lib/graphql/tracing/skylight_tracing.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-module GraphQL
-  module Tracing
-    class SkylightTracing < PlatformTracing
-      self.platform_keys = {
-        "lex" => "graphql.language",
-        "parse" => "graphql.language",
-        "validate" => "graphql.prepare",
-        "analyze_query" => "graphql.prepare",
-        "analyze_multiplex" => "graphql.prepare",
-        "execute_multiplex" => "graphql.execute",
-        "execute_query" => "graphql.execute",
-        "execute_query_lazy" => "graphql.execute",
-      }
-
-      # @param set_endpoint_name [Boolean] If true, the GraphQL operation name will be used as the endpoint name.
-      #   This is not advised if you run more than one query per HTTP request, for example, with `graphql-client` or multiplexing.
-      #   It can also be specified per-query with `context[:set_skylight_endpoint_name]`.
-      def initialize(options = {})
-        warn("GraphQL::Tracing::SkylightTracing is deprecated, please enable Skylight's GraphQL probe instead: https://www.skylight.io/support/getting-more-from-skylight#graphql.")
-        @set_endpoint_name = options.fetch(:set_endpoint_name, false)
-        super
-      end
-
-      def platform_trace(platform_key, key, data)
-        if key == "execute_query"
-          query = data[:query]
-          title = query.selected_operation_name || "<anonymous>"
-          category = platform_key
-          set_endpoint_name_override = query.context[:set_skylight_endpoint_name]
-          if set_endpoint_name_override == true || (set_endpoint_name_override.nil? && @set_endpoint_name)
-            # Assign the endpoint so that queries will be grouped
-            instrumenter = Skylight.instrumenter
-            if instrumenter
-              current_trace = instrumenter.current_trace
-              if current_trace
-                op_type = query.selected_operation ? query.selected_operation.operation_type : "query"
-                endpoint = "GraphQL/#{op_type}.#{title}"
-                current_trace.endpoint = endpoint
-              end
-            end
-          end
-        elsif key.start_with?("execute_field")
-          title = platform_key
-          category = key
-        else
-          title = key
-          category = platform_key
-        end
-
-        Skylight.instrument(category: category, title: title) do
-          yield
-        end
-      end
-
-      def platform_field_key(type, field)
-        "graphql.#{type.graphql_name}.#{field.graphql_name}"
-      end
-
-      def platform_authorized_key(type)
-        "graphql.authorized.#{type.graphql_name}"
-      end
-
-      def platform_resolve_type_key(type)
-        "graphql.resolve_type.#{type.graphql_name}"
-      end
-    end
-  end
-end

data/lib/graphql/types/relay/base_field.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module GraphQL
-  module Types
-    module Relay
-      class BaseField < GraphQL::Schema::Field
-        def initialize(edge_class: nil, **rest, &block)
-          @edge_class = edge_class
-          super(**rest, &block)
-        end
-
-        def to_graphql
-          field = super
-          if @edge_class
-            field.edge_class = @edge_class
-          end
-          field
-        end
-      end
-    end
-  end
-end

data/lib/graphql/types/relay/base_interface.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module GraphQL
-  module Types
-    module Relay
-      module BaseInterface
-        include GraphQL::Schema::Interface
-
-        field_class(Types::Relay::BaseField)
-
-        definition_methods do
-          def default_relay(new_value)
-            @default_relay = new_value
-          end
-
-          def default_relay?
-            !!@default_relay
-          end
-
-          def to_graphql
-            type_defn = super
-            type_defn.default_relay = default_relay?
-            type_defn
-          end
-        end
-      end
-    end
-  end
-end

data/lib/graphql/types/relay/base_object.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module GraphQL
-  module Types
-    module Relay
-      class BaseObject < GraphQL::Schema::Object
-        field_class(Types::Relay::BaseField)
-        class << self
-          def default_relay(new_value)
-            @default_relay = new_value
-          end
-
-          def default_relay?
-            !!@default_relay
-          end
-
-          def to_graphql
-            type_defn = super
-            type_defn.default_relay = default_relay?
-            type_defn
-          end
-        end
-      end
-    end
-  end
-end

data/lib/graphql/types/relay/node_field.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module Types
-    module Relay
-      # This can be used for implementing `Query.node(id: ...)`,
-      # or use it for inspiration for your own field definition.
-      #
-      # @example Adding this field directly
-      #   add_field(GraphQL::Types::Relay::NodeField)
-      #
-      # @example Implementing a similar field in your own Query root
-      #
-      #   field :node, GraphQL::Types::Relay::Node, null: true,
-      #     description: "Fetches an object given its ID" do
-      #       argument :id, ID, required: true
-      #     end
-      #
-      #   def node(id:)
-      #     context.schema.object_from_id(id, context)
-      #   end
-      #
-      NodeField = GraphQL::Schema::Field.new(
-        name: "node",
-        owner: nil,
-        type: GraphQL::Types::Relay::Node,
-        null: true,
-        description: "Fetches an object given its ID.",
-        relay_node_field: true,
-      ) do
-        argument :id, "ID!", required: true,
-          description: "ID of the object."
-
-        def resolve(obj, args, ctx)
-          ctx.schema.object_from_id(args[:id], ctx)
-        end
-
-        def resolve_field(obj, args, ctx)
-          resolve(obj, args, ctx)
-        end
-      end
-    end
-  end
-end

data/lib/graphql/types/relay/nodes_field.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module Types
-    module Relay
-      # This can be used for implementing `Query.nodes(ids: ...)`,
-      # or use it for inspiration for your own field definition.
-      #
-      # @example Adding this field directly
-      #   add_field(GraphQL::Types::Relay::NodesField)
-      #
-      # @example Implementing a similar field in your own Query root
-      #
-      #   field :nodes, [GraphQL::Types::Relay::Node, null: true], null: false,
-      #     description: Fetches a list of objects given a list of IDs." do
-      #       argument :ids, [ID], required: true
-      #     end
-      #
-      #   def nodes(ids:)
-      #     ids.map do |id|
-      #       context.schema.object_from_id(context, id)
-      #     end
-      #   end
-      #
-      NodesField = GraphQL::Schema::Field.new(
-        name: "nodes",
-        owner: nil,
-        type: [GraphQL::Types::Relay::Node, null: true],
-        null: false,
-        description: "Fetches a list of objects given a list of IDs.",
-        relay_nodes_field: true,
-      ) do
-        argument :ids, "[ID!]!", required: true,
-          description: "IDs of the objects."
-
-        def resolve(obj, args, ctx)
-          args[:ids].map { |id| ctx.schema.object_from_id(id, ctx) }
-        end
-
-        def resolve_field(obj, args, ctx)
-          resolve(obj, args, ctx)
-        end
-      end
-    end
-  end
-end