graphql 1.11.7 → 1.12.4

data/lib/graphql/dataloader/null_dataloader.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Dataloader
+    # The default implementation of dataloading -- all no-ops.
+    #
+    # The Dataloader interface isn't public, but it enables
+    # simple internal code while adding the option to add Dataloader.
+    class NullDataloader < Dataloader
+      # These are all no-ops because code was
+      # executed sychronously.
+      def run; end
+      def yield; end
+
+      def append_job
+        yield
+        nil
+      end
+    end
+  end
+end

data/lib/graphql/dataloader/request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module GraphQL
+  class Dataloader
+    # @see Source#request which returns an instance of this
+    class Request
+      def initialize(source, key)
+        @source = source
+        @key = key
+      end
+
+      # Call this method to cause the current Fiber to wait for the results of this request.
+      #
+      # @return [Object] the object loaded for `key`
+      def load
+        @source.load(@key)
+      end
+    end
+  end
+end

data/lib/graphql/dataloader/request_all.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module GraphQL
+  class Dataloader
+    # @see Source#request_all which returns an instance of this.
+    class RequestAll < Request
+      def initialize(source, keys)
+        @source = source
+        @keys = keys
+      end
+
+      # Call this method to cause the current Fiber to wait for the results of this request.
+      #
+      # @return [Array<Object>] One object for each of `keys`
+      def load
+        @source.load_all(@keys)
+      end
+    end
+  end
+end

data/lib/graphql/dataloader/source.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module GraphQL
+  class Dataloader
+    class Source
+      # Called by {Dataloader} to prepare the {Source}'s internal state
+      # @api private
+      def setup(dataloader)
+        @pending_keys = []
+        @results = {}
+        @dataloader = dataloader
+      end
+
+      attr_reader :dataloader
+
+      # @return [Dataloader::Request] a pending request for a value from `key`. Call `.load` on that object to wait for the result.
+      def request(key)
+        if !@results.key?(key)
+          @pending_keys << key
+        end
+        Dataloader::Request.new(self, key)
+      end
+
+      # @return [Dataloader::Request] a pending request for a values from `keys`. Call `.load` on that object to wait for the results.
+      def request_all(keys)
+        pending_keys = keys.select { |k| !@results.key?(k) }
+        @pending_keys.concat(pending_keys)
+        Dataloader::RequestAll.new(self, keys)
+      end
+
+      # @param key [Object] A loading key which will be passed to {#fetch} if it isn't already in the internal cache.
+      # @return [Object] The result from {#fetch} for `key`. If `key` hasn't been loaded yet, the Fiber will yield until it's loaded.
+      def load(key)
+        if @results.key?(key)
+          result_for(key)
+        else
+          @pending_keys << key
+          sync
+          result_for(key)
+        end
+      end
+
+      # @param keys [Array<Object>] Loading keys which will be passed to `#fetch` (or read from the internal cache).
+      # @return [Object] The result from {#fetch} for `keys`. If `keys` haven't been loaded yet, the Fiber will yield until they're loaded.
+      def load_all(keys)
+        if keys.any? { |k| !@results.key?(k) }
+          pending_keys = keys.select { |k| !@results.key?(k) }
+          @pending_keys.concat(pending_keys)
+          sync
+        end
+
+        keys.map { |k| result_for(k) }
+      end
+
+      # Subclasses must implement this method to return a value for each of `keys`
+      # @param keys [Array<Object>] keys passed to {#load}, {#load_all}, {#request}, or {#request_all}
+      # @return [Array<Object>] A loaded value for each of `keys`. The array must match one-for-one to the list of `keys`.
+      def fetch(keys)
+        # somehow retrieve these from the backend
+        raise "Implement `#{self.class}#fetch(#{keys.inspect}) to return a record for each of the keys"
+      end
+
+      # Wait for a batch, if there's anything to batch.
+      # Then run the batch and update the cache.
+      # @return [void]
+      def sync
+        @dataloader.yield
+      end
+
+      # @return [Boolean] True if this source has any pending requests for data.
+      def pending?
+        @pending_keys.any?
+      end
+
+      # Called by {GraphQL::Dataloader} to resolve and pending requests to this source.
+      # @api private
+      # @return [void]
+      def run_pending_keys
+        return if @pending_keys.empty?
+        fetch_keys = @pending_keys.uniq
+        @pending_keys = []
+        results = fetch(fetch_keys)
+        fetch_keys.each_with_index do |key, idx|
+          @results[key] = results[idx]
+        end
+      rescue StandardError => error
+        fetch_keys.each { |key| @results[key] = error }
+      ensure
+        nil
+      end
+
+      private
+
+      # Reads and returns the result for the key from the internal cache, or raises an error if the result was an error
+      # @param key [Object] key passed to {#load} or {#load_all}
+      # @return [Object] The result from {#fetch} for `key`.
+      # @api private
+      def result_for(key)
+        result = @results[key]
+
+        raise result if result.class <= StandardError
+
+        result
+      end
+    end
+  end
+end

