graphql 2.0.32 → 2.5.22

data/lib/graphql/analysis/ast/field_usage.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module Analysis
-    module AST
-      class FieldUsage < Analyzer
-        def initialize(query)
-          super
-          @used_fields = Set.new
-          @used_deprecated_fields = Set.new
-          @used_deprecated_arguments = Set.new
-        end
-
-        def on_leave_field(node, parent, visitor)
-          field_defn = visitor.field_definition
-          field = "#{visitor.parent_type_definition.graphql_name}.#{field_defn.graphql_name}"
-          @used_fields << field
-          @used_deprecated_fields << field if field_defn.deprecation_reason
-          arguments = visitor.query.arguments_for(node, visitor.field_definition)
-          # If there was an error when preparing this argument object,
-          # then this might be an error or something:
-          if arguments.respond_to?(:argument_values)
-            extract_deprecated_arguments(arguments.argument_values)
-          end
-        end
-
-        def result
-          {
-            used_fields: @used_fields.to_a,
-            used_deprecated_fields: @used_deprecated_fields.to_a,
-            used_deprecated_arguments: @used_deprecated_arguments.to_a,
-          }
-        end
-
-        private
-
-        def extract_deprecated_arguments(argument_values)
-          argument_values.each_pair do |_argument_name, argument|
-            if argument.definition.deprecation_reason
-              @used_deprecated_arguments << argument.definition.path
-            end
-
-            next if argument.value.nil?
-
-            if argument.definition.type.kind.input_object?
-              extract_deprecated_arguments(argument.value.arguments.argument_values) # rubocop:disable Development/ContextIsPassedCop -- runtime args instance
-            elsif argument.definition.type.list?
-              argument
-                .value
-                .select { |value| value.respond_to?(:arguments) }
-                .each { |value| extract_deprecated_arguments(value.arguments.argument_values) } # rubocop:disable Development/ContextIsPassedCop -- runtime args instance
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/graphql/analysis/ast/max_query_complexity.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module Analysis
-    module AST
-      # Used under the hood to implement complexity validation,
-      # see {Schema#max_complexity} and {Query#max_complexity}
-      class MaxQueryComplexity < QueryComplexity
-        def result
-          return if subject.max_complexity.nil?
-
-          total_complexity = max_possible_complexity
-
-          if total_complexity > subject.max_complexity
-            GraphQL::AnalysisError.new("Query has complexity of #{total_complexity}, which exceeds max complexity of #{subject.max_complexity}")
-          else
-            nil
-          end
-        end
-      end
-    end
-  end
-end

data/lib/graphql/analysis/ast/max_query_depth.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module Analysis
-    module AST
-      class MaxQueryDepth < QueryDepth
-        def result
-          configured_max_depth = if query
-            query.max_depth
-          else
-            multiplex.schema.max_depth
-          end
-
-          if configured_max_depth && @max_depth > configured_max_depth
-            GraphQL::AnalysisError.new("Query has depth of #{@max_depth}, which exceeds max depth of #{configured_max_depth}")
-          else
-            nil
-          end
-        end
-      end
-    end
-  end
-end

data/lib/graphql/analysis/ast/query_complexity.rb

