graphql 1.13.12 → 2.0.21

data/lib/graphql/tracing/trace.rb

@@ -0,0 +1,75 @@
+# 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
+
+      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,8 @@
 # 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"
@@ -6,55 +10,27 @@ 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/skylight_tracing"
 require "graphql/tracing/statsd_tracing"
 require "graphql/tracing/prometheus_tracing"
 
+# New Tracing:
+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
-  # 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,12 +5,13 @@ 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
@@ -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_date.rb

@@ -14,6 +14,7 @@ module GraphQL
     # own Date type.
     class ISO8601Date < GraphQL::Schema::Scalar
       description "An ISO 8601-encoded date"
+      specified_by_url "https://tools.ietf.org/html/rfc3339"
 
       # @param value [Date,Time,DateTime,String]
       # @return [String]
@@ -22,7 +23,7 @@ module GraphQL
       end
 
       # @param str_value [String, Date, DateTime, Time]
-      # @return [Date]
+      # @return [Date, nil]
       def self.coerce_input(value, ctx)
         if value.is_a?(::Date)
           value
@@ -30,6 +31,8 @@ module GraphQL
           value.to_date
         elsif value.is_a?(::Time)
           value.to_date
+        elsif value.nil?
+          nil
         else
           Date.iso8601(value)
         end

data/lib/graphql/types/iso_8601_date_time.rb

@@ -17,6 +17,7 @@ module GraphQL
     # own DateTime type.
     class ISO8601DateTime < GraphQL::Schema::Scalar
       description "An ISO 8601-encoded datetime"
+      specified_by_url "https://tools.ietf.org/html/rfc3339"
 
       # It's not compatible with Rails' default,
       # i.e. ActiveSupport::JSON::Encoder.time_precision (3 by default)
@@ -59,6 +60,9 @@ module GraphQL
           # But without this, it would zero out given any time part of `str_value` (hours and/or minutes)
           if dt.iso8601.start_with?(str_value)
             dt
+          elsif str_value.length == 8 && str_value.match?(/\A\d{8}\Z/)
+            # Allow dates that are missing the "-". eg. "20220404"
+            dt
           else
             nil
           end

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

@@ -10,6 +10,8 @@ module GraphQL
       # so you can extend your own `BaseObject` instead of `GraphQL::Schema::Object`.
       #
       # @example Implementation a connection and edge
+      #   class BaseObject < GraphQL::Schema::Object; end
+      #
       #   # Given some object in your app ...
       #   class Types::Post < BaseObject
       #   end
@@ -20,14 +22,22 @@ module GraphQL
       #
       #   # Then extend them for the object in your app
       #   class Types::PostEdge < Types::BaseEdge
-      #     node_type(Types::Post)
+      #     node_type Types::Post
       #   end
+      #
       #   class Types::PostConnection < Types::BaseConnection
-      #     edge_type(Types::PostEdge)
-      #     edges_nullable(true)
-      #     edge_nullable(true)
-      #     node_nullable(true)
-      #     has_nodes_field(true)
+      #     edge_type Types::PostEdge,
+      #               edges_nullable: true,
+      #               edge_nullable: true,
+      #               node_nullable: true,
+      #               nodes_field: true
+      #
+      #     # Alternatively, you can call the class methods followed by your edge type
+      #     # edges_nullable true
+      #     # edge_nullable true
+      #     # node_nullable true
+      #     # has_nodes_field true
+      #     # edge_type Types::PostEdge
       #   end
       #
       # @see Relay::BaseEdge for edge types

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

@@ -9,16 +9,34 @@ 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
+          }
           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
+          end
+
+          def default_relay?
+            true
+          end
+
           # @return [Class]
           attr_reader :node_type
 
@@ -36,7 +54,7 @@ module GraphQL
           # class name to set defaults. You can call it again in the class definition
           # to override the default (or provide a value, if the default lookup failed).
           # @param field_options [Hash] Any extra keyword arguments to pass to the `field :edges, ...` and `field :nodes, ...` configurations