data/lib/graphql/define/assign_global_id_field.rb

@@ -4,7 +4,7 @@ module GraphQL
     module AssignGlobalIdField
       def self.call(type_defn, field_name, **field_kwargs)
         resolve = GraphQL::Relay::GlobalIdResolve.new(type: type_defn)
-        GraphQL::Define::AssignObjectField.call(type_defn, field_name, **field_kwargs, type: GraphQL::ID_TYPE.to_non_null_type, resolve: resolve)
+        GraphQL::Define::AssignObjectField.call(type_defn, field_name, **field_kwargs, type: GraphQL::DEPRECATED_ID_TYPE.to_non_null_type, resolve: resolve)
       end
     end
   end

data/lib/graphql/define/instance_definable.rb

@@ -3,6 +3,23 @@ module GraphQL
   module Define
     # @api deprecated
     module InstanceDefinable
+      module DeprecatedDefine
+        def define(**kwargs, &block)
+          deprecated_caller = caller(1, 1).first
+          if deprecated_caller.include?("lib/graphql")
+            deprecated_caller = caller(2, 10).find { |c| !c.include?("lib/graphql") }
+          end
+
+          if deprecated_caller
+            GraphQL::Deprecation.warn <<-ERR
+#{self}.define will be removed in GraphQL-Ruby 2.0; use a class-based definition instead. See https://graphql-ruby.org/schema/class_based_api.html.
+  -> called from #{deprecated_caller}
+ERR
+          end
+          deprecated_define(**kwargs, &block)
+        end
+      end
+
       def self.included(base)
         base.extend(ClassMethods)
         base.ensure_defined(:metadata)
@@ -14,7 +31,7 @@ module GraphQL
       end
 
       # @api deprecated
-      def define(**kwargs, &block)
+      def deprecated_define(**kwargs, &block)
         # make sure the previous definition_proc was executed:
         ensure_defined
         stash_dependent_methods
@@ -22,11 +39,16 @@ module GraphQL
         nil
       end
 
+      # @api deprecated
+      def define(**kwargs, &block)
+        deprecated_define(**kwargs, &block)
+      end
+
       # @api deprecated
       def redefine(**kwargs, &block)
         ensure_defined
         new_inst = self.dup
-        new_inst.define(**kwargs, &block)
+        new_inst.deprecated_define(**kwargs, &block)
         new_inst
       end
 
@@ -125,8 +147,16 @@ module GraphQL
       module ClassMethods
         # Create a new instance
         # and prepare a definition using its {.definitions}.
+        # @api deprecated
         # @param kwargs [Hash] Key-value pairs corresponding to defininitions from `accepts_definitions`
         # @param block [Proc] Block which calls helper methods from `accepts_definitions`
+        def deprecated_define(**kwargs, &block)
+          instance = self.new
+          instance.deprecated_define(**kwargs, &block)
+          instance
+        end
+
+        # @api deprecated
         def define(**kwargs, &block)
           instance = self.new
           instance.define(**kwargs, &block)

data/lib/graphql/define/type_definer.rb

@@ -7,11 +7,11 @@ module GraphQL
     class TypeDefiner
       include Singleton
       # rubocop:disable Naming/MethodName
-      def Int;      GraphQL::INT_TYPE;      end
-      def String;   GraphQL::STRING_TYPE;   end
-      def Float;    GraphQL::FLOAT_TYPE;    end
-      def Boolean;  GraphQL::BOOLEAN_TYPE;  end
-      def ID;       GraphQL::ID_TYPE;       end
+      def Int;      GraphQL::DEPRECATED_INT_TYPE;      end
+      def String;   GraphQL::DEPRECATED_STRING_TYPE;   end
+      def Float;    GraphQL::DEPRECATED_FLOAT_TYPE;    end
+      def Boolean;  GraphQL::DEPRECATED_BOOLEAN_TYPE;  end
+      def ID;       GraphQL::DEPRECATED_ID_TYPE;       end
       # rubocop:enable Naming/MethodName
 
       # Make a {ListType} which wraps the input type

