graphql 2.0.13 → 2.3.10

data/lib/graphql/tracing/statsd_trace.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Tracing
+    module StatsdTrace
+      include PlatformTrace
+
+      # @param statsd [Object] A statsd client
+      def initialize(statsd:, **rest)
+        @statsd = statsd
+        super(**rest)
+      end
+
+      {
+        'lex' => "graphql.lex",
+        'parse' => "graphql.parse",
+        'validate' => "graphql.validate",
+        'analyze_query' => "graphql.analyze_query",
+        'analyze_multiplex' => "graphql.analyze_multiplex",
+        'execute_multiplex' => "graphql.execute_multiplex",
+        'execute_query' => "graphql.execute_query",
+        'execute_query_lazy' => "graphql.execute_query_lazy",
+      }.each do |trace_method, platform_key|
+        module_eval <<-RUBY, __FILE__, __LINE__
+          def #{trace_method}(**data)
+            @statsd.time("#{platform_key}") do
+              super
+            end
+          end
+        RUBY
+      end
+
+      def platform_execute_field(platform_key, &block)
+        @statsd.time(platform_key, &block)
+      end
+
+      def platform_authorized(key, &block)
+        @statsd.time(key, &block)
+      end
+
+      alias :platform_resolve_type :platform_authorized
+
+      def platform_field_key(field)
+        "graphql.#{field.path}"
+      end
+
+      def platform_authorized_key(type)
+        "graphql.authorized.#{type.graphql_name}"
+      end
+
+      def platform_resolve_type_key(type)
+        "graphql.resolve_type.#{type.graphql_name}"
+      end
+    end
+  end
+end

data/lib/graphql/tracing/trace.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+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.
+    #
+    class Trace
+      # @param multiplex [GraphQL::Execution::Multiplex, nil]
+      # @param query [GraphQL::Query, nil]
+      def initialize(multiplex: nil, query: nil, **_options)
+        @multiplex = multiplex
+        @query = query
+      end
+
+      # The Ruby parser doesn't call this method (`graphql/c_parser` does.)
+      def lex(query_string:)
+        yield
+      end
+
+      def parse(query_string:)
+        yield
+      end
+
+      def validate(query:, validate:)
+        yield
+      end
+
+      def analyze_multiplex(multiplex:)
+        yield
+      end
+
+      def analyze_query(query:)
+        yield
+      end
+
+      def execute_multiplex(multiplex:)
+        yield
+      end
+
+      def execute_query(query:)
+        yield
+      end
+
+      def execute_query_lazy(query:, multiplex:)
+        yield
+      end
+
+      def execute_field(field:, query:, ast_node:, arguments:, object:)
+        yield
+      end
+
+      def execute_field_lazy(field:, query:, ast_node:, arguments:, object:)
+        yield
+      end
+
+      def authorized(query:, type:, object:)
+        yield
+      end
+
+      def authorized_lazy(query:, type:, object:)
+        yield
+      end
+
+      def resolve_type(query:, type:, object:)
+        yield
+      end
+
+      def resolve_type_lazy(query:, type:, object:)
+        yield
+      end
+    end
+  end
+end

data/lib/graphql/tracing.rb

@@ -1,4 +1,9 @@
 # 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"
@@ -9,51 +14,26 @@ 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_tracing/graphql_collector"
+  require "graphql/tracing/prometheus_trace/graphql_collector"
 end
 
 module GraphQL
-  # Library entry point for performance metric reporting.
-  #
-  # @example Sending custom events
-  #   query.trace("my_custom_event", { ... }) do
-  #     # do stuff ...
-  #   end
-  #
-  # @example Adding a tracer to a schema
-  #  class MySchema < GraphQL::Schema
-  #    tracer MyTracer # <= responds to .trace(key, data, &block)
-  #  end
-  #
-  # @example Adding a tracer to a single query
-  #   MySchema.execute(query_str, context: { backtrace: true })
-  #
-  # Events:
-  #
-  # Key | Metadata
-  # ----|---------
-  # lex | `{ query_string: String }`
-  # parse | `{ query_string: String }`
-  # validate | `{ query: GraphQL::Query, validate: Boolean }`
-  # analyze_multiplex |  `{ multiplex: GraphQL::Execution::Multiplex }`
-  # analyze_query | `{ query: GraphQL::Query }`
-  # execute_multiplex | `{ multiplex: GraphQL::Execution::Multiplex }`
-  # execute_query | `{ query: GraphQL::Query }`
-  # execute_query_lazy | `{ query: GraphQL::Query?, multiplex: GraphQL::Execution::Multiplex? }`
-  # execute_field | `{ owner: Class, field: GraphQL::Schema::Field, query: GraphQL::Query, path: Array<String, Integer>, ast_node: GraphQL::Language::Nodes::Field}`
-  # execute_field_lazy | `{ owner: Class, field: GraphQL::Schema::Field, query: GraphQL::Query, path: Array<String, Integer>, ast_node: GraphQL::Language::Nodes::Field}`
-  # authorized | `{ context: GraphQL::Query::Context, type: Class, object: Object, path: Array<String, Integer> }`
-  # authorized_lazy | `{ context: GraphQL::Query::Context, type: Class, object: Object, path: Array<String, Integer> }`
-  # resolve_type | `{ context: GraphQL::Query::Context, type: Class, object: Object, path: Array<String, Integer> }`
-  # resolve_type_lazy | `{ context: GraphQL::Query::Context, type: Class, object: Object, path: Array<String, Integer> }`
-  #
-  # Note that `execute_field` and `execute_field_lazy` receive different data in different settings:
-  #
-  # - When using {GraphQL::Execution::Interpreter}, they receive `{field:, path:, query:}`
-  # - Otherwise, they receive `{context: ...}`
-  #
   module Tracing
