graphql 1.8.0 → 1.12.12

data/lib/graphql/static_validation/rules/fields_are_defined_on_type.rb

@@ -1,30 +1,28 @@
 # frozen_string_literal: true
 module GraphQL
   module StaticValidation
-    class FieldsAreDefinedOnType
-      include GraphQL::StaticValidation::Message::MessageHelper
-
-      def validate(context)
-        visitor = context.visitor
-        visitor[GraphQL::Language::Nodes::Field] << ->(node, parent) {
-          parent_type = context.object_types[-2]
-          parent_type = parent_type.unwrap
-          validate_field(context, node, parent_type, parent)
-        }
-      end
-
-      private
-
-      def validate_field(context, ast_field, parent_type, parent)
-        field = context.warden.get_field(parent_type, ast_field.name)
+    module FieldsAreDefinedOnType
+      def on_field(node, parent)
+        parent_type = @object_types[-2]
+        field = context.warden.get_field(parent_type, node.name)
 
         if field.nil?
-          if  parent_type.kind.union?
-            context.errors << message("Selections can't be made directly on unions (see selections on #{parent_type.name})", parent, context: context)
+          if parent_type.kind.union?
+            add_error(GraphQL::StaticValidation::FieldsHaveAppropriateSelectionsError.new(
+              "Selections can't be made directly on unions (see selections on #{parent_type.graphql_name})",
+              nodes: parent,
+              node_name: parent_type.graphql_name
+            ))
           else
-            context.errors << message("Field '#{ast_field.name}' doesn't exist on type '#{parent_type.name}'", ast_field, context: context)
+            add_error(GraphQL::StaticValidation::FieldsAreDefinedOnTypeError.new(
+              "Field '#{node.name}' doesn't exist on type '#{parent_type.graphql_name}'",
+              nodes: node,
+              field: node.name,
+              type: parent_type.graphql_name
+            ))
           end
-          return GraphQL::Language::Visitor::SKIP
+        else
+          super
         end
       end
     end

data/lib/graphql/static_validation/rules/fields_are_defined_on_type_error.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module GraphQL
+  module StaticValidation
+    class FieldsAreDefinedOnTypeError < StaticValidation::Error
+      attr_reader :type_name
+      attr_reader :field_name
+
+      def initialize(message, path: nil, nodes: [], type:, field:)
+        super(message, path: path, nodes: nodes)
+        @type_name = type
+        @field_name = field
+      end
+
+      # A hash representation of this Message
+      def to_h
+        extensions = {
+          "code" => code,
+          "typeName" => type_name,
+          "fieldName" => field_name
+        }
+
+        super.merge({
+          "extensions" => extensions
+        })
+      end
+
+      def code
+        "undefinedField"
+      end
+    end
+  end
+end

data/lib/graphql/static_validation/rules/fields_have_appropriate_selections.rb

@@ -3,34 +3,36 @@ module GraphQL
   module StaticValidation
     # Scalars _can't_ have selections
     # Objects _must_ have selections
-    class FieldsHaveAppropriateSelections
-      include GraphQL::StaticValidation::Message::MessageHelper
+    module FieldsHaveAppropriateSelections
+      include GraphQL::StaticValidation::Error::ErrorHelper
 
-      def validate(context)
-        context.visitor[GraphQL::Language::Nodes::Field] << ->(node, parent)  {
-          field_defn = context.field_definition
-          validate_field_selections(node, field_defn.type.unwrap, context)
-        }
+      def on_field(node, parent)
+        field_defn = field_definition
+        if validate_field_selections(node, field_defn.type.unwrap)
+          super
+        end
+      end
 
-        context.visitor[GraphQL::Language::Nodes::OperationDefinition] << ->(node, parent)  {
-          validate_field_selections(node, context.type_definition, context)
-        }
+      def on_operation_definition(node, _parent)
+        if validate_field_selections(node, type_definition)
+          super
+        end
       end
 
       private
 
 
-      def validate_field_selections(ast_node, resolved_type, context)
+      def validate_field_selections(ast_node, resolved_type)
         msg = if resolved_type.nil?
           nil
         elsif resolved_type.kind.scalar? && ast_node.selections.any?
           if ast_node.selections.first.is_a?(GraphQL::Language::Nodes::InlineFragment)
-            "Selections can't be made on scalars (%{node_name} returns #{resolved_type.name} but has inline fragments [#{ast_node.selections.map(&:type).map(&:name).join(", ")}])"
+            "Selections can't be made on scalars (%{node_name} returns #{resolved_type.graphql_name} but has inline fragments [#{ast_node.selections.map(&:type).map(&:name).join(", ")}])"
           else
