graphql 2.4.5 → 2.5.21

data/lib/graphql/tracing/trace.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
+
+require "graphql/tracing"
+
 module GraphQL
   module Tracing
     # This is the base class for a `trace` instance whose methods are called during query execution.
     # "Trace modes" are subclasses of this with custom tracing modules mixed in.
     #
     # A trace module may implement any of the methods on `Trace`, being sure to call `super`
-    # to continue any tracing hooks and call the actual runtime behavior. See {GraphQL::Backtrace::Trace} for example.
+    # to continue any tracing hooks and call the actual runtime behavior.
     #
     class Trace
       # @param multiplex [GraphQL::Execution::Multiplex, nil]
@@ -20,6 +23,8 @@ module GraphQL
         yield
       end
 
+      # @param query_string [String]
+      # @return [void]
       def parse(query_string:)
         yield
       end
@@ -28,6 +33,22 @@ module GraphQL
         yield
       end
 
+      def begin_validate(query, validate)
+      end
+
+      def end_validate(query, validate, errors)
+      end
+
+      # @param multiplex [GraphQL::Execution::Multiplex]
+      # @param analyzers [Array<Class>]
+      # @return [void]
+      def begin_analyze_multiplex(multiplex, analyzers); end
+      # @param multiplex [GraphQL::Execution::Multiplex]
+      # @param analyzers [Array<Class>]
+      # @return [void]
+      def end_analyze_multiplex(multiplex, analyzers); end
+      # @param multiplex [GraphQL::Execution::Multiplex]
+      # @return [void]
       def analyze_multiplex(multiplex:)
         yield
       end
@@ -36,6 +57,9 @@ module GraphQL
         yield
       end
 
+      # This wraps an entire `.execute` call.
+      # @param multiplex [GraphQL::Execution::Multiplex]
+      # @return [void]
       def execute_multiplex(multiplex:)
         yield
       end
@@ -48,6 +72,20 @@ module GraphQL
         yield
       end
 
+      # GraphQL is about to resolve this field
+      # @param field [GraphQL::Schema::Field]
+      # @param object [GraphQL::Schema::Object]
+      # @param arguments [Hash]
+      # @param query [GraphQL::Query]
+      def begin_execute_field(field, object, arguments, query); end
+      # GraphQL just finished resolving this field
+      # @param field [GraphQL::Schema::Field]
+      # @param object [GraphQL::Schema::Object]
+      # @param arguments [Hash]
+      # @param query [GraphQL::Query]
+      # @param result [Object]
+      def end_execute_field(field, object, arguments, query, result); end
+
       def execute_field(field:, query:, ast_node:, arguments:, object:)
         yield
       end
@@ -60,6 +98,22 @@ module GraphQL
         yield
       end
 
+      # A call to `.authorized?` is starting
+      # @param type [Class<GraphQL::Schema::Object>]
+      # @param object [Object]
+      # @param context [GraphQL::Query::Context]
+      # @return [void]
+      def begin_authorized(type, object, context)
+      end
+      # A call to `.authorized?` just finished
+      # @param type [Class<GraphQL::Schema::Object>]
+      # @param object [Object]
+      # @param context [GraphQL::Query::Context]
+      # @param authorized_result [Boolean]
+      # @return [void]
+      def end_authorized(type, object, context, authorized_result)
+      end
+
       def authorized_lazy(query:, type:, object:)
         yield
       end
@@ -71,6 +125,62 @@ module GraphQL
       def resolve_type_lazy(query:, type:, object:)
         yield
       end