+    NullTrace = Trace.new
+
     # Objects may include traceable to gain a `.trace(...)` method.
     # The object must have a `@tracers` ivar of type `Array<<#trace(k, d, &b)>>`.
     # @api private

data/lib/graphql/type_kinds.rb

@@ -5,17 +5,18 @@ module GraphQL
     # These objects are singletons, eg `GraphQL::TypeKinds::UNION`, `GraphQL::TypeKinds::SCALAR`.
     class TypeKind
       attr_reader :name, :description
-      def initialize(name, abstract: false, fields: false, wraps: false, input: false, description: nil)
+      def initialize(name, abstract: false, leaf: false, fields: false, wraps: false, input: false, description: nil)
         @name = name
         @abstract = abstract
         @fields = fields
         @wraps = wraps
         @input = input
+        @leaf = leaf
         @composite = fields? || abstract?
         @description = description
       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?
@@ -27,6 +28,8 @@ module GraphQL
       # Is this TypeKind a valid query input?
       def input?;     @input;     end
       def to_s;       @name;      end
+      # Is this TypeKind a primitive value?
+      def leaf?; @leaf; end
       # Is this TypeKind composed of many values?
       def composite?; @composite; end
 
@@ -64,11 +67,11 @@ module GraphQL
     end
 
     TYPE_KINDS = [
-      SCALAR =        TypeKind.new("SCALAR", input: true, description: 'Indicates this type is a scalar.'),
+      SCALAR =        TypeKind.new("SCALAR", input: true, leaf: true, description: 'Indicates this type is a scalar.'),
       OBJECT =        TypeKind.new("OBJECT", fields: true, description: 'Indicates this type is an object. `fields` and `interfaces` are valid fields.'),
       INTERFACE =     TypeKind.new("INTERFACE", abstract: true, fields: true, description: 'Indicates this type is an interface. `fields` and `possibleTypes` are valid fields.'),
       UNION =         TypeKind.new("UNION", abstract: true, description: 'Indicates this type is a union. `possibleTypes` is a valid field.'),
-      ENUM =          TypeKind.new("ENUM", input: true, description: 'Indicates this type is an enum. `enumValues` is a valid field.'),
+      ENUM =          TypeKind.new("ENUM", input: true, leaf: true, description: 'Indicates this type is an enum. `enumValues` is a valid field.'),
       INPUT_OBJECT =  TypeKind.new("INPUT_OBJECT", input: true, description: 'Indicates this type is an input object. `inputFields` is a valid field.'),
       LIST =          TypeKind.new("LIST", wraps: true, description: 'Indicates this type is a list. `ofType` is a valid field.'),
       NON_NULL =      TypeKind.new("NON_NULL", wraps: true, description: 'Indicates this type is a non-null. `ofType` is a valid field.'),

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/base_connection.rb

@@ -35,7 +35,7 @@ module GraphQL
       #     # Alternatively, you can call the class methods followed by your edge type
       #     # edges_nullable true
       #     # edge_nullable true
-      #     # nodes_nullable true
+      #     # node_nullable true
       #     # has_nodes_field true
       #     # edge_type Types::PostEdge
       #   end

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

@@ -9,16 +9,44 @@ module GraphQL
 
         def self.included(child_class)
           child_class.extend(ClassMethods)
-          child_class.extend(Relay::DefaultRelay)
-          child_class.default_relay(true)
           child_class.has_nodes_field(true)
           child_class.node_nullable(true)
           child_class.edges_nullable(true)
           child_class.edge_nullable(true)
+          child_class.module_eval {
+            self.edge_type = nil
+            self.node_type = nil
+            self.edge_class = nil
+          }
+          child_class.default_broadcastable(nil)
           add_page_info_field(child_class)
         end
 
         module ClassMethods
+          def inherited(child_class)
+            super
+            child_class.has_nodes_field(has_nodes_field)
+            child_class.node_nullable(node_nullable)
+            child_class.edges_nullable(edges_nullable)
+            child_class.edge_nullable(edge_nullable)
+            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
 
@@ -49,6 +77,7 @@ 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,
             }
 