-            "Selections can't be made on scalars (%{node_name} returns #{resolved_type.name} but has selections [#{ast_node.selections.map(&:name).join(", ")}])"
+            "Selections can't be made on scalars (%{node_name} returns #{resolved_type.graphql_name} but has selections [#{ast_node.selections.map(&:name).join(", ")}])"
           end
-        elsif resolved_type.kind.object? && ast_node.selections.none?
-          "Objects must have selections (%{node_name} returns #{resolved_type.name} but has no selections)"
+        elsif resolved_type.kind.fields? && ast_node.selections.empty?
+          "Field must have selections (%{node_name} returns #{resolved_type.graphql_name} but has no selections. Did you mean '#{ast_node.name} { ... }'?)"
         else
           nil
         end
@@ -48,8 +50,22 @@ module GraphQL
           else
             raise("Unexpected node #{ast_node}")
           end
-          context.errors << message(msg % { node_name: node_name }, ast_node, context: context)
-          GraphQL::Language::Visitor::SKIP
+          extensions = {
+            "rule": "StaticValidation::FieldsHaveAppropriateSelections",
+            "name": node_name.to_s
+          }
+          unless resolved_type.nil?
+            extensions["type"] = resolved_type.to_type_signature
+          end
+          add_error(GraphQL::StaticValidation::FieldsHaveAppropriateSelectionsError.new(
+            msg % { node_name: node_name },
+            nodes: ast_node,
+            node_name: node_name.to_s,
+            type: resolved_type.nil? ? nil : resolved_type.graphql_name,
+          ))
+          false
+        else
+          true
         end
       end
     end

data/lib/graphql/static_validation/rules/fields_have_appropriate_selections_error.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module GraphQL
+  module StaticValidation
+    class FieldsHaveAppropriateSelectionsError < StaticValidation::Error
+      attr_reader :type_name
+      attr_reader :node_name
+
+      def initialize(message, path: nil, nodes: [], node_name:, type: nil)
+        super(message, path: path, nodes: nodes)
+        @node_name = node_name
+        @type_name = type
+      end
+
+      # A hash representation of this Message
+      def to_h
+        extensions = {
+          "code" => code,
+          "nodeName" => node_name
+        }.tap { |h| h["typeName"] = type_name unless type_name.nil? }
+
+        super.merge({
+          "extensions" => extensions
+        })
+      end
+
+      def code
+        "selectionMismatch"
+      end
+    end
+  end
+end

data/lib/graphql/static_validation/rules/fields_will_merge.rb

@@ -1,46 +1,397 @@
+ # frozen_string_literal: true
+
 # frozen_string_literal: true
 module GraphQL
   module StaticValidation
-    class FieldsWillMerge
-      # Special handling for fields without arguments
+    module FieldsWillMerge
+      # Validates that a selection set is valid if all fields (including spreading any
+      # fragments) either correspond to distinct response names or can be merged
+      # without ambiguity.
+      #
+      # Original Algorithm: https://github.com/graphql/graphql-js/blob/master/src/validation/rules/OverlappingFieldsCanBeMerged.js
       NO_ARGS = {}.freeze
+      Field = Struct.new(:node, :definition, :owner_type, :parents)
+      FragmentSpread = Struct.new(:name, :parents)
+
+      def initialize(*)
+        super
+        @visited_fragments = {}
+        @compared_fragments = {}
+      end
+
+      def on_operation_definition(node, _parent)
+        conflicts_within_selection_set(node, type_definition)
+        super
+      end
+
+      def on_field(node, _parent)
+        conflicts_within_selection_set(node, type_definition)
+        super
+      end
+
+      private
+
+      def conflicts_within_selection_set(node, parent_type)
+        return if parent_type.nil?
+
+        fields, fragment_spreads = fields_and_fragments_from_selection(node, owner_type: parent_type, parents: [])
+
+        # (A) Find find all conflicts "within" the fields of this selection set.
+        find_conflicts_within(fields)
+
+        fragment_spreads.each_with_index do |fragment_spread, i|
+          are_mutually_exclusive = mutually_exclusive?(
+            fragment_spread.parents,
+            [parent_type]
+          )
+
+          # (B) Then find conflicts between these fields and those represented by
+          # each spread fragment name found.
+          find_conflicts_between_fields_and_fragment(
+            fragment_spread,
+            fields,
+            mutually_exclusive: are_mutually_exclusive,
+          )
+
+          # (C) Then compare this fragment with all other fragments found in this
+          # selection set to collect conflicts between fragments spread together.
+          # This compares each item in the list of fragment names to every other
+          # item in that same list (except for itself).
+          fragment_spreads[i + 1..-1].each do |fragment_spread2|
+            are_mutually_exclusive = mutually_exclusive?(
+              fragment_spread.parents,
+              fragment_spread2.parents
+            )
+
+            find_conflicts_between_fragments(
+              fragment_spread,
+              fragment_spread2,
+              mutually_exclusive: are_mutually_exclusive,
+            )
+          end
+        end
+      end
+
+      def find_conflicts_between_fragments(fragment_spread1, fragment_spread2, mutually_exclusive:)
+        fragment_name1 = fragment_spread1.name
+        fragment_name2 = fragment_spread2.name
+        return if fragment_name1 == fragment_name2
+
+        cache_key = compared_fragments_key(
+          fragment_name1,
+          fragment_name2,
+          mutually_exclusive,
+        )
+        if @compared_fragments.key?(cache_key)
+          return
+        else
+          @compared_fragments[cache_key] = true
+        end
+
+        fragment1 = context.fragments[fragment_name1]
+        fragment2 = context.fragments[fragment_name2]
+
+        return if fragment1.nil? || fragment2.nil?
 
