graphql 1.9.0 → 2.1.1

data/lib/graphql/tracing.rb

@@ -1,56 +1,37 @@
 # 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/skylight_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
-  # Library entry point for performance metric reporting.
-  #
-  # __Warning:__ Installing/uninstalling tracers is not thread-safe. Do it during application boot only.
-  #
-  # @example Sending custom events
-  #   GraphQL::Tracing.trace("my_custom_event", { ... }) do
-  #     # do stuff ...
-  #   end
-  #
-  # @example Adding a tracer to a schema
-  #  MySchema = GraphQL::Schema.define do
-  #    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 | `{ context: GraphQL::Query::Context::FieldResolutionContext?, field: GraphQL::Schema::Field?, path: Array<String, Integer>?}`
-  # execute_field_lazy | `{ context: GraphQL::Query::Context::FieldResolutionContext?, field: GraphQL::Schema::Field?, 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:}`
-  # - 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
@@ -58,8 +39,9 @@ module GraphQL
       # @param key [String] The name of the event in GraphQL internals
       # @param metadata [Hash] Event-related metadata (can be anything)
       # @return [Object] Must return the value of the block
-      def trace(key, metadata)
-        call_tracers(0, key, metadata) { yield }
+      def trace(key, metadata, &block)
+        return yield if @tracers.empty?
+        call_tracers(0, key, metadata, &block)
       end
 
       private
@@ -71,39 +53,14 @@ module GraphQL
       # @param key [String] The current event name
       # @param metadata [Object] The current event object
       # @return Whatever the block returns
-      def call_tracers(idx, key, metadata)
+      def call_tracers(idx, key, metadata, &block)
         if idx == @tracers.length
           yield
         else
-          @tracers[idx].trace(key, metadata) { call_tracers(idx + 1, key, metadata) { yield } }
-        end
-      end
-    end
-
-    class << self
-      # Install a tracer to receive events.
-      # @param tracer [<#trace(key, metadata)>]
-      # @return [void]
-      # @deprecated See {Schema#tracer} or use `context: { tracers: [...] }`
-      def install(tracer)
-        warn("GraphQL::Tracing.install is deprecated, add it to the schema with `tracer(my_tracer)` instead.")
-        if !tracers.include?(tracer)
-          @tracers << tracer
+          @tracers[idx].trace(key, metadata) { call_tracers(idx + 1, key, metadata, &block) }
         end
       end
-
-      # @deprecated See {Schema#tracer} or use `context: { tracers: [...] }`
-      def uninstall(tracer)
-        @tracers.delete(tracer)
-      end
-
-      # @deprecated See {Schema#tracer} or use `context: { tracers: [...] }`
-      def tracers
-        @tracers ||= []
-      end
     end
-    # Initialize the array
-    tracers
 
     module NullTracer
       module_function

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Types
+    class BigInt < GraphQL::Schema::Scalar
+      description "Represents non-fractional signed whole numeric values. Since the value may exceed the size of a 32-bit integer, it's encoded as a string."
+
+      def self.coerce_input(value, _ctx)
+        value && parse_int(value)
+      rescue ArgumentError
+        nil
+      end
+
+      def self.coerce_result(value, _ctx)
+        value.to_i.to_s
+      end
+
+      def self.parse_int(value)
+        value.is_a?(Numeric) ? value : Integer(value, 10)
+      end
+    end
+  end
+end

data/lib/graphql/types/int.rb

@@ -2,14 +2,22 @@
 
 module GraphQL
   module Types
+    # @see {Types::BigInt} for handling integers outside 32-bit range.
     class Int < GraphQL::Schema::Scalar
       description "Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1."
 
       MIN = -(2**31)
       MAX = (2**31) - 1
 
-      def self.coerce_input(value, _ctx)
-        value.is_a?(Numeric) ? value.to_i : nil
+      def self.coerce_input(value, ctx)
+        return if !value.is_a?(Integer)
+
+        if value >= MIN && value <= MAX
+          value
+        else
+          err = GraphQL::IntegerDecodingError.new(value)
+          ctx.schema.type_error(err, ctx)
+        end
       end
 
       def self.coerce_result(value, ctx)
@@ -17,7 +25,7 @@ module GraphQL
         if value >= MIN && value <= MAX
           value
         else
-          err = GraphQL::IntegerEncodingError.new(value)
+          err = GraphQL::IntegerEncodingError.new(value, context: ctx)
           ctx.schema.type_error(err, ctx)
         end
       end

data/lib/graphql/types/iso_8601_date.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+module GraphQL
+  module Types
+    # This scalar takes `Date`s and transmits them as strings,
+    # using ISO 8601 format.
+    #
+    # Use it for fields or arguments as follows:
+    #
+    #     field :published_at, GraphQL::Types::ISO8601Date, null: false
+    #
+    #     argument :deliver_at, GraphQL::Types::ISO8601Date, null: false
+    #
+    # Alternatively, use this built-in scalar as inspiration for your
+    # 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]
+      def self.coerce_result(value, _ctx)
+        Date.parse(value.to_s).iso8601
+      end
+
+      # @param str_value [String, Date, DateTime, Time]
+      # @return [Date, nil]
+      def self.coerce_input(value, ctx)
+        if value.is_a?(::Date)
+          value
+        elsif value.is_a?(::DateTime)
+          value.to_date
+        elsif value.is_a?(::Time)
+          value.to_date
+        elsif value.nil?
+          nil
+        else
+          Date.iso8601(value)
+        end
+      rescue ArgumentError, TypeError
+        err = GraphQL::DateEncodingError.new(value)
+        ctx.schema.type_error(err, ctx)
+      end
+    end
+  end
+end

data/lib/graphql/types/iso_8601_date_time.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+
+require 'time'
+
 module GraphQL
   module Types
