graphql 1.12.12 → 2.4.8

data/lib/graphql/analysis.rb

@@ -1,9 +1,93 @@
 # frozen_string_literal: true
-require "graphql/analysis/ast"
-require "graphql/analysis/max_query_complexity"
-require "graphql/analysis/max_query_depth"
+require "graphql/analysis/visitor"
+require "graphql/analysis/analyzer"
+require "graphql/analysis/field_usage"
 require "graphql/analysis/query_complexity"
+require "graphql/analysis/max_query_complexity"
 require "graphql/analysis/query_depth"
-require "graphql/analysis/reducer_state"
-require "graphql/analysis/analyze_query"
-require "graphql/analysis/field_usage"
+require "graphql/analysis/max_query_depth"
+require "timeout"
+
+module GraphQL
+  module Analysis
+    AST = self
+    module_function
+    # Analyze a multiplex, and all queries within.
+    # Multiplex analyzers are ran for all queries, keeping state.
+    # Query analyzers are ran per query, without carrying state between queries.
+    #
+    # @param multiplex [GraphQL::Execution::Multiplex]
+    # @param analyzers [Array<GraphQL::Analysis::Analyzer>]
+    # @return [Array<Any>] Results from multiplex analyzers
+    def analyze_multiplex(multiplex, analyzers)
+      multiplex_analyzers = analyzers.map { |analyzer| analyzer.new(multiplex) }
+
+      multiplex.current_trace.analyze_multiplex(multiplex: multiplex) do
+        query_results = multiplex.queries.map do |query|
+          if query.valid?
+            analyze_query(
+              query,
+              query.analyzers,
+              multiplex_analyzers: multiplex_analyzers
+            )
+          else
+            []
+          end
+        end
+
+        multiplex_results = multiplex_analyzers.map(&:result)
+        multiplex_errors = analysis_errors(multiplex_results)
+
+        multiplex.queries.each_with_index do |query, idx|
+          query.analysis_errors = multiplex_errors + analysis_errors(query_results[idx])
+        end
+        multiplex_results
+      end
+    end
+
+    # @param query [GraphQL::Query]
+    # @param analyzers [Array<GraphQL::Analysis::Analyzer>]
+    # @return [Array<Any>] Results from those analyzers
+    def analyze_query(query, analyzers, multiplex_analyzers: [])
+      query.current_trace.analyze_query(query: query) do
+        query_analyzers = analyzers
+          .map { |analyzer| analyzer.new(query) }
+          .tap { _1.select!(&:analyze?) }
+
+        analyzers_to_run = query_analyzers + multiplex_analyzers
+        if !analyzers_to_run.empty?
+
+          analyzers_to_run.select!(&:visit?)
+          if !analyzers_to_run.empty?
+            visitor = GraphQL::Analysis::Visitor.new(
+              query: query,
+              analyzers: analyzers_to_run
+            )
+
+            # `nil` or `0` causes no timeout
+            Timeout::timeout(query.validate_timeout_remaining) do
+              visitor.visit
+            end
+
+            if !visitor.rescued_errors.empty?
+              return visitor.rescued_errors
+            end
+          end
+
+          query_analyzers.map(&:result)
+        else
+          []
+        end
+      end
+    rescue Timeout::Error
+      [GraphQL::AnalysisError.new("Timeout on validation of query")]
+    rescue GraphQL::UnauthorizedError, GraphQL::ExecutionError
+      # This error was raised during analysis and will be returned the client before execution
+      []
+    end
+
+    def analysis_errors(results)
+      results.flatten.tap { _1.select! { |r| r.is_a?(GraphQL::AnalysisError) } }
+    end
+  end
+end

data/lib/graphql/autoload.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module GraphQL
+  # @see GraphQL::Railtie for automatic Rails integration
+  module Autoload
+    # Register a constant named `const_name` to be loaded from `path`.
+    # This is like `Kernel#autoload` but it tracks the constants so they can be eager-loaded with {#eager_load!}
+    # @param const_name [Symbol]
+    # @param path [String]
+    # @return [void]
+    def autoload(const_name, path)
+      @_eagerloaded_constants ||= []
+      @_eagerloaded_constants << const_name
+
+      super const_name, path
+    end
+
+    # Call this to load this constant's `autoload` dependents and continue calling recursively
+    # @return [void]
+    def eager_load!
+      @_eager_loading = true
+      if @_eagerloaded_constants
+        @_eagerloaded_constants.each { |const_name| const_get(const_name) }
+        @_eagerloaded_constants = nil
+      end
+      nil
+    ensure
+      @_eager_loading = false
+    end
+
+    private
+
+    # @return [Boolean] `true` if GraphQL-Ruby is currently eager-loading its constants
+    def eager_loading?
+      @_eager_loading ||= false
+    end
+  end
+end