data/lib/graphql/deprecated_dsl.rb

@@ -4,13 +4,13 @@ module GraphQL
   #
   # 1. Scoped by file (CRuby only), add to the top of the file:
   #
-  #      using GraphQL::DeprecatedDSL
+  #      using GraphQL::DeprecationDSL
   #
   #   (This is a "refinement", there are also other ways to scope it.)
   #
   # 2. Global application, add before schema definition:
   #
-  #      GraphQL::DeprecatedDSL.activate
+  #      GraphQL::DeprecationDSL.activate
   #
   module DeprecatedDSL
     TYPE_CLASSES = [
@@ -23,12 +23,17 @@ module GraphQL
     ]
 
     def self.activate
+      deprecated_caller = caller(1, 1).first
+      GraphQL::Deprecation.warn "DeprecatedDSL will be removed from GraphQL-Ruby 2.0, use `.to_non_null_type` instead of `!` and remove `.activate` from #{deprecated_caller}"
       TYPE_CLASSES.each { |c| c.extend(Methods) }
       GraphQL::Schema::List.include(Methods)
       GraphQL::Schema::NonNull.include(Methods)
     end
+
     module Methods
       def !
+        deprecated_caller = caller(1, 1).first
+        GraphQL::Deprecation.warn "DeprecatedDSL will be removed from GraphQL-Ruby 2.0, use `.to_non_null_type` instead of `!` at #{deprecated_caller}"
         to_non_null_type
       end
     end

data/lib/graphql/deprecation.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Deprecation
+    def self.warn(message)
+      if defined?(ActiveSupport::Deprecation)
+        ActiveSupport::Deprecation.warn(message)
+      else
+        Kernel.warn(message)
+      end
+    end
+  end
+end

data/lib/graphql/enum_type.rb

@@ -2,6 +2,8 @@
 module GraphQL
   # @api deprecated
   class EnumType < GraphQL::BaseType
+    extend Define::InstanceDefinable::DeprecatedDefine
+
     accepts_definitions :values, value: GraphQL::Define::AssignEnumValue
     ensure_defined(:values, :validate_non_null_input, :coerce_non_null_input, :coerce_result)
     attr_accessor :ast_node

data/lib/graphql/execution/errors.rb

@@ -18,6 +18,10 @@ module GraphQL
     #
     class Errors
       def self.use(schema)
+        if schema.plugins.any? { |(plugin, kwargs)| plugin == self }
+          definition_line = caller(2, 1).first
+          GraphQL::Deprecation.warn("GraphQL::Execution::Errors is now installed by default, remove `use GraphQL::Execution::Errors` from #{definition_line}")
+        end
         schema.error_handler = self.new(schema)
       end
 

data/lib/graphql/execution/execute.rb

@@ -18,7 +18,14 @@ module GraphQL
       # @api private
       PROPAGATE_NULL = PropagateNull.new
 
+      def self.use(schema_class)
+        schema_class.query_execution_strategy(self)
+        schema_class.mutation_execution_strategy(self)
+        schema_class.subscription_execution_strategy(self)
+      end
+
       def execute(ast_operation, root_type, query)
+        GraphQL::Deprecation.warn "#{self.class} will be removed in GraphQL-Ruby 2.0, please upgrade to the Interpreter: https://graphql-ruby.org/queries/interpreter.html"
         result = resolve_root_selection(query)
         lazy_resolve_root_selection(result, **{query: query})
         GraphQL::Execution::Flatten.call(query.context)

data/lib/graphql/execution/interpreter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require "fiber"
 require "graphql/execution/interpreter/argument_value"
 require "graphql/execution/interpreter/arguments"
 require "graphql/execution/interpreter/arguments_cache"
@@ -22,12 +23,15 @@ module GraphQL
       end
 
       def self.use(schema_class)