-    # This scalar takes `DateTime`s and transmits them as strings,
+    # This scalar takes `Time`s and transmits them as strings,
     # using ISO 8601 format.
     #
     # Use it for fields or arguments as follows:
@@ -14,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)
@@ -29,19 +33,43 @@ module GraphQL
         @time_precision = value
       end
 
-      # @param value [DateTime]
+      # @param value [Time,Date,DateTime,String]
       # @return [String]
       def self.coerce_result(value, _ctx)
-        value.iso8601(time_precision)
+        case value
+        when Date
+          return value.to_time.iso8601(time_precision)
+        when ::String
+          return Time.parse(value).iso8601(time_precision)
+        else
+          # Time, DateTime or compatible is given:
+          return value.iso8601(time_precision)
+        end
+      rescue StandardError => error
+        raise GraphQL::Error, "An incompatible object (#{value.class}) was given to #{self}. Make sure that only Times, Dates, DateTimes, and well-formatted Strings are used with this type. (#{error.message})"
       end
 
       # @param str_value [String]
-      # @return [DateTime]
+      # @return [Time]
       def self.coerce_input(str_value, _ctx)
-        DateTime.iso8601(str_value)
-      rescue ArgumentError
-        # Invalid input
-        nil
+        Time.iso8601(str_value)
+      rescue ArgumentError, TypeError
+        begin
+          dt = Date.iso8601(str_value).to_time
+          # For compatibility, continue accepting dates given without times
+          # 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
+        rescue ArgumentError, TypeError
+          # Invalid input
+          nil
+        end
       end
     end
   end

data/lib/graphql/types/json.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module GraphQL
+  module Types
+    # An untyped JSON scalar that maps to Ruby hashes, arrays, strings, integers, floats, booleans and nils.
+    # This should be used judiciously because it subverts the GraphQL type system.
+    #
+    # Use it for fields or arguments as follows:
+    #
+    #     field :template_parameters, GraphQL::Types::JSON, null: false
+    #
+    #     argument :template_parameters, GraphQL::Types::JSON, null: false
+    #
+    class JSON < GraphQL::Schema::Scalar
+      description "Represents untyped JSON"
+
+      def self.coerce_input(value, _context)
+        value
+      end
+
+      def self.coerce_result(value, _context)
+        value
+      end
+    end
+  end
+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,101 +22,27 @@ 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)
+      #     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
-      class BaseConnection < Types::Relay::BaseObject
-        extend Forwardable
-        def_delegators :@object, :cursor_from_node, :parent
-
-        class << self
-          # @return [Class]
-          attr_reader :node_type
-
-          # @return [Class]
-          attr_reader :edge_class
-
-          # Configure this connection to return `edges` and `nodes` based on `edge_type_class`.
-          #
-          # This method will use the inputs to create:
-          # - `edges` field
-          # - `nodes` field
-          # - description
-          #
-          # It's called when you subclass this base connection, trying to use the
-          # 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).
-          def edge_type(edge_type_class, edge_class: GraphQL::Relay::Edge, node_type: edge_type_class.node_type, nodes_field: true)
-            # Set this connection's graphql name
-            node_type_name = node_type.graphql_name
-
-            @node_type = node_type
-            @edge_type = edge_type_class
-            @edge_class = edge_class
-
-            field :edges, [edge_type_class, null: true],
-              null: true,
-              description: "A list of edges.",
-              edge_class: edge_class
-
-            define_nodes_field if nodes_field
-
-            description("The connection type for #{node_type_name}.")
-          end
-
-          # Filter this list according to the way its node type would scope them
-          def scope_items(items, context)
-            node_type.scope_items(items, context)
-          end
-
-          # Add the shortcut `nodes` field to this connection and its subclasses
-          def nodes_field
-            define_nodes_field
-          end
-
-          def authorized?(obj, ctx)
-            true # Let nodes be filtered out
-          end
-
-          def accessible?(ctx)
-            node_type.accessible?(ctx)
-          end
-
-          def visible?(ctx)
-            node_type.visible?(ctx)
-          end
-
-          private
-
-          def define_nodes_field
-            field :nodes, [@node_type, null: true],
-              null: true,
-              description: "A list of nodes."
-          end
-        end
-
-        field :page_info, GraphQL::Types::Relay::PageInfo, null: false, description: "Information to aid in pagination."
-
-        # 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 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
+      class BaseConnection < Schema::Object
+        include ConnectionBehaviors
       end
     end
   end

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

@@ -21,42 +21,8 @@ module GraphQL
       #   end
       #
       # @see {Relay::BaseConnection} for connection types
-      class BaseEdge < Types::Relay::BaseObject
-        description "An edge in a connection."
-
-        class << self
-          # Get or set the Object type that this edge wraps.
-          #
-          # @param node_type [Class] A `Schema::Object` subclass
-          def node_type(node_type = nil)
-            if node_type
-              @node_type = node_type
-              wrapped_type_name = node_type.graphql_name
-              # Set this to be named like the node type, but suffixed with `Edge`
-              graphql_name("#{wrapped_type_name}Edge")
-              # Add a default `node` field
-              field :node, node_type, null: true, description: "The item at the end of the edge."
-            end
-            @node_type
-          end
-
-          def authorized?(obj, ctx)
-            true
-          end
-
-          def accessible?(ctx)
-            node_type.accessible?(ctx)
-          end
-
-          def visible?(ctx)
-            node_type.visible?(ctx)
-          end
-        end
-
-
-        field :cursor, String,
-          null: false,
-          description: "A cursor for use in pagination."
+      class BaseEdge < GraphQL::Schema::Object
+        include Types::Relay::EdgeBehaviors
       end
     end
   end