graphql 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0019d58e7660531d537f4318a9f77df48ee6c501
-  data.tar.gz: b1b229e62437f03ce0f5003a92c2546b733121ad
+  metadata.gz: 54eddb1e7e7ebdbe1ada0ab8286bda07a4141ebc
+  data.tar.gz: d9cc5078d078b0d9d8eded46a17ae224d33b738c
 SHA512:
-  metadata.gz: 7d9f28b11005ac84e02b4528cd6c75ace38368c7bed476bc08a7c8b5b88e6a2643a2e5a3779da11babcf983aacc30bcc4bf6a69e53da83cc8e0b4ecac042a5f9
-  data.tar.gz: 22249283811a82bda630d4d5f24149cfbdea7ad2a7aa9a4583810a318f054093c077b87d6f84550c129e3d431f3a504fa0b97ad109c65b1b89dd0f6e7716e256
+  metadata.gz: f918ba8ec64d8e3157d454ef76002b4087644fcb1f92a50821f5fd189f40806b4daec24d27049c022a59c27dc9a698742ad099546ce53b20645a7e0f6ebd8c28
+  data.tar.gz: 21140eaea9b18fd8405cb195f67d8f380d08dbf7d537e191c4672bd65240b1f589074927e0a62951f6506eaf0762efcd351e35b0e7951c4012b3552d70b747e0

data/lib/graphql/base_type.rb

@@ -4,12 +4,22 @@ module GraphQL
   class BaseType
     include GraphQL::Define::NonNullWithBang
     include GraphQL::Define::InstanceDefinable
-    accepts_definitions :name, :description, {
-        connection: GraphQL::Define::AssignConnection,
-        global_id_field: GraphQL::Define::AssignGlobalIdField,
-      }
+    accepts_definitions :name, :description,
+        :introspection,
+        :default_scalar,
+        :default_relay,
+        {
+          connection: GraphQL::Define::AssignConnection,
+          global_id_field: GraphQL::Define::AssignGlobalIdField,
+        }
 
-    ensure_defined(:name, :description)
+    ensure_defined(:name, :description, :introspection?, :default_scalar?)
+
+    def initialize
+      @introspection = false
+      @default_scalar = false
+      @default_relay = false
+    end
 
     def initialize_copy(other)
       super
@@ -24,6 +34,24 @@ module GraphQL
     # @return [String, nil] a description for this type
     attr_accessor :description
 
+    # @return [Boolean] Is this type a predefined introspection type?
+    def introspection?
+      @introspection
+    end
+
+    # @return [Boolean] Is this type a built-in scalar type? (eg, `String`, `Int`)
+    def default_scalar?
+      @default_scalar
+    end
+
+    # @return [Boolean] Is this type a built-in Relay type? (`Node`, `PageInfo`)
+    def default_relay?
+      @default_relay
+    end
+
+    # @api private
+    attr_writer :introspection, :default_scalar, :default_relay
+
     # @param other [GraphQL::BaseType] compare to this object
     # @return [Boolean] are these types equivalent? (incl. non-null, list)
     def ==(other)

data/lib/graphql/boolean_type.rb

@@ -5,4 +5,5 @@ GraphQL::BOOLEAN_TYPE = GraphQL::ScalarType.define do
 
   coerce_input ->(value) { (value == true || value == false) ? value : nil }
   coerce_result ->(value) { !!value }
+  default_scalar true
 end

data/lib/graphql/compatibility/execution_specification.rb

@@ -198,7 +198,7 @@ module GraphQL
           end
 
           def test_it_applies_masking
