Contents

# frozen_string_literal: true
module GraphQL
  module Analysis
    # A query reducer for measuring the depth of a given query.
    #
    # @example Logging the depth of a query
    #   Schema.query_analyzers << GraphQL::Analysis::QueryDepth.new { |query, depth|  puts "GraphQL query depth: #{depth}" }
    #   Schema.execute(query_str)
    #   # GraphQL query depth: 8
    #
    class QueryDepth
      def initialize(&block)
        @depth_handler = block
      end

      def initial_value(query)
        {
          max_depth: 0,
          current_depth: 0,
          skip_depth: 0,
          query: query,
        }
      end

      def call(memo, visit_type, irep_node)
        if irep_node.ast_node.is_a?(GraphQL::Language::Nodes::Field)
          # Don't validate introspection fields or skipped nodes
          not_validated_node = GraphQL::Schema::DYNAMIC_FIELDS.include?(irep_node.definition_name) || !irep_node.included?
          if visit_type == :enter
            if not_validated_node
              memo[:skip_depth] += 1
            elsif memo[:skip_depth] > 0
              # we're inside an introspection query or skipped node
            else
              memo[:current_depth] += 1
            end
          else
            if not_validated_node
              memo[:skip_depth] -= 1
            else
              if memo[:max_depth] < memo[:current_depth]
                memo[:max_depth] = memo[:current_depth]
              end
              memo[:current_depth] -= 1
            end
          end
        end
        memo
      end

      def final_value(memo)
        @depth_handler.call(memo[:query], memo[:max_depth])
      end
    end
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version	Path
graphql-1.4.5	lib/graphql/analysis/query_depth.rb
graphql-1.4.4	lib/graphql/analysis/query_depth.rb
graphql-1.4.3	lib/graphql/analysis/query_depth.rb
graphql-1.4.2	lib/graphql/analysis/query_depth.rb
graphql-1.4.1	lib/graphql/analysis/query_depth.rb
graphql-1.4.0	lib/graphql/analysis/query_depth.rb
graphql-1.3.0	lib/graphql/analysis/query_depth.rb