data/lib/graphql/backtrace/inspect_result.rb

@@ -16,12 +16,6 @@ module GraphQL
           "[" +
             obj.map { |v| inspect_truncated(v) }.join(", ") +
             "]"
-        when Query::Context::SharedMethods
-          if obj.invalid_null?
-            "nil"
-          else
-            inspect_truncated(obj.value)
-          end
         else
           inspect_truncated(obj)
         end
@@ -33,12 +27,6 @@ module GraphQL
           "{...}"
         when Array
           "[...]"
-        when Query::Context::SharedMethods
-          if obj.invalid_null?
-            "nil"
-          else
-            inspect_truncated(obj.value)
-          end
         when GraphQL::Execution::Lazy
           "(unresolved)"
         else

data/lib/graphql/backtrace/table.rb

@@ -83,13 +83,13 @@ module GraphQL
           value = if top && @override_value
             @override_value
           else
-            value_at(@context.query.context.namespace(:interpreter)[:runtime], context_entry.path)
+            value_at(@context.query.context.namespace(:interpreter_runtime)[:runtime], context_entry.path)
           end
           rows << [
             "#{context_entry.ast_node ? context_entry.ast_node.position.join(":") : ""}",
             "#{context_entry.field.path}#{field_alias ? " as #{field_alias}" : ""}",
             "#{context_entry.object.object.inspect}",
-            context_entry.arguments.to_h.inspect,
+            context_entry.arguments.to_h.inspect, # rubocop:disable Development/ContextIsPassedCop -- unrelated method
             Backtrace::InspectResult.inspect_result(value),
           ]
           if (parent = context_entry.parent_frame)
@@ -97,24 +97,6 @@ module GraphQL
           else
             rows
           end
-        when GraphQL::Query::Context::FieldResolutionContext
-          ctx = context_entry
-          field_name = "#{ctx.irep_node.owner_type.name}.#{ctx.field.name}"
-          position = "#{ctx.ast_node.line}:#{ctx.ast_node.col}"
-          field_alias = ctx.ast_node.alias
-          object = ctx.object
-          if object.is_a?(GraphQL::Schema::Object)
-            object = object.object
-          end
-          rows << [
-            "#{position}",
-            "#{field_name}#{field_alias ? " as #{field_alias}" : ""}",
-            "#{object.inspect}",
-            ctx.irep_node.arguments.to_h.inspect,
-            Backtrace::InspectResult.inspect_result(top && @override_value ? @override_value : ctx.value),
-          ]
-
-          build_rows(ctx.parent, rows: rows)
         when GraphQL::Query::Context
           query = context_entry.query
           op = query.selected_operation
@@ -130,7 +112,7 @@ module GraphQL
           if object.is_a?(GraphQL::Schema::Object)
             object = object.object
           end