-      def validate(context)
-        context.each_irep_node do |node|
-          if node.ast_nodes.size > 1
-            defn_names = Set.new(node.ast_nodes.map(&:name))
+        fragment_type1 = context.warden.get_type(fragment1.type.name)
+        fragment_type2 = context.warden.get_type(fragment2.type.name)
 
-            # Check for more than one GraphQL::Field backing this node:
-            if defn_names.size > 1
-              defn_names = defn_names.sort.join(" or ")
-              msg = "Field '#{node.name}' has a field conflict: #{defn_names}?"
-              context.errors << GraphQL::StaticValidation::Message.new(msg, nodes: node.ast_nodes.to_a)
+        return if fragment_type1.nil? || fragment_type2.nil?
+
+        fragment_fields1, fragment_spreads1 = fields_and_fragments_from_selection(
+          fragment1,
+          owner_type: fragment_type1,
+          parents: [*fragment_spread1.parents, fragment_type1]
+        )
+        fragment_fields2, fragment_spreads2 = fields_and_fragments_from_selection(
+          fragment2,
+          owner_type: fragment_type1,
+          parents: [*fragment_spread2.parents, fragment_type2]
+        )
+
+        # (F) First, find all conflicts between these two collections of fields
+        # (not including any nested fragments).
+        find_conflicts_between(
+          fragment_fields1,
+          fragment_fields2,
+          mutually_exclusive: mutually_exclusive,
+        )
+
+        # (G) Then collect conflicts between the first fragment and any nested
+        # fragments spread in the second fragment.
+        fragment_spreads2.each do |fragment_spread|
+          find_conflicts_between_fragments(
+            fragment_spread1,
+            fragment_spread,
+            mutually_exclusive: mutually_exclusive,
+          )
+        end
+
+        # (G) Then collect conflicts between the first fragment and any nested
+        # fragments spread in the second fragment.
+        fragment_spreads1.each do |fragment_spread|
+          find_conflicts_between_fragments(
+            fragment_spread2,
+            fragment_spread,
+            mutually_exclusive: mutually_exclusive,
+          )
+        end
+      end
+
+      def find_conflicts_between_fields_and_fragment(fragment_spread, fields, mutually_exclusive:)
+        fragment_name = fragment_spread.name
+        return if @visited_fragments.key?(fragment_name)
+        @visited_fragments[fragment_name] = true
+
+        fragment = context.fragments[fragment_name]
+        return if fragment.nil?
+
+        fragment_type = context.warden.get_type(fragment.type.name)
+        return if fragment_type.nil?
+
+        fragment_fields, fragment_spreads = fields_and_fragments_from_selection(fragment, owner_type: fragment_type, parents: [*fragment_spread.parents, fragment_type])
+
+        # (D) First find any conflicts between the provided collection of fields
+        # and the collection of fields represented by the given fragment.
+        find_conflicts_between(
+          fields,
+          fragment_fields,
+          mutually_exclusive: mutually_exclusive,
+        )
+
+        # (E) Then collect any conflicts between the provided collection of fields
+        # and any fragment names found in the given fragment.
+        fragment_spreads.each do |fragment_spread|
+          find_conflicts_between_fields_and_fragment(
+            fragment_spread,
+            fields,
+            mutually_exclusive: mutually_exclusive,
+          )
+        end
+      end
+
+      def find_conflicts_within(response_keys)
+        response_keys.each do |key, fields|
+          next if fields.size < 2
+          # find conflicts within nodes
+          for i in 0..fields.size - 1
+            for j in i + 1..fields.size - 1
+              find_conflict(key, fields[i], fields[j])
             end
