graphql 2.0.31 → 2.6.1

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]
@@ -15,10 +18,13 @@ module GraphQL
         @query = query
       end
 
+      # The Ruby parser doesn't call this method (`graphql/c_parser` does.)
       def lex(query_string:)
         yield
       end
 
+      # @param query_string [String]
+      # @return [void]
       def parse(query_string:)
         yield
       end
@@ -27,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
@@ -35,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
@@ -47,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
@@ -59,6 +98,28 @@ module GraphQL
         yield
       end
 
+      def objects(type, object, context)
+      end
+
+      def object_loaded(argument_definition, object, context)
+      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
@@ -70,6 +131,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,36 +1,39 @@
 # frozen_string_literal: true
-require "graphql/tracing/trace"
-require "graphql/tracing/legacy_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/scout_trace"
-require "graphql/tracing/statsd_trace"
-require "graphql/tracing/prometheus_trace"
-if defined?(PrometheusExporter::Server)
-  require "graphql/tracing/prometheus_tracing/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,9 +14,10 @@ module GraphQL
         @leaf = leaf
         @composite = fields? || abstract?
         @description = description
+        freeze
       end
 
-      # Does this TypeKind have multiple possible implementors?
+      # Does this TypeKind have multiple possible implementers?
       # @deprecated Use `abstract?` instead of `resolves?`.
       def resolves?;  @abstract;  end
       # Is this TypeKind abstract?

data/lib/graphql/types/iso_8601_duration.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+module GraphQL
+  module Types
+    # This scalar takes `Duration`s and transmits them as strings,
+    # using ISO 8601 format. ActiveSupport >= 5.0 must be loaded to use
+    # this scalar.
+    #
+    # Use it for fields or arguments as follows:
+    #
+    #     field :age, GraphQL::Types::ISO8601Duration, null: false
+    #
+    #     argument :interval, GraphQL::Types::ISO8601Duration, null: false
+    #
+    # Alternatively, use this built-in scalar as inspiration for your
+    # own Duration type.
+    class ISO8601Duration < GraphQL::Schema::Scalar
+      description "An ISO 8601-encoded duration"
+
+      # @return [Integer, nil]
+      def self.seconds_precision
+        # ActiveSupport::Duration precision defaults to whatever input was given
+        @seconds_precision
+      end
+
+      # @param [Integer, nil] value
+      def self.seconds_precision=(value)
+        @seconds_precision = value
+      end
+
+      # @param value [ActiveSupport::Duration, String]
+      # @return [String]
+      # @raise [GraphQL::Error] if ActiveSupport::Duration is not defined or if an incompatible object is passed
+      def self.coerce_result(value, _ctx)
+        unless defined?(ActiveSupport::Duration)
+          raise GraphQL::Error, "ActiveSupport >= 5.0 must be loaded to use the built-in ISO8601Duration type."
+        end
+
+        begin
+          case value
+          when ActiveSupport::Duration
+            value.iso8601(precision: seconds_precision)
+          when ::String
+            ActiveSupport::Duration.parse(value).iso8601(precision: seconds_precision)
+          else
+            # Try calling as ActiveSupport::Duration compatible as a fallback
+            value.iso8601(precision: seconds_precision)
+          end
+        rescue StandardError => error
+          raise GraphQL::Error, "An incompatible object (#{value.class}) was given to #{self}. Make sure that only ActiveSupport::Durations and well-formatted Strings are used with this type. (#{error.message})"
+        end
+      end
+
+      # @param value [String, ActiveSupport::Duration]
+      # @return [ActiveSupport::Duration, nil]
+      # @raise [GraphQL::Error] if ActiveSupport::Duration is not defined
+      # @raise [GraphQL::DurationEncodingError] if duration cannot be parsed
+      def self.coerce_input(value, ctx)
+        unless defined?(ActiveSupport::Duration)
+          raise GraphQL::Error, "ActiveSupport >= 5.0 must be loaded to use the built-in ISO8601Duration type."
+        end
+
+        begin
+          if value.is_a?(ActiveSupport::Duration)
+            value
+          elsif value.nil?
+            nil
+          else
+            ActiveSupport::Duration.parse(value)
+          end
+        rescue ArgumentError, TypeError
+          err = GraphQL::DurationEncodingError.new(value)
+          ctx.schema.type_error(err, ctx)
+        end
+      end
+    end
+  end
+end

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

@@ -13,11 +13,12 @@ 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
           }
+          child_class.default_broadcastable(nil)
           add_page_info_field(child_class)
         end
 