-          value = value_at(context_entry.namespace(:interpreter)[:runtime], [])
+          value = value_at(context_entry.namespace(:interpreter_runtime)[:runtime], [])
           rows << [
             "#{position}",
             "#{op_type}#{op_name ? " #{op_name}" : ""}",
@@ -144,7 +126,7 @@ module GraphQL
       end
 
       def value_at(runtime, path)
-        response = runtime.response
+        response = runtime.final_result
         path.each do |key|
           if response && (response = response[key])
             next

data/lib/graphql/backtrace/trace.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+module GraphQL
+  class Backtrace
+    module Trace
+      def initialize(*args, **kwargs, &block)
+        @__backtrace_contexts = {}
+        @__backtrace_last_context = nil
+        super
+      end
+
+      def validate(query:, validate:)
+        if query.multiplex
+          push_query_backtrace_context(query)
+        end
+        super
+      end
+
+      def analyze_query(query:)
+        if query.multiplex # missing for stand-alone static validation
+          push_query_backtrace_context(query)
+        end
+        super
+      end
+
+      def execute_query(query:)
+        push_query_backtrace_context(query)
+        super
+      end
+
+      def execute_query_lazy(query:, multiplex:)
+        query ||= multiplex.queries.first
+        push_query_backtrace_context(query)
+        super
+      end
+
+      def execute_field(field:, query:, ast_node:, arguments:, object:)
+        push_field_backtrace_context(field, query, ast_node, arguments, object)
+        super
+      end
+
+      def execute_field_lazy(field:, query:, ast_node:, arguments:, object:)
+        push_field_backtrace_context(field, query, ast_node, arguments, object)
+        super
+      end
+
+      def execute_multiplex(multiplex:)
+        super
+      rescue StandardError => err
+        # This is an unhandled error from execution,
+        # Re-raise it with a GraphQL trace.
+        potential_context = @__backtrace_last_context
+        if potential_context.is_a?(GraphQL::Query::Context) ||
+            potential_context.is_a?(Backtrace::Frame)
+          raise TracedError.new(err, potential_context)
+        else
+          raise
+        end
+      end
+
+      private
+
+      def push_query_backtrace_context(query)
+        push_data = query
+        push_key = []
+        @__backtrace_contexts[push_key] = push_data
+        @__backtrace_last_context = push_data
+      end
+
+      def push_field_backtrace_context(field, query, ast_node, arguments, object)
+        push_key = query.context[:current_path]
+        push_storage = @__backtrace_contexts
+        parent_frame = push_storage[push_key[0..-2]]
+
+        if parent_frame.is_a?(GraphQL::Query)
+          parent_frame = parent_frame.context
+        end
+
+        push_data = Frame.new(
+          query: query,
+          path: push_key,
+          ast_node: ast_node,
+          field: field,
+          object: object,
+          arguments: arguments,
+          parent_frame: parent_frame,
+        )
+        push_storage[push_key] = push_data
+        @__backtrace_last_context = push_data
+      end
+
+    end
+  end
+end

data/lib/graphql/backtrace/tracer.rb

@@ -15,14 +15,17 @@ module GraphQL
           # No query context yet
           nil
         when "validate", "analyze_query", "execute_query", "execute_query_lazy"
-          query = metadata[:query] || metadata[:queries].first
           push_key = []
-          push_data = query
-          multiplex = query.multiplex
+          if (query = metadata[:query]) || ((queries = metadata[:queries]) && (query = queries.first))
+            push_data = query
+            multiplex = query.multiplex
+          elsif (multiplex = metadata[:multiplex])
+            push_data = multiplex.queries.first
+          end
         when "execute_field", "execute_field_lazy"
-          query = metadata[:query] || raise(ArgumentError, "Add `legacy: true` to use GraphQL::Backtrace without the interpreter runtime.")
+          query = metadata[:query]
           multiplex = query.multiplex
-          push_key = metadata[:path].reject { |i| i.is_a?(Integer) }
+          push_key = query.context[:current_path]
           parent_frame = multiplex.context[:graphql_backtrace_contexts][push_key[0..-2]]
 
           if parent_frame.is_a?(GraphQL::Query)
@@ -59,7 +62,6 @@ module GraphQL
             potential_context = multiplex_context[:last_graphql_backtrace_context]
 
             if potential_context.is_a?(GraphQL::Query::Context) ||
-                potential_context.is_a?(GraphQL::Query::Context::FieldResolutionContext) ||
                 potential_context.is_a?(Backtrace::Frame)
               raise TracedError.new(err, potential_context)
             else

data/lib/graphql/backtrace.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 require "graphql/backtrace/inspect_result"
-require "graphql/backtrace/legacy_tracer"
 require "graphql/backtrace/table"
 require "graphql/backtrace/traced_error"
 require "graphql/backtrace/tracer"
+require "graphql/backtrace/trace"
 module GraphQL
   # Wrap unhandled errors with {TracedError}.
   #
@@ -23,13 +23,8 @@ module GraphQL
 
     def_delegators :to_a, :each, :[]
 
-    def self.use(schema_defn, legacy: false)
-      tracer = if legacy
-        self::LegacyTracer
-      else
-        self::Tracer
-      end
-      schema_defn.tracer(tracer)
+    def self.use(schema_defn)
+      schema_defn.trace_with(self::Trace)
     end
 
     def initialize(context, value: nil)

data/lib/graphql/coercion_error.rb

@@ -1,13 +1,5 @@
 # frozen_string_literal: true
 module GraphQL
-  class CoercionError < GraphQL::Error
-    # @return [Hash] Optional custom data for error objects which will be added
-    # under the `extensions` key.
-    attr_accessor :extensions
-
-    def initialize(message, extensions: nil)
-      @extensions = extensions
-      super(message)
-    end
+  class CoercionError < GraphQL::ExecutionError
   end
 end

data/lib/graphql/current.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module GraphQL
+  # This module exposes Fiber-level runtime information.
+  #
+  # It won't work across unrelated fibers, although it will work in child Fibers.
+  #
+  # @example Setting Up ActiveRecord::QueryLogs
+  #
+  #   config.active_record.query_log_tags = [
+  #     :namespaced_controller,
+  #     :action,
+  #     :job,
+  #     # ...
+  #     {
+  #       # GraphQL runtime info:
+  #       current_graphql_operation: -> { GraphQL::Current.operation_name },
+  #       current_graphql_field: -> { GraphQL::Current.field&.path },
+  #       current_dataloader_source: -> { GraphQL::Current.dataloader_source_class },
+  #       # ...
+  #     },
+  #   ]
+  #
+  module Current
+    # @return [String, nil] Comma-joined operation names for the currently-running {Multiplex}. `nil` if all operations are anonymous.
+    def self.operation_name
+      if (m = Fiber[:__graphql_current_multiplex])
+        m.context[:__graphql_current_operation_name] ||= begin
+          names = m.queries.map { |q| q.selected_operation_name }
+          if names.all?(&:nil?)
+            nil
+          else
+            names.join(",")
+          end
+        end
+      else
+        nil
+      end
+    end
+
+    # @see GraphQL::Field#path for a string identifying this field
+    # @return [GraphQL::Field, nil] The currently-running field, if there is one.
+    def self.field
+      Fiber[:__graphql_runtime_info]&.values&.first&.current_field
+    end
+
+    # @return [Class, nil] The currently-running {Dataloader::Source} class, if there is one.
+    def self.dataloader_source_class
+      Fiber[:__graphql_current_dataloader_source]&.class
+    end
+  end
+end

data/lib/graphql/dataloader/async_dataloader.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+module GraphQL
+  class Dataloader
+    class AsyncDataloader < Dataloader
+      def yield
+        if (condition = Fiber[:graphql_dataloader_next_tick])
+          condition.wait
+        else
+          Fiber.yield
+        end
+        nil
+      end
+
+      def run
+        jobs_fiber_limit, total_fiber_limit = calculate_fiber_limit
+        job_fibers = []
+        next_job_fibers = []
+        source_tasks = []
+        next_source_tasks = []
+        first_pass = true
+        sources_condition = Async::Condition.new
+        manager = spawn_fiber do
+          while first_pass || !job_fibers.empty?
+            first_pass = false
+            fiber_vars = get_fiber_variables
+
+            while (f = (job_fibers.shift || (((job_fibers.size + next_job_fibers.size + source_tasks.size) < jobs_fiber_limit) && spawn_job_fiber)))
+              if f.alive?
+                finished = run_fiber(f)
+                if !finished
+                  next_job_fibers << f
+                end
+              end
+            end
+            job_fibers.concat(next_job_fibers)
+            next_job_fibers.clear
+
+            Sync do |root_task|
+              set_fiber_variables(fiber_vars)
+              while !source_tasks.empty? || @source_cache.each_value.any? { |group_sources| group_sources.each_value.any?(&:pending?) }
+                while (task = (source_tasks.shift || (((job_fibers.size + next_job_fibers.size + source_tasks.size + next_source_tasks.size) < total_fiber_limit) && spawn_source_task(root_task, sources_condition))))
+                  if task.alive?
+                    root_task.yield # give the source task a chance to run
+                    next_source_tasks << task
+                  end
+                end
+                sources_condition.signal
+                source_tasks.concat(next_source_tasks)
+                next_source_tasks.clear
+              end
+            end
+          end
+        end
+
+        manager.resume
+        if manager.alive?
+          raise "Invariant: Manager didn't terminate successfully: #{manager}"
+        end
+
+      rescue UncaughtThrowError => e
+        throw e.tag, e.value
+      end
+
+      private
+
+      def spawn_source_task(parent_task, condition)
+        pending_sources = nil
+        @source_cache.each_value do |source_by_batch_params|
+          source_by_batch_params.each_value do |source|
+            if source.pending?
+              pending_sources ||= []
+              pending_sources << source
+            end
+          end
+        end
+
+        if pending_sources
+          fiber_vars = get_fiber_variables
+          parent_task.async do
+            set_fiber_variables(fiber_vars)
+            Fiber[:graphql_dataloader_next_tick] = condition
+            pending_sources.each(&:run_pending_keys)
+            cleanup_fiber
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/dataloader/null_dataloader.rb

@@ -8,10 +8,12 @@ module GraphQL
     # simple internal code while adding the option to add Dataloader.
     class NullDataloader < Dataloader
       # These are all no-ops because code was
-      # executed sychronously.
+      # executed synchronously.
       def run; end
       def run_isolated; yield; end
-      def yield; end
+      def yield
+        raise GraphQL::Error, "GraphQL::Dataloader is not running -- add `use GraphQL::Dataloader` to your schema to use Dataloader sources."
+      end
 
       def append_job
         yield

data/lib/graphql/dataloader/request.rb

@@ -14,6 +14,11 @@ module GraphQL
       def load
         @source.load(@key)
       end
+
+      def load_with_deprecation_warning
+        warn("Returning `.request(...)` from GraphQL::Dataloader is deprecated, use `.load(...)` instead. (See usage of #{@source} with #{@key.inspect}).")
+        load
+      end
     end
   end
 end