+          end
+        end
+      end
+
+      def find_conflict(response_key, field1, field2, mutually_exclusive: false)
+        node1 = field1.node
+        node2 = field2.node
+
+        are_mutually_exclusive = mutually_exclusive ||
+                                 mutually_exclusive?(field1.parents, field2.parents)
+
+        if !are_mutually_exclusive
+          if node1.name != node2.name
+            errored_nodes = [node1.name, node2.name].sort.join(" or ")
+            msg = "Field '#{response_key}' has a field conflict: #{errored_nodes}?"
+            context.errors << GraphQL::StaticValidation::FieldsWillMergeError.new(
+              msg,
+              nodes: [node1, node2],
+              path: [],
+              field_name: response_key,
+              conflicts: errored_nodes
+            )
+          end
+
+          if !same_arguments?(node1, node2)
+            args = [serialize_field_args(node1), serialize_field_args(node2)]
+            conflicts = args.map { |arg| GraphQL::Language.serialize(arg) }.join(" or ")
+            msg = "Field '#{response_key}' has an argument conflict: #{conflicts}?"
+            context.errors << GraphQL::StaticValidation::FieldsWillMergeError.new(
+              msg,
+              nodes: [node1, node2],
+              path: [],
+              field_name: response_key,
+              conflicts: conflicts
+            )
+          end
+        end
+
+        find_conflicts_between_sub_selection_sets(
+          field1,
+          field2,
+          mutually_exclusive: are_mutually_exclusive,
+        )
+      end
 
-            # Check for incompatible / non-identical arguments on this node:
-            args = node.ast_nodes.map do |n|
-              if n.arguments.any?
-                n.arguments.reduce({}) do |memo, a|
-                  arg_value = a.value
-                  memo[a.name] = case arg_value
-                  when GraphQL::Language::Nodes::AbstractNode
-                    arg_value.to_query_string
-                  else
-                    GraphQL::Language.serialize(arg_value)
-                  end
-                  memo
-                end
-              else
-                NO_ARGS
+      def find_conflicts_between_sub_selection_sets(field1, field2, mutually_exclusive:)
+        return if field1.definition.nil? || field2.definition.nil?
+
+        return_type1 = field1.definition.type.unwrap
+        return_type2 = field2.definition.type.unwrap
+        parents1 = [return_type1]
+        parents2 = [return_type2]
+
+        fields, fragment_spreads = fields_and_fragments_from_selection(
+          field1.node,
+          owner_type: return_type1,
+          parents: parents1
+        )
+
+        fields2, fragment_spreads2 = fields_and_fragments_from_selection(
+          field2.node,
+          owner_type: return_type2,
+          parents: parents2
+        )
+
+        # (H) First, collect all conflicts between these two collections of field.
+        find_conflicts_between(fields, fields2, mutually_exclusive: mutually_exclusive)
+
+        # (I) Then collect conflicts between the first collection of fields and
+        # those referenced by each fragment name associated with the second.
+        fragment_spreads2.each do |fragment_spread|
+          find_conflicts_between_fields_and_fragment(
+            fragment_spread,
+            fields,
+            mutually_exclusive: mutually_exclusive,
+          )
+        end
+
+        # (I) Then collect conflicts between the second collection of fields and
+        # those referenced by each fragment name associated with the first.
+        fragment_spreads.each do |fragment_spread|
+          find_conflicts_between_fields_and_fragment(
+            fragment_spread,
+            fields2,
+            mutually_exclusive: mutually_exclusive,
+          )
+        end
+
+        # (J) Also collect conflicts between any fragment names by the first and
+        # fragment names by the second. This compares each item in the first set of
+        # names to each item in the second set of names.
+        fragment_spreads.each do |frag1|
+          fragment_spreads2.each do |frag2|
+            find_conflicts_between_fragments(
+              frag1,
+              frag2,
+              mutually_exclusive: mutually_exclusive
+            )
+          end
+        end
+      end
+
+      def find_conflicts_between(response_keys, response_keys2, mutually_exclusive:)
+        response_keys.each do |key, fields|
+          fields2 = response_keys2[key]
+          if fields2
+            fields.each do |field|
+              fields2.each do |field2|
+                find_conflict(
+                  key,
+                  field,
+                  field2,
+                  mutually_exclusive: mutually_exclusive,
+                )
               end
             end