-          def edge_type(edge_type_class, edge_class: GraphQL::Relay::Edge, node_type: edge_type_class.node_type, nodes_field: self.has_nodes_field, node_nullable: self.node_nullable, edges_nullable: self.edges_nullable, edge_nullable: self.edge_nullable, field_options: nil)
+          def edge_type(edge_type_class, edge_class: GraphQL::Pagination::Connection::Edge, node_type: edge_type_class.node_type, nodes_field: self.has_nodes_field, node_nullable: self.node_nullable, edges_nullable: self.edges_nullable, edge_nullable: self.edge_nullable, field_options: nil)
             # Set this connection's graphql name
             node_type_name = node_type.graphql_name
 
@@ -49,8 +67,9 @@ module GraphQL
               type: [edge_type_class, null: edge_nullable],
               null: edges_nullable,
               description: "A list of edges.",
-              legacy_edge_class: edge_class, # This is used by the old runtime only, for EdgesInstrumentation
               connection: false,
+              # Assume that the connection was scoped before this step:
+              scope: false,
             }
 
             if field_options
@@ -78,10 +97,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
@@ -127,6 +142,10 @@ module GraphQL
             end
           end
 
+          protected
+
+          attr_writer :edge_type, :node_type,  :edge_class
+
           private
 
           def define_nodes_field(nullable, field_options: nil)
@@ -136,6 +155,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)
@@ -149,25 +170,6 @@ module GraphQL
             obj_type.field :page_info, GraphQL::Types::Relay::PageInfo, null: false, description: "Information to aid in pagination."
           end
         end
-
-        # By default this calls through to the ConnectionWrapper's edge nodes method,
-        # but sometimes you need to override it to support the `nodes` field
-        def nodes
-          @object.edge_nodes
-        end
-
-        def edges
-          if @object.is_a?(GraphQL::Pagination::Connection)
-            @object.edges
-          elsif context.interpreter?
-            context.schema.after_lazy(object.edge_nodes) do |nodes|
-              nodes.map { |n| self.class.edge_class.new(n, object) }
-            end
-          else
-            # This is done by edges_instrumentation
-            @object.edge_nodes
-          end
-        end
       end
     end
   end

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

@@ -8,10 +8,21 @@ 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)
         end
 
         module ClassMethods
+          def inherited(child_class)
+            super
+            child_class.node_type = nil
+            child_class.node_nullable = nil
+          end
+
+          def default_relay?
+            true
+          end
+
           # Get or set the Object type that this edge wraps.
           #
           # @param node_type [Class] A `Schema::Object` subclass
@@ -40,10 +51,6 @@ module GraphQL
             true
           end
 
-          def accessible?(ctx)
-            node_type.accessible?(ctx)
-          end
-
           def visible?(ctx)
             node_type.visible?(ctx)
           end
@@ -52,11 +59,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,9 +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.")
+          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.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,12 @@ module GraphQL
             description: "When paginating forwards, the cursor to continue."
         end
       end
+
+      module ClassMethods
+        def default_relay?
+          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"
@@ -14,8 +13,6 @@ require "graphql/types/relay/page_info"
 require "graphql/types/relay/base_connection"
 require "graphql/types/relay/base_edge"
 require "graphql/types/relay/node"
-require "graphql/types/relay/node_field"
-require "graphql/types/relay/nodes_field"
 
 module GraphQL
   module Types

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

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

data/lib/graphql.rb

@@ -42,8 +42,8 @@ This is probably a bug in GraphQL-Ruby, please report this error on GitHub: http
   # Turn a query string or schema definition into an AST
   # @param graphql_string [String] a GraphQL query string or schema definition
   # @return [GraphQL::Language::Nodes::Document]
-  def self.parse(graphql_string, tracer: GraphQL::Tracing::NullTracer)
-    parse_with_racc(graphql_string, tracer: tracer)
+  def self.parse(graphql_string, trace: GraphQL::Tracing::NullTrace)
+    default_parser.parse(graphql_string, trace: trace)
   end
 
   # Read the contents of `filename` and parse them as GraphQL
@@ -51,21 +51,28 @@ This is probably a bug in GraphQL-Ruby, please report this error on GitHub: http
   # @return [GraphQL::Language::Nodes::Document]
   def self.parse_file(filename)
     content = File.read(filename)
-    parse_with_racc(content, filename: filename)
+    default_parser.parse(content, filename: filename)
   end
 
-  def self.parse_with_racc(string, filename: nil, tracer: GraphQL::Tracing::NullTracer)
-    GraphQL::Language::Parser.parse(string, filename: filename, tracer: tracer)
+  # @return [Array<Array>]
+  def self.scan(graphql_string)
+    default_parser.scan(graphql_string)
   end
 
