graphql 1.12.12 → 2.4.8

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)
@@ -54,7 +55,17 @@ module GraphQL
         Time.iso8601(str_value)
       rescue ArgumentError, TypeError
         begin
-          Date.iso8601(str_value).to_time
+          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

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

@@ -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,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
 
@@ -35,7 +63,8 @@ module GraphQL
           # 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: self.has_nodes_field, node_nullable: self.node_nullable, edges_nullable: self.edges_nullable, edge_nullable: self.edge_nullable)
+          # @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::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
 
@@ -43,13 +72,22 @@ module GraphQL
             @edge_type = edge_type_class
             @edge_class = edge_class
 
-            field :edges, [edge_type_class, null: edge_nullable],
+            base_field_options = {
+              name: :edges,
+              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
+              scope: false, # Assume that the connection was already scoped.
+              connection: false,
+            }
+
+            if field_options
+              base_field_options.merge!(field_options)
+            end
+
+            field(**base_field_options)
 
-            define_nodes_field(node_nullable) if nodes_field
+            define_nodes_field(node_nullable, field_options: field_options) if nodes_field
 
             description("The connection type for #{node_type_name}.")
           end
@@ -59,21 +97,31 @@ 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)
-            define_nodes_field(node_nullable)
+          def nodes_field(node_nullable: self.node_nullable, field_options: nil)
+            define_nodes_field(node_nullable, field_options: field_options)
           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)
+            # if this is an abstract base class, there may be no `node_type`
+            node_type ? node_type.visible?(ctx) : super
           end
 
           # Set the default `node_nullable` for this class and its child classes. (Defaults to `true`.)
@@ -116,13 +164,26 @@ module GraphQL
             end
           end
 
+          protected
+
+          attr_writer :edge_type, :node_type,  :edge_class
+
           private
 
-          def define_nodes_field(nullable)
-            field :nodes, [@node_type, null: nullable],
+          def define_nodes_field(nullable, field_options: nil)
+            base_field_options = {
+              name: :nodes,
+              type: [@node_type, null: nullable],
               null: nullable,
               description: "A list of nodes.",
-              connection: false
+              connection: false,
+              # Assume that the connection was scoped before this step:
+              scope: false,
+            }
+            if field_options
+              base_field_options.merge!(field_options)
+            end
+            field(**base_field_options)
           end
         end
 
@@ -132,23 +193,22 @@ module GraphQL
           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
+        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?
+          @object.edges
         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
+        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?
+          @object.nodes
         end
       end
     end

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

@@ -8,19 +8,58 @@ 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 = 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?
+          @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
           # @param null [Boolean]
-          def node_type(node_type = nil, null: self.node_nullable)
+          # @param field_options [Hash] Any extra arguments to pass to the `field :node` configuration
+          def node_type(node_type = nil, null: self.node_nullable, field_options: nil)
             if node_type
               @node_type = node_type
               # Add a default `node` field
-              field :node, node_type, null: null, description: "The item at the end of the edge.", connection: false
+              base_field_options = {
+                name: :node,
+                type: node_type,
+                null: null,
+                description: "The item at the end of the edge.",
+                connection: false,
+              }
+              if field_options
+                base_field_options.merge!(field_options)
+              end
+              field(**base_field_options)
             end
             @node_type
           end
@@ -29,10 +68,6 @@ module GraphQL
             true
           end
 
-          def accessible?(ctx)
-            node_type.accessible?(ctx)
-          end
-
           def visible?(ctx)
             node_type.visible?(ctx)
           end
@@ -41,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/has_node_field.rb

@@ -3,6 +3,7 @@
 module GraphQL
   module Types
     module Relay
+      # Include this module to your root Query type to get a Relay-compliant `node(id: ID!): Node` field that uses the schema's `object_from_id` hook.
       module HasNodeField
         def self.included(child_class)
           child_class.field(**field_options, &field_block)
@@ -12,7 +13,6 @@ module GraphQL
           def field_options
             {
               name: "node",
-              owner: nil,
               type: GraphQL::Types::Relay::Node,
               null: true,
               description: "Fetches an object given its ID.",
@@ -22,7 +22,7 @@ module GraphQL
 
           def field_block
             Proc.new {
-              argument :id, "ID!", required: true,
+              argument :id, "ID!",
                 description: "ID of the object."
 
               def resolve(obj, args, ctx)

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

@@ -3,6 +3,7 @@
 module GraphQL
   module Types
     module Relay
+      # Include this module to your root Query type to get a Relay-style `nodes(id: ID!): [Node]` field that uses the schema's `object_from_id` hook.
       module HasNodesField
         def self.included(child_class)
           child_class.field(**field_options, &field_block)
@@ -12,7 +13,6 @@ module GraphQL
           def field_options
             {
               name: "nodes",
-              owner: nil,
               type: [GraphQL::Types::Relay::Node, null: true],
               null: false,
               description: "Fetches a list of objects given a list of IDs.",
@@ -22,7 +22,7 @@ module GraphQL
 
           def field_block
             Proc.new {
-              argument :ids, "[ID!]!", required: true,
+              argument :ids, "[ID!]!",
                 description: "IDs of the objects."
 
               def resolve(obj, args, ctx)

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,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"
@@ -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)
@@ -15,7 +15,7 @@ module GraphQL
           str.encode!(Encoding::UTF_8)
         end
       rescue EncodingError
-        err = GraphQL::StringEncodingError.new(str)
+        err = GraphQL::StringEncodingError.new(str, context: ctx)
         ctx.schema.type_error(err, ctx)
       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

@@ -12,7 +12,7 @@ module GraphQL
     attr_reader :type
 
     # @return [GraphQL::Query::Context] the context for the current query
-    attr_reader :context
+    attr_accessor :context
 
     def initialize(message = nil, object: nil, type: nil, context: nil)
       if message.nil? && object.nil? && type.nil?

data/lib/graphql/version.rb

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