+
+      # A call to `.resolve_type` is starting
+      # @param type [Class<GraphQL::Schema::Union>, Module<GraphQL::Schema::Interface>]
+      # @param value [Object]
+      # @param context [GraphQL::Query::Context]
+      # @return [void]
+      def begin_resolve_type(type, value, context)
+      end
+
+      # A call to `.resolve_type` just ended
+      # @param type [Class<GraphQL::Schema::Union>, Module<GraphQL::Schema::Interface>]
+      # @param value [Object]
+      # @param context [GraphQL::Query::Context]
+      # @param resolved_type [Class<GraphQL::Schema::Object>]
+      # @return [void]
+      def end_resolve_type(type, value, context, resolved_type)
+      end
+
+      # A dataloader run is starting
+      # @param dataloader [GraphQL::Dataloader]
+      # @return [void]
+      def begin_dataloader(dataloader); end
+      # A dataloader run has ended
+      # @param dataloder [GraphQL::Dataloader]
+      # @return [void]
+      def end_dataloader(dataloader); end
+
+      # A source with pending keys is about to fetch
+      # @param source [GraphQL::Dataloader::Source]
+      # @return [void]
+      def begin_dataloader_source(source); end
+      # A fetch call has just ended
+      # @param source [GraphQL::Dataloader::Source]
+      # @return [void]
+      def end_dataloader_source(source); end
+
+      # Called when Dataloader spins up a new fiber for GraphQL execution
+      # @param jobs [Array<#call>] Execution steps to run
+      # @return [void]
+      def dataloader_spawn_execution_fiber(jobs); end
+      # Called when Dataloader spins up a new fiber for fetching data
+      # @param pending_sources [GraphQL::Dataloader::Source] Instances with pending keys
+      # @return [void]
+      def dataloader_spawn_source_fiber(pending_sources); end
+      # Called when an execution or source fiber terminates
+      # @return [void]
+      def dataloader_fiber_exit; end
+
+      # Called when a Dataloader fiber is paused to wait for data
+      # @param source [GraphQL::Dataloader::Source] The Source whose `load` call initiated this `yield`
+      # @return [void]
+      def dataloader_fiber_yield(source); end
+      # Called when a Dataloader fiber is resumed because data has been loaded
+      # @param source [GraphQL::Dataloader::Source] The Source whose `load` call previously caused this Fiber to wait
+      # @return [void]
+      def dataloader_fiber_resume(source); end
     end
   end
 end

data/lib/graphql/tracing.rb

@@ -1,38 +1,39 @@
 # frozen_string_literal: true
-require "graphql/tracing/trace"
-require "graphql/tracing/legacy_trace"
-require "graphql/tracing/legacy_hooks_trace"
 
-# Legacy tracing:
-require "graphql/tracing/active_support_notifications_tracing"
-require "graphql/tracing/platform_tracing"
-require "graphql/tracing/appoptics_tracing"
-require "graphql/tracing/appsignal_tracing"
-require "graphql/tracing/data_dog_tracing"
-require "graphql/tracing/new_relic_tracing"
-require "graphql/tracing/scout_tracing"
-require "graphql/tracing/statsd_tracing"
-require "graphql/tracing/prometheus_tracing"
-
-# New Tracing:
-require "graphql/tracing/active_support_notifications_trace"
-require "graphql/tracing/platform_trace"
-require "graphql/tracing/appoptics_trace"
-require "graphql/tracing/appsignal_trace"
-require "graphql/tracing/data_dog_trace"
-require "graphql/tracing/new_relic_trace"
-require "graphql/tracing/notifications_trace"
-require "graphql/tracing/sentry_trace"
-require "graphql/tracing/scout_trace"
-require "graphql/tracing/statsd_trace"
-require "graphql/tracing/prometheus_trace"
-if defined?(PrometheusExporter::Server)
-  require "graphql/tracing/prometheus_trace/graphql_collector"
-end
 
 module GraphQL
   module Tracing