@@ -1,230 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module Analysis
-    # Calculate the complexity of a query, using {Field#complexity} values.
-    module AST
-      class QueryComplexity < Analyzer
-        # State for the query complexity calculation:
-        # - `complexities_on_type` holds complexity scores for each type
-        def initialize(query)
-          super
-          @complexities_on_type_by_query = {}
-        end
-
-        # Overide this method to use the complexity result
-        def result
-          max_possible_complexity
-        end
-
-        class ScopedTypeComplexity
-          # A single proc for {#scoped_children} hashes. Use this to avoid repeated allocations,
-          # since the lexical binding isn't important.
-          HASH_CHILDREN = ->(h, k) { h[k] = {} }
-
-          attr_reader :field_definition, :response_path, :query
-
-          # @param parent_type [Class] The owner of `field_definition`
-          # @param field_definition [GraphQL::Field, GraphQL::Schema::Field] Used for getting the `.complexity` configuration
-          # @param query [GraphQL::Query] Used for `query.possible_types`
-          # @param response_path [Array<String>] The path to the response key for the field
-          def initialize(parent_type, field_definition, query, response_path)
-            @parent_type = parent_type
-            @field_definition = field_definition
-            @query = query
-            @response_path = response_path
-            @scoped_children = nil
-            @nodes = []
-          end
-
-          # @return [Array<GraphQL::Language::Nodes::Field>]
-          attr_reader :nodes
-
-          # Returns true if this field has no selections, ie, it's a scalar.
-          # We need a quick way to check whether we should continue traversing.
-          def terminal?
-            @scoped_children.nil?
-          end
-
-          # This value is only calculated when asked for to avoid needless hash allocations.
-          # Also, if it's never asked for, we determine that this scope complexity
-          # is a scalar field ({#terminal?}).
-          # @return [Hash<Hash<Class => ScopedTypeComplexity>]
-          def scoped_children
-            @scoped_children ||= Hash.new(&HASH_CHILDREN)
-          end
-
-          def own_complexity(child_complexity)
-            @field_definition.calculate_complexity(query: @query, nodes: @nodes, child_complexity: child_complexity)
-          end
-        end
-
-        def on_enter_field(node, parent, visitor)
-          # We don't want to visit fragment definitions,
-          # we'll visit them when we hit the spreads instead
-          return if visitor.visiting_fragment_definition?
-          return if visitor.skipping?
-          parent_type = visitor.parent_type_definition
-          field_key = node.alias || node.name
-          # Find the complexity calculation for this field --
-          # if we're re-entering a selection, we'll already have one.
-          # Otherwise, make a new one and store it.
-          #
-          # `node` and `visitor.field_definition` may appear from a cache,
-          # but I think that's ok. If the arguments _didn't_ match,
-          # then the query would have been rejected as invalid.
-          complexities_on_type = @complexities_on_type_by_query[visitor.query] ||= [ScopedTypeComplexity.new(nil, nil, query, visitor.response_path)]
-
-          complexity = complexities_on_type.last.scoped_children[parent_type][field_key] ||= ScopedTypeComplexity.new(parent_type, visitor.field_definition, visitor.query, visitor.response_path)
-          complexity.nodes.push(node)
-          # Push it on the stack.
-          complexities_on_type.push(complexity)
-        end
-
-        def on_leave_field(node, parent, visitor)
-          # We don't want to visit fragment definitions,
-          # we'll visit them when we hit the spreads instead
-          return if visitor.visiting_fragment_definition?
-          return if visitor.skipping?
-          complexities_on_type = @complexities_on_type_by_query[visitor.query]
-          complexities_on_type.pop
-        end
-
-        private
-
-        # @return [Integer]
-        def max_possible_complexity
-          @complexities_on_type_by_query.reduce(0) do |total, (query, complexities_on_type)|
-            root_complexity = complexities_on_type.last
-            # Use this entry point to calculate the total complexity
-            total_complexity_for_query = merged_max_complexity_for_scopes(query, [root_complexity.scoped_children])
-            total + total_complexity_for_query
-          end
-        end
-
-        # @param query [GraphQL::Query] Used for `query.possible_types`
-        # @param scoped_children_hashes [Array<Hash>] Array of scoped children hashes
-        # @return [Integer]
-        def merged_max_complexity_for_scopes(query, scoped_children_hashes)
-          # Figure out what scopes are possible here.
-          # Use a hash, but ignore the values; it's just a fast way to work with the keys.
-          all_scopes = {}
-          scoped_children_hashes.each do |h|
-            all_scopes.merge!(h)
-          end
-
-          # If an abstract scope is present, but _all_ of its concrete types
-          # are also in the list, remove it from the list of scopes to check,
-          # because every possible type is covered by a concrete type.
-          # (That is, there are no remainder types to check.)
-          prev_keys = all_scopes.keys
-          prev_keys.each do |scope|
-            next unless scope.kind.abstract?
-
-            missing_concrete_types = query.possible_types(scope).select { |t| !all_scopes.key?(t) }
-            # This concrete type is possible _only_ as a member of the abstract type.
-            # So, attribute to it the complexity which belongs to the abstract type.
-            missing_concrete_types.each do |concrete_scope|
-              all_scopes[concrete_scope] = all_scopes[scope]
-            end
-            all_scopes.delete(scope)
-          end
-
-          # This will hold `{ type => int }` pairs, one for each possible branch
-          complexity_by_scope = {}
-
-          # For each scope,
-          # find the lexical selections that might apply to it,
-          # and gather them together into an array.
-          # Then, treat the set of selection hashes
-          # as a set and calculate the complexity for them as a unit
-          all_scopes.each do |scope, _|
-            # These will be the selections on `scope`
-            children_for_scope = []
-            scoped_children_hashes.each do |sc_h|
-              sc_h.each do |inner_scope, children_hash|
-                if applies_to?(query, scope, inner_scope)
-                  children_for_scope << children_hash
-                end
-              end
-            end
-
-            # Calculate the complexity for `scope`, merging all
-            # possible lexical branches.
-            complexity_value = merged_max_complexity(query, children_for_scope)
-            complexity_by_scope[scope] = complexity_value
-          end
-
-          # Return the max complexity among all scopes
-          complexity_by_scope.each_value.max
-        end
-
-        def applies_to?(query, left_scope, right_scope)
-          if left_scope == right_scope
-            # This can happen when several branches are being analyzed together
-            true
-          else
-            # Check if these two scopes have _any_ types in common.
-            possible_right_types = query.possible_types(right_scope)
-            possible_left_types = query.possible_types(left_scope)
-            !(possible_right_types & possible_left_types).empty?
-          end
-        end
-
-        # A hook which is called whenever a field's max complexity is calculated.
-        # Override this method to capture individual field complexity details.
-        #
-        # @param scoped_type_complexity [ScopedTypeComplexity]
-        # @param max_complexity [Numeric] Field's maximum complexity including child complexity
-        # @param child_complexity [Numeric, nil] Field's child complexity
-        def field_complexity(scoped_type_complexity, max_complexity:, child_complexity: nil)
-        end
-
-        # @param children_for_scope [Array<Hash>] An array of `scoped_children[scope]` hashes
-        # (`{field_key => complexity}`)
-        # @return [Integer] Complexity value for all these selections in the current scope
-        def merged_max_complexity(query, children_for_scope)
-          all_keys = []
-          children_for_scope.each do |c|
-            all_keys.concat(c.keys)
-          end
-          all_keys.uniq!
-          complexity_for_keys = {}
-
-          all_keys.each do |child_key|
-            scoped_children_for_key = nil
-            complexity_for_key = nil
-            children_for_scope.each do |children_hash|
-              next unless children_hash.key?(child_key)
-
-              complexity_for_key = children_hash[child_key]
-              if complexity_for_key.terminal?
-                # Assume that all terminals would return the same complexity
-                # Since it's a terminal, its child complexity is zero.
-                complexity = complexity_for_key.own_complexity(0)
-                complexity_for_keys[child_key] = complexity
-
-                field_complexity(complexity_for_key, max_complexity: complexity, child_complexity: nil)
-              else
-                scoped_children_for_key ||= []
-                scoped_children_for_key << complexity_for_key.scoped_children
-              end
-            end
-
-            next unless scoped_children_for_key
-
-            child_complexity = merged_max_complexity_for_scopes(query, scoped_children_for_key)
-            # This is the _last_ one we visited; assume it's representative.
-            max_complexity = complexity_for_key.own_complexity(child_complexity)
-
-            field_complexity(complexity_for_key, max_complexity: max_complexity, child_complexity: child_complexity)
-
-            complexity_for_keys[child_key] = max_complexity
-          end
-
-          # Calculate the child complexity by summing the complexity of all selections
-          complexity_for_keys.each_value.inject(0, &:+)
-        end
-      end
-    end
-  end
-end