-  # @return [Array<GraphQL::Language::Token>]
-  def self.scan(graphql_string)
-    scan_with_ragel(graphql_string)
+  def self.parse_with_racc(string, filename: nil, trace: GraphQL::Tracing::NullTrace)
+    GraphQL::Language::Parser.parse(string, filename: filename, trace: trace)
   end
 
-  def self.scan_with_ragel(graphql_string)
+  def self.scan_with_ruby(graphql_string)
     GraphQL::Language::Lexer.tokenize(graphql_string)
   end
+
+  NOT_CONFIGURED = Object.new
+  private_constant :NOT_CONFIGURED
+  module EmptyObjects
+    EMPTY_HASH = {}.freeze
+    EMPTY_ARRAY = [].freeze
+  end
 end
 
 # Order matters for these:
@@ -81,27 +88,8 @@ require "graphql/integer_decoding_error"
 require "graphql/integer_encoding_error"
 require "graphql/string_encoding_error"
 require "graphql/date_encoding_error"
-
-require "graphql/define"
-require "graphql/deprecation"
-require "graphql/base_type"
-require "graphql/object_type"
-require "graphql/enum_type"
-require "graphql/input_object_type"
-require "graphql/interface_type"
-require "graphql/list_type"
-require "graphql/non_null_type"
-require "graphql/union_type"
-
-require "graphql/argument"
-require "graphql/field"
 require "graphql/type_kinds"
-
-require "graphql/backwards_compatibility"
-require "graphql/scalar_type"
-
 require "graphql/name_validator"
-
 require "graphql/language"
 
 require_relative "./graphql/railtie" if defined? Rails::Railtie
@@ -116,15 +104,8 @@ require "graphql/query"
 require "graphql/types"
 require "graphql/dataloader"
 require "graphql/filter"
-require "graphql/internal_representation"
-require "graphql/directive"
 require "graphql/static_validation"
 require "graphql/execution"
-require "graphql/boolean_type"
-require "graphql/float_type"
-require "graphql/id_type"
-require "graphql/int_type"
-require "graphql/string_type"
 require "graphql/schema/built_in_types"
 require "graphql/schema/loader"
 require "graphql/schema/printer"
@@ -132,49 +113,11 @@ require "graphql/introspection"
 require "graphql/relay"
 
 require "graphql/version"
-require "graphql/compatibility"
-require "graphql/function"
 require "graphql/subscriptions"
 require "graphql/parse_error"
 require "graphql/backtrace"
 
-require "graphql/deprecated_dsl"
-require "graphql/authorization"
 require "graphql/unauthorized_error"
 require "graphql/unauthorized_field_error"
 require "graphql/load_application_object_failed_error"
-require "graphql/directive/include_directive"
-require "graphql/directive/skip_directive"
-require "graphql/directive/deprecated_directive"
-
-module GraphQL
-  # Ruby has `deprecate_constant`,
-  # but I don't see a way to give a nice error message in that case,
-  # so I'm doing this instead.
-  DEPRECATED_INT_TYPE = INT_TYPE
-  DEPRECATED_FLOAT_TYPE = FLOAT_TYPE
-  DEPRECATED_STRING_TYPE = STRING_TYPE
-  DEPRECATED_BOOLEAN_TYPE = BOOLEAN_TYPE
-  DEPRECATED_ID_TYPE = ID_TYPE
-
-  remove_const :INT_TYPE
-  remove_const :FLOAT_TYPE
-  remove_const :STRING_TYPE
-  remove_const :BOOLEAN_TYPE
-  remove_const :ID_TYPE
-
-  def self.const_missing(const_name)
-    deprecated_const_name = :"DEPRECATED_#{const_name}"
-    if const_defined?(deprecated_const_name)
-      deprecated_type = const_get(deprecated_const_name)
-      deprecated_caller = caller(1, 1).first
-      # Don't warn about internal uses, like `types.Int`
-      if !deprecated_caller.include?("lib/graphql")
-        warn "GraphQL::#{const_name} is deprecated and will be removed in GraphQL-Ruby 2.0, use GraphQL::Types::#{deprecated_type.graphql_name} instead. (from #{deprecated_caller})"
-      end
-      deprecated_type
-    else
-      super
-    end
-  end
-end
+require "graphql/deprecation"