-    NullTrace = Trace.new
+    autoload :Trace, "graphql/tracing/trace"
+    autoload :CallLegacyTracers, "graphql/tracing/call_legacy_tracers"
+    autoload :LegacyTrace, "graphql/tracing/legacy_trace"
+    autoload :LegacyHooksTrace, "graphql/tracing/legacy_hooks_trace"
+    autoload :NullTrace, "graphql/tracing/null_trace"
+
+    autoload :ActiveSupportNotificationsTracing, "graphql/tracing/active_support_notifications_tracing"
+    autoload :PlatformTracing, "graphql/tracing/platform_tracing"
+    autoload :AppOpticsTracing, "graphql/tracing/appoptics_tracing"
+    autoload :AppsignalTracing, "graphql/tracing/appsignal_tracing"
+    autoload :DataDogTracing, "graphql/tracing/data_dog_tracing"
+    autoload :NewRelicTracing, "graphql/tracing/new_relic_tracing"
+    autoload :NotificationsTracing, "graphql/tracing/notifications_tracing"
+    autoload :ScoutTracing, "graphql/tracing/scout_tracing"
+    autoload :StatsdTracing, "graphql/tracing/statsd_tracing"
+    autoload :PrometheusTracing, "graphql/tracing/prometheus_tracing"
+
+    autoload :ActiveSupportNotificationsTrace, "graphql/tracing/active_support_notifications_trace"
+    autoload :PlatformTrace, "graphql/tracing/platform_trace"
+    autoload :AppOpticsTrace, "graphql/tracing/appoptics_trace"
+    autoload :AppsignalTrace, "graphql/tracing/appsignal_trace"
+    autoload :DataDogTrace, "graphql/tracing/data_dog_trace"
+    autoload :MonitorTrace, "graphql/tracing/monitor_trace"
+    autoload :NewRelicTrace, "graphql/tracing/new_relic_trace"
+    autoload :NotificationsTrace, "graphql/tracing/notifications_trace"
+    autoload :SentryTrace, "graphql/tracing/sentry_trace"
+    autoload :ScoutTrace, "graphql/tracing/scout_trace"
+    autoload :StatsdTrace, "graphql/tracing/statsd_trace"
+    autoload :PrometheusTrace, "graphql/tracing/prometheus_trace"
+    autoload :PerfettoTrace, "graphql/tracing/perfetto_trace"
+    autoload :DetailedTrace, "graphql/tracing/detailed_trace"
 
     # Objects may include traceable to gain a `.trace(...)` method.
     # The object must have a `@tracers` ivar of type `Array<<#trace(k, d, &b)>>`.

data/lib/graphql/type_kinds.rb

@@ -14,6 +14,7 @@ module GraphQL
         @leaf = leaf
         @composite = fields? || abstract?
         @description = description
+        freeze
       end
 
       # Does this TypeKind have multiple possible implementers?

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

@@ -13,7 +13,7 @@ module GraphQL
           child_class.node_nullable(true)
           child_class.edges_nullable(true)
           child_class.edge_nullable(true)