-        schema_class.interpreter = true
-        schema_class.query_execution_strategy(GraphQL::Execution::Interpreter)
-        schema_class.mutation_execution_strategy(GraphQL::Execution::Interpreter)
-        schema_class.subscription_execution_strategy(GraphQL::Execution::Interpreter)
-        schema_class.add_subscription_extension_if_necessary
-        GraphQL::Schema::Object.include(HandlesRawValue)
+        if schema_class.interpreter?
+          definition_line = caller(2, 1).first
+          GraphQL::Deprecation.warn("GraphQL::Execution::Interpreter is now the default; remove `use GraphQL::Execution::Interpreter` from the schema definition (#{definition_line})")
+        else
+          schema_class.query_execution_strategy(self)
+          schema_class.mutation_execution_strategy(self)
+          schema_class.subscription_execution_strategy(self)
+          schema_class.add_subscription_extension_if_necessary
+        end
       end
 
       def self.begin_multiplex(multiplex)
@@ -91,7 +95,7 @@ module GraphQL
         end
         final_values.compact!
         tracer.trace("execute_query_lazy", {multiplex: multiplex, query: query}) do
-          Interpreter::Resolve.resolve_all(final_values)
+          Interpreter::Resolve.resolve_all(final_values, multiplex.dataloader)
         end
         queries.each do |query|
           runtime = query.context.namespace(:interpreter)[:runtime]

data/lib/graphql/execution/interpreter/arguments.rb

@@ -5,6 +5,9 @@ module GraphQL
     class Interpreter
       # A wrapper for argument hashes in GraphQL queries.
       #
+      # This object is immutable so that the runtime code can be sure that
+      # modifications don't leak from one use to another
+      #
       # @see GraphQL::Query#arguments_for to get access to these objects.
       class Arguments
         extend Forwardable
@@ -14,26 +17,43 @@ module GraphQL
         # This hash is the one used at runtime.
         #
         # @return [Hash<Symbol, Object>]
-        def keyword_arguments
-          @keyword_arguments ||= begin
-            kwargs = {}
-            argument_values.each do |name, arg_val|
-              kwargs[name] = arg_val.value
-            end
-            kwargs
-          end
-        end
+        attr_reader :keyword_arguments
 
         # @param argument_values [nil, Hash{Symbol => ArgumentValue}]
-        def initialize(argument_values:)
-          @argument_values = argument_values
+        # @param keyword_arguments [nil, Hash{Symbol => Object}]
+        def initialize(keyword_arguments: nil, argument_values:)
           @empty = argument_values.nil? || argument_values.empty?
+          # This is only present when `extras` have been merged in:
+          if keyword_arguments
+            # This is a little crazy. We expect the `:argument_details` extra to _include extras_,
+            # but the object isn't created until _after_ extras are put together.
+            # So, we have to use a special flag here to say, "at the last minute, add yourself to the keyword args."
+            #
+            # Otherwise:
+            # - We can't access the final Arguments instance _while_ we're preparing extras
+            # - After we _can_ access it, it's frozen, so we can't add anything.
+            #
+            # So, this flag gives us a chance to sneak it in before freezing, _and_ while we have access
+            # to the new Arguments instance itself.
+            if keyword_arguments[:argument_details] == :__arguments_add_self
+              keyword_arguments[:argument_details] = self
+            end
+            @keyword_arguments = keyword_arguments.freeze
+          elsif !@empty
+            @keyword_arguments = {}
+            argument_values.each do |name, arg_val|
+              @keyword_arguments[name] = arg_val.value
+            end
+            @keyword_arguments.freeze
+          else
+            @keyword_arguments = NO_ARGS
+          end
+          @argument_values = argument_values ? argument_values.freeze : NO_ARGS
+          freeze
         end
 
         # @return [Hash{Symbol => ArgumentValue}]
-        def argument_values
-          @argument_values ||= {}
-        end
+        attr_reader :argument_values
 
         def empty?
           @empty
@@ -45,6 +65,23 @@ module GraphQL
         def inspect
           "#<#{self.class} @keyword_arguments=#{keyword_arguments.inspect}>"
         end
+
+        # Create a new arguments instance which includes these extras.
+        #
+        # This is called by the runtime to implement field `extras: [...]`
+        #
+        # @param extra_args [Hash<Symbol => Object>]
+        # @return [Interpreter::Arguments]
+        # @api private
+        def merge_extras(extra_args)
+          self.class.new(
+            argument_values: argument_values,
+            keyword_arguments: keyword_arguments.merge(extra_args)
+          )
+        end
+
+        NO_ARGS = {}.freeze
+        EMPTY = self.new(argument_values: nil, keyword_arguments: NO_ARGS).freeze
       end
     end
   end