@@ -68,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)
@@ -77,10 +119,6 @@ module GraphQL
             true # Let nodes be filtered out
           end
 
-          def accessible?(ctx)
-            node_type.accessible?(ctx)
-          end
-
           def visible?(ctx)
             # if this is an abstract base class, there may be no `node_type`
             node_type ? node_type.visible?(ctx) : super
@@ -126,6 +164,10 @@ module GraphQL
             end
           end
 
+          protected
+
+          attr_writer :edge_type, :node_type,  :edge_class
+
           private
 
           def define_nodes_field(nullable, field_options: nil)
@@ -135,6 +177,8 @@ module GraphQL
               null: nullable,
               description: "A list of nodes.",
               connection: false,
+              # Assume that the connection was scoped before this step:
+              scope: false,
             }
             if field_options
               base_field_options.merge!(field_options)
@@ -148,6 +192,24 @@ 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.
+          current_runtime_state = Thread.current[:__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?
+          @object.edges
+        end
+
+        def nodes
+          # Assume that whatever authorization needed to happen
+          # already happened at the connection level.
+          current_runtime_state = Thread.current[:__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?
+          @object.nodes
+        end
       end
     end
   end

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

@@ -8,10 +8,38 @@ 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.node_nullable(true)
+          child_class.default_broadcastable(nil)
+        end
+
+        def node
+          current_runtime_state = Thread.current[:__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?
+          @object.node
         end
 
         module ClassMethods
+          def inherited(child_class)
+            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
@@ -40,10 +68,6 @@ module GraphQL
             true
           end
 
-          def accessible?(ctx)
-            node_type.accessible?(ctx)
-          end
-
           def visible?(ctx)
             node_type.visible?(ctx)
           end
@@ -52,11 +76,15 @@ module GraphQL
           # Use `node_nullable(false)` in your base class to make non-null `node` field.
           def node_nullable(new_value = nil)
             if new_value.nil?
-              defined?(@node_nullable) ? @node_nullable : superclass.node_nullable
+              @node_nullable != nil ? @node_nullable : superclass.node_nullable
             else
               @node_nullable = new_value
             end
           end
+
+          protected
+
+          attr_writer :node_type, :node_nullable
         end
       end
     end

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

@@ -5,13 +5,19 @@ module GraphQL
     module Relay
       module NodeBehaviors
         def self.included(child_module)
-          child_module.extend(DefaultRelay)
+          child_module.extend(ClassMethods)
           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)
         end
 
         def default_global_id
-          context.schema.id_from_object(object, self, context)
+          context.schema.id_from_object(object, self.class, context)
+        end
+
+        module ClassMethods
+          def default_relay?
+            true
+          end
         end
       end
     end

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

@@ -4,8 +4,7 @@ module GraphQL
     module Relay
       module PageInfoBehaviors
         def self.included(child_class)
-          child_class.extend GraphQL::Types::Relay::DefaultRelay
-
+          child_class.extend ClassMethods
           child_class.description "Information about pagination in a connection."
           child_class.field :has_next_page, Boolean, null: false,
             description: "When paginating forwards, are there more items?"
@@ -20,6 +19,16 @@ module GraphQL
             description: "When paginating forwards, the cursor to continue."
         end
       end
+
+      module ClassMethods
+        def default_relay?
+          true
+        end
+
+        def default_broadcastable?
+          true
+        end
+      end
     end
   end
 end

data/lib/graphql/types/relay.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 # behavior modules:
-require "graphql/types/relay/default_relay"
 require "graphql/types/relay/connection_behaviors"
 require "graphql/types/relay/edge_behaviors"
 require "graphql/types/relay/node_behaviors"

data/lib/graphql/types/string.rb

@@ -7,7 +7,7 @@ module GraphQL
 
       def self.coerce_result(value, ctx)
         str = value.to_s
-        if str.encoding == Encoding::UTF_8
+        if str.encoding == Encoding::UTF_8 || str.ascii_only?
           str
         elsif str.frozen?
           str.encode(Encoding::UTF_8)

data/lib/graphql/types.rb

@@ -6,6 +6,7 @@ require "graphql/types/id"
 require "graphql/types/int"
 require "graphql/types/iso_8601_date"
 require "graphql/types/iso_8601_date_time"
+require "graphql/types/iso_8601_duration"
 require "graphql/types/json"
 require "graphql/types/string"
 require "graphql/types/relay"

data/lib/graphql/version.rb

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