-            args.uniq!
+          end
+        end
+      end
+
+      NO_SELECTIONS = [{}.freeze, [].freeze].freeze
+
+      def fields_and_fragments_from_selection(node, owner_type:, parents:)
+        if node.selections.empty?
+          NO_SELECTIONS
+        else
+          fields, fragment_spreads = find_fields_and_fragments(node.selections, owner_type: owner_type, parents: parents, fields: [], fragment_spreads: [])
+          response_keys = fields.group_by { |f| f.node.alias || f.node.name }
+          [response_keys, fragment_spreads]
+        end
+      end
+
+      def find_fields_and_fragments(selections, owner_type:, parents:, fields:, fragment_spreads:)
+        selections.each do |node|
+          case node
+          when GraphQL::Language::Nodes::Field
+            definition = context.schema.get_field(owner_type, node.name)
+            fields << Field.new(node, definition, owner_type, parents)
+          when GraphQL::Language::Nodes::InlineFragment
+            fragment_type = node.type ? context.warden.get_type(node.type.name) : owner_type
+            find_fields_and_fragments(node.selections, parents: [*parents, fragment_type], owner_type: owner_type, fields: fields, fragment_spreads: fragment_spreads) if fragment_type
+          when GraphQL::Language::Nodes::FragmentSpread
+            fragment_spreads << FragmentSpread.new(node.name, parents)
+          end
+        end
+
+        [fields, fragment_spreads]
+      end
+
+      def same_arguments?(field1, field2)
+        # Check for incompatible / non-identical arguments on this node:
+        arguments1 = field1.arguments
+        arguments2 = field2.arguments
+
+        return false if arguments1.length != arguments2.length
+
+        arguments1.all? do |argument1|
+          argument2 = arguments2.find { |argument| argument.name == argument1.name }
+          return false if argument2.nil?
+
+          serialize_arg(argument1.value) == serialize_arg(argument2.value)
+        end
+      end
+
+      def serialize_arg(arg_value)
+        case arg_value
+        when GraphQL::Language::Nodes::AbstractNode
+          arg_value.to_query_string
+        when Array
+          "[#{arg_value.map { |a| serialize_arg(a) }.join(", ")}]"
+        else
+          GraphQL::Language.serialize(arg_value)
+        end
+      end
+
+      def serialize_field_args(field)
+        serialized_args = {}
+        field.arguments.each do |argument|
+          serialized_args[argument.name] = serialize_arg(argument.value)
+        end
+        serialized_args
+      end
+
+      def compared_fragments_key(frag1, frag2, exclusive)
+        # Cache key to not compare two fragments more than once.
+        # The key includes both fragment names sorted (this way we
+        # avoid computing "A vs B" and "B vs A"). It also includes
+        # "exclusive" since the result may change depending on the parent_type
+        "#{[frag1, frag2].sort.join('-')}-#{exclusive}"
+      end
 
-            if args.length > 1
-              msg = "Field '#{node.name}' has an argument conflict: #{args.map{ |arg| GraphQL::Language.serialize(arg) }.join(" or ")}?"
-              context.errors << GraphQL::StaticValidation::Message.new(msg, nodes: node.ast_nodes.to_a)
+      # Given two list of parents, find out if they are mutually exclusive
+      # In this context, `parents` represends the "self scope" of the field,
+      # what types may be found at this point in the query.
+      def mutually_exclusive?(parents1, parents2)
+        if parents1.empty? || parents2.empty?
+          false
+        elsif parents1.length == parents2.length
+          parents1.length.times.any? do |i|
+            type1 = parents1[i - 1]
+            type2 = parents2[i - 1]
+            if type1 == type2
+              # If the types we're comparing are the same type,
+              # then they aren't mutually exclusive
+              false
+            else
+              # Check if these two scopes have _any_ types in common.
+              possible_right_types = context.query.possible_types(type1)
+              possible_left_types = context.query.possible_types(type2)
+              (possible_right_types & possible_left_types).empty?
             end
           end
+        else
+          true
         end
       end
     end

data/lib/graphql/static_validation/rules/fields_will_merge_error.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module GraphQL
+  module StaticValidation
+    class FieldsWillMergeError < StaticValidation::Error
+      attr_reader :field_name
+      attr_reader :conflicts
+
+      def initialize(message, path: nil, nodes: [], field_name:, conflicts:)
+        super(message, path: path, nodes: nodes)
+        @field_name = field_name
+        @conflicts = conflicts
+      end
+
+      # A hash representation of this Message
+      def to_h
+        extensions = {
+          "code" => code,
+          "fieldName" => field_name,
+          "conflicts" => conflicts
+        }
+
+        super.merge({
+          "extensions" => extensions
+        })
+      end
+
+      def code
+        "fieldConflict"
+      end
+    end
+  end
+end