data/lib/graphql/analysis/ast/query_depth.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module Analysis
-    # A query reducer for measuring the depth of a given query.
-    #
-    # See https://graphql-ruby.org/queries/ast_analysis.html for more examples.
-    #
-    # @example Logging the depth of a query
-    #   class LogQueryDepth < GraphQL::Analysis::QueryDepth
-    #     def result
-    #       log("GraphQL query depth: #{@max_depth}")
-    #     end
-    #   end
-    #
-    #   # In your Schema file:
-    #
-    #   class MySchema < GraphQL::Schema
-    #     query_analyzer LogQueryDepth
-    #   end
-    #
-    #   # When you run the query, the depth will get logged:
-    #
-    #   Schema.execute(query_str)
-    #   # GraphQL query depth: 8
-    #
-    module AST
-      class QueryDepth < Analyzer
-        def initialize(query)
-          @max_depth = 0
-          @current_depth = 0
-          super
-        end
-
-        def on_enter_field(node, parent, visitor)
-          return if visitor.skipping? || visitor.visiting_fragment_definition?
-
-          @current_depth += 1
-        end
-
-        def on_leave_field(node, parent, visitor)
-          return if visitor.skipping? || visitor.visiting_fragment_definition?
-
-          if @max_depth < @current_depth
-            @max_depth = @current_depth
-          end
-          @current_depth -= 1
-        end
-
-        def result
-          @max_depth
-        end
-      end
-    end
-  end
-end