-          child_class.module_eval {
+          child_class.module_exec {
             self.edge_type = nil
             self.node_type = nil
             self.edge_class = nil
@@ -196,18 +196,20 @@ module GraphQL
         def edges
           # Assume that whatever authorization needed to happen
           # already happened at the connection level.
-          current_runtime_state = Fiber[:__graphql_runtime_info]
-          query_runtime_state = current_runtime_state[context.query]
-          query_runtime_state.was_authorized_by_scope_items = @object.was_authorized_by_scope_items?
+          if (current_runtime_state = Fiber[:__graphql_runtime_info])
+            query_runtime_state = current_runtime_state[context.query]
+            query_runtime_state.was_authorized_by_scope_items = @object.was_authorized_by_scope_items?
+          end
           @object.edges
         end
 
         def nodes
           # Assume that whatever authorization needed to happen
           # already happened at the connection level.
-          current_runtime_state = Fiber[:__graphql_runtime_info]
-          query_runtime_state = current_runtime_state[context.query]
-          query_runtime_state.was_authorized_by_scope_items = @object.was_authorized_by_scope_items?
+          if (current_runtime_state = Fiber[:__graphql_runtime_info])
+            query_runtime_state = current_runtime_state[context.query]
+            query_runtime_state.was_authorized_by_scope_items = @object.was_authorized_by_scope_items?
+          end
           @object.nodes
         end
       end

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

@@ -8,15 +8,16 @@ module GraphQL
           child_class.description("An edge in a connection.")
           child_class.field(:cursor, String, null: false, description: "A cursor for use in pagination.")
           child_class.extend(ClassMethods)
-          child_class.class_eval { self.node_type = nil }
+          child_class.class_exec { self.node_type = nil }
           child_class.node_nullable(true)
           child_class.default_broadcastable(nil)
         end
 
         def node
-          current_runtime_state = Fiber[:__graphql_runtime_info]
-          query_runtime_state = current_runtime_state[context.query]
-          query_runtime_state.was_authorized_by_scope_items = @object.was_authorized_by_scope_items?
+          if (current_runtime_state = Fiber[:__graphql_runtime_info])
+            query_runtime_state = current_runtime_state[context.query]
+            query_runtime_state.was_authorized_by_scope_items = @object.was_authorized_by_scope_items?
+          end
           @object.node
         end
 

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

@@ -7,6 +7,17 @@ module GraphQL
       module HasNodeField
         def self.included(child_class)
           child_class.field(**field_options, &field_block)
+          child_class.extend(ExecutionMethods)
+        end
+
+        module ExecutionMethods
+          def get_relay_node(context, id:)
+            context.schema.object_from_id(id, context)
+          end
+        end
+
+        def get_relay_node(id:)
+          self.class.get_relay_node(context, id: id)
         end
 
         class << self
@@ -17,6 +28,8 @@ module GraphQL
               null: true,
               description: "Fetches an object given its ID.",
               relay_node_field: true,
+              resolver_method: :get_relay_node,
+              resolve_static: :get_relay_node,
             }
           end
 
@@ -24,14 +37,6 @@ module GraphQL
             Proc.new {
               argument :id, "ID!",
                 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

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

@@ -7,6 +7,17 @@ module GraphQL
       module HasNodesField
         def self.included(child_class)
           child_class.field(**field_options, &field_block)
+          child_class.extend(ExecutionMethods)
+        end
+
+        module ExecutionMethods
+          def get_relay_nodes(context, ids:)
+            ids.map { |id| context.schema.object_from_id(id, context) }
+          end
+        end
+
+        def get_relay_nodes(ids:)
+          self.class.get_relay_nodes(context, ids: ids)
         end
 
         class << self
@@ -17,6 +28,8 @@ module GraphQL
               null: false,
               description: "Fetches a list of objects given a list of IDs.",
               relay_nodes_field: true,
+              resolver_method: :get_relay_nodes,
+              resolve_static: :get_relay_nodes
             }
           end
 
@@ -24,14 +37,6 @@ module GraphQL
             Proc.new {
               argument :ids, "[ID!]!",
                 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

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

@@ -6,12 +6,13 @@ module GraphQL
       module NodeBehaviors
         def self.included(child_module)
           child_module.extend(ClassMethods)
+          child_module.extend(ExecutionMethods)
           child_module.description("An object with an ID.")
-          child_module.field(:id, ID, null: false, description: "ID of the object.", resolver_method: :default_global_id)
+          child_module.field(:id, ID, null: false, description: "ID of the object.", resolver_method: :default_global_id, resolve_each: :default_global_id)
         end
 
         def default_global_id
-          context.schema.id_from_object(object, self.class, context)
+          self.class.default_global_id(object, context)
         end
 
         module ClassMethods
@@ -19,6 +20,16 @@ module GraphQL
             true
           end
         end
+
+        module ExecutionMethods
+          def default_global_id(object, context)
+            context.schema.id_from_object(object, self, context)
+          end
+
+          def included(child_class)
+            child_class.extend(ExecutionMethods)
+          end
+        end
       end
     end
   end

data/lib/graphql/unauthorized_error.rb

@@ -4,7 +4,7 @@ module GraphQL
   # It's passed to {Schema.unauthorized_object}.
   #
   # Alternatively, custom code in `authorized?` may raise this error. It will be routed the same way.
-  class UnauthorizedError < GraphQL::Error
+  class UnauthorizedError < GraphQL::RuntimeError
     # @return [Object] the application object that failed the authorization check
     attr_reader :object
 
@@ -19,11 +19,15 @@ module GraphQL
         raise ArgumentError, "#{self.class.name} requires either a message or keywords"
       end
 
+      @path = nil
       @object = object
       @type = type
       @context = context
+      @ast_nodes = nil
       message ||= "An instance of #{object.class} failed #{type.graphql_name}'s authorization check"
       super(message)
     end
+
+    attr_accessor :path, :ast_nodes
   end
 end

data/lib/graphql/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module GraphQL
-  VERSION = "2.4.5"
+  VERSION = "2.5.21"
 end

data/lib/graphql.rb

@@ -4,7 +4,7 @@ require "json"
 require "set"
 require "singleton"
 require "forwardable"
-require "fiber/storage"
+require "fiber/storage" if RUBY_VERSION < "3.2.0"
 require "graphql/autoload"
 
 module GraphQL
@@ -15,11 +15,15 @@ module GraphQL
     super
     Query.eager_load!
     Types.eager_load!
+    Schema.eager_load!
   end
 
   class Error < StandardError
   end
 
+  class RuntimeError < Error
+  end
+
   # This error is raised when GraphQL-Ruby encounters a situation
   # that it *thought* would never happen. Please report this bug!
   class InvariantError < Error
@@ -71,7 +75,7 @@ This is probably a bug in GraphQL-Ruby, please report this error on GitHub: http
     GraphQL::Language::Lexer.tokenize(graphql_string)
   end
 
-  NOT_CONFIGURED = Object.new
+  NOT_CONFIGURED = Object.new.freeze
   private_constant :NOT_CONFIGURED
   module EmptyObjects
     EMPTY_HASH = {}.freeze
@@ -81,35 +85,6 @@ This is probably a bug in GraphQL-Ruby, please report this error on GitHub: http
   class << self
     # If true, the parser should raise when an integer or float is followed immediately by an identifier (instead of a space or punctuation)
     attr_accessor :reject_numbers_followed_by_names
-
-    # If `production?` is detected but `eager_load!` wasn't called, emit a warning.
-    # @return [void]
-    def ensure_eager_load!
-      if production? && !eager_loading?
-        warn <<~WARNING
-          GraphQL-Ruby thinks this is a production deployment but didn't eager-load its constants. Address this by:
-
-            - Calling `GraphQL.eager_load!` in a production-only initializer or setup hook
-            - Assign `GraphQL.env = "..."` to something _other_ than `"production"` (for example, `GraphQL.env = "development"`)
-
-          More details: https://graphql-ruby.org/schema/definition#production-considerations
-        WARNING
-      end
-    end
-
-    attr_accessor :env
-
-    private
-
-    # Detect whether this is a production deployment or not
-    def production?
-      if env
-        # Manually assigned to production?
-        env == "production"
-      else
-        (detected_env = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || ENV["HANAMI_ENV"] || ENV["APP_ENV"]) && detected_env.to_s.downcase == "production"
-      end
-    end
   end
 
   self.reject_numbers_followed_by_names = false
@@ -153,6 +128,12 @@ This is probably a bug in GraphQL-Ruby, please report this error on GitHub: http
   autoload :LoadApplicationObjectFailedError, "graphql/load_application_object_failed_error"
   autoload :Testing, "graphql/testing"
   autoload :Current, "graphql/current"
+  if defined?(::Rails::Engine)
+    # This needs to be defined before Rails runs `add_routing_paths`,
+    # otherwise GraphQL::Dashboard's routes won't have been gathered for loading
+    # when that initializer runs.
+    require 'graphql/dashboard'
+  end
 end
 
 require "graphql/version"