Class: GraphQL::Analysis::QueryDepth

Inherits:
Object
  • Object
show all
Defined in:
lib/graphql/analysis/query_depth.rb

Overview

A query reducer for measuring the depth of a given query.

Examples:

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

Direct Known Subclasses

MaxQueryDepth

Instance Method Summary collapse

Constructor Details

#initialize(&block) ⇒ QueryDepth

Returns a new instance of QueryDepth


11
12
13
# File 'lib/graphql/analysis/query_depth.rb', line 11

def initialize(&block)
  @depth_handler = block
end

Instance Method Details

#call(memo, visit_type, irep_node) ⇒ Object


24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/graphql/analysis/query_depth.rb', line 24

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

#final_value(memo) ⇒ Object


50
51
52
# File 'lib/graphql/analysis/query_depth.rb', line 50

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

#initial_value(query) ⇒ Object


15
16
17
18
19
20
21
22
# File 'lib/graphql/analysis/query_depth.rb', line 15

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