data/lib/graphql/analysis/ast/visitor.rb

@@ -1,276 +0,0 @@
-# frozen_string_literal: true
-module GraphQL
-  module Analysis
-    module AST
-      # Depth first traversal through a query AST, calling AST analyzers
-      # along the way.
-      #
-      # The visitor is a special case of GraphQL::Language::Visitor, visiting
-      # only the selected operation, providing helpers for common use cases such
-      # as skipped fields and visiting fragment spreads.
-      #
-      # @see {GraphQL::Analysis::AST::Analyzer} AST Analyzers for queries
-      class Visitor < GraphQL::Language::Visitor
-        def initialize(query:, analyzers:)
-          @analyzers = analyzers
-          @path = []
-          @object_types = []
-          @directives = []
-          @field_definitions = []
-          @argument_definitions = []
-          @directive_definitions = []
-          @rescued_errors = []
-          @query = query
-          @schema = query.schema
-          @response_path = []
-          @skip_stack = [false]
-          super(query.selected_operation)
-        end
-
-        # @return [GraphQL::Query] the query being visited
-        attr_reader :query
-
-        # @return [Array<GraphQL::ObjectType>] Types whose scope we've entered
-        attr_reader :object_types
-
-        # @return [Array<GraphQL::AnalysisError]
-        attr_reader :rescued_errors
-
-        def visit
-          return unless @document
-          super
-        end
-
-        # Visit Helpers
-
-        # @return [GraphQL::Execution::Interpreter::Arguments] Arguments for this node, merging default values, literal values and query variables
-        # @see {GraphQL::Query#arguments_for}
-        def arguments_for(ast_node, field_definition)
-          @query.arguments_for(ast_node, field_definition)
-        end
-
-        # @return [Boolean] If the visitor is currently inside a fragment definition
-        def visiting_fragment_definition?
-          @in_fragment_def
-        end
-
-        # @return [Boolean] If the current node should be skipped because of a skip or include directive
-        def skipping?
-          @skipping
-        end
-
-        # @return [Array<String>] The path to the response key for the current field
-        def response_path
-          @response_path.dup
-        end
-
-        # Visitor Hooks
-        [
-          :operation_definition, :fragment_definition,
-          :inline_fragment, :field, :directive, :argument, :fragment_spread
-        ].each do |node_type|
-          module_eval <<-RUBY, __FILE__, __LINE__
-          def call_on_enter_#{node_type}(node, parent)
-            @analyzers.each do |a|
-              begin
-                a.on_enter_#{node_type}(node, parent, self)
-              rescue AnalysisError => err
-                @rescued_errors << err
-              end
-            end
-          end
-
-          def call_on_leave_#{node_type}(node, parent)
-            @analyzers.each do |a|
-              begin
-                a.on_leave_#{node_type}(node, parent, self)
-              rescue AnalysisError => err
-                @rescued_errors << err
-              end
-            end
-          end
-
-          RUBY
-        end
-
-        def on_operation_definition(node, parent)
-          object_type = @schema.root_type_for_operation(node.operation_type)
-          @object_types.push(object_type)
-          @path.push("#{node.operation_type}#{node.name ? " #{node.name}" : ""}")
-          call_on_enter_operation_definition(node, parent)
-          super
-          call_on_leave_operation_definition(node, parent)
-          @object_types.pop
-          @path.pop
-        end
-
-        def on_fragment_definition(node, parent)
-          on_fragment_with_type(node) do
-            @path.push("fragment #{node.name}")
-            @in_fragment_def = false
-            call_on_enter_fragment_definition(node, parent)
-            super
-            @in_fragment_def = false
-            call_on_leave_fragment_definition(node, parent)
-          end
-        end
-
-        def on_inline_fragment(node, parent)
-          on_fragment_with_type(node) do
-            @path.push("...#{node.type ? " on #{node.type.name}" : ""}")
-            call_on_enter_inline_fragment(node, parent)
-            super
-            call_on_leave_inline_fragment(node, parent)
-          end
-        end
-
-        def on_field(node, parent)
-          @response_path.push(node.alias || node.name)
-          parent_type = @object_types.last
-          # This could be nil if the previous field wasn't found:
-          field_definition = parent_type && @schema.get_field(parent_type, node.name, @query.context)
-          @field_definitions.push(field_definition)
-          if !field_definition.nil?
-            next_object_type = field_definition.type.unwrap
-            @object_types.push(next_object_type)
-          else
-            @object_types.push(nil)
-          end
-          @path.push(node.alias || node.name)
-
-          @skipping = @skip_stack.last || skip?(node)
-          @skip_stack << @skipping
-
-          call_on_enter_field(node, parent)
-          super
-          @skipping = @skip_stack.pop
-          call_on_leave_field(node, parent)
-          @response_path.pop
-          @field_definitions.pop
-          @object_types.pop
-          @path.pop
-        end
-
-        def on_directive(node, parent)
-          directive_defn = @schema.directives[node.name]
-          @directive_definitions.push(directive_defn)
-          call_on_enter_directive(node, parent)
-          super
-          call_on_leave_directive(node, parent)
-          @directive_definitions.pop
-        end
-
-        def on_argument(node, parent)
-          argument_defn = if (arg = @argument_definitions.last)
-            arg_type = arg.type.unwrap
-            if arg_type.kind.input_object?
-              arg_type.get_argument(node.name, @query.context)
-            else
-              nil
-            end
-          elsif (directive_defn = @directive_definitions.last)
-            directive_defn.get_argument(node.name, @query.context)
-          elsif (field_defn = @field_definitions.last)
-            field_defn.get_argument(node.name, @query.context)
-          else
-            nil
-          end
-
-          @argument_definitions.push(argument_defn)
-          @path.push(node.name)
-          call_on_enter_argument(node, parent)
-          super
-          call_on_leave_argument(node, parent)
-          @argument_definitions.pop
-          @path.pop
-        end
-
-        def on_fragment_spread(node, parent)
-          @path.push("... #{node.name}")
-          call_on_enter_fragment_spread(node, parent)
-          enter_fragment_spread_inline(node)
-          super
-          leave_fragment_spread_inline(node)
-          call_on_leave_fragment_spread(node, parent)
-          @path.pop
-        end
-
-        # @return [GraphQL::BaseType] The current object type
-        def type_definition
-          @object_types.last
-        end
-
-        # @return [GraphQL::BaseType] The type which the current type came from
-        def parent_type_definition
-          @object_types[-2]
-        end
-
-        # @return [GraphQL::Field, nil] The most-recently-entered GraphQL::Field, if currently inside one
-        def field_definition
-          @field_definitions.last
-        end
-
-        # @return [GraphQL::Field, nil] The GraphQL field which returned the object that the current field belongs to
-        def previous_field_definition
-          @field_definitions[-2]
-        end
-
-        # @return [GraphQL::Directive, nil] The most-recently-entered GraphQL::Directive, if currently inside one
-        def directive_definition
-          @directive_definitions.last
-        end
-
-        # @return [GraphQL::Argument, nil] The most-recently-entered GraphQL::Argument, if currently inside one
-        def argument_definition
-          @argument_definitions.last
-        end
-
-        # @return [GraphQL::Argument, nil] The previous GraphQL argument
-        def previous_argument_definition
-          @argument_definitions[-2]
-        end
-
-        private
-
-        # Visit a fragment spread inline instead of visiting the definition
-        # by itself.
-        def enter_fragment_spread_inline(fragment_spread)
-          fragment_def = query.fragments[fragment_spread.name]
-
-          object_type = if fragment_def.type
-            @query.warden.get_type(fragment_def.type.name)
-          else
-            object_types.last
-          end
-
-          object_types << object_type
-
-          on_fragment_definition_children(fragment_def)
-        end
-
-        # Visit a fragment spread inline instead of visiting the definition
-        # by itself.
-        def leave_fragment_spread_inline(_fragment_spread)
-          object_types.pop
-        end
-
-        def skip?(ast_node)
-          dir = ast_node.directives
-          dir.any? && !GraphQL::Execution::DirectiveChecks.include?(dir, query)
-        end
-
-        def on_fragment_with_type(node)
-          object_type = if node.type
-            @query.warden.get_type(node.type.name)
-          else
-            @object_types.last
-          end
-          @object_types.push(object_type)
-          yield(node)
-          @object_types.pop
-          @path.pop
-        end
-      end
-    end
-  end
-end