@@ -31,12 +32,21 @@ module GraphQL
             child_class.edge_type = nil
             child_class.node_type = nil
             child_class.edge_class = nil
+            child_class.default_broadcastable(default_broadcastable?)
           end
 
           def default_relay?
             true
           end
 
+          def default_broadcastable?
+            @default_broadcastable
+          end
+
+          def default_broadcastable(new_value)
+            @default_broadcastable = new_value
+          end
+
           # @return [Class]
           attr_reader :node_type
 
@@ -67,9 +77,8 @@ module GraphQL
               type: [edge_type_class, null: edge_nullable],
               null: edges_nullable,
               description: "A list of edges.",
+              scope: false, # Assume that the connection was already scoped.
               connection: false,
-              # Assume that the connection was scoped before this step:
-              scope: false,
             }
 
             if field_options
@@ -88,6 +97,19 @@ module GraphQL
             node_type.scope_items(items, context)
           end
 
+          # The connection will skip auth on its nodes if the node_type is configured for that
+          def reauthorize_scoped_objects(new_value = nil)
+            if new_value.nil?
+              if @reauthorize_scoped_objects != nil
+                @reauthorize_scoped_objects
+              else
+                node_type.reauthorize_scoped_objects
+              end
+            else
+              @reauthorize_scoped_objects = new_value
+            end
+          end
+
           # Add the shortcut `nodes` field to this connection and its subclasses
           def nodes_field(node_nullable: self.node_nullable, field_options: nil)
             define_nodes_field(node_nullable, field_options: field_options)
@@ -170,6 +192,26 @@ module GraphQL
             obj_type.field :page_info, GraphQL::Types::Relay::PageInfo, null: false, description: "Information to aid in pagination."
           end
         end
+
+        def edges
+          # Assume that whatever authorization needed to happen
+          # already happened at the connection level.
+          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.
+          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
     end
   end

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

@@ -8,8 +8,17 @@ 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
+          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
 
         module ClassMethods
@@ -17,12 +26,21 @@ module GraphQL
             super
             child_class.node_type = nil
             child_class.node_nullable = nil
+            child_class.default_broadcastable(default_broadcastable?)
           end
 
           def default_relay?
             true
           end
 
+          def default_broadcastable?
+            @default_broadcastable
+          end
+
+          def default_broadcastable(new_value)
+            @default_broadcastable = new_value
+          end
+
           # Get or set the Object type that this edge wraps.
           #
           # @param node_type [Class] A `Schema::Object` subclass

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/types/relay/page_info_behaviors.rb

@@ -24,6 +24,10 @@ module GraphQL
         def default_relay?
           true
         end
+
+        def default_broadcastable?
+          true
+        end
       end
     end
   end

data/lib/graphql/types.rb

@@ -1,11 +1,19 @@
 # frozen_string_literal: true
-require "graphql/types/boolean"
-require "graphql/types/big_int"
-require "graphql/types/float"
-require "graphql/types/id"
-require "graphql/types/int"
-require "graphql/types/iso_8601_date"
-require "graphql/types/iso_8601_date_time"
-require "graphql/types/json"
-require "graphql/types/string"
-require "graphql/types/relay"
+
+module GraphQL
+  module Types
+    extend Autoload
+
+    autoload :Boolean, "graphql/types/boolean"
+    autoload :BigInt, "graphql/types/big_int"
+    autoload :Float, "graphql/types/float"
+    autoload :ID, "graphql/types/id"
+    autoload :Int, "graphql/types/int"
+    autoload :JSON, "graphql/types/json"
+    autoload :String, "graphql/types/string"
+    autoload :ISO8601Date, "graphql/types/iso_8601_date"
+    autoload :ISO8601DateTime, "graphql/types/iso_8601_date_time"
+    autoload :ISO8601Duration, "graphql/types/iso_8601_duration"
+    autoload :Relay, "graphql/types/relay"
+  end
+end

data/lib/graphql/unauthorized_enum_value_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module GraphQL
+  class UnauthorizedEnumValueError < GraphQL::UnauthorizedError
+    # @return [GraphQL::Schema::EnumValue] The value whose `#authorized?` check returned false
+    attr_accessor :enum_value
+
+    def initialize(type:, context:, enum_value:)
+      @enum_value = enum_value
+      message ||= "#{enum_value.path} failed authorization"
+      super(message, object: enum_value.value, type: type, context: context)
+    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,19 @@ 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
+
+    def finalize_graphql_result(query, result_data, key)
+      result_data[key] = nil
+    end
   end
 end

data/lib/graphql/version.rb

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