-            no_org = ->(member) { member.name == "Organization" }
+            no_org = ->(member, ctx) { member.name == "Organization" }
             query_string = %|
             {
               node(id: "2001") {

data/lib/graphql/compatibility/execution_specification/specification_schema.rb

@@ -49,6 +49,7 @@ module GraphQL
         end
 
         module TestMiddleware
+          # TODO: Once deprecated `next_middleware` argument becomes unsupported, add `&` to the argument
           def self.call(parent_type, parent_object, field_definition, field_args, query_context, next_middleware)
             query_context[:middleware_log] && query_context[:middleware_log] << field_definition.name
             next_middleware.call

data/lib/graphql/directive.rb

@@ -8,10 +8,12 @@ module GraphQL
   #
   class Directive
     include GraphQL::Define::InstanceDefinable
-    accepts_definitions :locations, :name, :description, :arguments, argument: GraphQL::Define::AssignArgument
+    accepts_definitions :locations, :name, :description, :arguments, :default_directive, argument: GraphQL::Define::AssignArgument
 
     attr_accessor :locations, :arguments, :name, :description
-    ensure_defined(:locations, :arguments, :name, :description)
+    # @api private
+    attr_writer :default_directive
+    ensure_defined(:locations, :arguments, :name, :description, :default_directive?)
 
     LOCATIONS = [
       QUERY =                  :QUERY,
@@ -58,6 +60,7 @@ module GraphQL
 
     def initialize
       @arguments = {}
+      @default_directive = false
     end
 
     def to_s
@@ -75,6 +78,11 @@ module GraphQL
     def on_operation?
       locations.include?(QUERY) && locations.include?(MUTATION) && locations.include?(SUBSCRIPTION)
     end
+
+    # @return [Boolean] Is this directive supplied by default? (eg `@skip`)
+    def default_directive?
+      @default_directive
+    end
   end
 end
 

data/lib/graphql/directive/deprecated_directive.rb

@@ -9,4 +9,5 @@ GraphQL::Directive::DeprecatedDirective = GraphQL::Directive.define do
     "in [Markdown](https://daringfireball.net/projects/markdown/)."
 
   argument :reason, GraphQL::STRING_TYPE, reason_description, default_value: GraphQL::Directive::DEFAULT_DEPRECATION_REASON
+  default_directive true
 end

data/lib/graphql/directive/include_directive.rb

@@ -4,4 +4,5 @@ GraphQL::Directive::IncludeDirective = GraphQL::Directive.define do
   description "Directs the executor to include this field or fragment only when the `if` argument is true."
   locations([GraphQL::Directive::FIELD, GraphQL::Directive::FRAGMENT_SPREAD, GraphQL::Directive::INLINE_FRAGMENT])
   argument :if, !GraphQL::BOOLEAN_TYPE, 'Included when true.'
+  default_directive true
 end

data/lib/graphql/directive/skip_directive.rb

@@ -5,4 +5,5 @@ GraphQL::Directive::SkipDirective = GraphQL::Directive.define do
   locations([GraphQL::Directive::FIELD, GraphQL::Directive::FRAGMENT_SPREAD, GraphQL::Directive::INLINE_FRAGMENT])
 
   argument :if, !GraphQL::BOOLEAN_TYPE, 'Skipped when true.'
+  default_directive true
 end

data/lib/graphql/enum_type.rb

@@ -76,6 +76,7 @@ module GraphQL
     ensure_defined(:values, :validate_non_null_input, :coerce_non_null_input, :coerce_result)
 
     def initialize
+      super
       @values_by_name = {}
     end
 

data/lib/graphql/execution/execute.rb

@@ -57,20 +57,8 @@ module GraphQL
         )
 
         arguments = query.arguments_for(selection.irep_node, field)
-        middlewares = query.schema.middleware
-        resolve_arguments = [parent_type, object, field, arguments, field_ctx]
-
         raw_value = begin
-          # only run a middleware chain if there are any middleware
-          if middlewares.any?
-            chain = GraphQL::Schema::MiddlewareChain.new(
-              steps: middlewares + [FieldResolveStep],
-              arguments: resolve_arguments
-            )
-            chain.call
-          else
-            FieldResolveStep.call(*resolve_arguments)
-          end
+          query_ctx.schema.middleware.invoke([parent_type, object, field, arguments, field_ctx])
         rescue GraphQL::ExecutionError => err
           err
         end

data/lib/graphql/float_type.rb

@@ -5,4 +5,5 @@ GraphQL::FLOAT_TYPE = GraphQL::ScalarType.define do
 
   coerce_input ->(value) { value.is_a?(Numeric) ? value.to_f : nil }
   coerce_result ->(value) { value.to_f }
+  default_scalar true
 end

data/lib/graphql/id_type.rb

@@ -12,4 +12,5 @@ GraphQL::ID_TYPE = GraphQL::ScalarType.define do
       nil
     end
   }
+  default_scalar true
 end

data/lib/graphql/input_object_type.rb

@@ -42,6 +42,7 @@ module GraphQL
 
 
     def initialize
+      super
       @arguments = {}
     end
 
@@ -57,7 +58,16 @@ module GraphQL
     def validate_non_null_input(input, warden)
       result = GraphQL::Query::InputValidationResult.new
 
-      visible_arguments_map = warden.input_fields(self).reduce({}) { |m, f| m[f.name] = f; m}
+      if (input.to_h rescue nil).nil?
+        result.add_problem(
+          "Expected #{JSON.generate(input, quirks_mode: true)} to be a key, value object " \
+          " responding to `to_h`."
+        )
+        return result
+      end
+
+
+      visible_arguments_map = warden.arguments(self).reduce({}) { |m, f| m[f.name] = f; m}
 
       # Items in the input that are unexpected
       input.each do |name, value|
@@ -67,7 +77,7 @@ module GraphQL
       end
 
       # Items in the input that are expected, but have invalid values
-      invalid_fields = visible_arguments_map.map do |name, field|
+      visible_arguments_map.map do |name, field|
         field_result = field.type.validate_input(input[name], warden)
         if !field_result.valid?
           result.merge_result!(name, field_result)

data/lib/graphql/int_type.rb

@@ -5,4 +5,5 @@ GraphQL::INT_TYPE = GraphQL::ScalarType.define do
 
   coerce_input ->(value) { value.is_a?(Numeric) ? value.to_i : nil }
   coerce_result ->(value) { value.to_i }
+  default_scalar true
 end

data/lib/graphql/interface_type.rb

@@ -29,6 +29,7 @@ module GraphQL
     ensure_defined :fields
 
     def initialize
+      super
       @fields = {}
     end
 

data/lib/graphql/introspection/directive_location_enum.rb

@@ -7,4 +7,5 @@ GraphQL::Introspection::DirectiveLocationEnum = GraphQL::EnumType.define do
   GraphQL::Directive::LOCATIONS.each do |location|
     value(location.to_s, GraphQL::Directive::LOCATION_DESCRIPTIONS[location], value: location)
   end
+  introspection true
 end

data/lib/graphql/introspection/directive_type.rb

@@ -14,4 +14,5 @@ GraphQL::Introspection::DirectiveType = GraphQL::ObjectType.define do
   field :onOperation, !types.Boolean, deprecation_reason: "Use `locations`.", property: :on_operation?
   field :onFragment, !types.Boolean, deprecation_reason: "Use `locations`.", property: :on_fragment?
   field :onField, !types.Boolean, deprecation_reason: "Use `locations`.", property: :on_field?
+  introspection true
 end

data/lib/graphql/introspection/enum_value_type.rb

@@ -10,4 +10,5 @@ GraphQL::Introspection::EnumValueType = GraphQL::ObjectType.define do
     resolve ->(obj, a, c) { !!obj.deprecation_reason }
   end
   field :deprecationReason, types.String, property: :deprecation_reason
+  introspection true
 end

data/lib/graphql/introspection/field_type.rb

@@ -11,4 +11,5 @@ GraphQL::Introspection::FieldType = GraphQL::ObjectType.define do
     resolve ->(obj, a, c) { !!obj.deprecation_reason }
   end
   field :deprecationReason, types.String, property: :deprecation_reason
+  introspection true
 end

data/lib/graphql/introspection/input_fields_field.rb

@@ -4,7 +4,7 @@ GraphQL::Introspection::InputFieldsField = GraphQL::Field.define do
   type types[!GraphQL::Introspection::InputValueType]
   resolve ->(target, a, ctx) {
     if target.kind.input_object?
-      ctx.warden.input_fields(target)
+      ctx.warden.arguments(target)
     else
       nil
     end

data/lib/graphql/introspection/input_value_type.rb

@@ -17,4 +17,5 @@ GraphQL::Introspection::InputValueType = GraphQL::ObjectType.define do
       end
     }
   end
+  introspection true
 end

data/lib/graphql/introspection/schema_type.rb

@@ -24,4 +24,6 @@ GraphQL::Introspection::SchemaType = GraphQL::ObjectType.define do
   field :directives, !types[!GraphQL::Introspection::DirectiveType], "A list of all directives supported by this server." do
     resolve ->(obj, arg, ctx) { obj.directives.values }
   end
+
+  introspection true
 end

data/lib/graphql/introspection/type_kind_enum.rb

@@ -5,4 +5,5 @@ GraphQL::Introspection::TypeKindEnum = GraphQL::EnumType.define do
   GraphQL::TypeKinds::TYPE_KINDS.each do |type_kind|
     value(type_kind.name, type_kind.description)
   end
+  introspection true
 end

data/lib/graphql/introspection/type_type.rb

@@ -22,4 +22,5 @@ GraphQL::Introspection::TypeType = GraphQL::ObjectType.define do
   field :enumValues,    GraphQL::Introspection::EnumValuesField
   field :inputFields,   GraphQL::Introspection::InputFieldsField
   field :ofType,        GraphQL::Introspection::OfTypeField
+  introspection true
 end

data/lib/graphql/list_type.rb

@@ -28,6 +28,7 @@ module GraphQL
     include GraphQL::BaseType::ModifiesAnotherType
     attr_reader :of_type
     def initialize(of_type:)
+      super()
       @of_type = of_type
     end
 

data/lib/graphql/non_null_type.rb

@@ -33,6 +33,7 @@ module GraphQL
 
     attr_reader :of_type
     def initialize(of_type:)
+      super()
       @of_type = of_type
     end
 

data/lib/graphql/object_type.rb

@@ -35,6 +35,7 @@ module GraphQL
 
 
     def initialize
+      super
       @fields = {}
       @dirty_interfaces = []
     end

data/lib/graphql/query.rb

@@ -18,14 +18,6 @@ module GraphQL
       end
     end
 
-    module NullExcept
-      module_function
-
-      def call(member)
-        false
-      end
-    end
-
     attr_reader :schema, :document, :context, :fragments, :operations, :root_value, :max_depth, :query_string, :warden, :provided_variables
 
     # Prepare query `query_string` on `schema`
@@ -38,11 +30,19 @@ module GraphQL
     # @param max_depth [Numeric] the maximum number of nested selections allowed for this query (falls back to schema-level value)
     # @param max_complexity [Numeric] the maximum field complexity for this query (falls back to schema-level value)
     # @param except [<#call(schema_member)>] If provided, objects will be hidden from the schema when `.call(schema_member)` returns truthy
-    def initialize(schema, query_string = nil, document: nil, context: nil, variables: {}, validate: true, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil, except: NullExcept)
+    def initialize(schema, query_string = nil, document: nil, context: nil, variables: {}, validate: true, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil, except: nil, only: nil)
       fail ArgumentError, "a query string or document is required" unless query_string || document
 
       @schema = schema
-      @warden = GraphQL::Schema::Warden.new(schema, except)
+      mask = if except
+        wrap_if_legacy_mask(except)
+      elsif only
+        InvertedMask.new(wrap_if_legacy_mask(only))
+      else
+        schema.default_mask
+      end
+      @context = Context.new(query: self, values: context)
+      @warden = GraphQL::Schema::Warden.new(mask, schema: @schema, context: @context)
       @max_depth = max_depth || schema.max_depth
       @max_complexity = max_complexity || schema.max_complexity
       @query_analyzers = schema.query_analyzers.dup
@@ -52,7 +52,6 @@ module GraphQL
       if @max_complexity
         @query_analyzers << GraphQL::Analysis::MaxQueryComplexity.new(@max_complexity)
       end
-      @context = Context.new(query: self, values: context)
       @root_value = root_value
       @operation_name = operation_name
       @fragments = {}
@@ -74,6 +73,8 @@ module GraphQL
         end
       end
 
+      @resolved_types_cache = Hash.new { |h, k| h[k] = @schema.resolve_type(k, @context) }
+
       @arguments_cache = Hash.new { |h, k| h[k] = {} }
       @validation_errors = []
       @analysis_errors = []
@@ -214,8 +215,11 @@ module GraphQL
       @warden.possible_types(type)
     end
 
-    def resolve_type(type)
-      @schema.resolve_type(type, @context)
+    # @param value [Object] Any runtime value
+    # @return [GraphQL::ObjectType, nil] The runtime type of `value` from {Schema#resolve_type}
+    # @see {#possible_types} to apply filtering from `only` / `except`
+    def resolve_type(value)
+      @resolved_types_cache[value]
     end
 
     def mutation?
@@ -257,5 +261,38 @@ module GraphQL
         operations[operation_name]
       end
     end
+
+    def wrap_if_legacy_mask(mask)
+      if (mask.is_a?(Proc) && mask.arity == 1) || mask.method(:call).arity == 1
+        warn("Schema.execute(..., except:) filters now accept two arguments, `(member, ctx)`. One-argument filters are deprecated.")
+        LegacyMaskWrap.new(mask)
+      else
+        mask
+      end
+    end
+
+    # @api private
+    class InvertedMask
+      def initialize(inner_mask)
+        @inner_mask = inner_mask
+      end
+
+      # Returns true when the inner mask returned false
+      # Returns false when the inner mask returned true
+      def call(member, ctx)
+        !@inner_mask.call(member, ctx)
+      end
+    end
+
+    # @api private
+    class LegacyMaskWrap
+      def initialize(inner_mask)
+        @inner_mask = inner_mask
+      end
+
+      def call(member, ctx)
+        @inner_mask.call(member)
+      end
+    end
   end
 end

data/lib/graphql/query/context.rb

@@ -32,9 +32,6 @@ module GraphQL
       # @return [GraphQL::Schema]
       attr_reader :schema
 
-      # @return [GraphQL::Schema::Mask::Warden]
-      attr_reader :warden
-
       # @return [Array<String, Integer>] The current position in the result
       attr_reader :path
 
@@ -46,7 +43,6 @@ module GraphQL
         @schema = query.schema
         @values = values || {}
         @errors = []
-        @warden = query.warden
         @path = []
       end
 
@@ -55,6 +51,11 @@ module GraphQL
         @values[key]
       end
 
+      # @return [GraphQL::Schema::Warden]
+      def warden
+        @warden ||= @query.warden
+      end
+
       # Reassign `key` to the hash passed to {Schema#execute} as `context:`
       def []=(key, value)
         @values[key] = value